AudioControlData Class Reference
Constructors
Instance Methods
- getEqualizerSettings() ⇒
Array.<EqualizerSettings> - getKeepContext() ⇒
Boolean - getSource() ⇒
PrimaryAudioSource - getVolume() ⇒
Number - setEqualizerSettings(settings) ⇒
AudioControlData - setKeepContext(context) ⇒
AudioControlData - setSource(source) ⇒
AudioControlData - setVolume(volume) ⇒
AudioControlData
Instance Methods
audioControlData.getEqualizerSettings() ⇒ Array.<EqualizerSettings>
Get the EqualizerSettings
Kind: Instance method of AudioControlData
Returns: Array.<EqualizerSettings> - the KEY_EQUALIZER_SETTINGS value
audioControlData.getKeepContext() ⇒ Boolean
Get the KeepContext
Kind: Instance method of AudioControlData
Returns: Boolean - the KEY_KEEP_CONTEXT value
audioControlData.getSource() ⇒ PrimaryAudioSource
Get the Source
Kind: Instance method of AudioControlData
Returns: PrimaryAudioSource - the KEY_SOURCE value
audioControlData.getVolume() ⇒ Number
Get the Volume
Kind: Instance method of AudioControlData
Returns: Number - the KEY_VOLUME value
audioControlData.setEqualizerSettings(settings) ⇒ AudioControlData
Set the EqualizerSettings
Kind: Instance method of AudioControlData
Returns: AudioControlData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| settings | Array.<EqualizerSettings> |
Defines the list of supported channels (band) and their current/desired settings on HMI - The desired EqualizerSettings. {'array_min_size': 1, 'array_max_size': 100} |
audioControlData.setKeepContext(context) ⇒ AudioControlData
Set the KeepContext
Kind: Instance method of AudioControlData
Returns: AudioControlData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| context | Boolean |
This parameter shall not be present in any getter responses or notifications. This parameter is optional in a setter request. The default value is false if it is not included. If it is false, the system not only changes the audio source but also brings the default application or system UI associated with the audio source to foreground. If it is true, the system only changes the audio source, but keeps the current application in foreground. - The desired KeepContext. |
audioControlData.setSource(source) ⇒ AudioControlData
Set the Source
Kind: Instance method of AudioControlData
Returns: AudioControlData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| source | PrimaryAudioSource |
In a getter response or a notification, it is the current primary audio source of the system. In a setter request, it is the target audio source that the system shall switch to. If the value is MOBILE_APP, the system shall switch to the mobile media app that issues the setter RPC. - The desired Source. |
audioControlData.setVolume(volume) ⇒ AudioControlData
Set the Volume
Kind: Instance method of AudioControlData
Returns: AudioControlData - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| volume | Number |
Reflects the volume of audio, from 0%-100%. - The desired Volume. {'num_min_value': 0, 'num_max_value': 100} |