Device

This object serves as a collection of APIs for accessing peripheral devices such as the Dolby Conference Phone.

Example:

dapi.device.phone.reboot();

Member Summary

Public Members

Flag that indicates whether the system idling mode has been disabled.

Returns the status of the most recent request to upload logs.

Provides access to a DevicePhone object which holds APIs related to a paired Dolby Conference Phone.

Flag that indicates whether the system sleep mode has been disabled.

Flag that indicates whether the system wake event has been disabled and cannot automatically exit sleep mode.

Method Summary

Public Methods

Allows being notified of when the status of the most recent logs-upload request has changed.

Instructs the system to make itself the active input to the TV.

Sets the system name that should appear as the input to the TV.

sleep()

Instructs the system to turn off the TV.

uploadLogs(url: string, type: string)

Starts uploading the device's logs.

wake()

Instructs the system to exit sleep mode (i.e., wake) and turn on the TV.

Public Members

public idleTimeoutDisabled: boolean source

Flag that indicates whether the system idling mode has been disabled. The system enters idle state when there is no user interaction such as:

  • on a call or conference
  • setting up system
  • receiving a call

When the system has been in idle mode for the user-preferred timeout, then the system will enter its sleep mode.

Possible values are:

  • true: The system will never get into idle state.
  • false: The system will get into idle state when all the conditions are met

public lastLogsUploadStatus: string source

Returns the status of the most recent request to upload logs.

Possible values are:

  • "IN_PROGRESS": Waiting for the logs-upload to finish.
  • "SUCCESS": The request finished successfully.
  • "FAILED": The request failed to complete.

public phone: Phone source

Provides access to a DevicePhone object which holds APIs related to a paired Dolby Conference Phone.

public systemSleepDisabled: boolean source

Flag that indicates whether the system sleep mode has been disabled.

Possible values are:

  • true: The system will never automatically go into sleep mode. The app is responsible for placing the system in sleep mode.
  • false: The system will automatically go into sleep mode after the timeout has expired. There are two different timeouts; one for regular working hours and one for after hours.

public systemWakeDisabled: boolean source

Flag that indicates whether the system wake event has been disabled and cannot automatically exit sleep mode.

Possible values are:

  • true: The system will never automatically wake. The app is responsible for waking the system from sleep mode.
  • false: The system will wake when the conditions for idling are no longer met.

Public Methods

public lastLogsUploadStatusChanged(newStatus: string) source

Allows being notified of when the status of the most recent logs-upload request has changed.

Params:

NameTypeAttributeDescription
newStatus string

the new state of the logs-upload request.

  • "IN_PROGRESS": Waiting for the logs-upload to finish.
  • "SUCCESS": The request finished successfully.
  • "FAILED": The request failed to complete.

Example:

dapi.device.lastLogsUploadStatusChanged.connect(myLogsStatusHandlerFunction);

public setActiveDisplayInput() source

Instructs the system to make itself the active input to the TV.

The connected TV/monitor needs to support CEC (Consumer Electronics Control) functionality.

public setOsdName(name: string) source

Sets the system name that should appear as the input to the TV.

Params:

NameTypeAttributeDescription
name string

The name that should appear on the OSD (On Screen Display) when referring to the Dolby Voice Room system.

The connected TV/monitor needs to support CEC (Consumer Electronics Control) functionality.

public sleep() source

Instructs the system to turn off the TV.

The connected TV/monitor needs to support CEC (Consumer Electronics Control) functionality.

public uploadLogs(url: string, type: string) source

Starts uploading the device's logs.

Params:

NameTypeAttributeDescription
url string

target address where the logs will be uploaded to

type string

specifies the kind of logs to upload:

  • "FULL": Upload maximum log information.
  • "EVENTS_ONLY": Only upload text log events.
  • "CALL_STATS": Upload call statistics.

Example:

dapi.device.uploadLogs("http://mywebserver.net/myupload", "FULL");

public wake() source

Instructs the system to exit sleep mode (i.e., wake) and turn on the TV.

The connected TV/monitor needs to support CEC (Consumer Electronics Control) functionality.