Class RoomExtended

Hierarchy (view full)

Room
- RoomExtended

Index

Constructors

Methods

#applyContentTypeConfig #dChannelSend #emmitAction #resolveOrNotify #setRemoteDescription assignRole authorizeWaitingList changeQuality conferenceType config configureWaitingRoom createRoom creationTime destroyRoom evictParticipant getBitrateTest getRemoteTrack getStats id invite join leaveRoom moveToWaitingRoom muteTrack name nickname off on owner pc pin processEvent reclaimOwnerRights renameParticipant role sendControlMessage sendMessage setAudioMuted setCanChangeNickname setChatMuted setInitialAudioMuted setInitialScreenSharingMuted setInitialVideoMuted setLock setParticipantAudioMuted setParticipantScreenSharingMuted setParticipantVideoMuted setScreenSharingEveryoneCanDoSubsequentShare setScreenSharingEveryoneCanShare setScreenSharingMultipleShares setScreenSharingMuted setVideoMuted startRecord state stopRecord subscribeToWaitingParticipant turnOffParticipantScreenSharing unsubscribeFromWaitingParticipant updateName updateState userId waitingRoomEnabled

Constructors

constructor

new RoomExtended(connection, id, owner, name, pin, userId, nickname, creationTime, config, waitingRoomEnabled, loggerPrefix?, conferenceType?, webRTCMetricsServerDescription?): RoomExtended
Parameters
- connection: Connection
- id: string
- owner: string
- name: string
- pin: string
- userId: string
- nickname: string
- creationTime: number
- config: RoomExtendedConfig
- waitingRoomEnabled: boolean
- Optional loggerPrefix: PrefixFunction
- Optional conferenceType: ConferenceType
- Optional webRTCMetricsServerDescription: RTCMetricsServerDescription
Returns RoomExtended
Overrides Room.constructor
- Defined in room-extended.ts:36

Properties

`Private` #_conferenceType

#_conferenceType: ConferenceType = ConferenceType.GLOBAL

`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` #config

#config: RoomExtendedConfig

`Private` #dChannel

#dChannel: RTCDataChannel

`Private` #incomingMessageQueue

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

Type declaration

[key: string]: FragmentedMessage[]

`Private` #inviteId

#inviteId: string

`Private` #owner

#owner: string

`Private` #vacantTransceivers

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

Type declaration

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

`Private` #waitingRoomEnabled

#waitingRoomEnabled: boolean

`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

Methods

`Private` #applyContentTypeConfig

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

`Private` #dChannelSend

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

`Private` #emmitAction

#emmitAction(action, data, resolve, reject): void
Parameters
- action: InternalApi
- data: object
- resolve: Function
- reject: Function
Returns void
- Defined in room-extended.ts:600

`Private` #resolveOrNotify

#resolveOrNotify(e, type, value): void
Parameters
- e: InternalMessage
- type: RoomEvent
- value: boolean | {}
Returns void
- Defined in room-extended.ts:594

`Private` #setRemoteDescription

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

assignRole

assignRole(userId, role): Promise<void>
Assign role

Used to transfer the role. The room owner will have the ParticipantRole.PARTICIPANT role.

Participants will receive RoomEvent.ROLE_ASSIGNED with RoleAssigned

New owner will receive RoomEvent.PARTICIPANT_CONFIG with ParticipantConfigEvent for each participant. The previous owner will receive RoomEvent.PARTICIPANT_CONFIG with ParticipantConfigEvent.
Parameters
- userId: string
- role: ParticipantRole
Returns Promise<void>
- Defined in room-extended.ts:177

authorizeWaitingList

authorizeWaitingList(userId, authorized): Promise<void>
Authorize or fail authorization for user from waiting List

Room owner will receive RoomEvent.WAITING_LIST with WaitingListEvent

If authorized = true - user will join to the room and other participants will receive RoomEvent.JOINED with JoinedRoom. If authorized = false - user will receive error RoomError.AUTHORIZATION_FAILED
Parameters
- userId: string
- authorized: boolean
Returns Promise<void>
- Defined in room-extended.ts:110

changeQuality

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

conferenceType

conferenceType(): ConferenceType
Returns ConferenceType
- Defined in room-extended.ts:590

config

config(): RoomExtendedConfig
Returns RoomExtendedConfig
- Defined in room-extended.ts:57

configureWaitingRoom

configureWaitingRoom(enabled): Promise<WaitingRoomUpdate>
Configure waiting room

Waiting room configuration, on/off switch for now

Waiting room must be empty
Parameters
- enabled: boolean
  flag indicates whether it's enabled or not
Returns Promise<WaitingRoomUpdate>
- Defined in room-extended.ts:154

createRoom

createRoom(): Promise<CreatedRoom>
Returns Promise<CreatedRoom>
- Defined in room-extended.ts:65

creationTime

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

destroyRoom

destroyRoom(): Promise<void>
Destroy room

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

Returns Promise<void>
Inherited from Room.destroyRoom
- 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>
Inherited from Room.evictParticipant
- Defined in room.ts:652

getBitrateTest

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

getRemoteTrack

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

getStats

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

id

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

invite

invite(): string
Returns string
Inherited from Room.invite
- 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>
Inherited from Room.join
- 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>
Inherited from Room.leaveRoom
- Defined in room.ts:622

moveToWaitingRoom

moveToWaitingRoom(userId): Promise<void>
Move user to waiting room

User will receive RoomEvent.DETACHED. Other participants will receive RoomEvent.LEFT with LeftRoom

Room owner will receive RoomEvent.WAITING_LIST with WaitingListEvent
Parameters
- userId: string
Returns Promise<void>
- Defined in room-extended.ts:132

muteTrack

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

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

name

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

nickname

nickname(): string
Returns string
Inherited from Room.nickname
- 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
Inherited from Room.off
- 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
Inherited from Room.on
- Defined in room.ts:762

owner

owner(): string
Returns string
- Defined in room-extended.ts:586

pc

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

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

processEvent

processEvent(e): Promise<void>
Parameters
- e: InternalMessage
Returns Promise<void>
Overrides Room.processEvent
- Defined in room-extended.ts:476

reclaimOwnerRights

reclaimOwnerRights(): Promise<void>
Reclaim owner rights

Participants will receive RoomEvent.ROLE_ASSIGNED with RoleAssigned

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

renameParticipant

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

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

role

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

sendControlMessage

sendControlMessage(msg, broadcast, to?): Promise<void>
Sending control message inside the room

Recipients will receive RoomEvent.CONTROL_MESSAGE with ControlMessageEvent
Parameters
- msg: string
- broadcast: boolean
  sending for all room participants, if true
- Optional to: string
  sending for user. Should use with broadcast = false
Returns Promise<void>
- Defined in room-extended.ts:86

sendMessage

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

setAudioMuted

setAudioMuted(muted): Promise<boolean>
Set room audio muted

Participants will receive RoomEvent.ROOM_AUDIO_MUTED with boolean value and RoomEvent.PARTICIPANT_CONFIG with ParticipantConfigEvent
Parameters
- muted: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:301

setCanChangeNickname

setCanChangeNickname(canChange): Promise<boolean>
Set room can change nickname

Participants will receive RoomEvent.ROOM_CAN_CHANGE_NICKNAME with boolean value.
Parameters
- canChange: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:357

setChatMuted

setChatMuted(muted): Promise<boolean>
Set room chat muted

Participants will receive RoomEvent.ROOM_CHAT_MUTED with boolean value and RoomEvent.PARTICIPANT_CONFIG with ParticipantConfigEvent

Chat receive policy will be ChatReceivePolicy.EVERYONE or ChatReceivePolicy.NOBODY.

Chat members will receive SfuEvent.CHAT_UPDATED with UpdateChatEvent
Parameters
- muted: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:345

setInitialAudioMuted

setInitialAudioMuted(muted): Promise<boolean>
Set room initial audio muted

Participants will receive RoomEvent.ROOM_INITIAL_AUDIO_MUTED with boolean value

Waiting participants will receive RoomEvent.STOP_TRACK with StopTrackEvent
Parameters
- muted: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:265

setInitialScreenSharingMuted

setInitialScreenSharingMuted(muted): Promise<boolean>
Set room initial screen sharing muted
Parameters
- muted: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:289

setInitialVideoMuted

setInitialVideoMuted(muted): Promise<boolean>
Set room initial video muted

Participants will receive RoomEvent.ROOM_INITIAL_VIDEO_MUTED with boolean value

Waiting participants will receive RoomEvent.STOP_TRACK with StopTrackEvent
Parameters
- muted: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:279

setLock

setLock(locked): Promise<boolean>
Set room lock

Participants will receive RoomEvent.ROOM_LOCKED with boolean value
Parameters
- locked: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:251

setParticipantAudioMuted

setParticipantAudioMuted(userId, muted): Promise<boolean>
Set participant's audio muted

Participant will receive RoomEvent.PARTICIPANT_AUDIO_MUTED with ParticipantAVSMutedEvent
Parameters
- userId: string
- muted: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:409

setParticipantScreenSharingMuted

setParticipantScreenSharingMuted(userId, muted): Promise<boolean>
Set participant's screen sharing muted

Participant will receive RoomEvent.PARTICIPANT_SCREEN_SHARING_MUTED with ParticipantAVSMutedEvent
Parameters
- userId: string
- muted: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:433

setParticipantVideoMuted

setParticipantVideoMuted(userId, muted): Promise<boolean>
Set participant's video muted

Participant will receive RoomEvent.PARTICIPANT_VIDEO_MUTED with ParticipantAVSMutedEvent
Parameters
- userId: string
- muted: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:421

setScreenSharingEveryoneCanDoSubsequentShare

setScreenSharingEveryoneCanDoSubsequentShare(canDoSubsequentShare): Promise<boolean>
Set room screen sharing everyone can do subsequent share

Participants will receive RoomEvent.SCREEN_SHARING_CONFIG with RoomScreenSharingConfigEvent
Parameters
- canDoSubsequentShare: boolean
  if false, participants with screen sharing will receive RoomEvent.STOP_SCREEN_SHARING with StopScreenSharingEvent
Returns Promise<boolean>
- Defined in room-extended.ts:397

setScreenSharingEveryoneCanShare

setScreenSharingEveryoneCanShare(everyoneCanShare): Promise<boolean>
Set room screen sharing everyone can share

Participants will receive RoomEvent.SCREEN_SHARING_CONFIG with RoomScreenSharingConfigEvent
Parameters
- everyoneCanShare: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:383

setScreenSharingMultipleShares

setScreenSharingMultipleShares(multipleShares): Promise<boolean>
Set room screen sharing multiple shares

Participants will receive RoomEvent.SCREEN_SHARING_CONFIG with RoomScreenSharingConfigEvent
Parameters
- multipleShares: boolean
  if false, participants with screen sharing will receive RoomEvent.STOP_SCREEN_SHARING with StopScreenSharingEvent
Returns Promise<boolean>
- Defined in room-extended.ts:371

setScreenSharingMuted

setScreenSharingMuted(muted): Promise<boolean>
Set room screen sharing muted

Participants will receive RoomEvent.ROOM_SCREEN_SHARING_MUTED with boolean value.

Participants that started screen sharing will receive RoomEvent.STOP_SCREEN_SHARING with StopScreenSharingEvent

All participants will receive RoomEvent.PARTICIPANT_CONFIG with ParticipantConfigEvent and RoomEvent.PARTICIPANT_SCREEN_SHARING_MUTED with boolean value.
Parameters
- muted: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:329

setVideoMuted

setVideoMuted(muted): Promise<boolean>
Set room audio muted

Participants will receive RoomEvent.ROOM_VIDEO_MUTED with boolean value and RoomEvent.PARTICIPANT_CONFIG with ParticipantConfigEvent
Parameters
- muted: boolean
Returns Promise<boolean>
- Defined in room-extended.ts:313

startRecord

startRecord(): Promise<void>
Returns Promise<void>
- Defined in room-extended.ts:452

state

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

stopRecord

stopRecord(): Promise<void>
Returns Promise<void>
- Defined in room-extended.ts:464

subscribeToWaitingParticipant

subscribeToWaitingParticipant(userId): Promise<AddRemoveTracks>
Subscribe to waiting participant

Used to check waiting participant's tracks.

Subscriber will receive RoomEvent.ADD_TRACKS with AddRemoveTracks
Parameters
- userId: string
Returns Promise<AddRemoveTracks>
- Defined in room-extended.ts:215

turnOffParticipantScreenSharing

turnOffParticipantScreenSharing(userId?, reason?): Promise<void>
Turn off participant's screen sharing

Participant(s) will receive RoomEvent.STOP_SCREEN_SHARING with StopScreenSharingEvent
Parameters
- Optional userId: string
- Optional reason: string
Returns Promise<void>
- Defined in room-extended.ts:445

unsubscribeFromWaitingParticipant

unsubscribeFromWaitingParticipant(userId): Promise<AddRemoveTracks>
Unsubscribe from waiting participant

Subscriber will receive RoomEvent.REMOVE_TRACKS with AddRemoveTracks
Parameters
- userId: string
Returns Promise<AddRemoveTracks>
- Defined in room-extended.ts:233

`Protected` updateName

updateName(name): void
Parameters
- name: string
Returns void
Inherited from Room.updateName
- 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>
Inherited from Room.updateState
- Defined in room.ts:476

userId

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

waitingRoomEnabled

waitingRoomEnabled(): boolean
Returns boolean
- Defined in room-extended.ts:61

Class RoomExtended

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RoomExtended

Properties

Private #_conferenceType

Private #_creationTime

Private #_httpStatSender

Private #_pc

Private #_role

Private #_statCollector

Private #_state

Private #config

Private #dChannel

Private #incomingMessageQueue

Type declaration

[key: string]: FragmentedMessage[]

Private #inviteId

Private #owner

Private #vacantTransceivers

Type declaration

audio: Queue<RTCRtpTransceiver>

video: Queue<RTCRtpTransceiver>

Private #waitingRoomEnabled

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

Methods

Private #applyContentTypeConfig

Parameters

[key: string]: string

Returns string

Private #dChannelSend

Parameters

Returns void

Private #emmitAction

Parameters

Returns void

Private #resolveOrNotify

Parameters

Returns void

Private #setRemoteDescription

Parameters

Returns Promise<void>

assignRole

Parameters

Returns Promise<void>

authorizeWaitingList

Parameters

Returns Promise<void>

changeQuality

Parameters

Returns Promise<void>

conferenceType

Returns ConferenceType

config

Returns RoomExtendedConfig

configureWaitingRoom

Parameters

Returns Promise<WaitingRoomUpdate>

`Private` #_conferenceType

`Private` #_creationTime

`Private` #_httpStatSender

`Private` #_pc

`Private` #_role

`Private` #_statCollector

`Private` #_state

`Private` #config

`Private` #dChannel

`Private` #incomingMessageQueue

`Private` #inviteId

`Private` #owner

`Private` #vacantTransceivers

`Private` #waitingRoomEnabled

`Private` #wrappedDataChannel

`Protected` connection

`Protected` logger

`Protected` notifier

`Protected` stats

`Private` #applyContentTypeConfig

`Private` #dChannelSend

`Private` #emmitAction

`Private` #resolveOrNotify

`Private` #setRemoteDescription