5.1.1. Release notes for v0.16

Bug fix: Remote recording samples recording state improvements

The sample code was tracking its own version of recording state, but the correct approach is to simply obtain the current recording state from the session, which is updated when changed by any session participant.

Remote recording sample update: requires audio feed

Proximie media server sessions expect an audio feed to be present when using the recording feature.

The remote recording sample has been updated to create “no-op” audio feed to demonstrate how an application that does not need audio input or output can meet this requirement. It uses special audio components AudioInputComponentSilence (for a silent input) and AudioOutputComponentNull (for a null output). See the recording demo sample for more details.

Note, this requirement will be removed in a forthcoming SDK release.

Bug fix: SDK destruction improvements

During static destruction, a logger could be destructed before other elements try to use it, resulting in an error. PXLOG() now checks for logger existence before trying to use it.

PXASSERT macros now log more useful information

PXASSERT(), PXASSERT_MSG() and PXASSERT_SUCCESS() macros now log error codes and error messages based on error codes where possible.

Docker images now pin some build dependency versions

To ensure consistent builds, some build dependencies in the SDK Docker images are now pinned to specific versions. The pinned versions are as follows:

• gcovr: 8.6

• breathe: 4.36.0

• sphinx-rtd-theme: 3.1.0

This change helps to avoid potential issues arising from updates to these tools that could affect the build process.

Bug fix: SDK feeds were incorrectly sorted in Live App

Newly added feeds are expected to appear after existing feeds.

Fix: Incorrect ‘outcome’ of session connect/disconnect

Fixes an incorrect outcome results being reported from connectToSession() and disconnectFromSession().

Previously, the outcome would indicate failure, but when the error value was checked, it would indicate success:

auto disconnected = mediaSession->disconnectFromSession().get();
if (!disconnected) {
    // Previously: the outcome always indicated failure...
    auto error = disconnected.error();
    if (!error) {
        // Disconnection was actually successful!?
    }
}

Now, the outcome will only indicate a failure when an actual error has occurred.

auto disconnected = mediaSession->disconnectFromSession().get();
if (!disconnected) {
    // Now: The outcome error will never indicate success when outcome indicated failure
    auto error = disconnected.error();
    assert(error); // error will never indicate success now
}

Outgoing media server feed creation functions now communicate with servers

The following functions:

• Proximie::PxMedia::MediaServerOutgoingVideoFeed::create

• Proximie::PxMedia::MediaServerTwoWayAudioFeed::create

now conduct blocking round trip communication with Proximie servers. Asynchronous versions of these functions have been added which return FutureOutcome instead of NotNullOutcome.

• Proximie::PxMedia::MediaServerOutgoingVideoFeed::createAsync

• Proximie::PxMedia::MediaServerTwoWayAudioFeed::createAsync

Sample authentication improvements

Access tokens required to access Proximie services expire after a set period; the sample authentication code didn’t fully demonstrate this but has been updated with a checkRefresh function that checks if the current token is soon to expire, and refreshes it if necessary.

The “auth” sample itself demonstrates token refresh using the refresh token acquired when initially authenticating.

The “complete” sample also demonstrates this by polling the auth helper in it’s sleep loop. Note that this is only for demonstration purposes, and applications will probably want to use a timer mechanism rather than polling.

Since all the samples use the same command line options for authentication, we have refactored the sample code so the authentication helper parses the command line options itself.

Updated CMake installer script

The CMake installer script, samples/environment/scripts/installers/cmake_ppa.sh, has been updated to include the previously-erroneously-missing installation of the Kitware keyring package. This ensures that the Kitware apt repository continues to work when the repository key is updated. The script has also been extended with a -u option to uninstall the Kitware repository and keyring, for convenience. Docker images have been rebuilt to include the Kitware keyring package.