RemoteControlCapabilities Class Reference
Constructors
Instance Methods
- getAudioControlCapabilities() ⇒
Array.<AudioControlCapabilities> - getButtonCapabilities() ⇒
Array.<ButtonCapabilities> - getClimateControlCapabilities() ⇒
Array.<ClimateControlCapabilities> - getHmiSettingsControlCapabilities() ⇒
HMISettingsControlCapabilities - getLightControlCapabilities() ⇒
LightControlCapabilities - getRadioControlCapabilities() ⇒
Array.<RadioControlCapabilities> - getSeatControlCapabilities() ⇒
Array.<SeatControlCapabilities> - setAudioControlCapabilities(capabilities) ⇒
RemoteControlCapabilities - setButtonCapabilities(capabilities) ⇒
RemoteControlCapabilities - setClimateControlCapabilities(capabilities) ⇒
RemoteControlCapabilities - setHmiSettingsControlCapabilities(capabilities) ⇒
RemoteControlCapabilities - setLightControlCapabilities(capabilities) ⇒
RemoteControlCapabilities - setRadioControlCapabilities(capabilities) ⇒
RemoteControlCapabilities - setSeatControlCapabilities(capabilities) ⇒
RemoteControlCapabilities
Constructors
new RemoteControlCapabilities(parameters)
Initializes an instance of RemoteControlCapabilities.
Instance Methods
remoteControlCapabilities.getAudioControlCapabilities() ⇒ Array.<AudioControlCapabilities>
Get the AudioControlCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: Array.<AudioControlCapabilities> - the KEY_AUDIO_CONTROL_CAPABILITIES value
remoteControlCapabilities.getButtonCapabilities() ⇒ Array.<ButtonCapabilities>
Get the ButtonCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: Array.<ButtonCapabilities> - the KEY_BUTTON_CAPABILITIES value
remoteControlCapabilities.getClimateControlCapabilities() ⇒ Array.<ClimateControlCapabilities>
Get the ClimateControlCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: Array.<ClimateControlCapabilities> - the KEY_CLIMATE_CONTROL_CAPABILITIES value
remoteControlCapabilities.getHmiSettingsControlCapabilities() ⇒ HMISettingsControlCapabilities
Get the HmiSettingsControlCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: HMISettingsControlCapabilities - the KEY_HMI_SETTINGS_CONTROL_CAPABILITIES value
remoteControlCapabilities.getLightControlCapabilities() ⇒ LightControlCapabilities
Get the LightControlCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: LightControlCapabilities - the KEY_LIGHT_CONTROL_CAPABILITIES value
remoteControlCapabilities.getRadioControlCapabilities() ⇒ Array.<RadioControlCapabilities>
Get the RadioControlCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: Array.<RadioControlCapabilities> - the KEY_RADIO_CONTROL_CAPABILITIES value
remoteControlCapabilities.getSeatControlCapabilities() ⇒ Array.<SeatControlCapabilities>
Get the SeatControlCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: Array.<SeatControlCapabilities> - the KEY_SEAT_CONTROL_CAPABILITIES value
remoteControlCapabilities.setAudioControlCapabilities(capabilities) ⇒ RemoteControlCapabilities
Set the AudioControlCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: RemoteControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<AudioControlCapabilities> |
If included, the platform supports audio controls. - The desired AudioControlCapabilities. {'array_min_size': 1, 'array_max_size': 100} |
remoteControlCapabilities.setButtonCapabilities(capabilities) ⇒ RemoteControlCapabilities
Set the ButtonCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: RemoteControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<ButtonCapabilities> |
If included, the platform supports RC button controls with the included button names. NOTE: Multiple button capabilities can exist for the same ButtonName with different module ids. The module Id for a button should match the module id for a "primary" module type, such as a climate module or a radio module. Whichever module the id matches the button's id is the module the button will control. - The desired ButtonCapabilities. {'array_min_size': 1, 'array_max_size': 100} |
remoteControlCapabilities.setClimateControlCapabilities(capabilities) ⇒ RemoteControlCapabilities
Set the ClimateControlCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: RemoteControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<ClimateControlCapabilities> |
If included, the platform supports RC climate controls. For this baseline version, maxsize=1. i.e. only one climate control module is supported. - The desired ClimateControlCapabilities. {'array_min_size': 1, 'array_max_size': 100} |
remoteControlCapabilities.setHmiSettingsControlCapabilities(capabilities) ⇒ RemoteControlCapabilities
Set the HmiSettingsControlCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: RemoteControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | HMISettingsControlCapabilities |
If included, the platform supports hmi setting controls. - The desired HmiSettingsControlCapabilities. |
remoteControlCapabilities.setLightControlCapabilities(capabilities) ⇒ RemoteControlCapabilities
Set the LightControlCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: RemoteControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | LightControlCapabilities |
If included, the platform supports light controls. - The desired LightControlCapabilities. |
remoteControlCapabilities.setRadioControlCapabilities(capabilities) ⇒ RemoteControlCapabilities
Set the RadioControlCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: RemoteControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<RadioControlCapabilities> |
If included, the platform supports RC radio controls. - The desired RadioControlCapabilities. {'array_min_size': 1, 'array_max_size': 100} |
remoteControlCapabilities.setSeatControlCapabilities(capabilities) ⇒ RemoteControlCapabilities
Set the SeatControlCapabilities
Kind: Instance method of RemoteControlCapabilities
Returns: RemoteControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| capabilities | Array.<SeatControlCapabilities> |
If included, the platform supports seat controls. - The desired SeatControlCapabilities. {'array_min_size': 1, 'array_max_size': 100} |