Events

Events

Room events

• room.started,
• room.updated,
• room.ended:

Emitted when the room session is, respectively, started, updated, or ended. Your event handler receives an object which is an instance of RoomSession.

• recording.started,
• recording.updated,
• recording.ended:

Emitted when a recording is, respectively, started, updated, or ended. Your event handler receives an object which is an instance of RoomSessionRecording.

• playback.started,
• playback.updated,
• playback.ended:

Emitted when a playback is, respectively, started, updated, or ended. Your event handler receives an object which is an instance of RoomSessionPlayback.

• layout.changed:

Emitted when the layout of the room changes.

Member events

• member.joined:

Emitted when a member joins the room. Your event handler receives an object of type RoomSessionMember.

• member.left:

Emitted when a member leaves the room. Your event handler receives an object of type RoomSessionMember.

• member.talking:

Emitted when a member starts or stops talking. Your event handler receives an object of type RoomSessionMember.

• member.talking.started:

Emitted when a member starts talking. Your event handler receives an object of type RoomSessionMember.

• member.talking.ended:

Emitted when a member stops talking. Your event handler receives an object of type RoomSessionMember.

• member.updated:

Emitted when any property of one of the members is updated. Your event handler receives an object member of type RoomSessionMember. Use member.updated to access the list of updated properties. Example:

1
roomSession.on('member.updated', (member) => {
2
    console.log(member.updated)
3
    // [ 'audioMuted' ]
4
}

• member.updated.audioMuted,
• member.updated.videoMuted,
• member.updated.deaf,
• member.updated.onHold,
• member.updated.visible,
• member.updated.inputVolume,
• member.updated.outputVolume,
• member.updated.inputSensitivity:

Each of the above events is emitted when the associated property changes. Your event handler receives an object member of type RoomSessionMember.

room.audience_count

• room.audience_count(e)

This event is received periodically, and contains a total count of audience members.

Audience members joining and leaving trigger this event.

Parameters

stream.ended

• stream.ended(stream)

A stream ended (e.g., it was stopped).

Parameters

stream.started

• stream.started(stream)

A new stream started.

Parameters