update doc

shinyoshiaki · Jan 1, 2024 · 0660f08 · 0660f08
1 parent c0965cd
commit 0660f08
Show file tree

Hide file tree

Showing 182 changed files with 3,990 additions and 5,533 deletions.
diff --git a/doc/classes/AV1Obu.md b/doc/classes/AV1Obu.md
@@ -26,7 +26,11 @@
 
 ### constructor
 
-• **new AV1Obu**()
+• **new AV1Obu**(): [`AV1Obu`](AV1Obu.md)
+
+#### Returns
+
+[`AV1Obu`](AV1Obu.md)
 
 ## Properties
 
@@ -78,7 +82,7 @@ ___
 
 ### deSerialize
 
-▸ `Static` **deSerialize**(`buf`): [`AV1Obu`](AV1Obu.md)
+▸ **deSerialize**(`buf`): [`AV1Obu`](AV1Obu.md)
 
 #### Parameters
 

diff --git a/doc/classes/AV1RtpPayload.md b/doc/classes/AV1RtpPayload.md
@@ -30,7 +30,11 @@
 
 ### constructor
 
-• **new AV1RtpPayload**()
+• **new AV1RtpPayload**(): [`AV1RtpPayload`](AV1RtpPayload.md)
+
+#### Returns
+
+[`AV1RtpPayload`](AV1RtpPayload.md)
 
 ## Properties
 
@@ -45,7 +49,7 @@ ___
 
 ### obu\_or\_fragment
 
-• **obu\_or\_fragment**: { `data`: `Buffer` ; `isFragment`: `boolean`  }[] = `[]`
+• **obu\_or\_fragment**: \{ `data`: `Buffer` ; `isFragment`: `boolean`  }[] = `[]`
 
 ___
 
@@ -88,7 +92,7 @@ MUST be set to 1 if the first OBU element is an OBU fragment that is a continuat
 
 ### deSerialize
 
-▸ `Static` **deSerialize**(`buf`): [`AV1RtpPayload`](AV1RtpPayload.md)
+▸ **deSerialize**(`buf`): [`AV1RtpPayload`](AV1RtpPayload.md)
 
 #### Parameters
 
@@ -104,7 +108,7 @@ ___
 
 ### getFrame
 
-▸ `Static` **getFrame**(`payloads`): `Buffer`
+▸ **getFrame**(`payloads`): `Buffer`
 
 #### Parameters
 
@@ -120,7 +124,7 @@ ___
 
 ### isDetectedFinalPacketInSequence
 
-▸ `Static` **isDetectedFinalPacketInSequence**(`header`): `boolean`
+▸ **isDetectedFinalPacketInSequence**(`header`): `boolean`
 
 #### Parameters
 

diff --git a/doc/classes/BitStream.md b/doc/classes/BitStream.md
@@ -22,14 +22,18 @@
 
 ### constructor
 
-• **new BitStream**(`uint8Array`)
+• **new BitStream**(`uint8Array`): [`BitStream`](BitStream.md)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `uint8Array` | `Buffer` |
 
+#### Returns
+
+[`BitStream`](BitStream.md)
+
 ## Properties
 
 ### uint8Array

diff --git a/doc/classes/BitWriter.md b/doc/classes/BitWriter.md
@@ -24,14 +24,18 @@
 
 ### constructor
 
-• **new BitWriter**(`bitLength`)
+• **new BitWriter**(`bitLength`): [`BitWriter`](BitWriter.md)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `bitLength` | `number` |
 
+#### Returns
+
+[`BitWriter`](BitWriter.md)
+
 ## Properties
 
 ### value

diff --git a/doc/classes/BitWriter2.md b/doc/classes/BitWriter2.md
@@ -25,7 +25,7 @@
 
 ### constructor
 
-• **new BitWriter2**(`bitLength`)
+• **new BitWriter2**(`bitLength`): [`BitWriter2`](BitWriter2.md)
 
 各valueがオクテットを跨いではならない
 
@@ -35,6 +35,10 @@
 | :------ | :------ | :------ |
 | `bitLength` | `number` | Max 32bit |
 
+#### Returns
+
+[`BitWriter2`](BitWriter2.md)
+
 ## Properties
 
 ### offset

diff --git a/doc/classes/BufferChain.md b/doc/classes/BufferChain.md
@@ -21,14 +21,18 @@
 
 ### constructor
 
-• **new BufferChain**(`size`)
+• **new BufferChain**(`size`): [`BufferChain`](BufferChain.md)
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `size` | `number` |
 
+#### Returns
+
+[`BufferChain`](BufferChain.md)
+
 ## Properties
 
 ### buffer

diff --git a/doc/classes/Candidate.md b/doc/classes/Candidate.md
@@ -32,7 +32,7 @@
 
 ### constructor
 
-• **new Candidate**(`foundation`, `component`, `transport`, `priority`, `host`, `port`, `type`, `relatedAddress?`, `relatedPort?`, `tcptype?`, `generation?`)
+• **new Candidate**(`foundation`, `component`, `transport`, `priority`, `host`, `port`, `type`, `relatedAddress?`, `relatedPort?`, `tcptype?`, `generation?`): [`Candidate`](Candidate.md)
 
 #### Parameters
 
@@ -50,6 +50,10 @@
 | `tcptype?` | `string` |
 | `generation?` | `number` |
 
+#### Returns
+
+[`Candidate`](Candidate.md)
+
 ## Properties
 
 ### component
@@ -146,7 +150,7 @@ ___
 
 ### fromSdp
 
-▸ `Static` **fromSdp**(`sdp`): [`Candidate`](Candidate.md)
+▸ **fromSdp**(`sdp`): [`Candidate`](Candidate.md)
 
 #### Parameters
 

diff --git a/doc/classes/CandidatePair.md b/doc/classes/CandidatePair.md
@@ -0,0 +1,155 @@
+[werift](../README.md) / [Exports](../modules.md) / CandidatePair
+
+# Class: CandidatePair
+
+## Table of contents
+
+### Constructors
+
+- [constructor](CandidatePair.md#constructor)
+
+### Properties
+
+- [handle](CandidatePair.md#handle)
+- [nominated](CandidatePair.md#nominated)
+- [protocol](CandidatePair.md#protocol)
+- [remoteCandidate](CandidatePair.md#remotecandidate)
+- [remoteNominated](CandidatePair.md#remotenominated)
+
+### Accessors
+
+- [component](CandidatePair.md#component)
+- [localCandidate](CandidatePair.md#localcandidate)
+- [remoteAddr](CandidatePair.md#remoteaddr)
+- [state](CandidatePair.md#state)
+
+### Methods
+
+- [toJSON](CandidatePair.md#tojson)
+- [updateState](CandidatePair.md#updatestate)
+
+## Constructors
+
+### constructor
+
+• **new CandidatePair**(`protocol`, `remoteCandidate`): [`CandidatePair`](CandidatePair.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `protocol` | [`Protocol`](../interfaces/Protocol.md) |
+| `remoteCandidate` | [`Candidate`](Candidate.md) |
+
+#### Returns
+
+[`CandidatePair`](CandidatePair.md)
+
+## Properties
+
+### handle
+
+• `Optional` **handle**: `Object`
+
+#### Type declaration
+
+| Name | Type |
+| :------ | :------ |
+| `cancel` | () => `void` |
+| `done` | () => `boolean` |
+| `promise` | `PCancelable`\<`any`\> |
+
+___
+
+### nominated
+
+• **nominated**: `boolean` = `false`
+
+___
+
+### protocol
+
+• **protocol**: [`Protocol`](../interfaces/Protocol.md)
+
+___
+
+### remoteCandidate
+
+• **remoteCandidate**: [`Candidate`](Candidate.md)
+
+___
+
+### remoteNominated
+
+• **remoteNominated**: `boolean` = `false`
+
+## Accessors
+
+### component
+
+• `get` **component**(): `number`
+
+#### Returns
+
+`number`
+
+___
+
+### localCandidate
+
+• `get` **localCandidate**(): [`Candidate`](Candidate.md)
+
+#### Returns
+
+[`Candidate`](Candidate.md)
+
+___
+
+### remoteAddr
+
+• `get` **remoteAddr**(): readonly [`string`, `number`]
+
+#### Returns
+
+readonly [`string`, `number`]
+
+___
+
+### state
+
+• `get` **state**(): [`CandidatePairState`](../enums/CandidatePairState.md)
+
+#### Returns
+
+[`CandidatePairState`](../enums/CandidatePairState.md)
+
+## Methods
+
+### toJSON
+
+▸ **toJSON**(): `Object`
+
+#### Returns
+
+`Object`
+
+| Name | Type |
+| :------ | :------ |
+| `protocol` | `string` |
+| `remoteAddr` | readonly [`string`, `number`] |
+
+___
+
+### updateState
+
+▸ **updateState**(`state`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `state` | [`CandidatePairState`](../enums/CandidatePairState.md) |
+
+#### Returns
+
+`void`