Events
Events
onRoomSubscribed
- RoomSession.listen(
{ onRoomSubscribed: Callback })
Emitted when the room session is subscribed too. Your event handler
will be called with an instance of the RoomSession object.
Parameters
The room session object. See RoomSession.
onRoomStarted
- RoomSession.listen(
{ onRoomStarted: Callback })
This event is emitted when the first participant joins the room.
Emitted when the room session is started.
Your event handler will be called with an instance of the RoomSession object.
Parameters
The room session object. See RoomSession.
onRoomUpdated
- RoomSession.listen(
{ onRoomUpdated: Callback })
Emitted when the room session is updated. Your event handler
will be called with an instance of the RoomSession object.
Parameters
The room session object. See RoomSession.
onRoomEnded
- RoomSession.listen(
{ onRoomEnded: Callback })
Emitted when the room session is ended. Your event handler
will be called with an instance of the RoomSession object.
Parameters
The room session object. See RoomSession.
onRoomAudienceCount
- RoomSession.listen(
{ onRoomAudienceCount: Callback })
Emitted periodically, and when the audience count of the room changes. Your event handler
will be called with an instance of the VideoRoomAudienceCount object.
Parameters
Object containing the event parameters.
ID of the room session.
ID of the room.
Total number of audience members.
onLayoutChanged
- RoomSession.listen(
{ onLayoutChanged: Callback })
Emitted when the layout of the room changes. Your event handler
will be called with an instance of the VideoLayOutChanged object.
Parameters
Object containing the event parameters.
ID of the room session.
ID of the room.
Name of the new layout.
onMemberJoined
- RoomSession.listen(
{ onMemberJoined: Callback })
This event is only emitted when the room session has already been started. This means the first participant to join the room will not trigger this event.
Emitted when a member joins the room. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member that joined. See RoomSessionMember.
onMemberUpdated
- RoomSession.listen(
{ onMemberUpdated: Callback })
Emitted when a member in the room is updated. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member that was updated. See RoomSessionMember.
onMemberListUpdated
- RoomSession.listen(
{ onMemberListUpdated: Callback })
Emitted when the list of members in the room is updated. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member list update. See RoomSessionMember.
onMemberLeft
- RoomSession.listen(
{ onMemberLeft: Callback })
Emitted when a member leaves the room. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member that left. See RoomSessionMember.
onMemberDeaf
- RoomSession.listen(
{ onMemberDeaf: Callback })
Emitted when a member in the room deafens status changes. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member whose deaf status changed. See RoomSessionMember.
onMemberVisible
- RoomSession.listen(
{ onMemberVisible: Callback })
Emitted when a member in the room visibility changes. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member whose visibility changed. See RoomSessionMember.
onMemberAudioMuted
- RoomSession.listen(
{ onMemberAudioMuted: Callback })
Emitted when a member in the room audio state changes. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member whose audio mute state changed. See RoomSessionMember.
onMemberVideoMuted
- RoomSession.listen(
{ onMemberVideoMuted: Callback })
Emitted when a member in the room video state changes. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member whose video mute state changed. See RoomSessionMember.
onMemberInputVolume
- RoomSession.listen(
{ onMemberInputVolume: Callback })
Emitted when a member in the room input volume changes. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member whose input volume changed. See RoomSessionMember.
onMemberOutputVolume
- RoomSession.listen(
{ onMemberOutputVolume: Callback })
Emitted when a member in the room output volume changes. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member whose output volume changed. See RoomSessionMember.
onMemberInputSensitivity
- RoomSession.listen(
{ onMemberInputSensitivity: Callback })
Emitted when a member in the room input sensitivity changes. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member whose input sensitivity changed. See RoomSessionMember.
onMemberTalking
- RoomSession.listen(
{ onMemberTalking: Callback })
Emitted when a member in the room talking status changes. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member whose talking status changed. See RoomSessionMember.
onMemberTalkingStarted
- RoomSession.listen(
{ onMemberTalkingStarted: Callback })
Emitted when a member in the room starts talking. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member who started talking. See RoomSessionMember.
onMemberTalkingEnded
• RoomSession.listen({ onMemberTalkingEnded: Callback })
Emitted when a member in the room stops talking. Your event handler
will be called with an instance of the RoomSessionMember object.
Parameters
The member who stopped talking. See RoomSessionMember.
onPlaybackStarted
• RoomSession.listen({ onPlaybackStarted: Callback })
Emitted when a playback starts in the room. Your event handler
will be called with an instance of the RoomSessionPlayback object.
Parameters
The playback that started. See RoomSessionPlayback.
onPlaybackUpdated
- RoomSession.listen(
{ onPlaybackUpdated: Callback })
Emitted when a playback in the room is updated. Your event handler
will be called with an instance of the RoomSessionPlayback object.
Parameters
The playback that was updated. See RoomSessionPlayback.
onPlaybackEnded
- RoomSession.listen(
{ onPlaybackEnded: Callback })
Emitted when a playback in the room ends. Your event handler
will be called with an instance of the RoomSessionPlayback object.
Parameters
The playback that ended. See RoomSessionPlayback.
onRecordingStarted
- RoomSession.listen(
{ onRecordingStarted: Callback })
Emitted when a recording starts in the room. Your event handler
will be called with an instance of the RoomSessionRecording object.
Parameters
The recording that started. See RoomSessionRecording.
onRecordingUpdated
- RoomSession.listen(
{ onRecordingUpdated: Callback })
Emitted when a recording in the room is updated. Your event handler
will be called with an instance of the RoomSessionRecording object.
Parameters
The recording that was updated. See RoomSessionRecording.
onRecordingEnded
- RoomSession.listen(
{ onRecordingEnded: Callback })
Emitted when a recording in the room ends. Your event handler
will be called with an instance of the RoomSessionRecording object.
Parameters
The recording that ended. See RoomSessionRecording.
onStreamEnded
- RoomSession.listen(
{ onStreamEnded: Callback })
Emitted when a stream in the room ends. Your event handler
will be called with an instance of the RoomSessionStream object.
Parameters
The stream that ended. See RoomSessionStream.
onStreamStarted
- RoomSession.listen(
{ onStreamStarted: Callback })
Emitted when a stream starts in the room. Your event handler
will be called with an instance of the RoomSessionStream object.
Parameters
The stream that started. See RoomSessionStream.
Alias Types
VideoPositions
▪ VideoPositions: [ key: string]: VideoPosition
An object whose keys represent member IDs, and values the layout position to assign.
Instead of a member ID, in some contexts you can use
the special keyword self if you don’t know yet the ID of the member which
is going to be created.
The position of the member in the layout is determined automatically.
The reserved position in the layout (e.g. reserved-3).
The standard position in the layout (e.g. standard-3).
Assign the member off-canvas, outside the layout.
