Events
On Active Speakers Changed
Triggered automatically when participants start or stop speaking.
Data provided
| Provides | Type | Description |
|---|---|---|
| Active Speakers | array of strings | The IDs of the participants who are currently speaking. |
On Audio Input Devices Received
Triggered by Dolby.io Get Audio Input Devices when devices are received.
Data provided
| Provides | Type | Description |
|---|---|---|
| Devices | array of Dolby.io Audio Device | The available devices. |
On Audio Levels Changed
Triggered automatically roughly every 500ms.
Data provided
| Provides | Type | Description |
|---|---|---|
| Active Speakers | array of strings | The IDs of the participants who are currently speaking. |
| Audio Levels | array of floats | Floating point numbers representing each participant's audio level. The order of Audio Levels corresponds to the order of Active Speakers. A value of 0.0 represents silence and a value of 1.0 represents the maximum volume. |
On Audio Output Devices Received
Triggered by Dolby.io Get Audio Output Devices when devices are received.
Data provided
| Provides | Type | Description |
|---|---|---|
| Devices | array of Dolby.io Audio Device | The available devices. |
On Connected
Triggered by Dolby.io Connect or Dolby.io Demo Conference when the client is successfully connected to the conference.
Data provided
| Provides | Type | Description |
|---|---|---|
| Local Participant ID | string | The ID of the local participant. |
| Conference ID | string | The ID of the conference. |
On Current Audio Input Device Changed
Triggered by Dolby.io Set Input Device or automatically when the device is changed.
Data provided
| Provides | Type | Description |
|---|---|---|
| Is None | bool | If this value is "true", then there is no device set and the information in the Optional Device parameter is meaningless. |
| Optional Device | Dolby.io Audio Device | The current device. |
On Current Audio Input Device Received
Triggered by Dolby.io Get Current Audio Input Device when the device is received.
Data provided
| Provides | Type | Description |
|---|---|---|
| Is None | bool | If this value is "true", then there is no device set and the information in the Optional Device parameter is meaningless. |
| Optional Device | Dolby.io Audio Device | The current device. |
On Current Audio Output Device Changed
Triggered by Dolby.io Set Output Device or automatically when the device is changed.
Data provided
| Provides | Type | Description |
|---|---|---|
| Is None | bool | If this value is "true", then there is no device set and the information in the Optional Device parameter is meaningless. |
| Optional Device | Dolby.io Audio Device | The current device. |
On Current Audio Output Device Received
Triggered by Dolby.io Get Current Audio Output Device when the device is received.
Data provided
| Provides | Type | Description |
|---|---|---|
| Is None | bool | If this value is "true", then there is no device set and the information in the Optional Device parameter is meaningless. |
| Optional Device | Dolby.io Audio Device | The current device. |
On Current Screenshare Source Received
Triggered by Dolby.io Get Current Screenshare Source when the source is received.
Data provided
| Provides | Type | Description |
|---|---|---|
| Is None | bool | If this value is "true", then there is no source set and the information in the Optional Source parameter is meaningless. |
| Optional Source | Dolby.io Screenshare Source | The current source. |
On Current Video Device Received
Triggered by Dolby.io Get Current Video Device when the device is received.
Data provided
| Provides | Type | Description |
|---|---|---|
| Is None | bool | If this value is "true", then there is no device set and the information in the Optional Device parameter is meaningless. |
| Optional Device | Dolby.io Video Device | The current device. |
On Disconnected
Triggered by Dolby.io Disconnect when the client is disconnected from the conference. The event is also triggered automatically after receiving an error that disconnected the client from the conference.
On Error
Triggered by functions if errors occur.
Data provided
| Provides | Type | Description |
|---|---|---|
| Error Msg | string | The error message. |
On Initialized
Triggered by Dolby.io Set Token when the plugin is successfully initialized. After receiving this event, the plugin is ready for use. You can now, for example, call the Dolby.io Connect function.
On Local Participant Updated
Triggered when the local participant's status is updated as a result of calling Connect, Demo Conference or Update User Metadata.
Data provided
| Provides | Type | Description |
|---|---|---|
| Status | Dolby.io Participant Status | The status of the participant. |
| Participant Info | Dolby.io Participant Info | Information about the participant. |
On Message Received
Triggered automatically when a message is received.
Data provided
| Provides | Type | Description |
|---|---|---|
| Message | string | The received message. |
| Participant Info | Dolby.io Participant Info | Information about the sender. |
On Participant Added
Triggered automatically when a remote participant is added to the conference.
This event is triggered for all participants who were present in the conference at any time, including participants who joined and left and are no longer in the conference. The status of the participant provided by this event should be taken into account when handling this event. For more information, refer to the graph of possible status changes.
Users who are only interested in tracking whether a participant is currently connected to the conference are encouraged to use On Remote Participant Connected and On Remote Participant Disconnected for simplicity.
Data provided
| Provides | Type | Description |
|---|---|---|
| Status | Dolby.io Participant Status | The status of the participant. |
| Participant Info | Dolby.io Participant Info | Information about the participant. |
On Participant Updated
Triggered automatically when a remote participant's status is updated. For more information, refer to the graph of possible status changes.
Data provided
| Provides | Type | Description |
|---|---|---|
| Status | Dolby.io Participant Status | The status of the participant. |
| Participant Info | Dolby.io Participant Info | Information about the participant. |
On Remote Participant Connected
Triggered automatically when a remote participant is connected to the conference.
Data provided
| Provides | Type | Description |
|---|---|---|
| Participant Info | Dolby.io Participant Info | Information about the participant. |
On Remote Participant Disconnected
Triggered automatically when a remote participant is disconnected from the conference.
Data provided
| Provides | Type | Description |
|---|---|---|
| Participant Info | Dolby.io Participant Info | Information about the participant. |
On Screenshare Sources Received
Triggered by Dolby.io Get Screenshare Sources when screen share sources are received.
Data provided
| Provides | Type | Description |
|---|---|---|
| Sources | array of Dolby.io Screenshare Source | The available screen share sources. |
On Screenshare Started
Triggered by Dolby.io Start Screenshare when screenshare is started.
Data provided
| Provides | Type | Description |
|---|---|---|
| Video Track ID | string | The ID of the screenshare video track. |
On Screenshare Stopped
Triggered by Dolby.io Stop Screenshare when screenshare is stopped.
Data provided
| Provides | Type | Description |
|---|---|---|
| Video Track ID | string | The ID of the screenshare video track. |
On Token Needed
Triggered automatically when an initial or refreshed client access token is needed, which happens when the Dolby.io Subsystem is initialized or when a refresh token is requested. After receiving this event, obtain a token for your Dolby.io application and call the Dolby.io Set Token function.
On Token Obtained
Triggered by Dolby.io Get Token From URL and Get Dolby.io Token when a client access token is obtained.
Data provided
| Provides | Type | Description |
|---|---|---|
| Token | string | The client access token. |
On Video Devices Received
Triggered by Dolby.io Get Video Devices when devices are received.
Data provided
| Provides | Type | Description |
|---|---|---|
| Devices | array of Dolby.io Video Device | The available devices. |
On Video Disabled
Triggered by Dolby.io Disable Video when local video is disabled.
Data provided
| Provides | Type | Description |
|---|---|---|
| Video Track ID | string | The ID of the local video track. |
On Video Enabled
Triggered by Dolby.io Enable Video when local video is enabled.
Data provided
| Provides | Type | Description |
|---|---|---|
| Video Track ID | string | The ID of the local video track. |
On Video Track Added
Triggered automatically when a video track is added.
Data provided
| Provides | Type | Description |
|---|---|---|
| Video Track | Dolby.io Video Track | Information about the video track. |
On Video Track Disabled
Triggered automatically when a video track is disabled as a result of the video forwarding strategy.
Data provided
| Provides | Type | Description |
|---|---|---|
| Video Track | Dolby.io Video Track | Information about the video track. |
On Video Track Enabled
Triggered automatically when a video track is enabled as a result of the video forwarding strategy.
Data provided
| Provides | Type | Description |
|---|---|---|
| Video Track | Dolby.io Video Track | Information about the video track. |
On Video Track Removed
Triggered automatically when a video track is removed.
Data provided
| Provides | Type | Description |
|---|---|---|
| Video Track | Dolby.io Video Track | Information about the video track. |