Dolbyio LOGO
Products
Communications APIs
Streaming APIs
Media APIs
Documentation
Communications APIs
Streaming 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

  • Basic Application Concepts
    • Accessing Dolby.io Platform
    • Session and Client Identification
    • Creating a Conference
    • Joining a Conference
  • Dolby Voice
  • Conference Capacity
  • Calculating Usage
  • Multi-region Support
  • Spatial Audio
    • Integrating Individual Spatial Audio
    • Integrating Shared Spatial Audio
    • Changing the Spatial Direction
  • Music Mode
  • Simulcast
  • Security
    • Application Credentials
    • API Authentication
    • Client Authentication
    • Enhanced Conference Access Control
    • Media Encryption
    • Signaling Encryption
    • Recordings
    • Webhook Signature Validation
  • Video Forwarding
  • Recording Conferences
    • Setting Recording Preferences
    • Downloading Recordings
    • Creating a Custom Mixer Layout Application
  • Migration Guides
    • Migrating from 1.x to 2.x
    • Migrating from 2.x to 3.x
  • Accessing the Local Audio Stream

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
  • Sample Apps
  • Reference
    • VoxeetSDK
    • AudioService
    • CommandService
    • ConferenceService
    • FilePresentationService
    • MediaDeviceService
    • NotificationService
    • RecordingService
    • SessionService
    • VideoPresentationService
    • VideoService
  • Models
    • ActiveParticipants
    • AudioBitrate
    • AudioCaptureMode
    • AudioCaptureModeMusicOptions
    • AudioCaptureModeOptions
    • AudioCaptureModeStandardOptions
    • AudioEchoCancellation
    • AudioProcessingOptions
    • AudioProcessingSenderOptions
    • 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
    • SpatialAudioError
    • SpatialAudioStyle
    • SpatialDirection
    • SpatialPosition
    • SpatialScale
    • Stats
    • SubscribeActiveParticipants
    • SubscribeConferenceCreated
    • SubscribeConferenceEnded
    • SubscribeInvitation
    • SubscribeParticipantJoined
    • SubscribeParticipantLeft
    • SubscriptionType
    • UnsupportedError
    • VideoForwardingError
    • VideoForwardingOptions
    • VideoForwardingStrategy
    • VideoPresentation
    • VideoPresentationState
    • VideoProcessor
    • VideoProcessorType
    • VideoServiceError
    • 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
    • AudioSamples
    • ComfortNoiseLevel
    • LocalAudio
    • LocalVideo
    • MediaStream
    • MediaStreamType
    • NoiseReduction
    • 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
    • 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
    • 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
    • LocalAudio
    • LocalVideo
    • LocalConferenceType
    • LocalInputAudioCallback
    • LocalInputAudioSamples
    • ComfortNoiseLevel
    • MediaStream
    • MediaStreamType
    • MessageReceivedInWrongConference
    • Mode
    • NoiseReduction
    • NotificationCenter
    • NotificationHelper
    • NotificationMode
    • NotificationTokenHolderFactory
    • NotInConferenceException
    • ParamsHolder
    • Participant
    • ParticipantAddedErrorEventException
    • ParticipantInfo
    • ParticipantInvited
    • ParticipantMediaStreamHandler
    • ParticipantNotification
    • ParticipantPosition
    • ParticipantPermissions
    • ParticipantQuality
    • ParticipantType
    • PresentationState
    • PromisePermissionRefusedEventException
    • Quality
    • QualityIndicators
    • 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
    • VoxeetSDKNotInitiliazedException

React Native SDK

  • Overview
  • Getting Started
  • Sample Apps
  • Reference
    • CommsAPI
    • AudioService
    • CommandService
    • ConferenceService
    • FilePresentationService
    • LocalAudio
    • LocalVideo
    • MediaDeviceService
    • NotificationService
    • RecordingService
    • RemoteAudio
    • RemoteVideo
    • SessionService
    • VideoPresentationService
    • VideoService
  • Enums
    • AudioCaptureMode
    • Codec
    • ComfortNoiseLevel
    • ConferencePermission
    • ConferenceStatus
    • MediaStreamType
    • NoiseReductionLevel
    • ParticipantStatus
    • ParticipantType
    • RecordingStatus
    • RTCPMode
    • SpatialAudioStyle
    • VideoForwardingStrategy
    • VideoPresentationState
  • Models
    • ActiveParticipantsEventType
    • AudioCaptureModeOptions
    • 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

Desktop SDK

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

C++ SDK

  • Overview
  • Getting Started
  • Reference

.NET SDK

  • Overview
  • Getting Started
  • Reference

Virtual World Plugins

  • Unity
  • Unreal

Troubleshooting

  • Troubleshooting Audio Issues
    • Audio Level Issues
    • Noise Issues
    • Echo Issues
    • Spatial Audio Issues
    • Audio Quality Issues
    • Reporting Audio Issues
    • Audio Issues in Music Mode
  • 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
    • Recording.MP4.Available
    • Stream.Hls.InProgress
    • Stream.Rtmp.InProgress
    • Stream.Rts.StatusUpdated

Project Sample Apps

  • Video Call Sample Apps
  • 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
  • Text Chat with GetStream.io

AudioService

Suggest Edits

The AudioService allows changing audio settings for the local and remote participants.

This service is available in SDK 3.7 and later.

Methods

getLocal

▸ getLocal(): LocalAudio

Audio settings for the local participant.

Returns

LocalAudio


getRemote

▸ getRemote(): RemoteAudio

Audio settings for a remote participant.

Returns

RemoteAudio

Updated 4 months ago


  • Table of Contents
    • Methods
      • getLocal
      • getRemote