Display Methods

dispatchAppSourcesTerminate

Stop an app source, such as Netflix.

Parameter

Type Definitions

`DispatchAppSourcesTerminateParams`

Property	Type	Required	Description
`args`	`DispatchAppSourcesTerminateArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`DispatchAppSourcesTerminateArgs`

Property	Type	Required	Description
`contextId`	`string`	✓
`sourceId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: id, source, canReportSource, input, canReportInput, outputs.

An active context of the device. For example, with picture-in-picture mode, there would be a minimum of 2 active contexts. I.e. a representation of currently used input(s), output(s), app(s), etc… on the device.

Property	Type	Description
`canReportInput`	`boolean`	Indicates whether the device is capable of reporting the currently active input. When true, the input field will be populated with the active input–if there is an active input; when false, the input field should always be null and will be ignored.
`canReportSource`	`boolean`	Indicates whether the device is capable of reporting the currently active application/source. When true, the source field will be populated with the active application/source–if there is an active application; when false, the source field should always be null and will be ignored.
`id`	`string`	The unique identifier for this context.
`input`	`Input \| null`	The physical input that is currently active on the device. This may be null if there is no active input, or if the device does not report this information.
`outputs`	`Output[] \| null`	The output(s) that are currently active on the device. This may be null or empty if there are no active outputs, or if the device does not report this information.
`source`	`AppSource \| null`	The application/source that is currently active on the device. This does not include physical inputs, which are represented separately by the input field. If there is no active application/source, or the device does not report this information, this field may be null.

`Input`

Input represents a physical input on the device, such as an HDMI port, a tuner, etc…

Property	Type	Description
`arcMode`	`KeyValuePair \| null`	The active ARC mode for this input. This field is only populated if the display supports reporting the current ARC mode on a per-input basis. See the inputs object’s arcMode field for more information.
`arcModes`	`KeyValuePair[] \| null`	A list of ARC modes supported by this input. This field is only populated if the display supports reporting ARC modes on a per-input basis. See the inputs object’s arcModes field for more information.
`canActivate`	`boolean`	Communicates whether this input can be selected as the active input. This value reflects the current state of the input, not the overall capability of the device or integration. For example, an HDMI input with no cable connected may have canActivate = false, even though the device supports activating that input.
`cecMode`	`KeyValuePair \| null`	The active CEC mode for this input. This field is only populated if the display supports reporting the current CEC mode on a per-input basis. See the inputs object’s cecMode field for more information.
`cecModes`	`KeyValuePair[] \| null`	A list of CEC modes supported by this input. This field is only populated if the display supports reporting CEC modes on a per-input basis. See the inputs object’s cecModes field for more information.
`connectionPresent`	`ConnectionPresentEnum \| null`	Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:
`connectionType`	`KeyValuePair`
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this input supports. For example: “COMPONENT vs or COMPOSITE” or “HDMI with Optical Audio”. In many cases, this field is not applicable. In which case it may be null or empty. A non-empty list implies that the integration supports setting the input’s connection type.
`friendlyName`	`string`	A user-friendly name for this input. This value provides a consistent identifier for the input, regardless of the device’s internal naming. For example: “HDMI1”.
`id`	`string`	The unique identifier for this input. This is used when setting the active input.
`label`	`Label \| null`	The input’s label, as stored on the device itself. E.g. “Playstation”, “Blu-ray”, “Cable Box”, etc… This is typically user-configurable on the device, and may be null if the device does not have a label for this input.
`signalPresent`	`SignalPresentEnum \| null`	Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`ConnectionPresentEnum`

Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Label`

Property	Type	Required	Description
`canSet`	`boolean`
`label`	`string`

`SignalPresentEnum`

Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Output`

Represents an individual physical output on the device, such as TV speakers, an ARC-connected soundbar, a headphone jack, etc…

Property	Type	Description
`audio`	`OutputAudio \| null`	The current state of audio on this output. This may be null if the display does not report audio information for individual outputs, in which case the allAudio field on the outputs object should be used–if possible.
`connectionType`	`KeyValuePair \| null`	The active connectionType for this output. Even if connectionTypes is empty or not supported, this field must be populated. For example a TV speaker output may have the type “Digital Optical” and a canonicalId of “CONN:OPTICAL”.
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this output supports. For example: “Digital Optical”, “Digital Coax”, “RCA”. In many cases, this field is not applicable. In which case it may be null. A non-null value implies that the integration supports setting the output’s connection type.
`friendlyName`	`string`	A user-friendly name for this output.
`id`	`string`	A unique identifier for this output. This is used when setting the active output.

`OutputAudio`

Reports the audio status for an individual output, or the display as a whole (in the case of the outputs.allAudio field).

Property	Type	Description
`format`	`KeyValuePair \| null`	The current audio format being streamed over this output. For example: “Dolby Atmos”, “DTS:X”, “PCM Stereo”, etc…
`muted`	`boolean \| null`	Whether the audio is currently muted. This value should be null if the mute status cannot be known.
`volume`	`Volume \| null`	The current volume level of the output or display. This value should be null if the volume level cannot be known.

`Volume`

Represents the volume level of an external output, such as the TV speakers, an ARC-connected soundbar, or a headphone jack.

Property	Type	Description
`level`	`number`	The current volume level, represented as an integer between min and max (inclusive).
`max`	`number \| null`	The maximum volume level supported by this output. This may be null if the display does not report a maximum volume level.
`min`	`number \| null`	The minimum volume level supported by this output. This may be null if the display does not report a minimum volume level.
`step`	`number \| null`	An integer representing the step size for volume changes. For example, a step of 5 means that the volume is changed in increments of 5 (e.g. 0, 5, 10, 15, etc…). This may be null if the display does not report a volume step size.

`AppSource`

Property	Type	Required	Description
`canActivate`	`boolean`
`canTerminate`	`boolean`
`canonicalId`	`string \| null`
`friendlyName`	`string`
`id`	`string`

dispatchAuthenticationPrompt

Parameter

Type Definitions

`DispatchAuthenticationPromptParams`

Property	Type	Required	Description
`args`	`DispatchAuthenticationPromptArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`DispatchAuthenticationPromptArgs`

Property	Type	Required	Description
`authenticationId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: id, label, valid, documentationURL, fields.

Result

Type Definitions

`DispatchAuthenticationPromptResult`

Represents a standalone authentication method or “form”. This object serves as a mechanism to logically group fields required for authentication. For example: a device may require an access token to communicate over the LAN. The integration may also support communicating via a cloud api, requiring a clientId and clientSecret. In this case, the integration would return two Authentication objects, one for the LAN method and one for the cloud method, each with their respective fields and types.

Property	Type	Description
`documentationURL`	`string (uri) \| null`	A url to documentation describing how to set/configure this authentication method. This is intended to be displayed to the user as guidance for how to obtain the necessary credentials or complete the necessary steps to successfully authenticate.
`fields`	`AuthenticationField[] \| null`	A list of authentication fields required for this authentication method. Each field has a type that indicates how the value should be obtained or set.
`id`	`string`	The unique identifier for this authentication method. This is used when setting authentication values.
`label`	`string`	A short description of the authentication method. For example: “Local Network Authentication”, “Cloud Authentication”, etc… This will be displayed to the user.
`valid`	`boolean`	Reports the state of this authentication method. If false, one or more of the fields are missing or invalid. There is no way to report the validity of an individual field within the authentication method itself.

`AuthenticationField`

Represents a single field within an authentication method.

Property	Type	Description
`credentialType`	`AuthenticationFieldCredentialType`
`key`	`string`	The unique identifier for this authentication field.
`label`	`string`	A short, user-facing label describing this field. For example: “Password”, “Access Token”, etc…
`type`	`TypeEnum`	The type of this authentication field, indicating how the value should be obtained or set. Pay close attention any specific requirements or constraints for the type being used. - “STRING”: An authentication field of type string. For example: a password, pin, preshared-key, access token, etc… - “PROMPT”: Prompt triggers an out-of-band authentication flow. For example: displaying a prompt on the device requesting permissions, or having a user scan a QR code. There is a 30 second timeout for a prompt to resolve. If an authentication method’s fields list contains a field of type `PROMPT`, it must be the only field present in the list.
`value`	`string \| null`	The current value of this authentication field. This typically only applies for the STRING types, but may be populated for other authentication types as well.

`AuthenticationFieldCredentialType`

Property	Type	Required	Description
`type`	`TypeEnum`		- “OTHER”: - “USERNAME”: - “CLIENTID”: - “CLIENTSECRET”: - “PASSWORD”: - “ACCESSTOKEN”: - “APIKEY”:

`TypeEnum`

“OTHER”:
“USERNAME”:
“CLIENTID”:
“CLIENTSECRET”:
“PASSWORD”:
“ACCESSTOKEN”:
“APIKEY”:

enum

One of: OTHER, USERNAME, CLIENTID, CLIENTSECRET, PASSWORD, ACCESSTOKEN, APIKEY.

dispatchFirmwareUpdate

Parameter

Type Definitions

`DispatchFirmwareUpdateParams`

Property	Type	Required	Description
`args`	`DispatchFirmwareUpdateArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`DispatchFirmwareUpdateArgs`

Property	Type	Required	Description
`versionId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: version, status.

Result

Type Definitions

`DispatchFirmwareUpdateResult`

Property	Type	Required	Description
`status`	`FirmwareStatus`
`version`	`FirmwareVersion \| null`

`FirmwareStatus`

Property	Type	Required	Description
`updateStatus`	`UpdateStatusEnum`		The current status of any ongoing firmware update operation. - “UNSUPPORTED”: Indicates that the integration does not support monitoring firmware update status, or that it cannot determine the current status of a firmware update operation. This DOES NOT indicate that the integration does not support firmware updates at all. See the `updateCandidates` field on the firmware type for that information. - “READY”: Communicates that the device is ready to begin a firmware update, and supports monitoring the status of the update once it has begun. This does not indicate that a firmware update is available. See the `updateCandidates` field on the firmware type for that information. - “COMPLETE”: Indicates that the firmware update has completed successfully. - “INPROGRESS”: Indicates that a firmware update is currently in progress. - “FAILED”: Indicates that the firmware update has failed.

`UpdateStatusEnum`

The current status of any ongoing firmware update operation.

“UNSUPPORTED”: Indicates that the integration does not support monitoring firmware update status, or that it cannot determine the current status of a firmware update operation. This DOES NOT indicate that the integration does not support firmware updates at all. See the updateCandidates field on the firmware type for that information.
“READY”: Communicates that the device is ready to begin a firmware update, and supports monitoring the status of the update once it has begun. This does not indicate that a firmware update is available. See the updateCandidates field on the firmware type for that information.
“COMPLETE”: Indicates that the firmware update has completed successfully.
“INPROGRESS”: Indicates that a firmware update is currently in progress.
“FAILED”: Indicates that the firmware update has failed.

enum

One of: UNSUPPORTED, READY, COMPLETE, INPROGRESS, FAILED.

`FirmwareVersion`

Property	Type	Required	Description
`current`	`FirmwareVersionDetails \| null`		The current firmware version details for the device.
`updateCandidates`	`FirmwareVersionDetails[] \| null`		A list of firmware versions available for update. A non-empty list indicates that a firmware update is available and that this integration supports dispatching firmware updates. A null value indicates that the integration does not support firmware updates, or that it cannot determine if there are any updates available. An empty list indicates that there are no firmware updates currently available for this device, but that the integration does support firmware updates.

`FirmwareVersionDetails`

An object describing an available firmware version for the device.

Property	Type	Description
`documentationUrl`	`string \| null`	A url pointing to documentation for this firmware version. This is used for display purposes in the UI when listing available firmware versions, and can be used by the user to learn more about this firmware version before deciding to update.
`friendlyName`	`string`	A user-friendly name for this firmware version. This is used for display purposes in the UI when listing available firmware versions.
`id`	`string`	A unique identifier for this firmware version. This is used when dispatching a firmware update to specify which version to update to.
`releaseDate`	`string (date-time) \| null`	The date this firmware version was released.
`releaseNotes`	`string \| null`	A description of the changes included in this firmware version. This is used for display purposes in the UI when listing available firmware versions.
`size`	`number \| null`	The size of the firmware file in bytes.

dispatchPowerReboot

Parameter

Type Definitions

`DispatchPowerRebootParams`

Property	Type	Required	Description
`args`	`DispatchPowerRebootArgs`	✓
`includeFields`	`string[]`

`DispatchPowerRebootArgs`

No properties.

Result

Type Definitions

`DispatchPowerRebootResult`

boolean

getActiveContexts

Parameter

Type Definitions

`GetActiveContextsParams`

Property	Type	Required	Description
`args`	`GetActiveContextsArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`GetActiveContextsArgs`

No properties.

`IncludeFieldsEnum`

enum

One of: contexts.

Result

Type Definitions

`GetActiveContextsResult`

Property	Type	Required	Description
`contexts`	`ActiveContext[] \| null`		A list of currently active display contexts. For many displays, this list will only ever contain a single item.

`ActiveContext`

Property	Type	Description
`canReportInput`	`boolean`	Indicates whether the device is capable of reporting the currently active input. When true, the input field will be populated with the active input–if there is an active input; when false, the input field should always be null and will be ignored.
`canReportSource`	`boolean`	Indicates whether the device is capable of reporting the currently active application/source. When true, the source field will be populated with the active application/source–if there is an active application; when false, the source field should always be null and will be ignored.
`id`	`string`	The unique identifier for this context.
`input`	`Input \| null`	The physical input that is currently active on the device. This may be null if there is no active input, or if the device does not report this information.
`outputs`	`Output[] \| null`	The output(s) that are currently active on the device. This may be null or empty if there are no active outputs, or if the device does not report this information.
`source`	`AppSource \| null`	The application/source that is currently active on the device. This does not include physical inputs, which are represented separately by the input field. If there is no active application/source, or the device does not report this information, this field may be null.

`Input`

Input represents a physical input on the device, such as an HDMI port, a tuner, etc…

Property	Type	Description
`arcMode`	`KeyValuePair \| null`	The active ARC mode for this input. This field is only populated if the display supports reporting the current ARC mode on a per-input basis. See the inputs object’s arcMode field for more information.
`arcModes`	`KeyValuePair[] \| null`	A list of ARC modes supported by this input. This field is only populated if the display supports reporting ARC modes on a per-input basis. See the inputs object’s arcModes field for more information.
`canActivate`	`boolean`	Communicates whether this input can be selected as the active input. This value reflects the current state of the input, not the overall capability of the device or integration. For example, an HDMI input with no cable connected may have canActivate = false, even though the device supports activating that input.
`cecMode`	`KeyValuePair \| null`	The active CEC mode for this input. This field is only populated if the display supports reporting the current CEC mode on a per-input basis. See the inputs object’s cecMode field for more information.
`cecModes`	`KeyValuePair[] \| null`	A list of CEC modes supported by this input. This field is only populated if the display supports reporting CEC modes on a per-input basis. See the inputs object’s cecModes field for more information.
`connectionPresent`	`ConnectionPresentEnum \| null`	Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:
`connectionType`	`KeyValuePair`
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this input supports. For example: “COMPONENT vs or COMPOSITE” or “HDMI with Optical Audio”. In many cases, this field is not applicable. In which case it may be null or empty. A non-empty list implies that the integration supports setting the input’s connection type.
`friendlyName`	`string`	A user-friendly name for this input. This value provides a consistent identifier for the input, regardless of the device’s internal naming. For example: “HDMI1”.
`id`	`string`	The unique identifier for this input. This is used when setting the active input.
`label`	`Label \| null`	The input’s label, as stored on the device itself. E.g. “Playstation”, “Blu-ray”, “Cable Box”, etc… This is typically user-configurable on the device, and may be null if the device does not have a label for this input.
`signalPresent`	`SignalPresentEnum \| null`	Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`ConnectionPresentEnum`

Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Label`

Property	Type	Required	Description
`canSet`	`boolean`
`label`	`string`

`SignalPresentEnum`

Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Output`

Represents an individual physical output on the device, such as TV speakers, an ARC-connected soundbar, a headphone jack, etc…

Property	Type	Description
`audio`	`OutputAudio \| null`	The current state of audio on this output. This may be null if the display does not report audio information for individual outputs, in which case the allAudio field on the outputs object should be used–if possible.
`connectionType`	`KeyValuePair \| null`	The active connectionType for this output. Even if connectionTypes is empty or not supported, this field must be populated. For example a TV speaker output may have the type “Digital Optical” and a canonicalId of “CONN:OPTICAL”.
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this output supports. For example: “Digital Optical”, “Digital Coax”, “RCA”. In many cases, this field is not applicable. In which case it may be null. A non-null value implies that the integration supports setting the output’s connection type.
`friendlyName`	`string`	A user-friendly name for this output.
`id`	`string`	A unique identifier for this output. This is used when setting the active output.

`OutputAudio`

Reports the audio status for an individual output, or the display as a whole (in the case of the outputs.allAudio field).

Property	Type	Description
`format`	`KeyValuePair \| null`	The current audio format being streamed over this output. For example: “Dolby Atmos”, “DTS:X”, “PCM Stereo”, etc…
`muted`	`boolean \| null`	Whether the audio is currently muted. This value should be null if the mute status cannot be known.
`volume`	`Volume \| null`	The current volume level of the output or display. This value should be null if the volume level cannot be known.

`Volume`

Represents the volume level of an external output, such as the TV speakers, an ARC-connected soundbar, or a headphone jack.

Property	Type	Description
`level`	`number`	The current volume level, represented as an integer between min and max (inclusive).
`max`	`number \| null`	The maximum volume level supported by this output. This may be null if the display does not report a maximum volume level.
`min`	`number \| null`	The minimum volume level supported by this output. This may be null if the display does not report a minimum volume level.
`step`	`number \| null`	An integer representing the step size for volume changes. For example, a step of 5 means that the volume is changed in increments of 5 (e.g. 0, 5, 10, 15, etc…). This may be null if the display does not report a volume step size.

`AppSource`

Property	Type	Required	Description
`canActivate`	`boolean`
`canTerminate`	`boolean`
`canonicalId`	`string \| null`
`friendlyName`	`string`
`id`	`string`

getAppSources

Parameter

Type Definitions

`GetAppSourcesParams`

Property	Type	Required	Description
`args`	`GetAppSourcesArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`GetAppSourcesArgs`

No properties.

`IncludeFieldsEnum`

enum

One of: canTerminate, available.

Result

Type Definitions

`GetAppSourcesResult`

Property	Type	Required	Description
`available`	`AppSource[] \| null`
`canTerminate`	`boolean`

`AppSource`

Property	Type	Required	Description
`canActivate`	`boolean`
`canTerminate`	`boolean`
`canonicalId`	`string \| null`
`friendlyName`	`string`
`id`	`string`

getAuthentication

Authentication methods supported by the integration.

Parameter

Type Definitions

`GetAuthenticationParams`

Property	Type	Required	Description
`args`	`GetAuthenticationArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`GetAuthenticationArgs`

No properties.

`IncludeFieldsEnum`

enum

One of: methods.

Result

Type Definitions

`GetAuthenticationResult`

The container for all authentication items.

Property	Type	Required	Description
`methods`	`Authentication[] \| null`		A list of authentication methods required or available for a user to use.

`Authentication`

Property	Type	Description
`documentationURL`	`string (uri) \| null`	A url to documentation describing how to set/configure this authentication method. This is intended to be displayed to the user as guidance for how to obtain the necessary credentials or complete the necessary steps to successfully authenticate.
`fields`	`AuthenticationField[] \| null`	A list of authentication fields required for this authentication method. Each field has a type that indicates how the value should be obtained or set.
`id`	`string`	The unique identifier for this authentication method. This is used when setting authentication values.
`label`	`string`	A short description of the authentication method. For example: “Local Network Authentication”, “Cloud Authentication”, etc… This will be displayed to the user.
`valid`	`boolean`	Reports the state of this authentication method. If false, one or more of the fields are missing or invalid. There is no way to report the validity of an individual field within the authentication method itself.

`AuthenticationField`

Represents a single field within an authentication method.

Property	Type	Description
`credentialType`	`AuthenticationFieldCredentialType`
`key`	`string`	The unique identifier for this authentication field.
`label`	`string`	A short, user-facing label describing this field. For example: “Password”, “Access Token”, etc…
`type`	`TypeEnum`	The type of this authentication field, indicating how the value should be obtained or set. Pay close attention any specific requirements or constraints for the type being used. - “STRING”: An authentication field of type string. For example: a password, pin, preshared-key, access token, etc… - “PROMPT”: Prompt triggers an out-of-band authentication flow. For example: displaying a prompt on the device requesting permissions, or having a user scan a QR code. There is a 30 second timeout for a prompt to resolve. If an authentication method’s fields list contains a field of type `PROMPT`, it must be the only field present in the list.
`value`	`string \| null`	The current value of this authentication field. This typically only applies for the STRING types, but may be populated for other authentication types as well.

`AuthenticationFieldCredentialType`

Property	Type	Required	Description
`type`	`TypeEnum`		- “OTHER”: - “USERNAME”: - “CLIENTID”: - “CLIENTSECRET”: - “PASSWORD”: - “ACCESSTOKEN”: - “APIKEY”:

`TypeEnum`

“OTHER”:
“USERNAME”:
“CLIENTID”:
“CLIENTSECRET”:
“PASSWORD”:
“ACCESSTOKEN”:
“APIKEY”:

enum

One of: OTHER, USERNAME, CLIENTID, CLIENTSECRET, PASSWORD, ACCESSTOKEN, APIKEY.

getFirmware

Firmware metadata reported by the device.

Parameter

Type Definitions

`GetFirmwareParams`

Property	Type	Required	Description
`args`	`GetFirmwareArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`GetFirmwareArgs`

No properties.

`IncludeFieldsEnum`

enum

One of: version, status.

Result

Type Definitions

`GetFirmwareResult`

Property	Type	Required	Description
`status`	`FirmwareStatus`
`version`	`FirmwareVersion \| null`

`FirmwareStatus`

Property	Type	Required	Description
`updateStatus`	`UpdateStatusEnum`		The current status of any ongoing firmware update operation. - “UNSUPPORTED”: Indicates that the integration does not support monitoring firmware update status, or that it cannot determine the current status of a firmware update operation. This DOES NOT indicate that the integration does not support firmware updates at all. See the `updateCandidates` field on the firmware type for that information. - “READY”: Communicates that the device is ready to begin a firmware update, and supports monitoring the status of the update once it has begun. This does not indicate that a firmware update is available. See the `updateCandidates` field on the firmware type for that information. - “COMPLETE”: Indicates that the firmware update has completed successfully. - “INPROGRESS”: Indicates that a firmware update is currently in progress. - “FAILED”: Indicates that the firmware update has failed.

`UpdateStatusEnum`

The current status of any ongoing firmware update operation.

“UNSUPPORTED”: Indicates that the integration does not support monitoring firmware update status, or that it cannot determine the current status of a firmware update operation. This DOES NOT indicate that the integration does not support firmware updates at all. See the updateCandidates field on the firmware type for that information.
“READY”: Communicates that the device is ready to begin a firmware update, and supports monitoring the status of the update once it has begun. This does not indicate that a firmware update is available. See the updateCandidates field on the firmware type for that information.
“COMPLETE”: Indicates that the firmware update has completed successfully.
“INPROGRESS”: Indicates that a firmware update is currently in progress.
“FAILED”: Indicates that the firmware update has failed.

enum

One of: UNSUPPORTED, READY, COMPLETE, INPROGRESS, FAILED.

`FirmwareVersion`

Property	Type	Required	Description
`current`	`FirmwareVersionDetails \| null`		The current firmware version details for the device.
`updateCandidates`	`FirmwareVersionDetails[] \| null`		A list of firmware versions available for update. A non-empty list indicates that a firmware update is available and that this integration supports dispatching firmware updates. A null value indicates that the integration does not support firmware updates, or that it cannot determine if there are any updates available. An empty list indicates that there are no firmware updates currently available for this device, but that the integration does support firmware updates.

`FirmwareVersionDetails`

An object describing an available firmware version for the device.

Property	Type	Description
`documentationUrl`	`string \| null`	A url pointing to documentation for this firmware version. This is used for display purposes in the UI when listing available firmware versions, and can be used by the user to learn more about this firmware version before deciding to update.
`friendlyName`	`string`	A user-friendly name for this firmware version. This is used for display purposes in the UI when listing available firmware versions.
`id`	`string`	A unique identifier for this firmware version. This is used when dispatching a firmware update to specify which version to update to.
`releaseDate`	`string (date-time) \| null`	The date this firmware version was released.
`releaseNotes`	`string \| null`	A description of the changes included in this firmware version. This is used for display purposes in the UI when listing available firmware versions.
`size`	`number \| null`	The size of the firmware file in bytes.

getInputs

Parameter

Type Definitions

`GetInputsParams`

Property	Type	Required	Description
`args`	`GetInputsArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`GetInputsArgs`

No properties.

`IncludeFieldsEnum`

enum

One of: available, cecMode, arcMode.

Result

Type Definitions

`GetInputsResult`

An object representing all physical inputs on the device, as well as any global input settings that may apply to all or some of the inputs.

Property	Type	Description
`arcMode`	`InputsARCMode \| null`	Global information about the displays’ available and configured ARC modes.
`available`	`Input[] \| null`	A list of physical inputs on the device. This may be null or empty if the device does not have any physical inputs, or if it does not support reporting them.
`cecMode`	`InputsCECMode \| null`	Global information about the display’s available and configured CEC modes.

`InputsARCMode`

Property	Type	Required	Description
`active`	`KeyValuePair \| null`		If the display does not support reporting the current ARC mode on a per-input basis, this field may be populated with the active ARC mode. See the arcModes field for more information.
`available`	`KeyValuePair[] \| null`		If the display does not support reporting ARC modes on a per-input basis, this field may be populated with the list of ARC modes the display supports. Typical modes might include “ARC”, “eARC”, or “Disabled”. If the display does support reporting ARC modes on a per-input basis, this field should be null, and the modes should be listed on the individual input(s) instead.

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`Input`

Input represents a physical input on the device, such as an HDMI port, a tuner, etc…

Property	Type	Description
`arcMode`	`KeyValuePair \| null`	The active ARC mode for this input. This field is only populated if the display supports reporting the current ARC mode on a per-input basis. See the inputs object’s arcMode field for more information.
`arcModes`	`KeyValuePair[] \| null`	A list of ARC modes supported by this input. This field is only populated if the display supports reporting ARC modes on a per-input basis. See the inputs object’s arcModes field for more information.
`canActivate`	`boolean`	Communicates whether this input can be selected as the active input. This value reflects the current state of the input, not the overall capability of the device or integration. For example, an HDMI input with no cable connected may have canActivate = false, even though the device supports activating that input.
`cecMode`	`KeyValuePair \| null`	The active CEC mode for this input. This field is only populated if the display supports reporting the current CEC mode on a per-input basis. See the inputs object’s cecMode field for more information.
`cecModes`	`KeyValuePair[] \| null`	A list of CEC modes supported by this input. This field is only populated if the display supports reporting CEC modes on a per-input basis. See the inputs object’s cecModes field for more information.
`connectionPresent`	`ConnectionPresentEnum \| null`	Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:
`connectionType`	`KeyValuePair`
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this input supports. For example: “COMPONENT vs or COMPOSITE” or “HDMI with Optical Audio”. In many cases, this field is not applicable. In which case it may be null or empty. A non-empty list implies that the integration supports setting the input’s connection type.
`friendlyName`	`string`	A user-friendly name for this input. This value provides a consistent identifier for the input, regardless of the device’s internal naming. For example: “HDMI1”.
`id`	`string`	The unique identifier for this input. This is used when setting the active input.
`label`	`Label \| null`	The input’s label, as stored on the device itself. E.g. “Playstation”, “Blu-ray”, “Cable Box”, etc… This is typically user-configurable on the device, and may be null if the device does not have a label for this input.
`signalPresent`	`SignalPresentEnum \| null`	Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:

`ConnectionPresentEnum`

Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Label`

Property	Type	Required	Description
`canSet`	`boolean`
`label`	`string`

`SignalPresentEnum`

Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`InputsCECMode`

Property	Type	Required	Description
`active`	`KeyValuePair \| null`		If the display does not support reporting the current CEC mode on a per-input basis, this field may be populated with the active CEC mode. See the cecModes field for more information.
`available`	`KeyValuePair[] \| null`		If the display does not support reporting CEC modes on a per-input basis, this field may be populated with the list of CEC modes the display supports. In many cases, this may be as simple “Enabled” or “Disabled”. If the display does support reporting CEC modes on a per-input basis, this field should be null, and the modes should be listed on the individual input(s) instead.

getMetadata

Parameter

Type Definitions

`GetMetadataParams`

Property	Type	Required	Description
`args`	`GetMetadataArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`GetMetadataArgs`

No properties.

`IncludeFieldsEnum`

enum

One of: userManualURL, knowledgeBaseURL, dataAcquisition.

Result

Type Definitions

`GetMetadataResult`

Property	Type	Required	Description
`dataAcquisition`	`KeyValuePair[] \| null`
`knowledgeBaseURL`	`string (uri) \| null`
`userManualURL`	`string (uri) \| null`

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

getNetwork

Parameter

Type Definitions

`GetNetworkParams`

Property	Type	Required	Description
`args`	`GetNetworkArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`GetNetworkArgs`

No properties.

`IncludeFieldsEnum`

enum

One of: interfaces.

Result

Type Definitions

`GetNetworkResult`

The device’s network information.

Property	Type	Required	Description
`interfaces`	`NetworkInterface[] \| null`		A list of available network interfaces on the device, such as Wi-Fi adapters and Ethernet ports.

`NetworkInterface`

A network interface on the device, such as a Wi-Fi adapter or Ethernet port.

Property	Type	Description
`canEnable`	`boolean \| null`	Whether this network interface can be enabled via the integration. Null indicates the integration does not support changing the enabled status of any network interfaces. False indicates the network interface cannot be enabled, but the integration does support changing the enabled status of network interfaces where canEnable is true.
`enabled`	`boolean`	Whether this network interface is currently enabled.
`friendlyName`	`string`	A user-friendly name for this network interface, such as “Wi-Fi”, “Ethernet”, “eth0”, etc…
`id`	`string`	A unique identifier for this network interface. This is used when setting network configuration, if supported.
`ipv4`	`IPv4Settings \| null`	The IPv4 settings for this network interface.
`macAddress`	`string \| null`	The network interface’s mac address.
`wifi`	`WifiInfo \| null`	Details about the Wi-Fi connection for this network interface. If this value is null, it is assumed that the network interface is a wired connection.

`IPv4Settings`

IPv4 network settings for a network interface, including the effective configuration, static configuration, and supported address types.

Property	Type	Description
`addressType`	`AddressTypeEnum \| null`	The currently active address type for this network interface. - “DHCP”: - “DHCP_STATIC_DNS”: - “STATIC”:
`addressTypes`	`AddressTypesEnum[] \| null`	A list of supported address types for this network interface, which can be changed if canSet is true.
`canSet`	`boolean`	If true, the integration must support setting the IPv4 configuration on this interface. If false, the effective configuration is read-only and cannot be modified by the integration.
`dnsServerCount`	`number`	The number of dns servers the network interface supports. This value may be at most 3.
`effective`	`IPv4Config \| null`	The configuration currently in effect on this network interface.
`static`	`IPv4Config \| null`	Where applicable, the static IPv4 configuration for this network interface.

`AddressTypeEnum`

The currently active address type for this network interface.

“DHCP”:
“DHCP_STATIC_DNS”:
“STATIC”:

enum

One of: DHCP, DHCP_STATIC_DNS, STATIC.

`AddressTypesEnum`

“DHCP”:
“DHCP_STATIC_DNS”:
“STATIC”:

enum

One of: DHCP, DHCP_STATIC_DNS, STATIC.

`IPv4Config`

The IPv4 configuration for a network interface, including the assigned address, netmask, gateway, and dns servers.

Property	Type	Description
`address`	`string (ipv4) \| null`	The IPv4 address assigned to the device. This may be null if the device does not expose this information.
`dnsServers`	`string (ipv4)[] \| null`	A list of dns servers assigned to the device. The list must return at most 3 servers.
`gateway`	`string (ipv4) \| null`	The IPv4 gateway assigned to the device.
`netmask`	`string (ipv4) \| null`	The IPv4 netmask assigned to the device.

`WifiInfo`

Property	Type	Required	Description
`ssid`	`string \| null`		The SSID of the currently connected Wi-Fi network, if applicable.

getOutputs

Parameter

Type Definitions

`GetOutputsParams`

Property	Type	Required	Description
`args`	`GetOutputsArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`GetOutputsArgs`

No properties.

`IncludeFieldsEnum`

enum

One of: available, allAudio.

Result

Type Definitions

`GetOutputsResult`

Property	Type	Required	Description
`allAudio`	`OutputAudio \| null`		The current state of audio for the display as a whole. This should only be provided if the audio cannot be reported on a per-output basis.
`available`	`Output[] \| null`		A list of outputs the display has available. This may be null or empty if the available outputs cannot be retrieved from the device.

`OutputAudio`

Reports the audio status for an individual output, or the display as a whole (in the case of the outputs.allAudio field).

Property	Type	Description
`format`	`KeyValuePair \| null`	The current audio format being streamed over this output. For example: “Dolby Atmos”, “DTS:X”, “PCM Stereo”, etc…
`muted`	`boolean \| null`	Whether the audio is currently muted. This value should be null if the mute status cannot be known.
`volume`	`Volume \| null`	The current volume level of the output or display. This value should be null if the volume level cannot be known.

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`Volume`

Represents the volume level of an external output, such as the TV speakers, an ARC-connected soundbar, or a headphone jack.

Property	Type	Description
`level`	`number`	The current volume level, represented as an integer between min and max (inclusive).
`max`	`number \| null`	The maximum volume level supported by this output. This may be null if the display does not report a maximum volume level.
`min`	`number \| null`	The minimum volume level supported by this output. This may be null if the display does not report a minimum volume level.
`step`	`number \| null`	An integer representing the step size for volume changes. For example, a step of 5 means that the volume is changed in increments of 5 (e.g. 0, 5, 10, 15, etc…). This may be null if the display does not report a volume step size.

`Output`

Represents an individual physical output on the device, such as TV speakers, an ARC-connected soundbar, a headphone jack, etc…

Property	Type	Description
`audio`	`OutputAudio \| null`	The current state of audio on this output. This may be null if the display does not report audio information for individual outputs, in which case the allAudio field on the outputs object should be used–if possible.
`connectionType`	`KeyValuePair \| null`	The active connectionType for this output. Even if connectionTypes is empty or not supported, this field must be populated. For example a TV speaker output may have the type “Digital Optical” and a canonicalId of “CONN:OPTICAL”.
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this output supports. For example: “Digital Optical”, “Digital Coax”, “RCA”. In many cases, this field is not applicable. In which case it may be null. A non-null value implies that the integration supports setting the output’s connection type.
`friendlyName`	`string`	A user-friendly name for this output.
`id`	`string`	A unique identifier for this output. This is used when setting the active output.

getPower

Parameter

Type Definitions

`GetPowerParams`

Property	Type	Required	Description
`args`	`GetPowerArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`GetPowerArgs`

No properties.

`IncludeFieldsEnum`

enum

One of: canReboot, state, powerSavingMode, wakeOnLAN.

Result

Type Definitions

`GetPowerResult`

Property	Type	Description
`canReboot`	`boolean \| null`	If non-null, denotes the integration supports the dispatchPowerReboot rpc method. A false value denotes the integration supports the dispatchPowerReboot rpc method, but the device cannot currently be rebooted. A true value denotes the integration supports the dispatchPowerReboot rpc method, and the device can be rebooted.
`powerSavingMode`	`PowerPowerSavingMode \| null`
`state`	`PowerPowerState \| null`
`wakeOnLAN`	`WakeOnLAN \| null`

`PowerPowerSavingMode`

Property	Type	Required	Description
`active`	`KeyValuePair \| null`
`available`	`KeyValuePair[] \| null`

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`PowerPowerState`

Property	Type	Required	Description
`allowedPowerState`	`AllowedPowerStateEnum \| null`		If non-null, denotes the integration supports the setPowerPowerState method. - “ON”: - “STANDBY”: - “OFF”:
`current`	`CurrentEnum \| null`		- “ON”: - “STANDBY”: - “UNKNOWN”:

`AllowedPowerStateEnum`

If non-null, denotes the integration supports the setPowerPowerState method.

“ON”:
“STANDBY”:
“OFF”:

enum

One of: ON, STANDBY, OFF.

`CurrentEnum`

“ON”:
“STANDBY”:
“UNKNOWN”:

enum

One of: ON, STANDBY, UNKNOWN.

`WakeOnLAN`

Property	Type	Required	Description
`canSet`	`boolean`
`mode`	`ModeEnum`		- “ENABLED”: - “DISABLED”:

`ModeEnum`

“ENABLED”:
“DISABLED”:

enum

One of: ENABLED, DISABLED.

getSystem

Parameter

Type Definitions

`GetSystemParams`

Property	Type	Required	Description
`args`	`GetSystemArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`GetSystemArgs`

No properties.

`IncludeFieldsEnum`

enum

One of: friendlyName, label, language, country, model, brand, serialNumber.

Result

Type Definitions

`GetSystemResult`

Property	Type	Required	Description
`brand`	`string \| null`
`country`	`SystemCountry \| null`
`friendlyName`	`string \| null`
`label`	`GlobalLabel \| null`
`language`	`SystemLanguage \| null`
`model`	`string \| null`
`serialNumber`	`string \| null`

`SystemCountry`

Property	Type	Required	Description
`active`	`KeyValuePair \| null`
`available`	`KeyValuePair[] \| null`

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`GlobalLabel`

Property	Type	Required	Description
`canSet`	`boolean`
`label`	`string`

`SystemLanguage`

Property	Type	Required	Description
`active`	`KeyValuePair \| null`
`available`	`KeyValuePair[] \| null`

getVideo

Parameter

Type Definitions

`GetVideoParams`

Property	Type	Required	Description
`args`	`GetVideoArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`GetVideoArgs`

No properties.

`IncludeFieldsEnum`

enum

One of: screenMute, aspectRatio, pictureMode, brightness, contrast, sharpness.

Result

Type Definitions

`GetVideoResult`

Property	Type	Required	Description
`aspectRatio`	`VideoAspectRatio \| null`
`brightness`	`VideoLevel \| null`
`contrast`	`VideoLevel \| null`
`pictureMode`	`VideoPictureMode \| null`
`screenMute`	`ScreenMute \| null`
`sharpness`	`VideoLevel \| null`

`VideoAspectRatio`

Property	Type	Required	Description
`active`	`KeyValuePair \| null`
`available`	`KeyValuePair[] \| null`

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`VideoLevel`

Property	Type	Required	Description
`max`	`number`
`min`	`number`
`step`	`number`
`value`	`number`

`VideoPictureMode`

Property	Type	Required	Description
`active`	`KeyValuePair \| null`
`available`	`KeyValuePair[] \| null`

`ScreenMute`

Property	Type	Required	Description
`muted`	`boolean`

setAppSourcesActive

Switch to an app source, such as Netflix.

Parameter

Type Definitions

`SetAppSourcesActiveParams`

Property	Type	Required	Description
`args`	`SetAppSourcesActiveArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetAppSourcesActiveArgs`

Property	Type	Required	Description
`contextId`	`string`	✓
`sourceId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: id, source, canReportSource, input, canReportInput, outputs.

Result

Type Definitions

`SetAppSourcesActiveResult`

Property	Type	Description
`canReportInput`	`boolean`	Indicates whether the device is capable of reporting the currently active input. When true, the input field will be populated with the active input–if there is an active input; when false, the input field should always be null and will be ignored.
`canReportSource`	`boolean`	Indicates whether the device is capable of reporting the currently active application/source. When true, the source field will be populated with the active application/source–if there is an active application; when false, the source field should always be null and will be ignored.
`id`	`string`	The unique identifier for this context.
`input`	`Input \| null`	The physical input that is currently active on the device. This may be null if there is no active input, or if the device does not report this information.
`outputs`	`Output[] \| null`	The output(s) that are currently active on the device. This may be null or empty if there are no active outputs, or if the device does not report this information.
`source`	`AppSource \| null`	The application/source that is currently active on the device. This does not include physical inputs, which are represented separately by the input field. If there is no active application/source, or the device does not report this information, this field may be null.

`Input`

Input represents a physical input on the device, such as an HDMI port, a tuner, etc…

Property	Type	Description
`arcMode`	`KeyValuePair \| null`	The active ARC mode for this input. This field is only populated if the display supports reporting the current ARC mode on a per-input basis. See the inputs object’s arcMode field for more information.
`arcModes`	`KeyValuePair[] \| null`	A list of ARC modes supported by this input. This field is only populated if the display supports reporting ARC modes on a per-input basis. See the inputs object’s arcModes field for more information.
`canActivate`	`boolean`	Communicates whether this input can be selected as the active input. This value reflects the current state of the input, not the overall capability of the device or integration. For example, an HDMI input with no cable connected may have canActivate = false, even though the device supports activating that input.
`cecMode`	`KeyValuePair \| null`	The active CEC mode for this input. This field is only populated if the display supports reporting the current CEC mode on a per-input basis. See the inputs object’s cecMode field for more information.
`cecModes`	`KeyValuePair[] \| null`	A list of CEC modes supported by this input. This field is only populated if the display supports reporting CEC modes on a per-input basis. See the inputs object’s cecModes field for more information.
`connectionPresent`	`ConnectionPresentEnum \| null`	Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:
`connectionType`	`KeyValuePair`
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this input supports. For example: “COMPONENT vs or COMPOSITE” or “HDMI with Optical Audio”. In many cases, this field is not applicable. In which case it may be null or empty. A non-empty list implies that the integration supports setting the input’s connection type.
`friendlyName`	`string`	A user-friendly name for this input. This value provides a consistent identifier for the input, regardless of the device’s internal naming. For example: “HDMI1”.
`id`	`string`	The unique identifier for this input. This is used when setting the active input.
`label`	`Label \| null`	The input’s label, as stored on the device itself. E.g. “Playstation”, “Blu-ray”, “Cable Box”, etc… This is typically user-configurable on the device, and may be null if the device does not have a label for this input.
`signalPresent`	`SignalPresentEnum \| null`	Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`ConnectionPresentEnum`

Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Label`

Property	Type	Required	Description
`canSet`	`boolean`
`label`	`string`

`SignalPresentEnum`

Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Output`

Represents an individual physical output on the device, such as TV speakers, an ARC-connected soundbar, a headphone jack, etc…

Property	Type	Description
`audio`	`OutputAudio \| null`	The current state of audio on this output. This may be null if the display does not report audio information for individual outputs, in which case the allAudio field on the outputs object should be used–if possible.
`connectionType`	`KeyValuePair \| null`	The active connectionType for this output. Even if connectionTypes is empty or not supported, this field must be populated. For example a TV speaker output may have the type “Digital Optical” and a canonicalId of “CONN:OPTICAL”.
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this output supports. For example: “Digital Optical”, “Digital Coax”, “RCA”. In many cases, this field is not applicable. In which case it may be null. A non-null value implies that the integration supports setting the output’s connection type.
`friendlyName`	`string`	A user-friendly name for this output.
`id`	`string`	A unique identifier for this output. This is used when setting the active output.

`OutputAudio`

Reports the audio status for an individual output, or the display as a whole (in the case of the outputs.allAudio field).

Property	Type	Description
`format`	`KeyValuePair \| null`	The current audio format being streamed over this output. For example: “Dolby Atmos”, “DTS:X”, “PCM Stereo”, etc…
`muted`	`boolean \| null`	Whether the audio is currently muted. This value should be null if the mute status cannot be known.
`volume`	`Volume \| null`	The current volume level of the output or display. This value should be null if the volume level cannot be known.

`Volume`

Represents the volume level of an external output, such as the TV speakers, an ARC-connected soundbar, or a headphone jack.

Property	Type	Description
`level`	`number`	The current volume level, represented as an integer between min and max (inclusive).
`max`	`number \| null`	The maximum volume level supported by this output. This may be null if the display does not report a maximum volume level.
`min`	`number \| null`	The minimum volume level supported by this output. This may be null if the display does not report a minimum volume level.
`step`	`number \| null`	An integer representing the step size for volume changes. For example, a step of 5 means that the volume is changed in increments of 5 (e.g. 0, 5, 10, 15, etc…). This may be null if the display does not report a volume step size.

`AppSource`

Property	Type	Required	Description
`canActivate`	`boolean`
`canTerminate`	`boolean`
`canonicalId`	`string \| null`
`friendlyName`	`string`
`id`	`string`

setAuthentication

Parameter

Type Definitions

`SetAuthenticationParams`

Property	Type	Required	Description
`args`	`SetAuthenticationArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetAuthenticationArgs`

Property	Type	Required	Description
`auth`	`AuthenticationInput`	✓	Input type for setting authentication values on an authentication method. This is only applicable for authentication methods composed of STRING fields.

`AuthenticationInput`

Input type for setting authentication values on an authentication method. This is only applicable for authentication methods composed of STRING fields.

Property	Type	Required	Description
`fields`	`AuthenticationFieldInput[]`	✓	The list of field values to set for this authentication method.
`id`	`string`	✓	The unique identifier of the authentication method to set values for.

`AuthenticationFieldInput`

Input type for setting the value of a single authentication field.

Property	Type	Required	Description
`key`	`string`	✓	The unique identifier of the authentication field to set.
`value`	`string`	✓	The value to set for this authentication field.

`IncludeFieldsEnum`

enum

One of: id, label, valid, documentationURL, fields.

Result

Type Definitions

`SetAuthenticationResult`

Property	Type	Description
`documentationURL`	`string (uri) \| null`	A url to documentation describing how to set/configure this authentication method. This is intended to be displayed to the user as guidance for how to obtain the necessary credentials or complete the necessary steps to successfully authenticate.
`fields`	`AuthenticationField[] \| null`	A list of authentication fields required for this authentication method. Each field has a type that indicates how the value should be obtained or set.
`id`	`string`	The unique identifier for this authentication method. This is used when setting authentication values.
`label`	`string`	A short description of the authentication method. For example: “Local Network Authentication”, “Cloud Authentication”, etc… This will be displayed to the user.
`valid`	`boolean`	Reports the state of this authentication method. If false, one or more of the fields are missing or invalid. There is no way to report the validity of an individual field within the authentication method itself.

`AuthenticationField`

Represents a single field within an authentication method.

Property	Type	Description
`credentialType`	`AuthenticationFieldCredentialType`
`key`	`string`	The unique identifier for this authentication field.
`label`	`string`	A short, user-facing label describing this field. For example: “Password”, “Access Token”, etc…
`type`	`TypeEnum`	The type of this authentication field, indicating how the value should be obtained or set. Pay close attention any specific requirements or constraints for the type being used. - “STRING”: An authentication field of type string. For example: a password, pin, preshared-key, access token, etc… - “PROMPT”: Prompt triggers an out-of-band authentication flow. For example: displaying a prompt on the device requesting permissions, or having a user scan a QR code. There is a 30 second timeout for a prompt to resolve. If an authentication method’s fields list contains a field of type `PROMPT`, it must be the only field present in the list.
`value`	`string \| null`	The current value of this authentication field. This typically only applies for the STRING types, but may be populated for other authentication types as well.

`AuthenticationFieldCredentialType`

Property	Type	Required	Description
`type`	`TypeEnum`		- “OTHER”: - “USERNAME”: - “CLIENTID”: - “CLIENTSECRET”: - “PASSWORD”: - “ACCESSTOKEN”: - “APIKEY”:

`TypeEnum`

“OTHER”:
“USERNAME”:
“CLIENTID”:
“CLIENTSECRET”:
“PASSWORD”:
“ACCESSTOKEN”:
“APIKEY”:

enum

One of: OTHER, USERNAME, CLIENTID, CLIENTSECRET, PASSWORD, ACCESSTOKEN, APIKEY.

setInputARCMode

Set the ARC mode for a specific input.

Parameter

Type Definitions

`SetInputARCModeParams`

Property	Type	Required	Description
`args`	`SetInputARCModeArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetInputARCModeArgs`

Property	Type	Required	Description
`inputId`	`string`	✓
`modeId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: id, friendlyName, label, canActivate, connectionTypes, connectionType, cecModes, cecMode, arcModes, arcMode, signalPresent, connectionPresent.

Result

Type Definitions

`SetInputARCModeResult`

Input represents a physical input on the device, such as an HDMI port, a tuner, etc…

Property	Type	Description
`arcMode`	`KeyValuePair \| null`	The active ARC mode for this input. This field is only populated if the display supports reporting the current ARC mode on a per-input basis. See the inputs object’s arcMode field for more information.
`arcModes`	`KeyValuePair[] \| null`	A list of ARC modes supported by this input. This field is only populated if the display supports reporting ARC modes on a per-input basis. See the inputs object’s arcModes field for more information.
`canActivate`	`boolean`	Communicates whether this input can be selected as the active input. This value reflects the current state of the input, not the overall capability of the device or integration. For example, an HDMI input with no cable connected may have canActivate = false, even though the device supports activating that input.
`cecMode`	`KeyValuePair \| null`	The active CEC mode for this input. This field is only populated if the display supports reporting the current CEC mode on a per-input basis. See the inputs object’s cecMode field for more information.
`cecModes`	`KeyValuePair[] \| null`	A list of CEC modes supported by this input. This field is only populated if the display supports reporting CEC modes on a per-input basis. See the inputs object’s cecModes field for more information.
`connectionPresent`	`ConnectionPresentEnum \| null`	Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:
`connectionType`	`KeyValuePair`
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this input supports. For example: “COMPONENT vs or COMPOSITE” or “HDMI with Optical Audio”. In many cases, this field is not applicable. In which case it may be null or empty. A non-empty list implies that the integration supports setting the input’s connection type.
`friendlyName`	`string`	A user-friendly name for this input. This value provides a consistent identifier for the input, regardless of the device’s internal naming. For example: “HDMI1”.
`id`	`string`	The unique identifier for this input. This is used when setting the active input.
`label`	`Label \| null`	The input’s label, as stored on the device itself. E.g. “Playstation”, “Blu-ray”, “Cable Box”, etc… This is typically user-configurable on the device, and may be null if the device does not have a label for this input.
`signalPresent`	`SignalPresentEnum \| null`	Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`ConnectionPresentEnum`

Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Label`

Property	Type	Required	Description
`canSet`	`boolean`
`label`	`string`

`SignalPresentEnum`

Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

setInputCECMode

Enable or disable CEC control for a specific input.

Parameter

Type Definitions

`SetInputCECModeParams`

Property	Type	Required	Description
`args`	`SetInputCECModeArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetInputCECModeArgs`

Property	Type	Required	Description
`inputId`	`string`	✓
`modeId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: id, friendlyName, label, canActivate, connectionTypes, connectionType, cecModes, cecMode, arcModes, arcMode, signalPresent, connectionPresent.

Result

Type Definitions

`SetInputCECModeResult`

Input represents a physical input on the device, such as an HDMI port, a tuner, etc…

Property	Type	Description
`arcMode`	`KeyValuePair \| null`	The active ARC mode for this input. This field is only populated if the display supports reporting the current ARC mode on a per-input basis. See the inputs object’s arcMode field for more information.
`arcModes`	`KeyValuePair[] \| null`	A list of ARC modes supported by this input. This field is only populated if the display supports reporting ARC modes on a per-input basis. See the inputs object’s arcModes field for more information.
`canActivate`	`boolean`	Communicates whether this input can be selected as the active input. This value reflects the current state of the input, not the overall capability of the device or integration. For example, an HDMI input with no cable connected may have canActivate = false, even though the device supports activating that input.
`cecMode`	`KeyValuePair \| null`	The active CEC mode for this input. This field is only populated if the display supports reporting the current CEC mode on a per-input basis. See the inputs object’s cecMode field for more information.
`cecModes`	`KeyValuePair[] \| null`	A list of CEC modes supported by this input. This field is only populated if the display supports reporting CEC modes on a per-input basis. See the inputs object’s cecModes field for more information.
`connectionPresent`	`ConnectionPresentEnum \| null`	Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:
`connectionType`	`KeyValuePair`
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this input supports. For example: “COMPONENT vs or COMPOSITE” or “HDMI with Optical Audio”. In many cases, this field is not applicable. In which case it may be null or empty. A non-empty list implies that the integration supports setting the input’s connection type.
`friendlyName`	`string`	A user-friendly name for this input. This value provides a consistent identifier for the input, regardless of the device’s internal naming. For example: “HDMI1”.
`id`	`string`	The unique identifier for this input. This is used when setting the active input.
`label`	`Label \| null`	The input’s label, as stored on the device itself. E.g. “Playstation”, “Blu-ray”, “Cable Box”, etc… This is typically user-configurable on the device, and may be null if the device does not have a label for this input.
`signalPresent`	`SignalPresentEnum \| null`	Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`ConnectionPresentEnum`

Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Label`

Property	Type	Required	Description
`canSet`	`boolean`
`label`	`string`

`SignalPresentEnum`

Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

setInputConnectionType

Set the input port type, such as HDMI or DisplayPort.

Parameter

Type Definitions

`SetInputConnectionTypeParams`

Property	Type	Required	Description
`args`	`SetInputConnectionTypeArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetInputConnectionTypeArgs`

Property	Type	Required	Description
`inputId`	`string`	✓
`typeId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: id, friendlyName, label, canActivate, connectionTypes, connectionType, cecModes, cecMode, arcModes, arcMode, signalPresent, connectionPresent.

Result

Type Definitions

`SetInputConnectionTypeResult`

Input represents a physical input on the device, such as an HDMI port, a tuner, etc…

Property	Type	Description
`arcMode`	`KeyValuePair \| null`	The active ARC mode for this input. This field is only populated if the display supports reporting the current ARC mode on a per-input basis. See the inputs object’s arcMode field for more information.
`arcModes`	`KeyValuePair[] \| null`	A list of ARC modes supported by this input. This field is only populated if the display supports reporting ARC modes on a per-input basis. See the inputs object’s arcModes field for more information.
`canActivate`	`boolean`	Communicates whether this input can be selected as the active input. This value reflects the current state of the input, not the overall capability of the device or integration. For example, an HDMI input with no cable connected may have canActivate = false, even though the device supports activating that input.
`cecMode`	`KeyValuePair \| null`	The active CEC mode for this input. This field is only populated if the display supports reporting the current CEC mode on a per-input basis. See the inputs object’s cecMode field for more information.
`cecModes`	`KeyValuePair[] \| null`	A list of CEC modes supported by this input. This field is only populated if the display supports reporting CEC modes on a per-input basis. See the inputs object’s cecModes field for more information.
`connectionPresent`	`ConnectionPresentEnum \| null`	Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:
`connectionType`	`KeyValuePair`
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this input supports. For example: “COMPONENT vs or COMPOSITE” or “HDMI with Optical Audio”. In many cases, this field is not applicable. In which case it may be null or empty. A non-empty list implies that the integration supports setting the input’s connection type.
`friendlyName`	`string`	A user-friendly name for this input. This value provides a consistent identifier for the input, regardless of the device’s internal naming. For example: “HDMI1”.
`id`	`string`	The unique identifier for this input. This is used when setting the active input.
`label`	`Label \| null`	The input’s label, as stored on the device itself. E.g. “Playstation”, “Blu-ray”, “Cable Box”, etc… This is typically user-configurable on the device, and may be null if the device does not have a label for this input.
`signalPresent`	`SignalPresentEnum \| null`	Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`ConnectionPresentEnum`

Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Label`

Property	Type	Required	Description
`canSet`	`boolean`
`label`	`string`

`SignalPresentEnum`

Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

setInputLabel

Name an input, such as Apple TV or HDMI 1.

Parameter

Type Definitions

`SetInputLabelParams`

Property	Type	Required	Description
`args`	`SetInputLabelArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetInputLabelArgs`

Property	Type	Required	Description
`inputId`	`string`	✓
`label`	`string`	✓

`IncludeFieldsEnum`

enum

One of: id, friendlyName, label, canActivate, connectionTypes, connectionType, cecModes, cecMode, arcModes, arcMode, signalPresent, connectionPresent.

Result

Type Definitions

`SetInputLabelResult`

Input represents a physical input on the device, such as an HDMI port, a tuner, etc…

Property	Type	Description
`arcMode`	`KeyValuePair \| null`	The active ARC mode for this input. This field is only populated if the display supports reporting the current ARC mode on a per-input basis. See the inputs object’s arcMode field for more information.
`arcModes`	`KeyValuePair[] \| null`	A list of ARC modes supported by this input. This field is only populated if the display supports reporting ARC modes on a per-input basis. See the inputs object’s arcModes field for more information.
`canActivate`	`boolean`	Communicates whether this input can be selected as the active input. This value reflects the current state of the input, not the overall capability of the device or integration. For example, an HDMI input with no cable connected may have canActivate = false, even though the device supports activating that input.
`cecMode`	`KeyValuePair \| null`	The active CEC mode for this input. This field is only populated if the display supports reporting the current CEC mode on a per-input basis. See the inputs object’s cecMode field for more information.
`cecModes`	`KeyValuePair[] \| null`	A list of CEC modes supported by this input. This field is only populated if the display supports reporting CEC modes on a per-input basis. See the inputs object’s cecModes field for more information.
`connectionPresent`	`ConnectionPresentEnum \| null`	Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:
`connectionType`	`KeyValuePair`
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this input supports. For example: “COMPONENT vs or COMPOSITE” or “HDMI with Optical Audio”. In many cases, this field is not applicable. In which case it may be null or empty. A non-empty list implies that the integration supports setting the input’s connection type.
`friendlyName`	`string`	A user-friendly name for this input. This value provides a consistent identifier for the input, regardless of the device’s internal naming. For example: “HDMI1”.
`id`	`string`	The unique identifier for this input. This is used when setting the active input.
`label`	`Label \| null`	The input’s label, as stored on the device itself. E.g. “Playstation”, “Blu-ray”, “Cable Box”, etc… This is typically user-configurable on the device, and may be null if the device does not have a label for this input.
`signalPresent`	`SignalPresentEnum \| null`	Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`ConnectionPresentEnum`

Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Label`

Property	Type	Required	Description
`canSet`	`boolean`
`label`	`string`

`SignalPresentEnum`

Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

setInputsARCMode

Selects the target ARC mode for the display. This action only applies to integrations that expose arcModes only at the global level–not per input.

The per input method is setInputARCMode.

Parameter

Type Definitions

`SetInputsARCModeParams`

Property	Type	Required	Description
`args`	`SetInputsARCModeArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetInputsARCModeArgs`

Property	Type	Required	Description
`modeId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: available, active.

Result

Type Definitions

`SetInputsARCModeResult`

Property	Type	Required	Description
`active`	`KeyValuePair \| null`		If the display does not support reporting the current ARC mode on a per-input basis, this field may be populated with the active ARC mode. See the arcModes field for more information.
`available`	`KeyValuePair[] \| null`		If the display does not support reporting ARC modes on a per-input basis, this field may be populated with the list of ARC modes the display supports. Typical modes might include “ARC”, “eARC”, or “Disabled”. If the display does support reporting ARC modes on a per-input basis, this field should be null, and the modes should be listed on the individual input(s) instead.

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

setInputsActive

Switch to a specific input, such as HDMI 1 or HDMI 2.

Parameter

Type Definitions

`SetInputsActiveParams`

Property	Type	Required	Description
`args`	`SetInputsActiveArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetInputsActiveArgs`

Property	Type	Required	Description
`contextId`	`string`	✓
`inputId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: id, source, canReportSource, input, canReportInput, outputs.

Result

Type Definitions

`SetInputsActiveResult`

Property	Type	Description
`canReportInput`	`boolean`	Indicates whether the device is capable of reporting the currently active input. When true, the input field will be populated with the active input–if there is an active input; when false, the input field should always be null and will be ignored.
`canReportSource`	`boolean`	Indicates whether the device is capable of reporting the currently active application/source. When true, the source field will be populated with the active application/source–if there is an active application; when false, the source field should always be null and will be ignored.
`id`	`string`	The unique identifier for this context.
`input`	`Input \| null`	The physical input that is currently active on the device. This may be null if there is no active input, or if the device does not report this information.
`outputs`	`Output[] \| null`	The output(s) that are currently active on the device. This may be null or empty if there are no active outputs, or if the device does not report this information.
`source`	`AppSource \| null`	The application/source that is currently active on the device. This does not include physical inputs, which are represented separately by the input field. If there is no active application/source, or the device does not report this information, this field may be null.

`Input`

Input represents a physical input on the device, such as an HDMI port, a tuner, etc…

Property	Type	Description
`arcMode`	`KeyValuePair \| null`	The active ARC mode for this input. This field is only populated if the display supports reporting the current ARC mode on a per-input basis. See the inputs object’s arcMode field for more information.
`arcModes`	`KeyValuePair[] \| null`	A list of ARC modes supported by this input. This field is only populated if the display supports reporting ARC modes on a per-input basis. See the inputs object’s arcModes field for more information.
`canActivate`	`boolean`	Communicates whether this input can be selected as the active input. This value reflects the current state of the input, not the overall capability of the device or integration. For example, an HDMI input with no cable connected may have canActivate = false, even though the device supports activating that input.
`cecMode`	`KeyValuePair \| null`	The active CEC mode for this input. This field is only populated if the display supports reporting the current CEC mode on a per-input basis. See the inputs object’s cecMode field for more information.
`cecModes`	`KeyValuePair[] \| null`	A list of CEC modes supported by this input. This field is only populated if the display supports reporting CEC modes on a per-input basis. See the inputs object’s cecModes field for more information.
`connectionPresent`	`ConnectionPresentEnum \| null`	Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:
`connectionType`	`KeyValuePair`
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this input supports. For example: “COMPONENT vs or COMPOSITE” or “HDMI with Optical Audio”. In many cases, this field is not applicable. In which case it may be null or empty. A non-empty list implies that the integration supports setting the input’s connection type.
`friendlyName`	`string`	A user-friendly name for this input. This value provides a consistent identifier for the input, regardless of the device’s internal naming. For example: “HDMI1”.
`id`	`string`	The unique identifier for this input. This is used when setting the active input.
`label`	`Label \| null`	The input’s label, as stored on the device itself. E.g. “Playstation”, “Blu-ray”, “Cable Box”, etc… This is typically user-configurable on the device, and may be null if the device does not have a label for this input.
`signalPresent`	`SignalPresentEnum \| null`	Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN. - “TRUE”: - “FALSE”: - “UNKNOWN”:

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`ConnectionPresentEnum`

Communicates whether a physical connection is detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Label`

Property	Type	Required	Description
`canSet`	`boolean`
`label`	`string`

`SignalPresentEnum`

Communicates whether an active signal can be detected on this input. If this value is not supported, it may be null or UNKNOWN.

“TRUE”:
“FALSE”:
“UNKNOWN”:

enum

One of: TRUE, FALSE, UNKNOWN.

`Output`

Represents an individual physical output on the device, such as TV speakers, an ARC-connected soundbar, a headphone jack, etc…

Property	Type	Description
`audio`	`OutputAudio \| null`	The current state of audio on this output. This may be null if the display does not report audio information for individual outputs, in which case the allAudio field on the outputs object should be used–if possible.
`connectionType`	`KeyValuePair \| null`	The active connectionType for this output. Even if connectionTypes is empty or not supported, this field must be populated. For example a TV speaker output may have the type “Digital Optical” and a canonicalId of “CONN:OPTICAL”.
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this output supports. For example: “Digital Optical”, “Digital Coax”, “RCA”. In many cases, this field is not applicable. In which case it may be null. A non-null value implies that the integration supports setting the output’s connection type.
`friendlyName`	`string`	A user-friendly name for this output.
`id`	`string`	A unique identifier for this output. This is used when setting the active output.

`OutputAudio`

Reports the audio status for an individual output, or the display as a whole (in the case of the outputs.allAudio field).

Property	Type	Description
`format`	`KeyValuePair \| null`	The current audio format being streamed over this output. For example: “Dolby Atmos”, “DTS:X”, “PCM Stereo”, etc…
`muted`	`boolean \| null`	Whether the audio is currently muted. This value should be null if the mute status cannot be known.
`volume`	`Volume \| null`	The current volume level of the output or display. This value should be null if the volume level cannot be known.

`Volume`

Represents the volume level of an external output, such as the TV speakers, an ARC-connected soundbar, or a headphone jack.

Property	Type	Description
`level`	`number`	The current volume level, represented as an integer between min and max (inclusive).
`max`	`number \| null`	The maximum volume level supported by this output. This may be null if the display does not report a maximum volume level.
`min`	`number \| null`	The minimum volume level supported by this output. This may be null if the display does not report a minimum volume level.
`step`	`number \| null`	An integer representing the step size for volume changes. For example, a step of 5 means that the volume is changed in increments of 5 (e.g. 0, 5, 10, 15, etc…). This may be null if the display does not report a volume step size.

`AppSource`

Property	Type	Required	Description
`canActivate`	`boolean`
`canTerminate`	`boolean`
`canonicalId`	`string \| null`
`friendlyName`	`string`
`id`	`string`

setInputsCECMode

Selects the target CEC mode for the display. This action only applies to integrations that expose cecModes only at the global level–not per input.

The per input method is setInputCECMode.

Parameter

Type Definitions

`SetInputsCECModeParams`

Property	Type	Required	Description
`args`	`SetInputsCECModeArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetInputsCECModeArgs`

Property	Type	Required	Description
`modeId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: available, active.

Result

Type Definitions

`SetInputsCECModeResult`

Property	Type	Required	Description
`active`	`KeyValuePair \| null`		If the display does not support reporting the current CEC mode on a per-input basis, this field may be populated with the active CEC mode. See the cecModes field for more information.
`available`	`KeyValuePair[] \| null`		If the display does not support reporting CEC modes on a per-input basis, this field may be populated with the list of CEC modes the display supports. In many cases, this may be as simple “Enabled” or “Disabled”. If the display does support reporting CEC modes on a per-input basis, this field should be null, and the modes should be listed on the individual input(s) instead.

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

setNetworkConfig

Parameter

Type Definitions

`SetNetworkConfigParams`

Property	Type	Required	Description
`args`	`SetNetworkConfigArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetNetworkConfigArgs`

Property	Type	Required	Description
`config`	`NetworkConfigInput`	✓	Updates to apply to the device’s network configuration.

`NetworkConfigInput`

Updates to apply to the device’s network configuration.

Property	Type	Required	Description
`interfaces`	`NetworkInterfaceConfigInput[]`	✓	The interfaces to update, with their configuration.

`NetworkInterfaceConfigInput`

Used when updating the network interface configuration for a device.

Property	Type	Required	Description
`enabled`	`boolean \| null`		Whether to enable or disable this network interface. This value is only relevant when the network interface canEnable field is non-null. A null value in this field should be treated as “no change” to the enabled status of the network interface.
`id`	`string`	✓	The unique identifier of the network interface to update the configuration for.
`ipv4`	`NetworkIPv4ConfigInput \| null`		The configuration for the network interface’s IPv4 settings. If null, the IPv4 configuration should not be changed.

`NetworkIPv4ConfigInput`

Property	Type	Required	Description
`addressType`	`AddressTypeEnum`	✓	The address type to use for the network interface. - “DHCP”: - “DHCP_STATIC_DNS”: - “STATIC”:
`static`	`IPv4StaticConfigInput \| null`		Static IPv4 configuration, if applicable.

`AddressTypeEnum`

The address type to use for the network interface.

“DHCP”:
“DHCP_STATIC_DNS”:
“STATIC”:

enum

One of: DHCP, DHCP_STATIC_DNS, STATIC.

`IPv4StaticConfigInput`

The configuration for a given static network interface.

Property	Type	Description
`address`	`string (ipv4) \| null`	IPv4 address configuration for this network interface.
`dnsServers`	`string (ipv4)[] \| null`	DNS server configuration.
`gateway`	`string (ipv4) \| null`	Gateway configuration, where applicable.
`netmask`	`string (ipv4) \| null`	Netmask configuration, where applicable.

`IncludeFieldsEnum`

enum

One of: interfaces.

Result

Type Definitions

`SetNetworkConfigResult`

The device’s network information.

Property	Type	Required	Description
`interfaces`	`NetworkInterface[] \| null`		A list of available network interfaces on the device, such as Wi-Fi adapters and Ethernet ports.

`NetworkInterface`

A network interface on the device, such as a Wi-Fi adapter or Ethernet port.

Property	Type	Description
`canEnable`	`boolean \| null`	Whether this network interface can be enabled via the integration. Null indicates the integration does not support changing the enabled status of any network interfaces. False indicates the network interface cannot be enabled, but the integration does support changing the enabled status of network interfaces where canEnable is true.
`enabled`	`boolean`	Whether this network interface is currently enabled.
`friendlyName`	`string`	A user-friendly name for this network interface, such as “Wi-Fi”, “Ethernet”, “eth0”, etc…
`id`	`string`	A unique identifier for this network interface. This is used when setting network configuration, if supported.
`ipv4`	`IPv4Settings \| null`	The IPv4 settings for this network interface.
`macAddress`	`string \| null`	The network interface’s mac address.
`wifi`	`WifiInfo \| null`	Details about the Wi-Fi connection for this network interface. If this value is null, it is assumed that the network interface is a wired connection.

`IPv4Settings`

IPv4 network settings for a network interface, including the effective configuration, static configuration, and supported address types.

Property	Type	Description
`addressType`	`AddressTypeEnum \| null`	The currently active address type for this network interface. - “DHCP”: - “DHCP_STATIC_DNS”: - “STATIC”:
`addressTypes`	`AddressTypesEnum[] \| null`	A list of supported address types for this network interface, which can be changed if canSet is true.
`canSet`	`boolean`	If true, the integration must support setting the IPv4 configuration on this interface. If false, the effective configuration is read-only and cannot be modified by the integration.
`dnsServerCount`	`number`	The number of dns servers the network interface supports. This value may be at most 3.
`effective`	`IPv4Config \| null`	The configuration currently in effect on this network interface.
`static`	`IPv4Config \| null`	Where applicable, the static IPv4 configuration for this network interface.

`AddressTypeEnum`

The currently active address type for this network interface.

“DHCP”:
“DHCP_STATIC_DNS”:
“STATIC”:

enum

One of: DHCP, DHCP_STATIC_DNS, STATIC.

`AddressTypesEnum`

“DHCP”:
“DHCP_STATIC_DNS”:
“STATIC”:

enum

One of: DHCP, DHCP_STATIC_DNS, STATIC.

`IPv4Config`

The IPv4 configuration for a network interface, including the assigned address, netmask, gateway, and dns servers.

Property	Type	Description
`address`	`string (ipv4) \| null`	The IPv4 address assigned to the device. This may be null if the device does not expose this information.
`dnsServers`	`string (ipv4)[] \| null`	A list of dns servers assigned to the device. The list must return at most 3 servers.
`gateway`	`string (ipv4) \| null`	The IPv4 gateway assigned to the device.
`netmask`	`string (ipv4) \| null`	The IPv4 netmask assigned to the device.

`WifiInfo`

Property	Type	Required	Description
`ssid`	`string \| null`		The SSID of the currently connected Wi-Fi network, if applicable.

setOutputConnectionType

Output port type, such as HDMI or optical audio.

Parameter

Type Definitions

`SetOutputConnectionTypeParams`

Property	Type	Required	Description
`args`	`SetOutputConnectionTypeArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetOutputConnectionTypeArgs`

Property	Type	Required	Description
`outputId`	`string`	✓
`typeId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: id, friendlyName, connectionTypes, connectionType, audio.

Result

Type Definitions

`SetOutputConnectionTypeResult`

Represents an individual physical output on the device, such as TV speakers, an ARC-connected soundbar, a headphone jack, etc…

Property	Type	Description
`audio`	`OutputAudio \| null`	The current state of audio on this output. This may be null if the display does not report audio information for individual outputs, in which case the allAudio field on the outputs object should be used–if possible.
`connectionType`	`KeyValuePair \| null`	The active connectionType for this output. Even if connectionTypes is empty or not supported, this field must be populated. For example a TV speaker output may have the type “Digital Optical” and a canonicalId of “CONN:OPTICAL”.
`connectionTypes`	`KeyValuePair[] \| null`	A list of connection types that this output supports. For example: “Digital Optical”, “Digital Coax”, “RCA”. In many cases, this field is not applicable. In which case it may be null. A non-null value implies that the integration supports setting the output’s connection type.
`friendlyName`	`string`	A user-friendly name for this output.
`id`	`string`	A unique identifier for this output. This is used when setting the active output.

`OutputAudio`

Reports the audio status for an individual output, or the display as a whole (in the case of the outputs.allAudio field).

Property	Type	Description
`format`	`KeyValuePair \| null`	The current audio format being streamed over this output. For example: “Dolby Atmos”, “DTS:X”, “PCM Stereo”, etc…
`muted`	`boolean \| null`	Whether the audio is currently muted. This value should be null if the mute status cannot be known.
`volume`	`Volume \| null`	The current volume level of the output or display. This value should be null if the volume level cannot be known.

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

`Volume`

Represents the volume level of an external output, such as the TV speakers, an ARC-connected soundbar, or a headphone jack.

Property	Type	Description
`level`	`number`	The current volume level, represented as an integer between min and max (inclusive).
`max`	`number \| null`	The maximum volume level supported by this output. This may be null if the display does not report a maximum volume level.
`min`	`number \| null`	The minimum volume level supported by this output. This may be null if the display does not report a minimum volume level.
`step`	`number \| null`	An integer representing the step size for volume changes. For example, a step of 5 means that the volume is changed in increments of 5 (e.g. 0, 5, 10, 15, etc…). This may be null if the display does not report a volume step size.

setPowerPowerSavingMode

Power-saving mode for the display, such as sleep.

Parameter

Type Definitions

`SetPowerPowerSavingModeParams`

Property	Type	Required	Description
`args`	`SetPowerPowerSavingModeArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetPowerPowerSavingModeArgs`

Property	Type	Required	Description
`modeId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: available, active.

Result

Type Definitions

`SetPowerPowerSavingModeResult`

Property	Type	Required	Description
`active`	`KeyValuePair \| null`
`available`	`KeyValuePair[] \| null`

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

setPowerState

Turn the display on, off, or wake it up.

Parameter

Type Definitions

`SetPowerStateParams`

Property	Type	Required	Description
`args`	`SetPowerStateArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetPowerStateArgs`

Property	Type	Required	Description
`state`	`StateEnum`	✓	- “ON”: - “STANDBY”: - “OFF”:

`StateEnum`

“ON”:
“STANDBY”:
“OFF”:

enum

One of: ON, STANDBY, OFF.

`IncludeFieldsEnum`

enum

One of: current, allowedPowerState.

Result

Type Definitions

`SetPowerStateResult`

Property	Type	Required	Description
`allowedPowerState`	`AllowedPowerStateEnum \| null`		If non-null, denotes the integration supports the setPowerPowerState method. - “ON”: - “STANDBY”: - “OFF”:
`current`	`CurrentEnum \| null`		- “ON”: - “STANDBY”: - “UNKNOWN”:

`AllowedPowerStateEnum`

If non-null, denotes the integration supports the setPowerPowerState method.

“ON”:
“STANDBY”:
“OFF”:

enum

One of: ON, STANDBY, OFF.

`CurrentEnum`

“ON”:
“STANDBY”:
“UNKNOWN”:

enum

One of: ON, STANDBY, UNKNOWN.

setPowerWakeOnLan

Parameter

Type Definitions

`SetPowerWakeOnLanParams`

Property	Type	Required	Description
`args`	`SetPowerWakeOnLanArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetPowerWakeOnLanArgs`

Property	Type	Required	Description
`mode`	`ModeEnum`	✓	- “ENABLED”: - “DISABLED”:

`ModeEnum`

“ENABLED”:
“DISABLED”:

enum

One of: ENABLED, DISABLED.

`IncludeFieldsEnum`

enum

One of: mode, canSet.

Result

Type Definitions

`SetPowerWakeOnLanResult`

Property	Type	Required	Description
`canSet`	`boolean`
`mode`	`ModeEnum`		- “ENABLED”: - “DISABLED”:

`ModeEnum`

“ENABLED”:
“DISABLED”:

enum

One of: ENABLED, DISABLED.

setSystemCountry

Sets the system country, providing a countryId from the list of available languages returned by getSystem.

Parameter

Type Definitions

`SetSystemCountryParams`

Property	Type	Required	Description
`args`	`SetSystemCountryArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetSystemCountryArgs`

Property	Type	Required	Description
`countryId`	`string`	✓

`IncludeFieldsEnum`

enum

One of: available, active.

Result

Type Definitions

`SetSystemCountryResult`

Property	Type	Required	Description
`active`	`KeyValuePair \| null`
`available`	`KeyValuePair[] \| null`

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

Property	Type	Required	Description
`args`	`SetSystemLabelArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetSystemLabelArgs`

Property	Type	Required	Description
`label`	`string`	✓

Property	Type	Required	Description
`canSet`	`boolean`
`label`	`string`

Property	Type	Required	Description
`args`	`SetSystemLanguageArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetSystemLanguageArgs`

Property	Type	Required	Description
`languageId`	`string`	✓

Property	Type	Required	Description
`active`	`KeyValuePair \| null`
`available`	`KeyValuePair[] \| null`

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

Property	Type	Required	Description
`args`	`SetVideoAspectRatioArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetVideoAspectRatioArgs`

Property	Type	Required	Description
`aspectRatioId`	`string`	✓

Property	Type	Required	Description
`active`	`KeyValuePair \| null`
`available`	`KeyValuePair[] \| null`

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

Property	Type	Required	Description
`args`	`SetVideoPictureModeArgs`	✓
`includeFields`	`IncludeFieldsEnum[]`

`SetVideoPictureModeArgs`

Property	Type	Required	Description
`modeId`	`string`	✓

Property	Type	Required	Description
`active`	`KeyValuePair \| null`
`available`	`KeyValuePair[] \| null`

`KeyValuePair`

Property	Type	Required	Description
`canonicalId`	`string \| null`
`friendlyName`	`string`
`key`	`string`

Keyboard shortcuts

OvrC Integration Developer Documentation