NEWDolby Interactivity APIs are now the Dolby.io Communications APIs Learn More >
X

Conference.Ended

The Conference.Ended event is sent when the conference is ended. The payload includes all the participants at the time of the Conference.Ended event.

{
    "eventType": "Conference.Ended",
    "conference": {
        "confId": "conferenceId_UUID",
        "confAlias": "example_conference_alias"
    },
    "confId": "conferenceId_UUID",
    "thirdPartyId": "example_thirdpartyId",
    "confAlias": "example_conference_alias",
    "confType": "SDK_CONF",
    "ownerId": "ownerId_UUID",
    "startTime": 1602086897206,
    "duration": 18135,
    "speakingDuration": 9097,
    "recordingDuration": 6418,
    "participants": [
        {
            "userId": "userId_UUID_01",
            "ipAddress": "00.000.000.000",
            "presenceDuration": 17773,
            "recvTimers": {},
            "sendTimers": {
                "VIDEO": 12425,
                "AUDIO": 15310
            },
            "metadata": {
                "preferSendMono": "false",
                "externalName": "external_name",
                "externalPhotoUrl": "link_to_participant_photo",
                "simulcast": "false",
                "preferRecvMono": "false"
            }
        },
        {
            "userId": "userId_UUID_02",
            "ipAddress": "00.000.000.001",
            "presenceDuration": 9098,
            "recvTimers": {
                "AUDIO": 9049
            },
            "sendTimers": {},
            "metadata": {
                "preferSendMono": "false",
                "externalName": "Mixer",
                "externalId": "Mixer_record",
                "simulcast": "false",
                "preferRecvMono": "false"
            }
        }
    ],
    "region": "eu",
    "recordingFormat": "both",
    "dolbyVoice": "true"
}

Where:

  • startTime is the time when the conference started, in milliseconds since epoch.
  • ownerId is the creator of the conference, it can be either:
    • The participant ID randomly generated by the Voxeet service.
    • The externalID, supplied by the customer application, when the session is open.
  • region is the conference region, the possible values are:
    • ca: Canada
    • us: US
    • eu: EU
    • in: India
    • au: Australia
  • recordingFormat indicates the recording format, either audio, video, or both.
  • dolbyVoice indicates whether a conference is a Dolby Voice conference or non-Dolby Voice conference. This information is only available for conferences created with SDK 3.0 and later versions.

Note: The duration units are in milliseconds.


Did this page help you?