Skip to content

Commit 10051a8

Browse files
committed
chore: update api docs
1 parent ba340dd commit 10051a8

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

API.md

+28
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,18 @@ export interface RtcConfig {
1414
bindAddress?: string;
1515
enableIceTcp?: boolean;
1616
enableIceUdpMux?: boolean;
17+
disableAutoNegotiation?: boolean;
18+
disableFingerprintVerification?: boolean;
19+
disableAutoGathering?: boolean;
20+
forceMediaTransport?: boolean;
1721
portRangeBegin?: number;
1822
portRangeEnd?: number;
1923
maxMessageSize?: number;
2024
mtu?: number;
2125
iceTransportPolicy?: TransportPolicy;
26+
certificatePemFile?: string;
27+
keyPemFile?: string;
28+
keyPemPass?: string;
2229
}
2330
2431
export const enum RelayType {
@@ -65,6 +72,27 @@ export const enum DescriptionType {
6572
}
6673
```
6774

75+
**setLocalDescription: (sdp: string, init?: LocalDescriptionInit) => void**
76+
77+
Set Local Description and optionally the ICE ufrag/pwd to use. These should not
78+
be set as they will be generated automatically as per the spec.
79+
```
80+
export interface LocalDescriptionInit {
81+
iceUfrag?: string;
82+
icePwd?: string;
83+
}
84+
```
85+
86+
**remoteFingerprint: () => CertificateFingerprint**
87+
88+
Returns the certificate fingerprint used by the remote peer
89+
```
90+
export interface CertificateFingerprint {
91+
value: string;
92+
algorithm: 'sha-1' | 'sha-224' | 'sha-256' | 'sha-384' | 'sha-512' | 'md5' | 'md2';
93+
}
94+
```
95+
6896
**addRemoteCandidate: (candidate: string, mid: string) => void**
6997

7098
Add remote candidate info

0 commit comments

Comments
 (0)