Controlling system layers from your website

Technical reference

Technical guide for website developers

Connect your own buttons to the system’s navigation functions. Start with the shared calling conventions, then follow the individual functions and code examples.

The player provides these functions to a website opened in the website application. Check that a function is available before calling it, as shown in the examples below.

Available navigation functions

onUp

Requests a return through the system’s navigation. The destination depends on the web application mode and the available navigation path. This is not a return to the previous URL in the browser history and is not equivalent to window.history.back(). If returning is unavailable, the function reports the error shown below.

if (typeof window.onUp !== 'function') {
    console.warn("The player navigation function is unavailable.");
} else {
    window.onUp({
        request: '{}',
        onSuccess: function () {
            console.log("The navigation request was accepted.");
        },
        onFailure: function (error_code, error_message) {
            console.warn(error_code, error_message);
        }
    });
}

Error: error_code -1, Disabled bottom layer. Single-app kiosk.

showLayerBottom

Requests the application layer’s application menu. This requires more than one currently available item in the application list, taking their scheduled validity into account. If only one item or no items are available, the function reports the error shown below.

if (typeof window.showLayerBottom !== 'function') {
    console.warn("The player navigation function is unavailable.");
} else {
    window.showLayerBottom({
        request: '{}',
        onSuccess: function () {
            console.log("The navigation request was accepted.");
        },
        onFailure: function (error_code, error_message) {
            console.warn(error_code, error_message);
        }
    });
}

Error: error_code -1, Single-app kiosk.

showLayerTop

Requests the presentation layer. This layer must be enabled in the device configuration; otherwise, the function reports the error shown below. Acceptance of the request does not confirm that a particular campaign has played or that its content is available.

if (typeof window.showLayerTop !== 'function') {
    console.warn("The player navigation function is unavailable.");
} else {
    window.showLayerTop({
        request: '{}',
        onSuccess: function () {
            console.log("The navigation request was accepted.");
        },
        onFailure: function (error_code, error_message) {
            console.warn(error_code, error_message);
        }
    });
}

Error: error_code -1, Top layer disabled.