Updating github pages 2.0.0

voxeet · Jul 22, 2022 · 8b187c7 · 8b187c7
1 parent f7d32f4
commit 8b187c7
Show file tree

Hide file tree

Showing 78 changed files with 548 additions and 481 deletions.
diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 54bd462083b6f3007e078b8646fab0df
+config: 703cf7a91f2ad47055af9a4bf5d250ed
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.doctrees/api/injection/audio.doctree b/docs/.doctrees/api/injection/audio.doctree
diff --git a/docs/.doctrees/api/injection/example.doctree b/docs/.doctrees/api/injection/example.doctree
diff --git a/docs/.doctrees/api/injection/media_source_interface.doctree b/docs/.doctrees/api/injection/media_source_interface.doctree
diff --git a/docs/.doctrees/api/injection/video.doctree b/docs/.doctrees/api/injection/video.doctree
diff --git a/docs/.doctrees/api/recording/audio.doctree b/docs/.doctrees/api/recording/audio.doctree
diff --git a/docs/.doctrees/api/recording/encoded_video.doctree b/docs/.doctrees/api/recording/encoded_video.doctree
diff --git a/docs/.doctrees/api/recording/example.doctree b/docs/.doctrees/api/recording/example.doctree
diff --git a/docs/.doctrees/api/recording/media_sink_interface.doctree b/docs/.doctrees/api/recording/media_sink_interface.doctree
diff --git a/docs/.doctrees/api/recording/raw_video.doctree b/docs/.doctrees/api/recording/raw_video.doctree
diff --git a/docs/.doctrees/api/sdk/common/async_ops.doctree b/docs/.doctrees/api/sdk/common/async_ops.doctree
diff --git a/docs/.doctrees/api/sdk/common/event_handling.doctree b/docs/.doctrees/api/sdk/common/event_handling.doctree
diff --git a/docs/.doctrees/api/sdk/common/exception.doctree b/docs/.doctrees/api/sdk/common/exception.doctree
diff --git a/docs/.doctrees/api/sdk/common/log_level.doctree b/docs/.doctrees/api/sdk/common/log_level.doctree
diff --git a/docs/.doctrees/api/sdk/conference.doctree b/docs/.doctrees/api/sdk/conference.doctree
diff --git a/docs/.doctrees/api/sdk/device_management.doctree b/docs/.doctrees/api/sdk/device_management.doctree
diff --git a/docs/.doctrees/api/sdk/injector.doctree b/docs/.doctrees/api/sdk/injector.doctree
diff --git a/docs/.doctrees/api/sdk/recorder.doctree b/docs/.doctrees/api/sdk/recorder.doctree
diff --git a/docs/.doctrees/api/sdk/sdk.doctree b/docs/.doctrees/api/sdk/sdk.doctree
diff --git a/docs/.doctrees/api/sdk/session.doctree b/docs/.doctrees/api/sdk/session.doctree
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree
diff --git a/docs/.doctrees/other/getting_started.doctree b/docs/.doctrees/other/getting_started.doctree
diff --git a/docs/.doctrees/other/supported_platforms.doctree b/docs/.doctrees/other/supported_platforms.doctree
diff --git a/docs/_sources/api/injection/audio.rst.txt b/docs/_sources/api/injection/audio.rst.txt
@@ -2,7 +2,7 @@
 
 Audio Source Interface
 ========================
-#include <comms/media/media_engine.h>
+#include <dolbyio/comms/media/media_engine.h>
 
 The interface through which raw audio frames are provided to the CoreSDK. This audio source must provide signed 16 bit PCM data in 10ms chunks at 10ms intervals. Application writers who want to 
 implement this source must override the two virtual functions of :cpp:func:`registering <dolbyio::comms::audio_source::register_audio_frame_rtc_source>` and 

diff --git a/docs/_sources/api/injection/example.rst.txt b/docs/_sources/api/injection/example.rst.txt
@@ -13,20 +13,20 @@ The paths in this CMakeLists.txt are assuming that the file is located in the sa
 
 custom_injector.h
 _________________
-.. literalinclude:: ../../../src/public/comms/sample/custom_injector/custom_injector.h
+.. literalinclude:: ../../../src/public/dolbyio/comms/sample/custom_injector/custom_injector.h
   :language: c++
 
 custom_injector.cc
 __________________
-.. literalinclude:: ../../../src/public/comms/sample/custom_injector/custom_injector.cc
+.. literalinclude:: ../../../src/public/dolbyio/comms/sample/custom_injector/custom_injector.cc
   :language: c++
 
 main.cc
 _______
-.. literalinclude:: ../../../src/public/comms/sample/custom_injector/main.cc
+.. literalinclude:: ../../../src/public/dolbyio/comms/sample/custom_injector/main.cc
   :language: c++
 
 Injector CMakeLists.txt
 _______________________
-.. literalinclude:: ../../../src/public/comms/sample/custom_injector/CMakeLists.txt
+.. literalinclude:: ../../../src/public/dolbyio/comms/sample/custom_injector/CMakeLists.txt
   :language: console
diff --git a/docs/_sources/api/injection/media_source_interface.rst.txt b/docs/_sources/api/injection/media_source_interface.rst.txt
@@ -2,7 +2,7 @@
 
 Media Source Interface
 =========================
-#include <comms/media/media_engine.h>
+#include <dolbyio/comms/media/media_engine.h>
 
 Top level interface that exposes the underlying source interfaces for injecting raw video and raw audio. This abstract class exposes
 the two possible source interfaces: :cpp:class:`video <dolbyio::comms::video_source>`, :cpp:class:`audio <dolbyio::comms::audio_source>`. These two source interfaces essentially serve as input for the RTC Audio and Video sources created by the Media Engine.

diff --git a/docs/_sources/api/injection/video.rst.txt b/docs/_sources/api/injection/video.rst.txt
@@ -2,7 +2,7 @@
 
 Video Source Interface
 ========================
-#include <comms/media/media_engine.h>
+#include <dolbyio/comms/media/media_engine.h>
 
 The interface through which raw video frames are provided to the CoreSDK. Application writers who want to implement this source must override the two virtual functions of :cpp:func:`registering <dolbyio::comms::video_source::register_video_frame_rtc_source>` and cpp:func:`deregistering <dolbyio::comms::video_source::deregister_video_frame_rtc_source>` the RTC Video Source on the Injector. When a 
 VideoTrack is successfully added to an active PeerConnection, these virtual functions are invoked to provide/remove the reference to the RTC Video Source. Attaching the RTC Video source to the 

diff --git a/docs/_sources/api/recording/audio.rst.txt b/docs/_sources/api/recording/audio.rst.txt
@@ -2,7 +2,7 @@
 
 Audio Sink Interface
 ========================
-#include <comms/media/media_engine.h>
+#include <dolbyio/comms/media/media_engine.h>
 
 The interface for handling incoming audio frames. Applications must set listener which override the virtual function. The 
 :cpp:func:`handle_audio <dolbyio::comms::audio_sink::handle_audio>` function is called with the decoded PCM audio data. When inside a conference the 

diff --git a/docs/_sources/api/recording/encoded_video.rst.txt b/docs/_sources/api/recording/encoded_video.rst.txt
@@ -2,7 +2,7 @@
 
 Encoded Video Sink Interface
 ============================
-#include <comms/media/media_engine.h>
+#include <dolbyio/comms/media/media_engine.h>
 
 The interface for handling encoded video frames. Application must set listeners which override both of the virtual functions. The 
 :cpp:func:`handle_frame_encoded <dolbyio::comms::video_sink_encoded::handle_frame_encoded>` function is called after the RTP data is depacktized and an encoded frame 

diff --git a/docs/_sources/api/recording/example.rst.txt b/docs/_sources/api/recording/example.rst.txt
@@ -15,15 +15,15 @@ This paths in this CMakeLists.txt are assuming that the file is located in the s
 
 custom_recorder.h
 _________________
-.. literalinclude:: ../../../src/public/comms/sample/custom_recorder/custom_recorder.h
+.. literalinclude:: ../../../src/public/dolbyio/comms/sample/custom_recorder/custom_recorder.h
   :language: c++
 
 custom_recorder.cc
 __________________
-.. literalinclude:: ../../../src/public/comms/sample/custom_recorder/custom_recorder.cc
+.. literalinclude:: ../../../src/public/dolbyio/comms/sample/custom_recorder/custom_recorder.cc
   :language: c++
 
 Recorder CMakeLists.txt
 _______________________
-.. literalinclude:: ../../../src/public/comms/sample/custom_recorder/CMakeLists.txt
+.. literalinclude:: ../../../src/public/dolbyio/comms/sample/custom_recorder/CMakeLists.txt
   :language: console
diff --git a/docs/_sources/api/recording/media_sink_interface.rst.txt b/docs/_sources/api/recording/media_sink_interface.rst.txt
@@ -2,7 +2,7 @@
 
 Media Sink Interface
 =========================
-#include <comms/media/media_engine.h>
+#include <dolbyio/comms/media/media_engine.h>
 
 Top level interface which exposes the underlying sink interfaces for receiving and handling audio, raw video and encoded video data. This abstract class just exposes
 the three possible sink interfaces: :cpp:class:`raw video <dolbyio::comms::video_sink_yuv>`, :cpp:class:`encoded video <dolbyio::comms::video_sink_encoded>` 

diff --git a/docs/_sources/api/recording/raw_video.rst.txt b/docs/_sources/api/recording/raw_video.rst.txt
@@ -2,7 +2,7 @@
 
 Raw Video Sink Interface
 ========================
-#include <comms/media/media_engine.h>
+#include <dolbyio/comms/media/media_engine.h>
 
 The interface for handling decoded video frames. Application must set listener which overrides the virtual function. The 
 :cpp:func:`handle_frame <dolbyio::comms::video_sink_yuv::handle_frame>` function is called after the Webrtc Decoder has decoded the frame and will provide the 

diff --git a/docs/_sources/api/sdk/common/async_ops.rst.txt b/docs/_sources/api/sdk/common/async_ops.rst.txt
@@ -21,7 +21,7 @@ set, on the application's thread. Otherwise, the callbacks are invoked when the
 
 Thread Safe Types and Helper Methods
 ------------------------------------
-#include <comms/async_result.h>
+#include <dolbyio/comms/async_result.h>
 
 The thread safe types which can be exposed by the user via the public API. They define thread safe versions of the Asynchronous Classes documented in the
 sections below. The helper method allows for synchronous usage of the asynchronous API when called from a different thread.
@@ -52,7 +52,7 @@ sections below. The helper method allows for synchronous usage of the asynchrono
 
 Async Result Class
 ------------------
-#include <comms/async_result_detail.h>
+#include <dolbyio/comms/async_result_detail.h>
 
 The async_result is a result that is returned to the SDK by all asynchronous calls, except calls that create the SDK and set the log level. Asynchronous operations can be chained together using
 :cpp:func:`async_result::then <dolbyio::comms::detail::async_result::then>` calls and must be terminated with

diff --git a/docs/_sources/api/sdk/common/event_handling.rst.txt b/docs/_sources/api/sdk/common/event_handling.rst.txt
@@ -2,7 +2,7 @@
 
 Event Handling Interface 
 ========================
-#include <comms/event_handling.h>
+#include <dolbyio/comms/event_handling.h>
 
 The event handler connection interface is used for handling subscriptions to events which can be emitted by the SDK. The user will utilize either
 :cpp:func:`sdk::add_event_handler <dolbyio::comms::sdk::add_event_handler>` or :cpp:func:`conference::add_event_handler <dolbyio::comms::services::conference::add_event_handler>` to subscribe to an events.

diff --git a/docs/_sources/api/sdk/common/exception.rst.txt b/docs/_sources/api/sdk/common/exception.rst.txt
@@ -2,7 +2,7 @@
 
 SDK Exceptions
 ==============
-#include <comms/exception.h>
+#include <dolbyio/comms/exception.h>
 
 Exception's which can be thrown by the SDK and caught by user. These have been left defined
 

diff --git a/docs/_sources/api/sdk/common/log_level.rst.txt b/docs/_sources/api/sdk/common/log_level.rst.txt
@@ -2,7 +2,7 @@
 
 Logging
 =========
-#include <comms/log_level.h>
+#include <dolbyio/comms/log_level.h>
 
 Enum describing the log levels of the SDK.
 

diff --git a/docs/_sources/api/sdk/conference.rst.txt b/docs/_sources/api/sdk/conference.rst.txt
@@ -2,41 +2,36 @@
 
 Conference Service
 ==================
-During a conference, the SDK receives:
+.. note::
+  Features, such as recording and injecting media are only available for server applications.
+
+The Conference Service allows the application to manage the conference life-cycle and interact with the conference. During a conference, the SDK may receive:
 
  - A single audio stream that contains mixed audio of all un-muted participants
  - Video streams from all participants who joined the conference with their cameras enabled
- - One screen share stream, if any participant shares a screen
+ - One screen-share stream
 
 The basic usage of the Conference Service is as follows:
   1) Log in to :ref:`sess_serv`.
   2) Create the media recording module instance. If you want to use the Default Recorder, use the :ref:`recorder` API, specifically the
      :cpp:func:`recorder::create <dolbyio::comms::plugin::recorder::create>` method.
-
-      - **Please note that Recorder is only applicable for Server SDK applications.**
-
   3) Provide the output directory location for the recorder module.
-  4) Set the media recording module as the Media Sink for the Conference Service, this allows passing the service a pointer to the created recorder instance. After this step, the recorder module should be set with the :cpp:func:`conference::set_media_sink <dolbyio::comms::services::conference::set_media_sink>`.
+  4) Set the media recording module as the Media Sink for the Conference Service. This allows passing the service a pointer to the created recorder instance. After this step, the recorder module should be set with the :cpp:func:`conference::set_media_sink <dolbyio::comms::services::conference::set_media_sink>`.
   5) Create the Media Injector Module instance using the Default Injector provided through the :ref:`default_injector` API. Specifically the :cpp:class:`injetor_paced <dolbyio::comms::plugin::injector_paced>` or the :cpp:class:`injetor_passthrough <dolbyio::comms::plugin::injector_passthrough>` constructors.
   6) Create a Media Injection Source that adds the ability to provide raw frames to the Media Injector Module. This can be an application which reads from a file, gets remote stream, and provides the media frames to the injector. This Media Injection Source should be passed as a reference to the Media Injector Module on creation.
   7) Set the Injector Module instance as the Media Source for the Conference Service via the :cpp:func:`conference::set_media_source <dolbyio::comms::services::conference::set_media_source>` method.
-
-      - **Please note the Injector is only applicable for Server SDK applications.**
-
   8) Subscribe to any of the available :ref:`conf_events` using the :cpp:func:`conference::add_event_handler <dolbyio::comms::services::conference::add_event_handler>` method.
   9) Create a conference using a conference alias :cpp:func:`conference::create <dolbyio::comms::services::conference::create>`. You can omit this step if you want to join an existing conference.
-  10) Join a conference using the :cpp:func:`conference::join <dolbyio::comms::services::conference::join>` or :cpp:func:`conference::listen <dolbyio::comms::services::conference::listen>` method. This method should return the conference_info struct (see :ref:`conf_models`) describing the conference. In the case of failure, you will receive an exception returned in the async_result.
-
-      - By default, Dolby Voice Conference Server audio processing is disabled.
-      - You can enable the processing by setting audio_processing flag to true in :cpp:struct:`dolbyio::comms::services::conference::media_constraints`.
-
+  10) Join a conference using the :cpp:func:`conference::join <dolbyio::comms::services::conference::join>` or :cpp:func:`conference::listen <dolbyio::comms::services::conference::listen>` method. This method returns the conference_info structure (see :ref:`conf_models`) describing the conference. In the case of failure, you will receive an exception returned in the async_result.
   11) To leave the conference, call the :cpp:func:`conference::leave <dolbyio::comms::services::conference::leave>` method.
+
+By default, Dolby Voice Conference Server audio processing is disabled. You can enable the processing by setting the audio_processing flag to true in :cpp:struct:`dolbyio::comms::services::conference::media_constraints`.
 
 .. _conf_serv:
 
 Conference Interface
 --------------------------
-#include <comms/conference.h>
+#include <dolbyio/comms/conference.h>
 
 The interface for the :ref:`api_conference`. Methods of this interface provide the ability to create, join, and leave conferences and subscribe to
 events. The conference service methods are all asynchronous in nature, refer to :ref:`api_async_result` for more information. Structures which are part of the
@@ -46,7 +41,7 @@ interface can be passed to and returned by the service.
 
 Spatial Audio
 -------------
-#include <comms/spatial_audio_types.h>
+#include <dolbyio/comms/spatial_audio_types.h>
 
 The spatial audio methods that allow placing conference participants spatially in a 3D rendered audio scene and hear the audio from the participants rendered at the given locations.
 
@@ -60,6 +55,8 @@ The spatial audio methods that allow placing conference participants spatially i
 
 .. doxygenclass:: dolbyio::comms::spatial_audio_batch_update
 
+.. doxygenenum:: dolbyio::comms::spatial_audio_style
+
 .. _conf_events:
 
 Conference Events

diff --git a/docs/_sources/api/sdk/device_management.rst.txt b/docs/_sources/api/sdk/device_management.rst.txt
@@ -17,7 +17,7 @@ Once the SDK is instantiated, applications have access to the device management
 
 Device Management Interface
 ----------------------------
-#include <comms/device_management.h>
+#include <dolbyio/comms/device_management.h>
 
 .. doxygenclass:: dolbyio::comms::services::device_management
 

diff --git a/docs/_sources/api/sdk/injector.rst.txt b/docs/_sources/api/sdk/injector.rst.txt
@@ -96,8 +96,8 @@ The Media File Source sample is able to decode the following video and audio cod
 The library is included along with proper CMake file in the package under **share/dolbyio/comms/sample/media_source/** directory. A sample of the top-level object
 of the Media Source File library is in the following files:
 
-.. literalinclude:: ../../../src/public/comms/sample/media_source/file/source_capture.h
+.. literalinclude:: ../../../src/public/dolbyio/comms/sample/media_source/file/source_capture.h
   :language: c++
 
-.. literalinclude:: ../../../src/public/comms/sample/media_source/file/source_capture.cc
+.. literalinclude:: ../../../src/public/dolbyio/comms/sample/media_source/file/source_capture.cc
   :language: c++
diff --git a/docs/_sources/api/sdk/recorder.rst.txt b/docs/_sources/api/sdk/recorder.rst.txt
@@ -65,7 +65,7 @@ WebRTC may change the format in which RAW audio is presented to the audio track
 
 Default Recorder Interface
 --------------------------
-#include <comms/multimedia_streaming/recorder.h>
+#include <dolbyio/comms/multimedia_streaming/recorder.h>
 
 The Recorder interface is used for configuring the default recorder. The methods in the recorder interface are used to create and configure the recording module. This
 creates and configures the recording module that is provided as a part of the C++ SDK. The enums of the interface are used for setting the Video/Audio storage formats of the media. If you want to build your own recorder module, do not use this API.

diff --git a/docs/_sources/api/sdk/sdk.rst.txt b/docs/_sources/api/sdk/sdk.rst.txt
@@ -2,7 +2,7 @@
 
 Sdk Interface
 =============
-#include <comms/sdk.h>
+#include <dolbyio/comms/sdk.h>
 
 This interface is the starting point for the SDK. It exposes methods that allow initializing the SDK and accessing the underlying services. The basic steps to use the SDK are:
   1) Acquire the necessary Access Token from the application server. This is a mandatory step that allows using the SDK.

diff --git a/docs/_sources/api/sdk/session.rst.txt b/docs/_sources/api/sdk/session.rst.txt
@@ -2,8 +2,9 @@
 
 Session Service
 ===============
-The Session Service provides the ability to log in and out of the Dolby.io backend. Logging in to the backend is necessary to use any of the conferencing features
-provided by the SDK.
+The Session Service allows logging in and out of the Dolby.io backend. Logging into the backend is essential for the SDK to receive backend
+notifications in and out of a conference; the Session Service provides APIs for the application to manage subscriptions to various types
+of the backend notifications.
 
 The basic usage of the session service is:
   1) Log in to the session using the :cpp:func:`session::open <dolbyio::comms::services::session::open>` command.
@@ -14,7 +15,7 @@ The basic usage of the session service is:
 
 Session Interface
 -----------------
-#include <comms/session.h>
+#include <dolbyio/comms/session.h>
 
 The methods of the Session Interface provide the ability to connect to the Dolby.io
 backend. The session service methods are all asynchronous in nature. For more information, refer to :ref:`api_async_result`. The structures defined in the interface

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -1,8 +1,6 @@
 C++ SDK |release| Documentation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-This is the HTML documentation of the C++ SDK.
-
 Overview
 """"""""
 The Dolby.io Communications C++ SDK provides both Client and Server applications the ability to create HD voice and video for fully immersive real-time communications and streaming experiences. The C++SDK allows creating an application that can join Dolby.io conferences.