diff --git a/docs/.buildinfo b/docs/.buildinfo index f6e21d7..7ccd7a8 100644 --- 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: 6b39eac240195e2f0a8a922cc03c0422 +config: cad02adcc14fa981e2655987c418d4fa tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/.doctrees/api/media_io.doctree b/docs/.doctrees/api/media_io.doctree index be584b2..b063c32 100644 Binary files a/docs/.doctrees/api/media_io.doctree and b/docs/.doctrees/api/media_io.doctree differ diff --git a/docs/.doctrees/api/sdk/conference.doctree b/docs/.doctrees/api/sdk/conference.doctree index 2313eb7..e1cf08d 100644 Binary files a/docs/.doctrees/api/sdk/conference.doctree and b/docs/.doctrees/api/sdk/conference.doctree differ diff --git a/docs/.doctrees/api/sdk/sdk.doctree b/docs/.doctrees/api/sdk/sdk.doctree index 0e1d632..dc2e35c 100644 Binary files a/docs/.doctrees/api/sdk/sdk.doctree and b/docs/.doctrees/api/sdk/sdk.doctree differ diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle index e7bf887..016b59f 100644 Binary files a/docs/.doctrees/environment.pickle and b/docs/.doctrees/environment.pickle differ diff --git a/docs/.doctrees/index.doctree b/docs/.doctrees/index.doctree index 06c5925..e6a48ad 100644 Binary files a/docs/.doctrees/index.doctree and b/docs/.doctrees/index.doctree differ diff --git a/docs/.doctrees/other/supported_platforms.doctree b/docs/.doctrees/other/supported_platforms.doctree index 692afb1..64cc1d8 100644 Binary files a/docs/.doctrees/other/supported_platforms.doctree and b/docs/.doctrees/other/supported_platforms.doctree differ diff --git a/docs/_sources/other/supported_platforms.rst.txt b/docs/_sources/other/supported_platforms.rst.txt index d40fd84..c225b16 100644 --- a/docs/_sources/other/supported_platforms.rst.txt +++ b/docs/_sources/other/supported_platforms.rst.txt @@ -8,7 +8,10 @@ The C++ SDK is compatible with the following operating systems: * Ubuntu 20.04+ * x86_64 * gcc9/gnustl, clang10/libc++ -* MacOS 10.14+ +* Debian 11 (Beta) + * arm64 + * gcc9/gnustl +* MacOS 10.15+ * x86_64, arm64 * Windows 10+ * x86_64 diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js index 05617ed..f35a7ed 100644 --- a/docs/_static/documentation_options.js +++ b/docs/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '2.5.5', + VERSION: '2.6.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/api/coresdk.html b/docs/api/coresdk.html index 92141fe..eecb58e 100644 --- a/docs/api/coresdk.html +++ b/docs/api/coresdk.html @@ -4,7 +4,7 @@ - Core API — C++ SDK 2.5.5 documentation + Core API — C++ SDK 2.6.0 documentation diff --git a/docs/api/injection/audio.html b/docs/api/injection/audio.html index a9163e5..6d01f71 100644 --- a/docs/api/injection/audio.html +++ b/docs/api/injection/audio.html @@ -4,7 +4,7 @@ - Audio — C++ SDK 2.5.5 documentation + Audio — C++ SDK 2.6.0 documentation diff --git a/docs/api/injection/example.html b/docs/api/injection/example.html index 720df2c..6fea2b0 100644 --- a/docs/api/injection/example.html +++ b/docs/api/injection/example.html @@ -4,7 +4,7 @@ - Example Injector Implementation — C++ SDK 2.5.5 documentation + Example Injector Implementation — C++ SDK 2.6.0 documentation diff --git a/docs/api/injection/video.html b/docs/api/injection/video.html index e67c4e8..1068a03 100644 --- a/docs/api/injection/video.html +++ b/docs/api/injection/video.html @@ -4,7 +4,7 @@ - Video — C++ SDK 2.5.5 documentation + Video — C++ SDK 2.6.0 documentation diff --git a/docs/api/media_io.html b/docs/api/media_io.html index fe995d9..3a236af 100644 --- a/docs/api/media_io.html +++ b/docs/api/media_io.html @@ -4,7 +4,7 @@ - Media IO API — C++ SDK 2.5.5 documentation + Media IO API — C++ SDK 2.6.0 documentation @@ -181,6 +181,11 @@ +
+
+virtual async_result<void> set_mixed_audio_sink(mixed_audio_sink *sink) = 0
+
+
virtual async_result<void> set_audio_source(audio_source *source) = 0
diff --git a/docs/api/plugins.html b/docs/api/plugins.html index e95f9d6..7e72923 100644 --- a/docs/api/plugins.html +++ b/docs/api/plugins.html @@ -4,7 +4,7 @@ - Plugins — C++ SDK 2.5.5 documentation + Plugins — C++ SDK 2.6.0 documentation diff --git a/docs/api/recording/audio.html b/docs/api/recording/audio.html index fb51578..e368cf0 100644 --- a/docs/api/recording/audio.html +++ b/docs/api/recording/audio.html @@ -4,7 +4,7 @@ - Audio — C++ SDK 2.5.5 documentation + Audio — C++ SDK 2.6.0 documentation diff --git a/docs/api/recording/encoded_video.html b/docs/api/recording/encoded_video.html index 4692321..d6e55d5 100644 --- a/docs/api/recording/encoded_video.html +++ b/docs/api/recording/encoded_video.html @@ -4,7 +4,7 @@ - Encoded Video — C++ SDK 2.5.5 documentation + Encoded Video — C++ SDK 2.6.0 documentation diff --git a/docs/api/recording/events.html b/docs/api/recording/events.html index 36132ef..a8379bd 100644 --- a/docs/api/recording/events.html +++ b/docs/api/recording/events.html @@ -4,7 +4,7 @@ - Media Recording Events — C++ SDK 2.5.5 documentation + Media Recording Events — C++ SDK 2.6.0 documentation diff --git a/docs/api/recording/example.html b/docs/api/recording/example.html index 16e48d6..781f9ce 100644 --- a/docs/api/recording/example.html +++ b/docs/api/recording/example.html @@ -4,7 +4,7 @@ - Example Recorder Implementation — C++ SDK 2.5.5 documentation + Example Recorder Implementation — C++ SDK 2.6.0 documentation diff --git a/docs/api/recording/raw_video.html b/docs/api/recording/raw_video.html index 8be92d5..e3025a0 100644 --- a/docs/api/recording/raw_video.html +++ b/docs/api/recording/raw_video.html @@ -4,7 +4,7 @@ - Raw Video — C++ SDK 2.5.5 documentation + Raw Video — C++ SDK 2.6.0 documentation diff --git a/docs/api/sdk/audio.html b/docs/api/sdk/audio.html index b87ec1c..eb81bcf 100644 --- a/docs/api/sdk/audio.html +++ b/docs/api/sdk/audio.html @@ -4,7 +4,7 @@ - Audio Service — C++ SDK 2.5.5 documentation + Audio Service — C++ SDK 2.6.0 documentation diff --git a/docs/api/sdk/common/async_ops.html b/docs/api/sdk/common/async_ops.html index 24d0694..822f839 100644 --- a/docs/api/sdk/common/async_ops.html +++ b/docs/api/sdk/common/async_ops.html @@ -4,7 +4,7 @@ - Asynchronous Operations — C++ SDK 2.5.5 documentation + Asynchronous Operations — C++ SDK 2.6.0 documentation diff --git a/docs/api/sdk/common/custom_allocator.html b/docs/api/sdk/common/custom_allocator.html index 34fe3d0..0bd6eda 100644 --- a/docs/api/sdk/common/custom_allocator.html +++ b/docs/api/sdk/common/custom_allocator.html @@ -4,7 +4,7 @@ - Overriding new/delete operators — C++ SDK 2.5.5 documentation + Overriding new/delete operators — C++ SDK 2.6.0 documentation diff --git a/docs/api/sdk/common/event_handling.html b/docs/api/sdk/common/event_handling.html index bb944ad..7aa6103 100644 --- a/docs/api/sdk/common/event_handling.html +++ b/docs/api/sdk/common/event_handling.html @@ -4,7 +4,7 @@ - Event Handling Interface — C++ SDK 2.5.5 documentation + Event Handling Interface — C++ SDK 2.6.0 documentation diff --git a/docs/api/sdk/common/exception.html b/docs/api/sdk/common/exception.html index 3735132..477313d 100644 --- a/docs/api/sdk/common/exception.html +++ b/docs/api/sdk/common/exception.html @@ -4,7 +4,7 @@ - SDK Exceptions — C++ SDK 2.5.5 documentation + SDK Exceptions — C++ SDK 2.6.0 documentation diff --git a/docs/api/sdk/common/log_level.html b/docs/api/sdk/common/log_level.html index 49ed26f..87cb6a3 100644 --- a/docs/api/sdk/common/log_level.html +++ b/docs/api/sdk/common/log_level.html @@ -4,7 +4,7 @@ - Logging — C++ SDK 2.5.5 documentation + Logging — C++ SDK 2.6.0 documentation diff --git a/docs/api/sdk/conference.html b/docs/api/sdk/conference.html index 0b93897..7db7bac 100644 --- a/docs/api/sdk/conference.html +++ b/docs/api/sdk/conference.html @@ -4,7 +4,7 @@ - Conference Service — C++ SDK 2.5.5 documentation + Conference Service — C++ SDK 2.6.0 documentation @@ -169,6 +169,35 @@
+
+
+virtual async_result<conference_info> replay(const std::string &conference_id) = 0
+

Creates a replay conference and joins to it upon completion.

+

// Wait for the conference creation
+auto conf_info = wait(sdk->conference().replay(some_conf_id));
+
+ // Invoking the method directly requires chaining successive operations
+ // via the `then` call
+sdk->conference().replay(some_conf_id))
+   .then[](auto&& info) {
+     // Do something with the returned conf info;
+   })
+   .on_error([](auto&& e) {
+     // Handle exception
+   });
+
+
+

+
+
Parameters:
+

conference_id – The ID of the conference to replay.

+
+
Returns:
+

The result object producing the conference_info asynchronously.

+
+
+
+
virtual async_result<conference_info> create(const conference_options &options) = 0
diff --git a/docs/api/sdk/device_management.html b/docs/api/sdk/device_management.html index fbe34a2..66e499b 100644 --- a/docs/api/sdk/device_management.html +++ b/docs/api/sdk/device_management.html @@ -4,7 +4,7 @@ - Device Management Service — C++ SDK 2.5.5 documentation + Device Management Service — C++ SDK 2.6.0 documentation diff --git a/docs/api/sdk/injector.html b/docs/api/sdk/injector.html index 7e292fe..e54efb8 100644 --- a/docs/api/sdk/injector.html +++ b/docs/api/sdk/injector.html @@ -4,7 +4,7 @@ - Default Media Injector — C++ SDK 2.5.5 documentation + Default Media Injector — C++ SDK 2.6.0 documentation diff --git a/docs/api/sdk/processor.html b/docs/api/sdk/processor.html index f3ab435..4f1be2e 100644 --- a/docs/api/sdk/processor.html +++ b/docs/api/sdk/processor.html @@ -4,7 +4,7 @@ - Video Processor Library — C++ SDK 2.5.5 documentation + Video Processor Library — C++ SDK 2.6.0 documentation diff --git a/docs/api/sdk/recorder.html b/docs/api/sdk/recorder.html index d616136..f784384 100644 --- a/docs/api/sdk/recorder.html +++ b/docs/api/sdk/recorder.html @@ -4,7 +4,7 @@ - Default Media Recorder — C++ SDK 2.5.5 documentation + Default Media Recorder — C++ SDK 2.6.0 documentation diff --git a/docs/api/sdk/sdk.html b/docs/api/sdk/sdk.html index b9cb576..13ed360 100644 --- a/docs/api/sdk/sdk.html +++ b/docs/api/sdk/sdk.html @@ -4,7 +4,7 @@ - Sdk Interface — C++ SDK 2.5.5 documentation + Sdk Interface — C++ SDK 2.6.0 documentation @@ -210,6 +210,11 @@
+
+
+virtual services::experimental &experimental() = 0
+
+
virtual async_result<component_data> register_component_version(const std::string &name, const std::string &version) = 0
@@ -339,11 +344,7 @@ dolbyio::comms::sdk::set_log_settings(log_settings); -
-
Attention

Calling more than once has no effect.

-
-
-

+

Parameters:

settings – Structure of type log_settings.

@@ -351,9 +352,13 @@
Throws:

dolbyio::comms::exception – Thrown when:

  • provided invalid log directory

    • +

  • attempting to set log settings more than once

+
Returns:
+

true if logging settings were set, false otherwise

+
@@ -394,6 +399,12 @@ +
+
+static std::string get_sdk_version()
+

Version of the SDK.

+
+
@@ -440,10 +451,16 @@

Directory to which SDK logs should be saved. The application must have write access to the directory or it must be able to create such a directory. Providing a valid directory implies starting logging to a timestamped file. Providing no value or an empty string has no effect. Default is an empty string.

+
+
+std::shared_ptr<logger_sink_callback> log_callback = {}
+

Log callback function. The callback object will not be destroyed until the application shutdown (SDK dynamic library unload). If set, the logs will be additionally passed to the callback.

+
+
bool suppress_stdout_logs = {false}
-

Suppress the logs to stdout. This parameter will only be taken into account if the log directory is set. In which case logs will only be passed to the file in directory and nothing on stdout.

+

Suppress the logs to stdout. This parameter will only be taken into account if the log directory or the log callback is set. If true, logs will not be output on the stdout.

diff --git a/docs/api/sdk/session.html b/docs/api/sdk/session.html index 686192d..a5605f3 100644 --- a/docs/api/sdk/session.html +++ b/docs/api/sdk/session.html @@ -4,7 +4,7 @@ - Session Service — C++ SDK 2.5.5 documentation + Session Service — C++ SDK 2.6.0 documentation diff --git a/docs/api/sdk/video.html b/docs/api/sdk/video.html index 5e2cd84..25f8df3 100644 --- a/docs/api/sdk/video.html +++ b/docs/api/sdk/video.html @@ -4,7 +4,7 @@ - Video Service — C++ SDK 2.5.5 documentation + Video Service — C++ SDK 2.6.0 documentation diff --git a/docs/genindex.html b/docs/genindex.html index 03d845e..51b458c 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -3,7 +3,7 @@ - Index — C++ SDK 2.5.5 documentation + Index — C++ SDK 2.6.0 documentation @@ -883,12 +883,12 @@

D

  • dolbyio::comms::remote_participant_updated::remote_participant_updated (C++ function), [1], [2]
    • - - +