Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
AddCommand

AddCommand Class Reference

Constructors

Instance Methods

Constructors

new AddCommand(parameters)

Initalizes an instance of AddCommand.

Instance Methods

addCommand.getCmdID() ⇒ Number

Get the CmdID

Kind: Instance method of AddCommand
Returns: Number - the KEY_CMD_ID value

addCommand.getCmdIcon() ⇒ Image

Get the CmdIcon

Kind: Instance method of AddCommand
Returns: Image - the KEY_CMD_ICON value

addCommand.getMenuParams() ⇒ MenuParams

Get the MenuParams

Kind: Instance method of AddCommand
Returns: MenuParams - the KEY_MENU_PARAMS value

addCommand.getVrCommands() ⇒ Array.<String>

Get the VrCommands

Kind: Instance method of AddCommand
Returns: Array.<String> - the KEY_VR_COMMANDS value

addCommand.setCmdID(id) ⇒ AddCommand

Set the CmdID

Kind: Instance method of AddCommand
Returns: AddCommand - The class instance for method chaining.

ParamTypeDescription
id Number unique ID of the command to add. - The desired CmdID.

addCommand.setCmdIcon(icon) ⇒ AddCommand

Set the CmdIcon

Kind: Instance method of AddCommand
Returns: AddCommand - The class instance for method chaining.

ParamTypeDescription
icon Image Image struct determining whether static or dynamic icon. If omitted on supported displays, - The desired CmdIcon. no (or the default if applicable) icon shall be displayed.

addCommand.setMenuParams(params) ⇒ AddCommand

Set the MenuParams

Kind: Instance method of AddCommand
Returns: AddCommand - The class instance for method chaining.

ParamTypeDescription
params MenuParams Optional sub value containing menu parameters - The desired MenuParams.

addCommand.setVrCommands(commands) ⇒ AddCommand

Set the VrCommands

Kind: Instance method of AddCommand
Returns: AddCommand - The class instance for method chaining.

ParamTypeDescription
commands Array.<String> An array of strings to be used as VR synonyms for this command. If this array is - The desired VrCommands. provided, it may not be empty.
View on GitHub.com
Previous Section Next Section