Class Room

Hierarchy (view full)

Constructors

constructor

Properties

#_creationTime #_httpStatSender #_pc #_role #_statCollector #_state #dChannel #incomingMessageQueue #inviteId #localTrafficMonitor #serverTrafficMonitor #trafficListeners #trafficPollInFlight #trafficPollTimer #wrappedDataChannel _crutch _id _mediaSessionId _name _nickname _pin _uid _userId _webRTCMetricsServerDescription connection logger notifier stats transceiverPool #BITRATE_CHANNEL #CONTROL_CHANNEL #ICE_GATHERING_TIMEOUT #TRAFFIC_POLL_INTERVAL

Methods

#applyContentTypeConfig #dChannelSend #handleServerTrafficUpdate #notifyTrafficListeners #requiresRelayCandidate #setLocalDescription #setLocalDescriptionAndGatherIce #setRemoteDescription #startTrafficPolling #stopTrafficPolling addServerTrafficListener addTrafficListener changeQuality createTransceiverPool creationTime destroyRoom evictParticipant getBitrateTest getRemoteTrack getStats getTraffic id invite join leaveRoom muteRemoteTrack muteTrack name nickname off on pc pin processEvent removeServerTrafficListener removeTrafficListener renameParticipant role sendMessage state updateName updateState userId #findCandidateInsertIndex #formatIceCandidateError #hasRelayCandidate #isRelayCandidateLine #withGatheredCandidates #withOnlyRelayCandidates

Constructors

constructor

  • new Room(connection, name, pin, nickname, creationTime, userId?, webRTCMetricsServerDescription?): Room

  • Parameters

    • connection: Connection
    • name: string
    • pin: string
    • nickname: string
    • creationTime: number
    • Optional userId: string
    • Optional webRTCMetricsServerDescription: RTCMetricsServerDescription

    Returns Room

Properties

Private #_creationTime

#_creationTime: number

Private #_httpStatSender

#_httpStatSender: RTCMetricsHttpSender

Private #_pc

#_pc: RTCPeerConnection

Private #_role

#_role: ParticipantRole = ParticipantRole.PARTICIPANT

Private #_statCollector

#_statCollector: RTCMetricsCollector

Private #_state

#_state: RoomState = RoomState.NEW

Private #dChannel

#dChannel: RTCDataChannel

Private #incomingMessageQueue

#incomingMessageQueue: {
    [key: string]: FragmentedMessage[];
} = {}

Type declaration

Private #inviteId

#inviteId: string

Private #localTrafficMonitor

#localTrafficMonitor: LocalTrafficMonitor

Private #serverTrafficMonitor

#serverTrafficMonitor: ServerTrafficMonitor

Private #trafficListeners

#trafficListeners: ((traffic) => void)[] = []

Type declaration

Private #trafficPollInFlight

#trafficPollInFlight: boolean = false

Private #trafficPollTimer

#trafficPollTimer: Timer

Private #wrappedDataChannel

#wrappedDataChannel: WrappedDatachannel

_crutch

_crutch: {
    mutex: Mutex;
    tid: string;
}

Type declaration

  • mutex: Mutex
  • tid: string

_id

_id: string

_mediaSessionId

_mediaSessionId: string

_name

_name: string

_nickname

_nickname: string

_pin

_pin: string

_uid

_uid: string

_userId

_userId: string

_webRTCMetricsServerDescription

_webRTCMetricsServerDescription: RTCMetricsServerDescription

Protected connection

connection: Connection

Protected logger

logger: default

Protected notifier

notifier: Notifier<RoomEvent, InternalMessage> = ...

Protected stats

stats: WebRTCStats

Private transceiverPool

transceiverPool: TransceiverPool

Static Private Readonly #BITRATE_CHANNEL

#BITRATE_CHANNEL: "bitrate" = "bitrate"

Static Private Readonly #CONTROL_CHANNEL

#CONTROL_CHANNEL: "control" = "control"

Static Private Readonly #ICE_GATHERING_TIMEOUT

#ICE_GATHERING_TIMEOUT: 15000 = 15000

Static Private Readonly #TRAFFIC_POLL_INTERVAL

#TRAFFIC_POLL_INTERVAL: 1000 = 1000

Methods

Private #applyContentTypeConfig

  • #applyContentTypeConfig(sdp, config): string

  • Parameters

    • sdp: string
    • config: {
          [key: string]: string;
      }
      • [key: string]: string

    Returns string

Private #dChannelSend

  • #dChannelSend(msg): void

  • Parameters

    • msg: string

    Returns void

Private #handleServerTrafficUpdate

  • #handleServerTrafficUpdate(e): void

  • Parameters

    Returns void

Private #notifyTrafficListeners

  • #notifyTrafficListeners(traffic): void

  • Parameters

    Returns void

Private #requiresRelayCandidate

  • #requiresRelayCandidate(): boolean

  • Returns boolean

Private #setLocalDescription

  • #setLocalDescription(description): Promise<string>

  • Parameters

    • description: RTCSessionDescriptionInit

    Returns Promise<string>

Private #setLocalDescriptionAndGatherIce

  • #setLocalDescriptionAndGatherIce(description): Promise<GatheredIceCandidate[]>

  • Parameters

    • description: RTCSessionDescriptionInit

    Returns Promise<GatheredIceCandidate[]>

Private #setRemoteDescription

  • #setRemoteDescription(remoteSdp): Promise<void>

  • Parameters

    Returns Promise<void>

Private #startTrafficPolling

  • #startTrafficPolling(): void

  • Returns void

Private #stopTrafficPolling

  • #stopTrafficPolling(): void

  • Returns void

addServerTrafficListener

  • addServerTrafficListener(listener): void

  • Parameters

    • listener: ((traffic) => void)

    Returns void

addTrafficListener

  • addTrafficListener(listener): void

  • Parameters

    Returns void

changeQuality

  • changeQuality(trackId, quality, tid): Promise<void>

  • Change the quality of the requested track

    Parameters

    • trackId: string
    • quality: string
    • tid: number

    Returns Promise<void>

Private createTransceiverPool

  • createTransceiverPool(predefinedTracksCount, idleTransceiverTimeoutMs): void

  • Parameters

    • predefinedTracksCount: number
    • idleTransceiverTimeoutMs: number

    Returns void

creationTime

  • creationTime(): number

  • Returns number

destroyRoom

evictParticipant

  • evictParticipant(userId): Promise<void>

  • Evict participant

    Participants will receive RoomEvent.EVICTED with EvictedFromRoom.

    Parameters

    • userId: string

    Returns Promise<void>

getBitrateTest

getRemoteTrack

getStats

  • getStats(track, type, callback): void

  • Parameters

    • track: MediaStreamTrack
    • type: StatsType
    • callback: Function

    Returns void

getTraffic

id

  • id(): string

  • Returns string

invite

  • invite(): string

  • Returns string

join

  • join(pc, nickname?, config?, predefinedTracksCount?, idleTransceiverTimeoutMs?, transportType?): Promise<JoinedRoom>

  • Join the room

    Parameters

    • pc: RTCPeerConnection

      peer connection

    • Optional nickname: string

      user nickname

    • Optional config: {
          [key: string]: string;
      }

      [track.id] : track content type

      • [key: string]: string
    • Optional predefinedTracksCount: number

      Initial number of allocated transceivers.

    • Optional idleTransceiverTimeoutMs: number

      Timeout for useless transceivers.

    • Optional transportType: TransportType

      Ice transport protocol. "UDP"/"TCP".

    Returns Promise<JoinedRoom>

leaveRoom

Private muteRemoteTrack

  • muteRemoteTrack(mid, mute): Promise<void>

  • Parameters

    • mid: string
    • mute: boolean

    Returns Promise<void>

muteTrack

  • muteTrack(trackId, mute): Promise<void>

  • Mute track

    Participants will receive RoomEvent.MUTE_TRACKS with AddRemoveTracks

    Parameters

    • trackId: string
    • mute: boolean

    Returns Promise<void>

name

  • name(): string

  • Returns string

nickname

  • nickname(): string

  • Returns string

off

  • off(event, callback): Room

  • Parameters

    Returns Room

on

  • on(event, callback): Room

  • Parameters

    Returns Room

pc

  • pc(): RTCPeerConnection

  • Returns RTCPeerConnection

pin

  • pin(): string

  • Returns string

processEvent

  • processEvent(e): Promise<void>

  • Parameters

    Returns Promise<void>

removeServerTrafficListener

  • removeServerTrafficListener(listener): void

  • Parameters

    • listener: ((traffic) => void)

    Returns void

removeTrafficListener

  • removeTrafficListener(listener): void

  • Parameters

    Returns void

renameParticipant

role

sendMessage

  • sendMessage(msg): Promise<void>

  • Parameters

    • msg: string

    Returns Promise<void>

state

Protected updateName

  • updateName(name): void

  • Parameters

    • name: string

    Returns void

updateState

  • updateState(config?): Promise<void>

  • Used for SDP exchange

    Parameters

    • Optional config: {
          [key: string]: string;
      }
      • [key: string]: string

    Returns Promise<void>

userId

  • userId(): string

  • Returns string

Static Private #findCandidateInsertIndex

  • #findCandidateInsertIndex(lines, candidate): number

  • Parameters

    • lines: string[]
    • candidate: GatheredIceCandidate

    Returns number

Static Private #formatIceCandidateError

  • #formatIceCandidateError(event): string

  • Parameters

    • event: RTCPeerConnectionIceErrorEvent

    Returns string

Static Private #hasRelayCandidate

  • #hasRelayCandidate(sdp?): boolean

  • Parameters

    • Optional sdp: string

    Returns boolean

Static Private #isRelayCandidateLine

  • #isRelayCandidateLine(candidateLine?): boolean

  • Parameters

    • Optional candidateLine: string

    Returns boolean

Static Private #withGatheredCandidates

  • #withGatheredCandidates(sdp, candidates): string

  • Parameters

    • sdp: string
    • candidates: GatheredIceCandidate[]

    Returns string

Static Private #withOnlyRelayCandidates

  • #withOnlyRelayCandidates(sdp): string

  • Parameters

    • sdp: string

    Returns string

Settings

Member Visibility

Theme

On This Page

constructor#_creationTime#_httpStatSender#_pc#_role#_statCollector#_state#dChannel#incomingMessageQueue#inviteId#localTrafficMonitor#serverTrafficMonitor#trafficListeners#trafficPollInFlight#trafficPollTimer#wrappedDataChannel_crutch_id_mediaSessionId_name_nickname_pin_uid_userId_webRTCMetricsServerDescriptionconnectionloggernotifierstatstransceiverPool#BITRATE_CHANNEL#CONTROL_CHANNEL#ICE_GATHERING_TIMEOUT#TRAFFIC_POLL_INTERVAL#applyContentTypeConfig#dChannelSend#handleServerTrafficUpdate#notifyTrafficListeners#requiresRelayCandidate#setLocalDescription#setLocalDescriptionAndGatherIce#setRemoteDescription#startTrafficPolling#stopTrafficPollingaddServerTrafficListeneraddTrafficListenerchangeQualitycreateTransceiverPoolcreationTimedestroyRoomevictParticipantgetBitrateTestgetRemoteTrackgetStatsgetTrafficidinvitejoinleaveRoommuteRemoteTrackmuteTracknamenicknameoffonpcpinprocessEventremoveServerTrafficListenerremoveTrafficListenerrenameParticipantrolesendMessagestateupdateNameupdateStateuserId#findCandidateInsertIndex#formatIceCandidateError#hasRelayCandidate#isRelayCandidateLine#withGatheredCandidates#withOnlyRelayCandidates