• namespace dolbyio
    • namespace comms
      • struct active_speaker_change
        Emitted whenever the active speaker changes. An empty list of speakers indicates that there is no active speaker.
      • class async_operation_canceled
        The base class that describes exceptions that are thrown when an asynchronous operation is abruptly canceled.
      • namespace async_result_tags
      • class audio_frame
        Interface that wraps decoded audio frames to be injected into WebRTC.
      • class audio_sink
        The interface for receiving audio frames.
      • class audio_source
        The interface for providing audio frames.
      • struct audio_track_added
        Emitted when a new audio track is received.
      • struct audio_track_removed
        Emitted when an audio track is removed and no longer received.
      • class certificate_exception
        Describes the exception thrown if WebRTC fails to generate a certificate.
      • class conference_exception
        The class that describes errors that occur in an active conference.
      • struct conference_info
        Contains the conference information. This structure provides conference details that are required to join a specific conference. The SDK returns conference_info to describe the created or joined conference.
      • struct conference_message_received
        Emitted when a new message is received in the current conference.
      • class conference_state_exception
        The class that describes errors for attempted operations that require a different conference state.
      • struct conference_status_updated
        Emitted whenever conference status changes.
      • class create_answer_exception
        The class that describes conference error where the WebRTC is unable to create an answer for the received offer.
      • class create_peer_connection_exception
        The class that describes a conferencing error that may occur during a creation of an initial peer connection.
      • namespace detail
      • class dvc_error_exception
        The class that describes a conference error that originates in the DVC library. This exception can also be listened for by attaching a handler for the dvc_error_exception type through the Conference Service.
      • class dvc_exception
        Describes exceptions originating from the DVC library.
      • class encoded_video_frame
        The interface that wraps encoded video frames received from the conference.
      • class event_handler_connection
        The interface that exposes a connection to the handler. The interface is created for each subscribed event.
      • class exception
        The base class for the SDK exceptions.
      • class http_exception
        The class that describes the HTTP errors.
      • class ice_candidate_exception
        The class that describes a conferencing error that can occur during an initial setting of candidates for a connection when the remote description is successfully applied.
      • class invalid_token_exception
        The class that describes the rejected REST API requests caused by an invalid access token. The user can also set a listener for this exception object using sdk::add_event_handler. In such a case, the event will be emitted whenever a signaling error occurs.
      • class io_exception
        The base class for all IO exceptions that occur in the case of problems with opening sockets or files.
      • class json_exception
        The base class for the JSON and depicts exceptions that are thrown when there is a JSON parsing error. This means an error in serializing or deserializing JSON string or object.
      • class jwt_exception
        Describes the JSON web token exceptions indicating that the authentication web token is not correct.
      • class media_engine_exception
        The base class describing exceptions stemming from media engine.
      • class media_exception
        The base exception class for exceptions originating from the media_engine.
      • class media_sink_interface
        The interface that is a sink for the Conference Service, where audio and video data for a specific conference are stored.
      • class media_source_interface
        The interface that acts as a media source for the Conference Service.
      • class media_stream_exception
        The exception that indicates an issue with the local media stream.
      • struct participant_added
        Emitted when a participant successfully joins the conference.
      • struct participant_info
        Contains the current status of a conference participant and information whether the participant's audio is enabled.
        • struct info
          Information about a conference participant.
      • struct participant_updated
        Emitted when a participant changes status.
      • class peer_connection_disconnected_exception
        The class that describes a conference error that results from a network connection issue. This error has a direct correlation with the disconnected PeerConnectionState. According to the WebRTC documentation, this state may be triggered intermittently and resolve without any action on less reliable networks. Therefore, this error is not considered fatal or non-recoverable like the PeerConnectionFailed state.
      • class peer_connection_failed_exception
        The exception that is emitted when there is a failure detected with the peer connection to the server. Meaning One or more of the ICE transports on the connection is in the failed state. This error is strict and indicates that peer connection will not return to normal state. This exception can also be listened for by attaching a handler for the peer_connection_failed_exception type through the Conference Service.
      • namespace plugin
        • class injector
          The base abstract class for the Default Media Injector's.
        • class injector_paced
          The interface for the Default Paced Media Injector.
        • class injector_passthrough
          The interface for the Default Passthrough Media Injector.
        • struct media_injection_status
          The current media injection status is expressed via this structure. This structure can be passed to the application by the injector to describe the current status.
        • class recorder
          The interface for the Default Media Recorder.
      • class refresh_token
        The interface for the function object, which is passed by the SDK to the applications' refresh token callback. The application needs to fetch a new token and invoke the function call operator that passes the token.
      • class remote_description_exception
        The class that describes conferencing errors that occur when setting a remote description fails. This means that there is an incompatibility in the offer, for example, that the offer contains not supported codecs.
      • class restapi_exception
        The class that describes errors received from the backend service during REST API calls.
      • class rtc_audio_source
        The adapter that is used for providing Audio frames into WebRTC. This interface is an Audio Sink from the perspective of the Injector. It is an Audio Source from the perspective of WebRTC Audio Tracks, thus it provides this connection in establishing the audio injection pipeline.
      • class rtc_video_source
        The adapter that is used for providing video frames into WebRTC. This interface is a video sink from the perspective of the Injector. It is a video source from the perspective of WebRTC Video Tracks, thus it provides this connection in establishing the video injection pipeline.
      • class sdk
        The SDK interface is the entry point for the CoreSDK API.
      • class security_check_exception
        The class for exceptions indicating that the CA certificates are not properly loaded.
      • namespace services
        • class conference
          Provides methods of the Conference Service.
          • struct conference_options
            The conference options structure that provides additional information about a conference.
            • struct params
              The conference parameters.
          • struct join_options
            The options that define how the application expects to join a conference in terms of media preference.
            • struct constraints
              The local media constraints that are passed to the getUserMedia call.
        • class session
          The session class.
          • struct participant_info
            The class that represents the participant who tries to open a session.
      • class session_exception
        The class that describes errors related to the Session Service.
      • class session_state_exception
        The class that defines exceptions for invalid session states.
      • class signaling_channel_exception
        The class that describes IO errors that occur on the signaling WebSocket. The user can also set a listener for this exception object using sdk::add_event_handler to emitted the event whenever a signaling error occurs.
      • struct thread_safe_solver_traits
        Traits that allow for safe implementation of asynchronous classes. They allow public APIs to safely use the objects of these classes.
      • class video_frame
        The interface that wraps decoded video frames received from and to be injected into WebRTC.
      • class video_sink_encoded
        The interface for receiving the encoded video frames.
      • class video_sink_yuv
        The interface for receiving the raw video frames.
      • class video_source
        The interface for providing video frames.
      • struct video_track_added
        Emitted when a new video track is received.
      • struct video_track_removed
        Event indicates that a video track is no longer being received.


Did this page help you?