Skip to main content

BasePeerConnection

Extended by

Properties

PropertyTypeDescription
answerOptionsundefined | RTCAnswerOptions-
bandwidthBandwidth-
close() => void-
configsMediaConfig[]-
connectionStateRTCPeerConnectionState-
createDataChannel(label, dataChannelDict?) => RTCDataChannel-
getConfiguration() => RTCConfiguration-
getDataChannelConfigs() => DataChannelConfig[]-
getTransceiverConfigs() => TransceiverConfig[]-
hasICECandidatesboolean-
iceConnectionStateRTCIceConnectionState-
iceGatheringStateRTCIceGatheringState-
offerOptionsundefined | RTCOfferOptions-
peerExtendedRTCPeerConnection-
politeboolean-
receiversRTCRtpReceiver[]-
referencesReferencesReference of any logical associations to the peer connection for logging
restartIce() => void-
sendersRTCRtpSender[]-
setConfigurationundefined | (configuration?) => voidOnly recently supported on some browser: https://caniuse.com/?search=setconfiguration
signalingStateRTCSignalingState-

Methods

addConfig()

Call Signature

addConfig(peer, initOrConfig): DataChannelConfig;
Parameters
ParameterType
peerRTCPeerConnection
initOrConfig| DataChannelConfig | DataChannelInit
Returns

DataChannelConfig

Call Signature

addConfig(peer, initOrConfig): TransceiverConfig;
Parameters
ParameterType
peerRTCPeerConnection
initOrConfig| TransceiverConfig | TransceiverInit
Returns

TransceiverConfig

Call Signature

addConfig(peer, initOrConfig): 
| TransceiverConfig
| DataChannelConfig;
Parameters
ParameterType
peerRTCPeerConnection
initOrConfig| TransceiverConfig | DataChannelConfig | DataChannelInit | TransceiverInit
Returns

| TransceiverConfig | DataChannelConfig


getStats()

getStats(selector?): Promise<RTCStatsReport>;

Parameters

ParameterType
selector?null | MediaStreamTrack

Returns

Promise<RTCStatsReport>


setLocalStream()

setLocalStream(
stream,
target,
shouldSyncMedia?): Promise<void>;

Parameters

ParameterType
streamundefined | MediaStream
targetTransceiverConfigDirectionTuple[]
shouldSyncMedia?boolean

Returns

Promise<void>


setReference()

setReference(key, value): void;

Key/Value pair for referencing logical associations for logging

Parameters

ParameterTypeDescription
keystringThe key for the reference
valuestringThe value for the reference

Returns

void