Class Room

Hierarchy (view full)

Room
- RoomExtended

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
- Defined in room.ts:90

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

[key: string]: FragmentedMessage[]

`Private` #inviteId

#inviteId: string

`Private` #vacantTransceivers

#vacantTransceivers: {
audio: Queue<RTCRtpTransceiver>;
video: Queue<RTCRtpTransceiver>;
}

Type declaration

audio: Queue<RTCRtpTransceiver>
video: Queue<RTCRtpTransceiver>

`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

`Static` `Private` `Readonly` #BITRATE_CHANNEL

#BITRATE_CHANNEL: "bitrate" = "bitrate"

`Static` `Private` `Readonly` #CONTROL_CHANNEL

#CONTROL_CHANNEL: "control" = "control"

Methods

`Private` #applyContentTypeConfig

#applyContentTypeConfig(sdp, config): string
Parameters
- sdp: string
- config: {
  [key: string]: string;
  }
  - [key: string]: string
Returns string
- Defined in room.ts:114

`Private` #dChannelSend

#dChannelSend(msg): void
Parameters
- msg: string
Returns void
- Defined in room.ts:109

`Private` #setRemoteDescription

#setRemoteDescription(remoteSdp): Promise<void>
Parameters
- remoteSdp: RemoteSdpInfo
Returns Promise<void>
- Defined in room.ts:132

changeQuality

changeQuality(trackId, quality, tid): Promise<void>
Change the quality of the requested track
Parameters
- trackId: string
- quality: string
- tid: number
Returns Promise<void>
- Defined in room.ts:714

creationTime

creationTime(): number
Returns number
- Defined in room.ts:812

destroyRoom

destroyRoom(): Promise<void>
Destroy room

Participants will receive RoomEvent.ENDED. state will be RoomState.DISPOSED

Returns Promise<void>
- Defined in room.ts:523

evictParticipant

evictParticipant(userId): Promise<void>
Evict participant

Participants will receive RoomEvent.EVICTED with EvictedFromRoom.
Parameters
- userId: string
Returns Promise<void>
- Defined in room.ts:652

getBitrateTest

getBitrateTest(): BitrateTestController
Returns BitrateTestController
- Defined in room.ts:540

getRemoteTrack

getRemoteTrack(kind, force): Promise<RemoteTrack>
Parameters
- kind: TrackType
- force: boolean
Returns Promise<RemoteTrack>
- Defined in room.ts:820

getStats

getStats(track, type, callback): void
Parameters
- track: MediaStreamTrack
- type: StatsType
- callback: Function
Returns void
- Defined in room.ts:816

id

id(): string
Returns string
- Defined in room.ts:772

invite

invite(): string
Returns string
- Defined in room.ts:804

join

join(pc, nickname?, config?, predefinedTracksCount?, 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 transportType: TransportType
  Ice transport protocol. "UDP"/"TCP".
Returns Promise<JoinedRoom>
- Defined in room.ts:381

leaveRoom

leaveRoom(): Promise<LeftRoom>
Leave room

Participants will receive RoomEvent.LEFT with LeftRoom. state will be RoomState.DISPOSED

Returns Promise<LeftRoom>
- Defined in room.ts:622

`Private` muteRemoteTrack

muteRemoteTrack(mid, mute): Promise<void>
Parameters
- mid: string
- mute: boolean
Returns Promise<void>
- Defined in room.ts:748

muteTrack

muteTrack(trackId, mute): Promise<void>
Mute track

Participants will receive RoomEvent.MUTE_TRACKS with AddRemoveTracks
Parameters
- trackId: string
- mute: boolean
Returns Promise<void>
- Defined in room.ts:734

name

name(): string
Returns string
- Defined in room.ts:780

nickname

nickname(): string
Returns string
- Defined in room.ts:792

off

off(event, callback): Room
Parameters
- event: RoomEvent
- callback: ((arg0) => void)
  - - (arg0): void
    - Parameters
      arg0: InternalMessage
      Returns void
Returns Room
- Defined in room.ts:767

on

on(event, callback): Room
Parameters
- event: RoomEvent
- callback: ((arg0) => void)
  - - (arg0): void
    - Parameters
      arg0: InternalMessage
      Returns void
Returns Room
- Defined in room.ts:762

pc

pc(): RTCPeerConnection
Returns RTCPeerConnection
- Defined in room.ts:796

pin(): string
Returns string
- Defined in room.ts:788

processEvent

processEvent(e): Promise<void>
Parameters
- e: InternalMessage
Returns Promise<void>
- Defined in room.ts:144

renameParticipant

renameParticipant(userId, newNickname): Promise<ParticipantRenamed>
Rename participant

Participants will receive RoomEvent.PARTICIPANT_RENAMED with ParticipantRenamed.
Parameters
- userId: string
- newNickname: string
Returns Promise<ParticipantRenamed>
- Defined in room.ts:670

role

role(): ParticipantRole
Returns ParticipantRole
- Defined in room.ts:800

sendMessage

sendMessage(msg): Promise<void>
Parameters
- msg: string
Returns Promise<void>
- Defined in room.ts:684

state

state(): RoomState
Returns RoomState
- Defined in room.ts:808

`Protected` updateName

updateName(name): void
Parameters
- name: string
Returns void
- Defined in room.ts:776

updateState

updateState(config?): Promise<void>
Used for SDP exchange
Parameters
- Optional config: {
  [key: string]: string;
  }
  - [key: string]: string
Returns Promise<void>
- Defined in room.ts:476

userId

userId(): string
Returns string
- Defined in room.ts:784

Class Room

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Room

Properties

Private #_creationTime

Private #_httpStatSender

Private #_pc

Private #_role

Private #_statCollector

Private #_state

Private #dChannel

Private #incomingMessageQueue

Type declaration

[key: string]: FragmentedMessage[]

Private #inviteId

Private #vacantTransceivers

Type declaration

audio: Queue<RTCRtpTransceiver>

video: Queue<RTCRtpTransceiver>

Private #wrappedDataChannel

_crutch

Type declaration

mutex: Mutex

tid: string

_id

_mediaSessionId

_name

_nickname

_pin

_uid

_userId

_webRTCMetricsServerDescription

Protected connection

Protected logger

Protected notifier

Protected stats

Static Private Readonly #BITRATE_CHANNEL

Static Private Readonly #CONTROL_CHANNEL

Methods

Private #applyContentTypeConfig

Parameters

[key: string]: string

Returns string

Private #dChannelSend

Parameters

Returns void

Private #setRemoteDescription

Parameters

Returns Promise<void>

changeQuality

Parameters

Returns Promise<void>

creationTime

Returns number

destroyRoom

Returns Promise<void>

evictParticipant

Parameters

Returns Promise<void>

getBitrateTest

Returns BitrateTestController

getRemoteTrack

Parameters

Returns Promise<RemoteTrack>

getStats

Parameters

Returns void

id

Returns string

invite

Returns string

join

Parameters

`Private` #_creationTime

`Private` #_httpStatSender

`Private` #_pc

`Private` #_role

`Private` #_statCollector

`Private` #_state

`Private` #dChannel

`Private` #incomingMessageQueue

`Private` #inviteId

`Private` #vacantTransceivers

`Private` #wrappedDataChannel

`Protected` connection

`Protected` logger

`Protected` notifier

`Protected` stats

`Static` `Private` `Readonly` #BITRATE_CHANNEL

`Static` `Private` `Readonly` #CONTROL_CHANNEL

`Private` #applyContentTypeConfig

`Private` #dChannelSend

`Private` #setRemoteDescription

`Private` muteRemoteTrack

`Protected` updateName