2020-10-30
Updates to the Web Client SDK (v3.0.0), iOS Client SDK (v3.0.0), Android Client SDK (v3.0.0), Webhooks, Authentication, and Monitor REST APIs.
Web Client SDK
3.0.0
Features
-
Introduced Dolby Voice support to improve voice quality and make virtual meetings more natural and productive. The Dolby Voice article describes in detail the significant changes to Interactivity APIs.
-
Introduced improved video resolution scaling in non-simulcast transmissions. The resolution is based on the available bitrate and the number of conference participants.
Changes
Deprecated the 3D immersive calls functionality. The SDK 3.0 introduces Dolby Voice, which offers a spatial audio experience.
Bug Fixes
-
Fixed an issue with the Safari browser not playing any audio during conferences. The issue is caused by the Safari auto-play policy, which does not play audio unless Safari has permission to access a participant's speaker. To resolve this issue, the Web SDK 3.0 generates a new autoplayBlocked event when Safari rejects the play() element. This requires creating an additional interaction event that requests camera access. If a participant grants access, a new playBlockedAudio method enables audio.
-
Fixed an issue where a refresh of a conference participant resulted in not playing this participant audio to a participant who joined a conference using Safari. The fix is available only for Dolby Voice conferences.
2.4.5
Bug Fixes
Fixed an issue with closing PeerConnection when a conference participant who joined a conference without audio and video, enabled audio or video
iOS Client SDK
3.0.0
Release date: 2020-10-29
Features
-
Introduced Dolby Voice support to improve voice quality and make virtual meetings more natural and productive. The Dolby Voice article describes in detail the significant changes to Interactivity APIs.
-
Introduced a new isMuted method, which informs whether a local participant is muted.
-
Introduced a new muteOutput method, which controls playing remote participants' audio to the local participant. This API is only supported when the client connects to a Dolby Voice conference.
-
Introduced a new decline method, which allows application users to decline the conference invitations.
Changes
-
Deprecated the 3D immersive calls functionality. The SDK 3.0 introduces Dolby Voice, which offers a spatial audio experience.
-
Separated the mute method for local and remote participants. The existing mute method mutes only the local participant. The iOS SDK 3.0 introduces the new muteOutput method for muting remote participants.
-
Introduced a new Dolby Software License Agreement that describes terms and conditions required for using iOS SDK 3.0. The license is available on GitHub.
Android Client SDK
3.0.0
Release date: 2020-10-29
Features
-
Introduced Dolby Voice support to improve voice quality and make virtual meetings more natural and productive. The Dolby Voice article describes in detail the significant changes to Interactivity APIs.
-
Introduced improved video resolution scaling in non-simulcast transmissions. The resolution is based on the available bitrate and the number of conference participants.
-
Introduced a new muteOutput method, which controls playing remote participants' audio to the local participant. This API is only supported when the client connects to a Dolby Voice conference.
-
Introduced a new decline method, which allows application users to decline the conference invitations.
Changes
-
Deprecated the 3D immersive calls functionality. The SDK 3.0 introduces Dolby Voice, which offers a spatial audio experience.
-
The Android SDK 3.0 uses a new repository for accessing the SDK. The Android SDK 3.0 is available at https://github.com/voxeet/voxeet-sdk-android. The previous versions of the Android SDK are still accessible through bintray.
-
Introduced a new Dolby Software License Agreement that describes terms and conditions required for using Android SDK 3.0. The license is available on GitHub.
Bug Fixes
Fixed an issue with mobile device screens not turning off during video presentations when the local camera was disabled.
REST APIs
New REST APIs
Introduced the Monitor API, which provides recording details of Dolby Voice conferences and allows downloading MP3 audio recordings of these conferences.
Modified REST APIs
-
Added the
dolbyVoice
andlive
properties to Get a summary of a conference in the Monitor API. -
Added the
recordings
,first
, andnext
properties to Get recording details and Get the recording of a specific conference in the Monitor API. -
Added the following responses to the Get the recording of a specific conference of the Monitor API:
- 400: Conference cid is invalid
- 401: Unauthorized
-
Modified the content type of the following APIs:
-
Download the conference recording in MP3 format to the Monitor API: The
audio/mpeg
value replaces the previousapplication/mp3
content-type. -
Download the conference recording in MP3 format to the Monitor API: The
video/mp4
value replaces the previousapplication/mp3
content-type. -
Client access token in Authentication API: The
application/x-www-form-urlencoded
value replaces the previousapplication/json
content-type.
Deprecated REST APIs
-
Deprecated the Revoke a token method of Authentication API, which is no longer available for applications on the new Dolby Interactivity API platform.
-
Deprecated the GET method for JWT authentication token of the Authentication API
Webhooks
New webhook events
- Introduced the Recording.Audio.Available webhook event, which is sent when the recorded conference in MP3 format is ready and can be downloaded through the URL link included in the webhook. This event is available only for conferences enabled with Dolby Voice.
Modified webhook events
-
Modified the Recording.MP4.Available webhook event, which is sent when the recorded conference is ready and can be downloaded through the URL link included in the webhook. The recording format available in the webhook depends on whether the recorded conference was enabled with Dolby Voice:
-
Non-Dolby Voice conferences: The event can include MP3, MP4, and both MP3 and MP4 recordings.
-
Dolby Voice conferences: The event includes only MP4 recordings. To receive audio-related recording webhook notifications for conferences enabled with Dolby Voice, use the Recording.Audio.Available webhook.
-
-
Added the
preferSendMono
,preferRecvMono
,simulcast
,region
, andduration
properties to the Recording.MP4.Available webhook event in the split recording option. -
Added the
dolbyVoice
,preferSendMono
,preferRecvMono
,recordingFormat
, andsimulcast
properties to the Conference.Ended webhook event. -
Added the
thirdPartyId
andregion
properties to the Conference.Created, Participant.Joined, and Participant.Left webhook events.