Interface: PeerConfig
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:293
Properties
bundlePolicy
bundlePolicy:
BundlePolicy
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:352
certificates
certificates:
RTCCertificate[]
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:355
codecs
codecs:
Partial<{audio:RTCRtpCodecParameters[];video:RTCRtpCodecParameters[]; }>
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:294
debug
debug:
DebugConfig
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:356
dtls
dtls:
Partial<{keys:DtlsKeys; }>
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:348
forceTurnTCP
forceTurnTCP:
boolean
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:341
Deprecated
Prefer turn URL transport parameters or turnTransport.
headerExtensions
headerExtensions:
Partial<{audio:RTCRtpHeaderExtensionParameters[];video:RTCRtpHeaderExtensionParameters[]; }>
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:302
iceAdditionalHostAddresses
iceAdditionalHostAddresses:
string[] |undefined
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:316
Add additional host (local) addresses to use for candidate gathering. Notably, you can include hosts that are normally excluded, such as loopback, tun interfaces, etc.
iceCandidatePoolSize
iceCandidatePoolSize:
number
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:354
iceFilterCandidatePair
iceFilterCandidatePair: ((
pair) =>boolean) |undefined
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:347
iceFilterStunResponse
iceFilterStunResponse: ((
message,addr,protocol) =>boolean) |undefined
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:346
If provided, is called on each STUN request. Return true if a STUN response should be sent, false if it should be skipped.
iceInterfaceAddresses
iceInterfaceAddresses:
InterfaceAddresses|undefined
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:312
iceLite
iceLite:
boolean
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:308
Advertise local ICE lite and operate in the controlled role.
icePasswordPrefix
icePasswordPrefix:
string|undefined
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:351
icePortRange
icePortRange: [
number,number] |undefined
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:311
Minimum port and Maximum port must not be the same value
iceServers
iceServers:
RTCIceServer[]
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:309
iceStunGatherTimeout
iceStunGatherTimeout:
number|undefined
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:326
Seconds to wait for server-reflexive candidates while gathering. Defaults to 5 when undefined.
iceTcpPassive
iceTcpPassive:
boolean
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:321
Gather passive (listening) TCP host candidates. Defaults to true.
iceTransportPolicy
iceTransportPolicy:
"all"|"relay"
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:306
iceTurnConnectTimeout
iceTurnConnectTimeout:
number|undefined
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:331
Seconds to wait for a TURN TCP/TLS connection to be established. Defaults to 8 when undefined.
iceUseIpv4
iceUseIpv4:
boolean
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:317
iceUseIpv6
iceUseIpv6:
boolean
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:318
iceUseLinkLocalAddress
iceUseLinkLocalAddress:
boolean|undefined
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:343
such as google cloud run
iceUseTcp
iceUseTcp:
boolean
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:319
maxMessageSize
maxMessageSize:
number
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:359
Advertised local SCTP max-message-size in SDP. Use 0 for unlimited.
midSuffix
midSuffix:
boolean
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:357
mLineReuse
mLineReuse:
MLineReuse
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:376
How local SDP marks inactive / stopped m-lines. Cannot be changed after construction.
"compatible"(default): an acceptedinactivem-line keeps a non-zero port. Only rejected (no common codec / remote port 0) or stopped m-lines use port 0, and only those negotiated port 0 positions are reused by new transceivers."aggressive": legacy behavior.inactivem-lines are also written with port 0.
pendingRtp
pendingRtp:
NonNullable<boolean|PendingRtpOptions|undefined>
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:368
Queue outbound RTP on each sender until DTLS is connected. Disabled by default. Pass true or { enabled: true, maxLength } to buffer.
rtcpMuxPolicy
rtcpMuxPolicy:
"require"
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:353
sctp
sctp:
object
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:361
SCTP outbound packet MTU used for DATA chunk fragmentation.
mtu
mtu:
number
turnTlsOptions
turnTlsOptions:
TlsConnectionOptions|undefined
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:333
turnTransport
turnTransport:
"tcp"|"udp"|"tls"|undefined
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:332
turnUdpFamily
turnUdpFamily:
4|6|undefined
Defined in: node_modules/werift/lib/webrtc/src/peerConnection.d.ts:339
Preferred IP family of the TURN/UDP socket, applied only when the TURN server is a hostname. Ignored for an IP literal server, whose own family always selects the socket. Defaults to 4 when undefined.