Skip to content

Commit

Permalink
verup
Browse files Browse the repository at this point in the history
  • Loading branch information
shinyoshiaki committed Jan 5, 2025
1 parent 1bda402 commit c4401df
Show file tree
Hide file tree
Showing 64 changed files with 1,714 additions and 299 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ see console & chrome://webrtc-internals/
- [x] Trickle ICE
- [x] ICE-Lite Client Side
- [ ] ICE-Lite Server Side
- [x] ICE restart
- [x] DTLS
- [x] DTLS-SRTP
- [x] Curve25519
Expand Down Expand Up @@ -89,6 +90,7 @@ see console & chrome://webrtc-internals/
- [x] SRTP
- [x] SRTCP
- [x] SDP
- [x] reuse inactive m-line
- [x] PeerConnection
- [x] Simulcast
- [x] recv
Expand Down Expand Up @@ -122,10 +124,6 @@ see console & chrome://webrtc-internals/
## Road Map Towards 2.0

- [ ] API compatible with browser RTCPeerConnection
- [ ] ICE
- [ ] ICE restart
- [ ] SDP
- [ ] reuse inactive m-line
- [ ] Simulcast
- [ ] send
- [ ] support more cipher suites
Expand Down
10 changes: 9 additions & 1 deletion doc/classes/Candidate.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

### new Candidate()

> **new Candidate**(`foundation`, `component`, `transport`, `priority`, `host`, `port`, `type`, `relatedAddress`?, `relatedPort`?, `tcptype`?, `generation`?): [`Candidate`](Candidate.md)
> **new Candidate**(`foundation`, `component`, `transport`, `priority`, `host`, `port`, `type`, `relatedAddress`?, `relatedPort`?, `tcptype`?, `generation`?, `ufrag`?): [`Candidate`](Candidate.md)
#### Parameters

Expand All @@ -36,6 +36,8 @@

**generation?**: `number`

**ufrag?**: `string`

#### Returns

[`Candidate`](Candidate.md)
Expand Down Expand Up @@ -106,6 +108,12 @@

> **type**: `string`
***

### ufrag?

> `optional` **ufrag**: `string`
## Methods

### canPairWith()
Expand Down
66 changes: 48 additions & 18 deletions doc/classes/CandidatePair.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,16 @@

### new CandidatePair()

> **new CandidatePair**(`protocol`, `remoteCandidate`): [`CandidatePair`](CandidatePair.md)
> **new CandidatePair**(`protocol`, `remoteCandidate`, `iceControlling`): [`CandidatePair`](CandidatePair.md)
#### Parameters

**protocol**: [`Protocol`](../interfaces/Protocol.md)

**remoteCandidate**: [`Candidate`](Candidate.md)

**iceControlling**: `boolean`

#### Returns

[`CandidatePair`](CandidatePair.md)
Expand All @@ -26,27 +28,19 @@

### handle?

> `optional` **handle**: `object`
#### cancel()

> **cancel**: () => `void`
> `optional` **handle**: `Cancelable`\<`void`\>
##### Returns

`void`

#### done()
***

> **done**: () => `boolean`
### iceControlling

##### Returns
> **iceControlling**: `boolean`
`boolean`
***

#### promise
### id

> **promise**: `PCancelable`\<`any`\> = `pCancel`
> `readonly` **id**: \`$\{string\}-$\{string\}-$\{string\}-$\{string\}-$\{string\}\`
***

Expand Down Expand Up @@ -84,6 +78,28 @@

***

### json

> `get` **json**(): `object`
#### Returns

`object`

##### localCandidate

> **localCandidate**: `string`
##### protocol

> **protocol**: `string`
##### remoteCandidate

> **remoteCandidate**: `string`
***

### localCandidate

> `get` **localCandidate**(): [`Candidate`](Candidate.md)
Expand All @@ -94,6 +110,16 @@

***

### priority

> `get` **priority**(): `number`
#### Returns

`number`

***

### remoteAddr

> `get` **remoteAddr**(): readonly [`string`, `number`]
Expand Down Expand Up @@ -122,13 +148,17 @@ readonly [`string`, `number`]

`object`

##### localCandidate

> **localCandidate**: `string`
##### protocol

> **protocol**: `string`
##### remoteAddr
##### remoteCandidate

> **remoteAddr**: readonly [`string`, `number`]
> **remoteCandidate**: `string`
***

Expand Down
Loading

0 comments on commit c4401df

Please sign in to comment.