dapi

The JavaScript library for Dolby Voice Hub APIs.

The app must first load dapi.js from the hub's localhost and then initialize it using dapi.init. After successful initialization, the dapi APIs are globally available as window.dapi or dapi.

Example:

<script src="//localhost/js/dapi.js"></script>
<script type="text/javascript">
 dapi.init(function (ok) {
    if(ok) {
        output("SUCCESS initialized dapi");
        // OK to use configuration APIs, now.
    } else {
        output("FAILED to initialize dapi");
    }
});
</script>

Member Summary

Public Members

The app heartbeat APIs - allows to customize heartbeat mechanism

The AppLink APIs - Creates a communication channel between the Dolby Voice Hub and Dolby Conference Phone apps.

Configuration APIs.

The Device APIs - Provides access to device-specific APIs, such as APIs for the Dolby Conference Phone.

The Displays APIs - Provides display information to the app

The PeripheralModeAudio APIs - Provides monitoring methods for the audio connection between a Dolby Conference Phone and Dolby Voice Hub.

The Telephony APIs - Provides access to IP PBX telephony information for monitoring purposes.

Method Summary

Public Methods

init(callback: function(ok: boolean))

Initializes the dapi library.

Public Members

public appHeartBeat: AppHeartBeat source

The app heartbeat APIs - allows to customize heartbeat mechanism

public appLinkSession: AppLinkSession source

The AppLink APIs - Creates a communication channel between the Dolby Voice Hub and Dolby Conference Phone apps.

public configuration: Configuration source

Configuration APIs.

public device: Device source

The Device APIs - Provides access to device-specific APIs, such as APIs for the Dolby Conference Phone.

public displays: Displays source

The Displays APIs - Provides display information to the app

public peripheralModeAudio: PeripheralModeAudio source

The PeripheralModeAudio APIs - Provides monitoring methods for the audio connection between a Dolby Conference Phone and Dolby Voice Hub.

public telephony: Telephony source

The Telephony APIs - Provides access to IP PBX telephony information for monitoring purposes.

Public Methods

public init(callback: function(ok: boolean)) source

Initializes the dapi library.

This is an asynchronous operation.

Params:

NameTypeAttributeDescription
callback function(ok: boolean)

The callback function

Example:

//BEGIN SETUP
dapi.init(function (ok) {
    if(ok) {
        output("SUCCESS initialized dapi");
        // OK to use configuration APIs, now.
    } else {
        output("FAILED to initialize dapi");
    }
});
//END SETUP