メインコンテンツまでスキップ

werift

Enumerations#

Classes#

Interfaces#

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#

NameType
idnumber
payloadBuffer

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#

NameType
candidatestring
sdpMLineIndexnumber
sdpMidstring

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#

NameType
credential?string
urlsstring
username?string

Defined in#

packages/webrtc/src/peerConnection.ts:1154


RTCPFB#

Ƭ RTCPFB: Object

Type declaration#

NameType
parameter?string
typestring

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#

NameType
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#

NameType
type"offer" | "answer"
descriptionSessionDescription

Returns#

void

Defined in#

packages/webrtc/src/sdp.ts:604


addTransportDescription#

addTransportDescription(media, dtlsTransport): void

Parameters#

NameType
mediaMediaDescription
dtlsTransportRTCDtlsTransport

Returns#

void

Defined in#

packages/webrtc/src/peerConnection.ts:1095


allocateMid#

allocateMid(mids): string

Parameters#

NameType
midsSet<string>

Returns#

string

Defined in#

packages/webrtc/src/peerConnection.ts:1129


andDirection#

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

Parameters#

NameType
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#

NameType
cCandidate

Returns#

IceCandidate

Defined in#

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


candidateFromSdp#

candidateFromSdp(sdp): IceCandidate

Parameters#

NameType
sdpstring

Returns#

IceCandidate

Defined in#

packages/webrtc/src/sdp.ts:563


candidateToIce#

candidateToIce(x): Candidate

Parameters#

NameType
xIceCandidate

Returns#

Candidate

Defined in#

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


candidateToSdp#

candidateToSdp(c): string

Parameters#

NameType
cIceCandidate

Returns#

string

Defined in#

packages/webrtc/src/sdp.ts:507


createMediaDescriptionForSctp#

createMediaDescriptionForSctp(sctp, mid): MediaDescription

Parameters#

NameType
sctpRTCSctpTransport
midstring

Returns#

MediaDescription

Defined in#

packages/webrtc/src/peerConnection.ts:1077


createMediaDescriptionForTransceiver#

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

Parameters#

NameType
transceiverRTCRtpTransceiver
cnamestring
directionDirection
midstring

Returns#

MediaDescription

Defined in#

packages/webrtc/src/peerConnection.ts:1043


divide#

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

Parameters#

NameType
fromstring
splitstring

Returns#

[string, string]

Defined in#

packages/webrtc/src/helper.ts:7


enumerate#

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

Type parameters#

Name
T

Parameters#

NameType
arrT[]

Returns#

[number, T][]

Defined in#

packages/webrtc/src/helper.ts:3


fingerprint#

fingerprint(file, hashName): any

Parameters#

NameType
fileBuffer
hashNamestring

Returns#

any

Defined in#

packages/webrtc/src/utils.ts:15


isDtls#

isDtls(buf): boolean

Parameters#

NameType
bufBuffer

Returns#

boolean

Defined in#

packages/webrtc/src/utils.ts:24


isMedia#

isMedia(buf): boolean

Parameters#

NameType
bufBuffer

Returns#

boolean

Defined in#

packages/webrtc/src/utils.ts:29


isRtcp#

isRtcp(buf): boolean

Parameters#

NameType
bufBuffer

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#

NameType
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#

NameType
iceServersRTCIceServer[]

Returns#

Object

NameType
stunServerundefined | Address
turnPasswordundefined | string
turnServerundefined | Address
turnUsernameundefined | 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#

NameType
dirDirection

Returns#

Direction

Defined in#

packages/webrtc/src/utils.ts:49


reverseSimulcastDirection#

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

Parameters#

NameType
dir"recv" | "send"

Returns#

"send" | "recv"

Defined in#

packages/webrtc/src/utils.ts:38


uint16Add#

uint16Add(a, b): number

Parameters#

NameType
anumber
bnumber

Returns#

number

Defined in#

packages/webrtc/src/utils.ts:88


uint24#

uint24(v): number

Parameters#

NameType
vnumber

Returns#

number

Defined in#

packages/webrtc/src/utils.ts:96


uint32Add#

uint32Add(a, b): bigint

Parameters#

NameType
abigint
bbigint

Returns#

bigint

Defined in#

packages/webrtc/src/utils.ts:92


uint8Add#

uint8Add(a, b): number

Parameters#

NameType
anumber
bnumber

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