Dolbyio LOGO
PRODUCTS
Communications APIs
Media APIs
DOCUMENTATION
Communications APIs
Media APIs
Jump to Content
Communications APIsPRODUCTSDOCUMENTATIONBLOGGALLERY
DocumentationREST APIsRelease Notes
PRODUCTSDOCUMENTATIONBLOGGALLERYLogin >SIGN UPCommunications APIs
Login >SIGN UP

Overview

  • Introduction to Dolby.io Communications APIs
  • Developer Tools
  • Supported Environments
  • Network Requirements
  • Release Notes
  • Beta Programs
  • SDK Support
  • REST APIs

Platform Guides

  • Dolby Voice
  • Conference Capacity
  • Calculating Usage
  • Spatial Audio
    • Integrating Spatial Audio
    • Changing the Spatial Direction
  • Security
    • Application Credentials
    • API Authentication
    • Client Authentication
    • Enhanced Conference Access Control
    • Media Encryption
    • Signaling Encryption
    • Recordings
    • Webhook Signature Validation
  • Video Forwarding
  • Recording Mechanisms
  • Creating a Custom Mixer Layout Application
  • Migration Guides
    • Migrating from 1.x to 2.x
    • Migrating from 2.x to 3.x
  • Simulcast

Web SDK

  • Overview
  • Getting Started
  • Tutorials
    • Create a Basic Audio Conference Application
    • Integrate Video
    • Manage Participants
    • Implement Screen Sharing
    • Record the Conference
  • Guides
    • Initializing the SDK
    • Conferencing
    • Recording
    • Inviting Participants
    • Using Notifications
    • Presenting
  • Reference
    • VoxeetSDK
    • CommandService
    • ConferenceService
    • FilePresentationService
    • MediaDeviceService
    • NotificationService
    • RecordingService
    • SessionService
    • VideoFiltersService
    • VideoPresentationService
  • Models
    • ActiveParticipants
    • AudioProcessingOptions
    • AudioProcessingSenderOptions
    • BaseSubscription
    • BrowserError
    • ComfortNoiseLevel
    • Conference
    • ConferenceCreatedNotification
    • ConferenceEndedNotification
    • ConferenceError
    • ConferenceLeaveOptions
    • ConferenceOptions
    • ConferenceParameters
    • ConferencePermission
    • ConferenceStatus
    • ConferenceStatusNotification
    • DeviceChangeResult
    • DevicesList
    • DevicesUpdates
    • FileConversionProgress
    • FileConverted
    • FilePresentation
    • InvitationReceived
    • JoinOptions
    • ListenOptions
    • MediaDeviceServiceInterface
    • MediaError
    • MediaStreamError
    • MediaStreamType
    • MediaStreamWithType
    • MixingOptions
    • ParameterError
    • Participant
    • ParticipantInfo
    • ParticipantInvited
    • ParticipantJoinedNotification
    • ParticipantLeftNotification
    • ParticipantPermissions
    • ParticipantQuality
    • ParticipantStatus
    • ParticipantType
    • PeerError
    • Quality
    • QualityIndicator
    • Recording
    • ReplayOptions
    • ServerError
    • SpatialAudioError
    • SpatialDirection
    • SpatialPosition
    • SpatialScale
    • Stats
    • SubscribeActiveParticipants
    • SubscribeConferenceCreated
    • SubscribeConferenceEnded
    • SubscribeInvitation
    • SubscribeParticipantJoined
    • SubscribeParticipantLeft
    • SubscriptionType
    • UnsupportedError
    • VideoFilter
    • VideoFilterOptions
    • VideoForwardingError
    • VideoPresentation
    • VideoPresentationState
    • WebRTCStats
    • WebSocketError

iOS SDK

  • Overview
    • Installing the SDK
    • Initializing the SDK
    • Conferencing
    • Presenting
    • Recording
    • 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
    • CommandService
    • ConferenceService
    • FilePresentationService
    • MediaDeviceService
    • NotificationService
    • RecordingService
    • SessionService
    • VideoPresentationService
  • Models
    • MediaEngineComfortNoiseLevel
    • MediaStream
    • MediaStreamType
    • VTActiveParticipantsNotification
    • VTCommandDelegate
    • VTConference
    • VTConferenceCreatedNotification
    • VTConferenceDelegate
    • VTConferenceEndedNotification
    • VTConferenceOptions
    • VTConferenceParameters
    • VTConferencePermission
    • VTConferenceStatus
    • VTConferenceStatusNotification
    • VTErrorCode
    • VTFileConverted
    • VTFilePresentation
    • VTFilePresentationDelegate
    • VTInvitationReceivedNotification
    • VTJoinOptions
    • VTJoinOptionsConstraints
    • VTListenOptions
    • VTNotificationDelegate
    • VTParticipant
    • VTParticipantInfo
    • VTParticipantInvited
    • VTParticipantJoinedNotification
    • VTParticipantLeftNotification
    • VTParticipantPermissions
    • VTParticipantQuality
    • VTParticipantStatus
    • VTQuality
    • VTRecordingDelegate
    • VTRecordingStatus
    • VTReplayOptions
    • VTSessionDelegate
    • VTSessionState
    • VTSpatialDirection
    • VTSpatialPosition
    • VTSpatialScale
    • VTSubscribeActiveParticipants
    • VTSubscribeConferenceCreated
    • VTSubscribeConferenceEnded
    • VTSubscribeInvitation
    • VTSubscribeParticipantJoined
    • VTSubscribeParticipantLeft
    • VTSubscriptionBase
    • VTVideoPresentation
    • VTVideoPresentationDelegate
    • VTVideoPresentationState

Android SDK

  • Overview
    • Initializing the SDK
    • Conferencing
    • Presenting
    • Recording
    • 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
  • Models
    • AudioProcessing
    • AudioType
    • BaseSubscription
    • ChatMessage
    • ChatMessageType
    • Conference
    • ConferenceAtMaxCapacityError
    • ConferenceConfigurations
    • ConferenceCreateOptions
    • ConferenceCreateOptions.Builder
    • ConferenceInformation
    • ConferenceJoinOptions
    • ConferenceJoinOptions.Builder
    • ConferenceListenOptions
    • ConferenceListenOptions.Builder
    • ConferenceParticipantsInvitedResult
    • ConferenceParticipantStatus
    • ConferenceParticipantType
    • ConferencePermission
    • ConferencePermissionException
    • ConferenceStatus
    • ConferenceStatusResult
    • Constraints
    • CreateConferenceResult
    • DemoOptions
    • DemoOptions.Builder
    • EnforcedNotificationMode
    • FilePresentation
    • IIncomingInvitationListener
    • InConferenceException
    • InDolbyVoiceConferenceException
    • INotificationTokenProvider
    • InvitationBundle
    • LocalConferenceType
    • MediaEngine.ComfortNoiseLevel
    • MediaStream
    • MediaStreamType
    • MessageReceivedInWrongConference
    • NotificationCenter
    • NotificationHelper
    • NotificationMode
    • NotificationTokenHolderFactory
    • NotInConferenceException
    • ParamsHolder
    • Participant
    • ParticipantAddedErrorEventException
    • ParticipantInfo
    • ParticipantInvited
    • ParticipantMediaStreamHandler
    • ParticipantNotification
    • ParticipantPosition
    • ParticipantPermissions
    • ParticipantQuality
    • ParticipantType
    • PresentationState
    • PromisePermissionRefusedEventException
    • Quality
    • QualityIndicators
    • RefreshTokenCallback
    • ServerErrorException
    • ServerErrorOrigin
    • SoundManager
    • SpatialAudioException
    • SpatialDirection
    • SpatialPosition
    • SpatialScale
    • SubscribeActiveParticipants
    • SubscribeConferenceCreated
    • SubscribeConferenceEnded
    • SubscribeInvitation
    • SubscribeParticipantJoined
    • SubscribeParticipantLeft
    • VersionFilter
    • VideoCapturerBundle
    • VideoCapturerProvider
    • VideoPresentation
    • VoxeetSDKNotInitiliazedException

React Native SDK

  • Overview
  • Getting Started
  • Reference
    • CommsAPI
    • CommandService
    • ConferenceService
    • FilePresentationService
    • MediaDeviceService
    • NotificationService
    • RecordingService
    • SessionService
    • VideoPresentationService
  • Enums
    • Codec
    • ComfortNoiseLevel
    • ConferencePermission
    • ConferenceStatus
    • MediaStreamType
    • ParticipantStatus
    • ParticipantType
    • RTCPMode
    • VideoPresentationState
  • Models
    • SpatialDirection
    • AudioProcessingOptions
    • AudioProcessingSenderOptions
    • Conference
    • ConferenceConstraints
    • ConferenceCreateOptions
    • ConferenceCreateParameters
    • ConferenceJoinOptions
    • ConferenceLeaveOptions
    • ConferenceMixingOptions
    • ConferenceReplayOptions
    • ConferenceStatusUpdatedEventType
    • File
    • FileConverted
    • FileConvertedEventType
    • FilePresentation
    • FilePresentationChangedEventType
    • InvitationReceivedEventType
    • MessageReceivedEventType
    • Participant
    • ParticipantChangedEventType
    • ParticipantInfo
    • ParticipantInvited
    • ParticipantPermissions
    • PermissionsUpdatedEventType
    • Recording
    • SpatialDirection
    • SpatialPosition
    • SpatialScale
    • StreamChangedEventType
    • VideoPresentation
    • VideoPresentationEventType
  • Modules

Desktop SDK

  • Overview
  • Getting Started
  • Troubleshooting desktop application problems

Server C++ SDK

  • Overview
  • Getting Started
  • Reference
    • Server C++ SDK
    • Asynchronous Operations
    • Conference Service
    • Default Media Injector Plugin
    • Default Media Recorder Plugin
    • Event Handling
    • SDK Event Types
    • Exceptions
    • Logging Levels
    • Media Injector API
    • Media Recorder API
    • Session Service
  • Classes
    • active_speaker_change
    • async_operation_canceled
    • audio_sink
    • audio_track_added
    • audio_track_removed
    • certificate_exception
    • conference_exception
    • conference_info
    • conference_state_exception
    • conference_status_updated
    • create_answer_exception
    • create_peer_connection_exception
    • detail::async_result
    • detail::solver
    • detail::solver< void, traits >
    • dvc_error_exception
    • dvc_exception
    • event_handler_connection
    • exception
    • frame
    • http_exception
    • ice_candidate_exception
    • invalid_token_exception
    • io_exception
    • json_exception
    • jwt_exception
    • media_engine_exception
    • media_exception
    • media_sink_interface
    • media_stream_exception
    • participant_added
    • participant_info
    • participant_info::info
    • participant_updated
    • peer_connection_disconnected_exception
    • peer_connection_failed_exception
    • plugin::recorder
    • refresh_token
    • remote_description_exception
    • restapi_exception
    • sdk
    • security_check_exception
    • services::conference
    • services::conference::conference_options
    • services::conference::conference_options::params
    • services::conference::join_options
    • services::conference::join_options::constraints
    • services::session
    • services::session::participant_info
    • session_exception
    • session_state_exception
    • signaling_channel_exception
    • thread_safe_solver_traits
    • video_sink_encoded
    • video_sink_yuv
    • video_track_added
    • video_track_removed
    • detail::async_result_with_solver
    • detail::low_level_solver
    • detail::low_level_solver< void, traits >
    • video_frame
    • conference_message_received
    • detail::async_result::set_local_error_callback_and_chain_result
    • detail::async_result::set_local_error_callback_and_reset_result
    • audio_frame
    • audio_source
    • media_source_interface
    • plugin::injector_paced
    • plugin::injector
    • plugin::injector_passthrough
    • rtc_audio_source
    • rtc_video_source
    • video_source
    • plugin::media_injection_status
    • encoded_video_frame

Troubleshooting

  • Troubleshooting Audio Issues
    • Audio Level Issues
    • Noise Issues
    • Echo Issues
    • Spatial Audio Issues
    • Audio Quality Issues
    • Reporting Audio Issues
  • Troubleshooting Desktop SDK

UXKit

  • UXKit Overview
    • UXKit Voxeet Cordova
    • UXKit Voxeet Java
    • UXKit Voxeet React
    • UXKit Voxeet React Native
    • UXKit Voxeet Swift

Webhooks

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

Example Projects

  • Layout Samples
    • Flow Layout in an iFrame
    • Classroom with Fixed Layout and Roles
    • Standalone Conference App Supporting Multiple Layouts
  • Mobile Samples
    • Android 1-on-1 Conference Finder
  • Spatial Audio Samples
    • Dynamic 2D Map with Breakout Rooms and Spatial Audio
  • Feature Samples
    • Detect Participants Who Are Speaking
    • Broadcast Messages Between Client Apps
  • Integration Samples
    • Token Authentication with Netlify Functions
    • Text Chat with GetStream.io

Migration Guides

Suggest Edits

Migration Guides list all significant SDK changes to help you migrate from one release to the next. If you wish to know more about changes between releases, check our Release Notes.

  • Migrating from 1.x to 2.x
  • Migrating from 2.x to 3.x

Updated 5 months ago


Did this page help you?