dolbyio_comms_sdk_flutter
library
Classes
-
AudioProcessingOptions
-
The AudioProcessingOptions class is responsible for enabling and disabling audio processing.
-
AudioProcessingSenderOptions
-
The AudioProcessingSenderOptions class allows enabling and disabling audio processing for the local participant who transmits an audio stream.
-
CommandService
-
The CommandService allows the application to send and receive text messages and notifications during a conference.
-
Conference
-
The Conference class gathers information about a conference.
-
ConferenceConstraints
-
The ConferenceConstraints class gathers information about the preferred WebRTC constraints.
-
ConferenceCreateOption
-
The ConferenceCreateOption class allows defining conference details.
-
ConferenceCreateParameters
-
The ConferenceCreateParameters class allows defining conference parameters.
-
ConferenceJoinOptions
-
The ConferenceJoinOptions class defines how an application expects to join a conference in terms of media preference.
-
ConferenceLeaveOptions
-
The ConferenceLeaveOptions class gathers information about preferences for leaving a conference.
-
ConferenceMixingOptions
-
The ConferenceMixingOptions class is responsible for notifying the Dolby.io server that a participant who joins or replays a conference is a special participant called Mixer. Mixer can use the SDK to record or replay a conference. For more information, see the Recording Conferences article.
-
ConferenceReplayOptions
-
The ConferenceReplayOptions class contains options for replaying conferences.
-
ConferenceService
-
The ConferenceService allows an application to manage a conference life-cycle and interact with the conference. The service allows creating, joining, and leaving conferences and managing the audio, video, and screen-share streams.
-
DolbyioCommsSdk
-
DolbyioCommsSdk is the main class that allows an application to interact with Dolby.io services.
-
Event<T, B>
-
Describes a generic event.
-
File
-
The File class gathers information about a file that a presenter wants to share during a conference.
-
FileConverted
-
The FileConverted class gathers information about a converted file.
-
FileConvertedEventType
-
The FileConvertedEventType class gathers information about a converted file.
-
FilePresentation
-
The FilePresentation class gathers information about a file presentation.
-
FilePresentationChangedEventType
-
The FilePresentationChangedEventType class gathers information about a presented file.
-
FilePresentationService
-
The FilePresentationService allows presenting files during a conference. The Dolby.io Communications APIs service converts the user-provided file into multiple pages that are accessible through the getImage method.
-
InvitationReceivedNotificationData
-
The InvitationReceivedNotificationData class gathers information about a received invitation.
-
MediaDeviceService
-
The MediaDeviceService allows an application to manage media devices that are used during a conference.
-
MediaStream
-
The MediaStream type gathers information about media streams.
-
MessageReceivedData
-
The MessageReceivedData interface gathers information about a received message.
-
NotificationService
-
The NotificationService allows inviting participants to a conference.
-
Participant
-
The Participant class gathers information about a conference participant.
-
ParticipantInfo
-
The ParticipantInfo class gathers information about a conference participant.
-
ParticipantInvited
-
The ParticipantInvited class gathers information about an invited participant.
-
ParticipantPermissions
-
The ParticipantPermissions class gathers information about the invited participants and their conference permissions.
-
RecordingInformation
-
The RecordingInformation class gathers information about a conference recording.
-
RecordingService
-
The RecordingService allows recording conferences.
-
SessionService
-
The SessionService allows connecting the SDK with the Dolby.io backend via the open method. Opening a session is mandatory before interacting with any service.
-
SpatialDirection
-
The SpatialDirection class defines the direction a participant is facing. The class is specified as a set of three Euler rotations about the corresponding axis. The following properties define a rotation about the specified positive axis:
-
SpatialPosition
-
The SpatialPosition class represents a participant's audio position. The position is defined using Cartesian coordinates.
-
SpatialScale
-
The SpatialScale class defines how to convert units from the application's coordinate system (pixels or centimeters) into meters used by the spatial audio coordinate system. For example, let's assume that SpatialScale is set to (100,100,100), which indicates that 100 of the applications units (cm) map to 1 meter for the audio coordinates. If the listener's location is (0,0,0)cm and a remote participant's location is (200,200,200)cm, the listener has an impression of hearing the remote participant from the (2,2,2)m location.
-
StreamsChangeData
-
The StreamsChangeData class gathers information about media stream updates.
-
VideoPresentation
-
The VideoPresentation class gathers information about a video presentation.
-
VideoPresentationService
-
The VideoPresentationService allows sharing videos during a conference. To present a video, a conference participant needs to provide the URL of the video file. We recommend sharing files in the MPEG-4 Part 14 or MP4 video formats.
-
VideoView
-
A widget that can display a MediaStream for a Participant.
-
VideoViewController
-
A controller for the VideoView that is responsible for attaching a Participant and a MediaStream to the VideoView, detaching them, and getting information about the VideoView state.
Enums
-
Codec
-
The Codec enum gathers the available video codecs.
-
ComfortNoiseLevel
-
The ComfortNoiseLevel enum gathers the available comfort noise levels.
-
CommandServiceEventNames
-
The CommandServiceEventNames enum gathers the CommandService events.
-
ConferencePermission
-
The ConferencePermission enum gathers the possible permissions a participant may have in a conference.
-
ConferenceServiceEventNames
-
The ConferenceServiceEventNames enum gathers events that inform about changes in the participants list and the connected streams.
-
ConferenceStatus
-
The ConferenceStatus enum represents the possible conference statuses.
-
FilePresentationServiceEventNames
-
The FilePresentationServiceEventNames enum gathers events informing about the file presentation status.
-
MediaStreamType
-
The MediaStreamType enum gathers the possible types of media streams.
-
NotificationServiceEventNames
-
The NotificationServiceEventNames enum gathers the NotificationService events.
-
ParticipantStatus
-
The ParticipantStatus enum gathers the possible statuses of a conference participant.
-
ParticipantType
-
The ParticipantType enum gathers the possible types of a conference participant.
-
RecordingStatus
-
The RecordingStatus enum gathers the possible statuses of recording.
-
RTCPMode
-
The RTCPMode enum gathers the possible bitrate adaptation modes for video transmission.
-
VideoForwardingStrategy
-
-
VideoPresentationEventNames
-
The VideoPresentationEventNames enum gathers the possible statuses of a video presentation.
-
VideoPresentationState
-
The VideoPresentationState enum gathers the possible statuses of a video presentation.
Typedefs
-
UnsubscribeFunction
= void Function()
-
The UnsubscribeFunction unsubscribes from event listeners.