update docs

shinyoshiaki · Oct 13, 2024 · d70aea5 · d70aea5
1 parent 1b7fa3e
commit d70aea5
Show file tree

Hide file tree

Showing 438 changed files with 14,101 additions and 10,988 deletions.
diff --git a/doc/.nojekyll b/doc/.nojekyll
diff --git a/doc/README.md b/doc/README.md
@@ -1,4 +1,6 @@
-werift / [Exports](modules.md)
+**werift** • [**Docs**](globals.md)
+
+***
 
 # werift
 

diff --git a/doc/classes/AV1Obu.md b/doc/classes/AV1Obu.md
@@ -1,32 +1,16 @@
-[werift](../README.md) / [Exports](../modules.md) / AV1Obu
+[**werift**](../README.md) • **Docs**
 
-# Class: AV1Obu
-
-## Table of contents
-
-### Constructors
-
-- [constructor](AV1Obu.md#constructor)
+***
 
-### Properties
+[werift](../globals.md) / AV1Obu
 
-- [obu\_extension\_flag](AV1Obu.md#obu_extension_flag)
-- [obu\_forbidden\_bit](AV1Obu.md#obu_forbidden_bit)
-- [obu\_has\_size\_field](AV1Obu.md#obu_has_size_field)
-- [obu\_reserved\_1bit](AV1Obu.md#obu_reserved_1bit)
-- [obu\_type](AV1Obu.md#obu_type)
-- [payload](AV1Obu.md#payload)
-
-### Methods
-
-- [serialize](AV1Obu.md#serialize)
-- [deSerialize](AV1Obu.md#deserialize)
+# Class: AV1Obu
 
 ## Constructors
 
-### constructor
+### new AV1Obu()
 
-• **new AV1Obu**(): [`AV1Obu`](AV1Obu.md)
+> **new AV1Obu**(): [`AV1Obu`](AV1Obu.md)
 
 #### Returns
 
@@ -36,59 +20,57 @@
 
 ### obu\_extension\_flag
 
-• **obu\_extension\_flag**: `number`
+> **obu\_extension\_flag**: `number`
 
-___
+***
 
 ### obu\_forbidden\_bit
 
-• **obu\_forbidden\_bit**: `number`
+> **obu\_forbidden\_bit**: `number`
 
-___
+***
 
 ### obu\_has\_size\_field
 
-• **obu\_has\_size\_field**: `number`
+> **obu\_has\_size\_field**: `number`
 
-___
+***
 
 ### obu\_reserved\_1bit
 
-• **obu\_reserved\_1bit**: `number`
+> **obu\_reserved\_1bit**: `number`
 
-___
+***
 
 ### obu\_type
 
-• **obu\_type**: `OBU_TYPE`
+> **obu\_type**: `OBU_TYPE`
 
-___
+***
 
 ### payload
 
-• **payload**: `Buffer`
+> **payload**: `Buffer`
 
 ## Methods
 
-### serialize
+### serialize()
 
-▸ **serialize**(): `Buffer`
+> **serialize**(): `Buffer`
 
 #### Returns
 
 `Buffer`
 
-___
+***
 
-### deSerialize
+### deSerialize()
 
-▸ **deSerialize**(`buf`): [`AV1Obu`](AV1Obu.md)
+> `static` **deSerialize**(`buf`): [`AV1Obu`](AV1Obu.md)
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `buf` | `Buffer` |
+• **buf**: `Buffer`
 
 #### Returns
 

diff --git a/doc/classes/AV1RtpPayload.md b/doc/classes/AV1RtpPayload.md
@@ -1,36 +1,16 @@
-[werift](../README.md) / [Exports](../modules.md) / AV1RtpPayload
+[**werift**](../README.md) • **Docs**
 
-# Class: AV1RtpPayload
-
-## Table of contents
-
-### Constructors
-
-- [constructor](AV1RtpPayload.md#constructor)
-
-### Properties
+***
 
-- [nBit\_RtpStartsNewCodedVideoSequence](AV1RtpPayload.md#nbit_rtpstartsnewcodedvideosequence)
-- [obu\_or\_fragment](AV1RtpPayload.md#obu_or_fragment)
-- [w\_RtpNumObus](AV1RtpPayload.md#w_rtpnumobus)
-- [yBit\_RtpEndsWithFragment](AV1RtpPayload.md#ybit_rtpendswithfragment)
-- [zBit\_RtpStartsWithFragment](AV1RtpPayload.md#zbit_rtpstartswithfragment)
+[werift](../globals.md) / AV1RtpPayload
 
-### Accessors
-
-- [isKeyframe](AV1RtpPayload.md#iskeyframe)
-
-### Methods
-
-- [deSerialize](AV1RtpPayload.md#deserialize)
-- [getFrame](AV1RtpPayload.md#getframe)
-- [isDetectedFinalPacketInSequence](AV1RtpPayload.md#isdetectedfinalpacketinsequence)
+# Class: AV1RtpPayload
 
 ## Constructors
 
-### constructor
+### new AV1RtpPayload()
 
-• **new AV1RtpPayload**(): [`AV1RtpPayload`](AV1RtpPayload.md)
+> **new AV1RtpPayload**(): [`AV1RtpPayload`](AV1RtpPayload.md)
 
 #### Returns
 
@@ -40,40 +20,40 @@
 
 ### nBit\_RtpStartsNewCodedVideoSequence
 
-• **nBit\_RtpStartsNewCodedVideoSequence**: `number`
+> **nBit\_RtpStartsNewCodedVideoSequence**: `number`
 
 RtpStartsNewCodedVideoSequence
 MUST be set to 1 if the packet is the first packet of a coded video sequence, and MUST be set to 0 otherwise.
 
-___
+***
 
 ### obu\_or\_fragment
 
-• **obu\_or\_fragment**: \{ `data`: `Buffer` ; `isFragment`: `boolean`  }[] = `[]`
+> **obu\_or\_fragment**: `object`[] = `[]`
 
-___
+***
 
 ### w\_RtpNumObus
 
-• **w\_RtpNumObus**: `number`
+> **w\_RtpNumObus**: `number`
 
 RtpNumObus
 two bit field that describes the number of OBU elements in the packet. This field MUST be set equal to 0 or equal to the number of OBU elements contained in the packet. If set to 0, each OBU element MUST be preceded by a length field.
 
-___
+***
 
 ### yBit\_RtpEndsWithFragment
 
-• **yBit\_RtpEndsWithFragment**: `number`
+> **yBit\_RtpEndsWithFragment**: `number`
 
 RtpEndsWithFragment
 MUST be set to 1 if the last OBU element is an OBU fragment that will continue in the next packet, and MUST be set to 0 otherwise.
 
-___
+***
 
 ### zBit\_RtpStartsWithFragment
 
-• **zBit\_RtpStartsWithFragment**: `number`
+> **zBit\_RtpStartsWithFragment**: `number`
 
 RtpStartsWithFragment
 MUST be set to 1 if the first OBU element is an OBU fragment that is a continuation of an OBU fragment from the previous packet, and MUST be set to 0 otherwise.
@@ -82,55 +62,49 @@ MUST be set to 1 if the first OBU element is an OBU fragment that is a continuat
 
 ### isKeyframe
 
-• `get` **isKeyframe**(): `boolean`
+> `get` **isKeyframe**(): `boolean`
 
 #### Returns
 
 `boolean`
 
 ## Methods
 
-### deSerialize
+### deSerialize()
 
-▸ **deSerialize**(`buf`): [`AV1RtpPayload`](AV1RtpPayload.md)
+> `static` **deSerialize**(`buf`): [`AV1RtpPayload`](AV1RtpPayload.md)
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `buf` | `Buffer` |
+• **buf**: `Buffer`
 
 #### Returns
 
 [`AV1RtpPayload`](AV1RtpPayload.md)
 
-___
+***
 
-### getFrame
+### getFrame()
 
-▸ **getFrame**(`payloads`): `Buffer`
+> `static` **getFrame**(`payloads`): `Buffer`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `payloads` | [`AV1RtpPayload`](AV1RtpPayload.md)[] |
+• **payloads**: [`AV1RtpPayload`](AV1RtpPayload.md)[]
 
 #### Returns
 
 `Buffer`
 
-___
+***
 
-### isDetectedFinalPacketInSequence
+### isDetectedFinalPacketInSequence()
 
-▸ **isDetectedFinalPacketInSequence**(`header`): `boolean`
+> `static` **isDetectedFinalPacketInSequence**(`header`): `boolean`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `header` | [`RtpHeader`](RtpHeader.md) |
+• **header**: [`RtpHeader`](RtpHeader.md)
 
 #### Returns
 

diff --git a/doc/classes/BitStream.md b/doc/classes/BitStream.md
@@ -1,34 +1,20 @@
-[werift](../README.md) / [Exports](../modules.md) / BitStream
+[**werift**](../README.md) • **Docs**
 
-# Class: BitStream
-
-## Table of contents
-
-### Constructors
-
-- [constructor](BitStream.md#constructor)
-
-### Properties
-
-- [uint8Array](BitStream.md#uint8array)
+***
 
-### Methods
+[werift](../globals.md) / BitStream
 
-- [readBits](BitStream.md#readbits)
-- [seekTo](BitStream.md#seekto)
-- [writeBits](BitStream.md#writebits)
+# Class: BitStream
 
 ## Constructors
 
-### constructor
+### new BitStream()
 
-• **new BitStream**(`uint8Array`): [`BitStream`](BitStream.md)
+> **new BitStream**(`uint8Array`): [`BitStream`](BitStream.md)
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `uint8Array` | `Buffer` |
+• **uint8Array**: `Buffer`
 
 #### Returns
 
@@ -38,53 +24,49 @@
 
 ### uint8Array
 
-• **uint8Array**: `Buffer`
+> **uint8Array**: `Buffer`
 
 ## Methods
 
-### readBits
+### readBits()
 
-▸ **readBits**(`bits`, `bitBuffer?`): `any`
+> **readBits**(`bits`, `bitBuffer`?): `any`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `bits` | `number` |
-| `bitBuffer?` | `number` |
+• **bits**: `number`
+
+• **bitBuffer?**: `number`
 
 #### Returns
 
 `any`
 
-___
+***
 
-### seekTo
+### seekTo()
 
-▸ **seekTo**(`bitPos`): `void`
+> **seekTo**(`bitPos`): `void`
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `bitPos` | `number` |
+• **bitPos**: `number`
 
 #### Returns
 
 `void`
 
-___
+***
 
-### writeBits
+### writeBits()
 
-▸ **writeBits**(`bits`, `value`): [`BitStream`](BitStream.md)
+> **writeBits**(`bits`, `value`): [`BitStream`](BitStream.md)
 
 #### Parameters
 
-| Name | Type |
-| :------ | :------ |
-| `bits` | `number` |
-| `value` | `number` |
+• **bits**: `number`
+
+• **value**: `number`
 
 #### Returns