Dolbyio LOGO
Products
Communications APIs
Streaming APIs
Media APIs
Documentation
Communications APIs
Streaming APIs
Media APIs
Jump to Content
Communications APIsProductsDocumentationBlogGitHubForums
DocumentationREST APIsRelease Notes
ProductsDocumentationBlogGitHubForumsLogin >SIGN UPCommunications APIs
Login >SIGN UP

Overview

  • Introduction to Dolby.io Communications APIs
  • Developer Tools
  • Supported Environments
  • Network Requirements
  • Release Notes
  • Beta Programs
  • Policies
    • API Deprecation
    • Product Support
    • Product End-of-Life
  • REST APIs

Platform Guides

  • Basic Application Concepts
    • Accessing Dolby.io Platform
    • Session and Client Identification
    • Creating a Conference
    • Joining a Conference
  • Conference Capacity
  • Calculating Usage
  • Dolby Voice
  • Multi-region Support
  • Recording Conferences
    • Multiple Layout Mixes
    • Creating a Custom Mixer Layout Application
  • Security
    • Application Credentials
    • API Authentication
    • Client Authentication
    • Enhanced Conference Access Control
    • Media Encryption
    • Signaling Encryption
    • Recordings
    • Webhook Signature Validation
  • Simulcast
  • Video Forwarding
  • Video Processing

Audio Guides

  • Accessing the Local Audio Stream
  • Music Mode
  • Pre-processing the Local Audio Stream
  • Spatial Chat
    • Integrating Individual Spatial Chat
    • Integrating Shared Spatial Chat
    • Changing the Spatial Direction
  • Using Voice Fonts

Web SDK

  • Overview
  • Getting Started
  • Tutorials
    • Create a Basic Audio Conference Application
    • Integrate Video
    • Enable Video Processing
    • Manage Participants
    • Implement Screen Sharing
    • Record the Conference
  • Guides
    • Initializing the SDK
    • Presenting
    • Inviting Participants
    • Using Notifications
    • Using the Dolby Voice Codec
    • Using Audio Capabilities
    • Using Video Capabilities
    • Using Recording Capabilities
  • Sample Apps
  • Reference
    • VoxeetSDK
    • AudioService
    • CommandService
    • ConferenceService
    • FilePresentationService
    • MediaDeviceService
    • NotificationService
    • RecordingService
    • SessionService
    • VideoPresentationService
    • VideoService
  • Models
    • ActiveParticipants
    • AudioBitrate
    • AudioCaptureMode
    • AudioCaptureModeMusicOptions
    • AudioCaptureModeOptions
    • AudioCaptureModeStandardOptions
    • AudioEchoCancellation
    • BaseSubscription
    • BrowserError
    • ComfortNoiseLevel
    • Conference
    • ConferenceCreatedNotification
    • ConferenceEndedNotification
    • ConferenceError
    • ConferenceOptions
    • ConferenceParameters
    • ConferencePermission
    • ConferenceStatus
    • ConferenceStatusNotification
    • DemoOptions
    • DeviceChangeResult
    • DevicesList
    • DevicesUpdates
    • FileConversionProgress
    • FileConverted
    • FilePresentation
    • InvitationReceived
    • JoinOptions
    • ListenOptions
    • ListenType
    • LocalAudio
    • LocalVideo
    • MediaDeviceServiceInterface
    • MediaError
    • MediaStreamError
    • MediaStreamType
    • MediaStreamWithType
    • MixingOptions
    • NoiseReductionLevel
    • ParameterError
    • Participant
    • ParticipantInfo
    • ParticipantInvited
    • ParticipantJoinedNotification
    • ParticipantLeftNotification
    • ParticipantPermissions
    • ParticipantQuality
    • ParticipantStatus
    • ParticipantType
    • PeerError
    • Quality
    • QualityIndicator
    • Recording
    • RemoteAudio
    • RemoteVideo
    • ReplayOptions
    • ScreenshareOptions
    • ServerError
    • SessionError
    • SpatialAudioError
    • SpatialAudioStyle
    • SpatialDirection
    • SpatialPosition
    • SpatialScale
    • Stats
    • SubscribeActiveParticipants
    • SubscribeConferenceCreated
    • SubscribeConferenceEnded
    • SubscribeInvitation
    • SubscribeParticipantJoined
    • SubscribeParticipantLeft
    • SubscriptionType
    • UnsupportedError
    • VideoForwardingError
    • VideoForwardingOptions
    • VideoForwardingStrategy
    • VideoPresentation
    • VideoPresentationState
    • VideoProcessor
    • VideoProcessorOptions
    • VideoProcessorType
    • VideoServiceError
    • VoiceFont
    • WebRTCStats
    • WebSocketError

UIKits

  • Overview
  • Getting Started
  • Hooks
  • Themes

iOS SDK

  • Overview
    • Installing the SDK
    • Initializing the SDK
    • Presenting
    • Inviting Participants
    • Using Notifications
    • ScreenShare with iOS
  • Getting Started
    • Set Up a Project
    • Create a Basic Audio Conference Application for iOS
    • Integrate Video for iOS
    • Manage Participants for iOS
    • Implement Screen Sharing for iOS
    • Record the Conference for iOS
  • Reference
    • VoxeetSDK
    • AudioService
    • CommandService
    • ConferenceService
    • FilePresentationService
    • MediaDeviceService
    • NotificationService
    • RecordingService
    • SessionService
    • VideoPresentationService
    • VideoService
  • Models
    • AudioCaptureMode
    • AudioDelegate
    • AudioFormat
    • AudioFrame
    • AudioPreview
    • AudioPreviewStatus
    • AudioSamples
    • ComfortNoiseLevel
    • ListenType
    • LocalAudio
    • LocalInputAudioProcessor
    • LocalVideo
    • MediaStream
    • MediaStreamType
    • NoiseReduction
    • RecorderStatus
    • RemoteAudio
    • RemoteVideo
    • StandardAudioCaptureMode
    • UnprocessedAudioCaptureMode
    • VideoForwardingOptions
    • VideoForwardingStrategy
    • VoiceFont
    • VTActiveParticipantsNotification
    • VTCommandDelegate
    • VTConference
    • VTConferenceCreatedNotification
    • VTConferenceDelegate
    • VTConferenceEndedNotification
    • VTConferenceOptions
    • VTConferenceParameters
    • VTConferencePermission
    • VTConferenceStatus
    • VTConferenceStatusNotification
    • VTErrorCode
    • VTFileConverted
    • VTFilePresentation
    • VTFilePresentationDelegate
    • VTInvitationReceivedNotification
    • VTJoinOptions
    • VTJoinOptionsConstraints
    • VTListenOptions
    • VTNotificationDelegate
    • VTNotificationPushManager
    • VTNotificationPushType
    • VTParticipant
    • VTParticipantInfo
    • VTParticipantInvited
    • VTParticipantJoinedNotification
    • VTParticipantLeftNotification
    • VTParticipantPermissions
    • VTParticipantQuality
    • VTParticipantStatus
    • VTParticipantType
    • VTQuality
    • VTRecordingDelegate
    • VTRecordingStatus
    • VTReplayOptions
    • VTSessionDelegate
    • VTSessionState
    • VTSpatialAudioStyle
    • VTSpatialDirection
    • VTSpatialPosition
    • VTSpatialScale
    • VTSubscribeActiveParticipants
    • VTSubscribeConferenceCreated
    • VTSubscribeConferenceEnded
    • VTSubscribeInvitation
    • VTSubscribeParticipantJoined
    • VTSubscribeParticipantLeft
    • VTSubscriptionBase
    • VTVideoPresentation
    • VTVideoPresentationDelegate
    • VTVideoPresentationState

Android SDK

  • Overview
    • Initializing the SDK
    • Presenting
    • Inviting Participants
    • Using Notifications
  • Getting Started
    • Create a Basic Audio Conference Application for Android
    • Integrate Video for Android
    • Manage Participants for Android
    • Implement Screen Sharing for Android
    • Record the Conference for Android
  • Reference
    • VoxeetSDK
    • AudioService
    • CommandService
    • ConferenceService
    • FilePresentationService
    • MediaDeviceService
    • NotificationService
    • RecordingService
    • ScreenCapturerService
    • ScreenShareService
    • SessionService
    • VideoPresentationService
    • VideoService
  • Models
    • AudioCaptureMode
    • AudioPreview
    • AudioPreviewStatus
    • AudioProcessing
    • AudioType
    • BaseSubscription
    • ChatMessage
    • ChatMessageType
    • ComfortNoiseLevel
    • Conference
    • ConferenceAtMaxCapacityError
    • ConferenceConfigurations
    • ConferenceCreateOptions
    • ConferenceCreateOptions.Builder
    • ConferenceInformation
    • ConferenceJoinOptions
    • ConferenceJoinOptions.Builder
    • ConferenceListenOptions
    • ConferenceListenOptions.Builder
    • ConferenceParticipantsInvitedResult
    • ConferenceParticipantStatus
    • ConferenceParticipantType
    • ConferencePermission
    • ConferencePermissionException
    • ConferenceStatus
    • Constraints
    • CreateConferenceResult
    • DemoOptions
    • DemoOptions.Builder
    • EnforcedNotificationMode
    • FilePresentation
    • IIncomingInvitationListener
    • InConferenceException
    • InDolbyVoiceConferenceException
    • INotificationTokenProvider
    • InvitationBundle
    • LocalAudio
    • LocalConferenceType
    • LocalVideo
    • LocalInputAudioCallback
    • LocalInputAudioProcessor
    • LocalInputAudioSamples
    • MediaStream
    • MediaStreamType
    • MessageReceivedInWrongConference
    • Mode
    • NoiseReduction
    • NotificationCenter
    • NotificationHelper
    • NotificationMode
    • NotificationTokenHolderFactory
    • NotInConferenceException
    • ParamsHolder
    • Participant
    • ParticipantAddedErrorEventException
    • ParticipantInfo
    • ParticipantInvited
    • ParticipantMediaStreamHandler
    • ParticipantNotification
    • ParticipantPermissions
    • ParticipantPosition
    • ParticipantQuality
    • ParticipantType
    • PresentationState
    • PromisePermissionRefusedEventException
    • Quality
    • QualityIndicators
    • RecorderStatus
    • RefreshTokenCallback
    • RemoteAudio
    • RemoteVideo
    • ServerErrorException
    • ServerErrorOrigin
    • SoundManager
    • SpatialAudioException
    • SpatialAudioStyle
    • SpatialDirection
    • SpatialPosition
    • SpatialScale
    • StandardNoiseReduction
    • SubscribeActiveParticipants
    • SubscribeConferenceCreated
    • SubscribeConferenceEnded
    • SubscribeInvitation
    • SubscribeParticipantJoined
    • SubscribeParticipantLeft
    • VersionFilter
    • VideoCapturerBundle
    • VideoCapturerProvider
    • VideoForwardingOptions
    • VideoForwardingOptions.Builder
    • VideoForwardingStrategy
    • VideoPresentation
    • VoiceFont
    • VoxeetSDKNotInitiliazedException
    • AudioTrack
    • ListenType
    • VideoTrack

React Native SDK

  • Overview
  • Getting Started
  • Sample Apps
  • Reference
    • AudioPreview
    • AudioService
    • CommsAPI
    • CommandService
    • ConferenceService
    • FilePresentationService
    • LocalAudio
    • LocalVideo
    • MediaDeviceService
    • NotificationService
    • RecordingService
    • RemoteAudio
    • RemoteVideo
    • SessionService
    • VideoPresentationService
    • VideoService
  • Enums
    • AudioCaptureMode
    • AudioPreviewStatus
    • Codec
    • ComfortNoiseLevel
    • ConferencePermission
    • ConferenceStatus
    • MediaStreamType
    • NoiseReductionLevel
    • ParticipantStatus
    • ParticipantType
    • RecordingStatus
    • RTCPMode
    • SpatialAudioStyle
    • VideoForwardingStrategy
    • VideoPresentationState
    • VoiceFont
  • Models
    • ActiveParticipantsEventType
    • AudioCaptureModeOptions
    • AudioPreviewStatusChangedEventType
    • AudioProcessingOptions
    • AudioProcessingSenderOptions
    • Conference
    • ConferenceConstraints
    • ConferenceCreatedEventType
    • ConferenceCreateOptions
    • ConferenceCreateParameters
    • ConferenceEndedEventType
    • ConferenceJoinOptions
    • ConferenceLeaveOptions
    • ConferenceListenOptions
    • ConferenceMixingOptions
    • ConferenceReplayOptions
    • ConferenceStatusEventType
    • ConferenceStatusUpdatedEventType
    • File
    • FileConverted
    • FileConvertedEventType
    • FilePresentation
    • FilePresentationChangedEventType
    • InvitationReceivedEventType
    • MessageReceivedEventType
    • Participant
    • ParticipantChangedEventType
    • ParticipantInfo
    • ParticipantInvited
    • ParticipantJoinedEventType
    • ParticipantLeftEventType
    • ParticipantPermissions
    • PermissionsUpdatedEventType
    • Recording
    • RecordingStatusUpdatedEventType
    • SpatialDirection
    • SpatialPosition
    • SpatialScale
    • StreamChangedEventType
    • Subscription
    • VideoForwardingOptions
    • VideoPresentation
    • VideoPresentationEventType
  • Modules

Flutter SDK

  • Overview
  • Getting Started
  • Reference

C++ SDK

  • Overview
  • Getting Started
  • Reference

.NET SDK

  • Overview
  • Getting Started
  • Reference

Virtual Worlds Plugins

  • Unity
  • Unreal

Real-time Media Extensions

  • Real-time Media Extensions

Desktop SDK

  • Overview
  • Getting Started
  • Reference
    • VideoFiltersService
    • VideoFilterOptions
    • VideoFilter
  • Troubleshooting desktop application problems

Troubleshooting

  • Troubleshooting Audio Issues
    • Audio Issues in Music Mode
    • Audio Level Issues
    • Audio Quality Issues
    • Echo Issues
    • Noise Issues
    • Screen Share Audio Issues
    • Spatial Audio Issues
    • Reporting Audio Issues
  • Troubleshooting Desktop SDK

Webhooks

  • Overview
    • Signature Validation
  • Events
    • Conference.Created
    • Conference.Ended
    • Mixer.Service.Error
    • Participant.Joined
    • Participant.Left
    • Recording.Audio.Available
    • Recording.Live.InProgress
    • Recordings.Available
    • Stream.Rtmp.InProgress
    • Stream.Rts.StatusUpdated
  • Deprecated Events
    • Recording.MP4.Available

Project Sample Apps

  • Video Call Sample Apps
  • Pre-Call Test Sample App
  • Virtual Events Sample App
  • Feature: Live streaming a Video Call
  • Feature: Enable Music Mode in a Video Call
  • Android 1-on-1 Conference Finder
  • Broadcast Messages Between Client Apps
  • Token Authentication with Netlify Functions

Models

Suggest Edits
AudioCaptureMode
AudioDelegate
AudioFormat
AudioFrame
AudioPreview
AudioPreviewStatus
AudioSamples
ComfortNoiseLevel
LocalAudio
LocalInputAudioProcessor
LocalVideo
MediaStream
MediaStreamType
NoiseReduction
RecorderStatus
RemoteAudio
RemoteVideo
StandardAudioCaptureMode
UnprocessedAudioCaptureMode
VideoForwardingOptions
VideoForwardingStrategy
VTActiveParticipantsNotification
VTCommandDelegate
VTConference
VTConferenceCreatedNotification
VTConferenceDelegate
VTConferenceEndedNotification
VTConferenceOptions
VTConferenceParameters
VTConferencePermission
VTConferenceStatus
VTConferenceStatusNotification
VTErrorCode
VTFileConverted
VTFilePresentation
VTFilePresentationDelegate
VTInvitationReceivedNotification
VTJoinOptions
VTJoinOptionsConstraints
VTListenOptions
VTNotificationDelegate
VTNotificationPushManager
VTNotificationPushType
VTParticipant
VTParticipantInfo
VTParticipantInvited
VTParticipantJoinedNotification
VTParticipantLeftNotification
VTParticipantPermissions
VTParticipantQuality
VTParticipantStatus
VTParticipantType
VTQuality
VTRecordingDelegate
VTRecordingStatus
VTReplayOptions
VTSessionDelegate
VTSessionState
VTSpatialAudioStyle
VTSpatialDirection
VTSpatialPosition
VTSpatialScale
VTSubscribeActiveParticipants
VTSubscribeConferenceCreated
VTSubscribeConferenceEnded
VTSubscribeInvitation
VTSubscribeParticipantJoined
VTSubscribeParticipantLeft
VTSubscriptionBase
VTVideoPresentation
VTVideoPresentationDelegate
VTVideoPresentationState

Updated about 2 months ago