werift

Enumerations

• PacketChunk
• PacketStatus

Classes

• EventTarget
• GenericNack
• GroupDescription
• IceCandidate
• MediaDescription
• MediaStream
• MediaStreamTrack
• PictureLossIndication
• PromiseQueue
• RTCCertificate
• RTCDataChannel
• RTCDataChannelParameters
• RTCDtlsFingerprint
• RTCDtlsParameters
• RTCDtlsTransport
• RTCIceGatherer
• RTCIceParameters
• RTCIceTransport
• RTCPeerConnection
• RTCRtcpFeedback
• RTCRtcpParameters
• RTCRtpCodecCapability
• RTCRtpCodecParameters
• RTCRtpCodingParameters
• RTCRtpHeaderExtensionParameters
• RTCRtpRtxParameters
• RTCRtpSimulcastParameters
• RTCRtpTransceiver
• RTCSctpCapabilities
• RTCSctpTransport
• RTCSessionDescription
• ReceiverEstimatedMaxBitrate
• RecvDelta
• RtcpHeader
• RtcpPacketConverter
• RtcpPayloadSpecificFeedback
• RtcpReceiverInfo
• RtcpRrPacket
• RtcpSenderInfo
• RtcpSourceDescriptionPacket
• RtcpSrPacket
• RtcpTransportLayerFeedback
• RtpBuilder
• RtpHeader
• RtpPacket
• RunLengthChunk
• SessionDescription
• SourceDescriptionChunk
• SourceDescriptionItem
• SrtcpSession
• SrtpSession
• SsrcDescription
• StatusVectorChunk
• TransportWideCC

Interfaces

• MessageEvent
• PeerConfig
• RTCDataChannelEvent
• RTCErrorEvent
• RTCPeerConnectionIceEvent
• RTCRtpParameters
• RTCRtpReceiveParameters
• RTCTrackEvent
• TransceiverOptions

Type aliases

ConnectionState

Ƭ ConnectionState: typeof ConnectionStates[number]

Defined in

packages/webrtc/src/types/domain.ts:23

---

DCState

Ƭ DCState: "open" | "closed" | "connecting" | "closing"

Defined in

packages/webrtc/src/dataChannel.ts:132

---

Direction

Ƭ Direction: typeof Directions[number]

Defined in

packages/webrtc/src/media/rtpTransceiver.ts:87

---

DtlsRole

Ƭ DtlsRole: "auto" | "server" | "client"

Defined in

packages/webrtc/src/transport/dtls.ts:213

---

DtlsState

Ƭ DtlsState: typeof DtlsStates[number]

Defined in

packages/webrtc/src/transport/dtls.ts:211

---

Extension

Ƭ Extension: Object

Type declaration

Name	Type
id	number
payload	Buffer

Defined in

packages/rtp/src/rtp/rtp.ts:3

---

IceGathererState

Ƭ IceGathererState: typeof IceGathererStates[number]

Defined in

packages/webrtc/src/transport/ice.ts:96

---

Kind

Ƭ Kind: "audio" | "video" | "application" | "unknown"

Defined in

packages/webrtc/src/types/domain.ts:1

---

RTCIceCandidate

Ƭ RTCIceCandidate: Object

Type declaration

Name	Type
candidate	string
sdpMLineIndex	number
sdpMid	string

Defined in

packages/webrtc/src/transport/ice.ts:169

---

RTCIceConnectionState

Ƭ RTCIceConnectionState: typeof IceTransportStates[number]

Defined in

packages/webrtc/src/transport/ice.ts:93

---

RTCIceServer

Ƭ RTCIceServer: Object

Type declaration

Name	Type
credential?	string
urls	string
username?	string

Defined in

packages/webrtc/src/peerConnection.ts:1154

---

RTCPFB

Ƭ RTCPFB: Object

Type declaration

Name	Type
parameter?	string
type	string

Defined in

packages/webrtc/src/media/parameters.ts:23

---

RTCSignalingState

Ƭ RTCSignalingState: typeof SignalingStates[number]

Defined in

packages/webrtc/src/types/domain.ts:12

---

RtcpPacket

Ƭ RtcpPacket: RtcpRrPacket | RtcpSrPacket | RtcpPayloadSpecificFeedback | RtcpSourceDescriptionPacket | RtcpTransportLayerFeedback

Defined in

packages/rtp/src/rtcp/rtcp.ts:12

Variables

ConnectionStates

• Const ConnectionStates: readonly ["closed", "failed", "disconnected", "new", "connecting", "connected"]

Defined in

packages/webrtc/src/types/domain.ts:14

---

Directions

• Const Directions: readonly ["inactive", "sendonly", "recvonly", "sendrecv"]

Defined in

packages/webrtc/src/media/rtpTransceiver.ts:80

---

DtlsStates

• Const DtlsStates: readonly ["new", "connecting", "connected", "closed", "failed"]

Defined in

packages/webrtc/src/transport/dtls.ts:204

---

IceGathererStates

• Const IceGathererStates: readonly ["new", "gathering", "complete"]

Defined in

packages/webrtc/src/transport/ice.ts:95

---

IceTransportStates

• Const IceTransportStates: readonly ["new", "checking", "connected", "completed", "disconnected", "failed", "closed"]

Defined in

packages/webrtc/src/transport/ice.ts:84

---

RTP_EXTENSION_URI

• Const RTP_EXTENSION_URI: Object

Type declaration

Name	Type
absSendTime	"http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time"
sdesMid	"urn:ietf:params:rtp-hdrext:sdes:mid"
sdesRTPStreamID	"urn:ietf:params:rtp-hdrext:sdes:rtp-stream-id"
transportWideCC	"http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01"

Defined in

packages/webrtc/src/extension/rtpExtension.ts:3

---

SignalingStates

• Const SignalingStates: readonly ["stable", "have-local-offer", "have-remote-offer", "have-local-pranswer", "have-remote-pranswer", "closed"]

Defined in

packages/webrtc/src/types/domain.ts:3

---

defaultPeerConfig

• Const defaultPeerConfig: PeerConfig

Defined in

packages/webrtc/src/peerConnection.ts:1160

Functions

addSDPHeader

▸ addSDPHeader(type, description): void

Parameters

Name	Type
type	"offer" | "answer"
description	SessionDescription

Returns

void

Defined in

packages/webrtc/src/sdp.ts:604

---

addTransportDescription

▸ addTransportDescription(media, dtlsTransport): void

Parameters

Name	Type
media	MediaDescription
dtlsTransport	RTCDtlsTransport

Returns

void

Defined in

packages/webrtc/src/peerConnection.ts:1095

---

allocateMid

▸ allocateMid(mids): string

Parameters

Name	Type
mids	Set<string>

Returns

string

Defined in

packages/webrtc/src/peerConnection.ts:1129

---

andDirection

▸ Const andDirection(a, b): "inactive" | "sendonly" | "recvonly" | "sendrecv"

Parameters

Name	Type
a	"inactive" | "sendonly" | "recvonly" | "sendrecv"
b	"inactive" | "sendonly" | "recvonly" | "sendrecv"

Returns

"inactive" | "sendonly" | "recvonly" | "sendrecv"

Defined in

packages/webrtc/src/utils.ts:43

---

candidateFromIce

▸ candidateFromIce(c): IceCandidate

Parameters

Name	Type
c	Candidate

Returns

IceCandidate

Defined in

packages/webrtc/src/transport/ice.ts:138

---

candidateFromSdp

▸ candidateFromSdp(sdp): IceCandidate

Parameters

Name	Type
sdp	string

Returns

IceCandidate

Defined in

packages/webrtc/src/sdp.ts:563

---

candidateToIce

▸ candidateToIce(x): Candidate

Parameters

Name	Type
x	IceCandidate

Returns

Candidate

Defined in

packages/webrtc/src/transport/ice.ts:154

---

candidateToSdp

▸ candidateToSdp(c): string

Parameters

Name	Type
c	IceCandidate

Returns

string

Defined in

packages/webrtc/src/sdp.ts:507

---

createMediaDescriptionForSctp

▸ createMediaDescriptionForSctp(sctp, mid): MediaDescription

Parameters

Name	Type
sctp	RTCSctpTransport
mid	string

Returns

MediaDescription

Defined in

packages/webrtc/src/peerConnection.ts:1077

---

createMediaDescriptionForTransceiver

▸ createMediaDescriptionForTransceiver(transceiver, cname, direction, mid): MediaDescription

Parameters

Name	Type
transceiver	RTCRtpTransceiver
cname	string
direction	Direction
mid	string

Returns

MediaDescription

Defined in

packages/webrtc/src/peerConnection.ts:1043

---

divide

▸ divide(from, split): [string, string]

Parameters

Name	Type
from	string
split	string

Returns

[string, string]

Defined in

packages/webrtc/src/helper.ts:7

---

enumerate

▸ enumerate<T>(arr): [number, T][]

Type parameters

Name
T

Parameters

Name	Type
arr	T[]

Returns

[number, T][]

Defined in

packages/webrtc/src/helper.ts:3

---

fingerprint

▸ fingerprint(file, hashName): any

Parameters

Name	Type
file	Buffer
hashName	string

Returns

any

Defined in

packages/webrtc/src/utils.ts:15

---

isDtls

▸ isDtls(buf): boolean

Parameters

Name	Type
buf	Buffer

Returns

boolean

Defined in

packages/webrtc/src/utils.ts:24

---

isMedia

▸ isMedia(buf): boolean

Parameters

Name	Type
buf	Buffer

Returns

boolean

Defined in

packages/webrtc/src/utils.ts:29

---

isRtcp

▸ isRtcp(buf): boolean

Parameters

Name	Type
buf	Buffer

Returns

boolean

Defined in

packages/webrtc/src/utils.ts:34

---

microTime

▸ Const microTime(): number

Returns

number

Defined in

packages/webrtc/src/utils.ts:55

---

milliTime

▸ Const milliTime(): number

Returns

number

Defined in

packages/webrtc/src/utils.ts:57

---

ntpTime

▸ Const ntpTime(): bigint

Returns

bigint

Defined in

packages/webrtc/src/utils.ts:59

---

orDirection

▸ Const orDirection(a, b): "inactive" | "sendonly" | "recvonly" | "sendrecv"

Parameters

Name	Type
a	"inactive" | "sendonly" | "recvonly" | "sendrecv"
b	"inactive" | "sendonly" | "recvonly" | "sendrecv"

Returns

"inactive" | "sendonly" | "recvonly" | "sendrecv"

Defined in

packages/webrtc/src/utils.ts:46

---

parseIceServers

▸ parseIceServers(iceServers): Object

Parameters

Name	Type
iceServers	RTCIceServer[]

Returns

Object

Name	Type
stunServer	undefined | Address
turnPassword	undefined | string
turnServer	undefined | Address
turnUsername	undefined | string

Defined in

packages/webrtc/src/utils.ts:100

---

random16

▸ random16(): any

Returns

any

Defined in

packages/webrtc/src/utils.ts:76

---

random32

▸ random32(): bigint

Returns

bigint

Defined in

packages/webrtc/src/utils.ts:80

---

reverseDirection

▸ reverseDirection(dir): Direction

Parameters

Name	Type
dir	Direction

Returns

Direction

Defined in

packages/webrtc/src/utils.ts:49

---

reverseSimulcastDirection

▸ reverseSimulcastDirection(dir): "send" | "recv"

Parameters

Name	Type
dir	"recv" | "send"

Returns

"send" | "recv"

Defined in

packages/webrtc/src/utils.ts:38

---

uint16Add

▸ uint16Add(a, b): number

Parameters

Name	Type
a	number
b	number

Returns

number

Defined in

packages/webrtc/src/utils.ts:88

---

uint24

▸ uint24(v): number

Parameters

Name	Type
v	number

Returns

number

Defined in

packages/webrtc/src/utils.ts:96

---

uint32Add

▸ uint32Add(a, b): bigint

Parameters

Name	Type
a	bigint
b	bigint

Returns

bigint

Defined in

packages/webrtc/src/utils.ts:92

---

uint8Add

▸ uint8Add(a, b): number

Parameters

Name	Type
a	number
b	number

Returns

number

Defined in

packages/webrtc/src/utils.ts:84

---

useAbsSendTime

▸ useAbsSendTime(): RTCRtpHeaderExtensionParameters

Returns

RTCRtpHeaderExtensionParameters

Defined in

packages/webrtc/src/extension/rtpExtension.ts:29

---

useFIR

▸ Const useFIR(): RTCPFB

Returns

RTCPFB

Defined in

packages/webrtc/src/extension/rtcpFeedback.ts:3

---

useNACK

▸ Const useNACK(): RTCPFB

Returns

RTCPFB

Defined in

packages/webrtc/src/extension/rtcpFeedback.ts:5

---

usePLI

▸ Const usePLI(): RTCPFB

Returns

RTCPFB

Defined in

packages/webrtc/src/extension/rtcpFeedback.ts:7

---

useREMB

▸ Const useREMB(): RTCPFB

Returns

RTCPFB

Defined in

packages/webrtc/src/extension/rtcpFeedback.ts:9

---

useSdesMid

▸ useSdesMid(): RTCRtpHeaderExtensionParameters

Returns

RTCRtpHeaderExtensionParameters

Defined in

packages/webrtc/src/extension/rtpExtension.ts:11

---

useSdesRTPStreamID

▸ useSdesRTPStreamID(): RTCRtpHeaderExtensionParameters

Returns

RTCRtpHeaderExtensionParameters

Defined in

packages/webrtc/src/extension/rtpExtension.ts:17

---

useTWCC

▸ Const useTWCC(): RTCPFB

Returns

RTCPFB

Defined in

packages/webrtc/src/extension/rtcpFeedback.ts:11

---

useTransportWideCC

▸ useTransportWideCC(): RTCRtpHeaderExtensionParameters

Returns

RTCRtpHeaderExtensionParameters

Defined in

packages/webrtc/src/extension/rtpExtension.ts:23