Skip to main content

BasePeerConnection

Extended by

Properties

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

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


setLocalStream()

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

Parameters

ParameterType
streamMediaStream | undefined
targetTransceiverConfigDirectionTuple[]
shouldSyncMedia?boolean

Returns

Promise<void>


getStats()

getStats(selector?): Promise<RTCStatsReport>;

Parameters

ParameterType
selector?MediaStreamTrack | null

Returns

Promise<RTCStatsReport>


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