AudioControlCapabilities Class Reference
Constructors
Instance Methods
- getEqualizerAvailable() ⇒
Boolean - getEqualizerMaxChannelId() ⇒
Number - getKeepContextAvailable() ⇒
Boolean - getModuleInfo() ⇒
ModuleInfo - getModuleName() ⇒
String - getSourceAvailable() ⇒
Boolean - getVolumeAvailable() ⇒
Boolean - setEqualizerAvailable(available) ⇒
AudioControlCapabilities - setEqualizerMaxChannelId(id) ⇒
AudioControlCapabilities - setKeepContextAvailable(available) ⇒
AudioControlCapabilities - setModuleInfo(info) ⇒
AudioControlCapabilities - setModuleName(name) ⇒
AudioControlCapabilities - setSourceAvailable(available) ⇒
AudioControlCapabilities - setVolumeAvailable(available) ⇒
AudioControlCapabilities
Constructors
new AudioControlCapabilities(parameters)
Initializes an instance of AudioControlCapabilities.
Instance Methods
audioControlCapabilities.getEqualizerAvailable() ⇒ Boolean
Get the EqualizerAvailable
Kind: Instance method of AudioControlCapabilities
Returns: Boolean - the KEY_EQUALIZER_AVAILABLE value
audioControlCapabilities.getEqualizerMaxChannelId() ⇒ Number
Get the EqualizerMaxChannelId
Kind: Instance method of AudioControlCapabilities
Returns: Number - the KEY_EQUALIZER_MAX_CHANNEL_ID value
audioControlCapabilities.getKeepContextAvailable() ⇒ Boolean
Get the KeepContextAvailable
Kind: Instance method of AudioControlCapabilities
Returns: Boolean - the KEY_KEEP_CONTEXT_AVAILABLE value
audioControlCapabilities.getModuleInfo() ⇒ ModuleInfo
Get the ModuleInfo
Kind: Instance method of AudioControlCapabilities
Returns: ModuleInfo - the KEY_MODULE_INFO value
audioControlCapabilities.getModuleName() ⇒ String
Get the ModuleName
Kind: Instance method of AudioControlCapabilities
Returns: String - the KEY_MODULE_NAME value
audioControlCapabilities.getSourceAvailable() ⇒ Boolean
Get the SourceAvailable
Kind: Instance method of AudioControlCapabilities
Returns: Boolean - the KEY_SOURCE_AVAILABLE value
audioControlCapabilities.getVolumeAvailable() ⇒ Boolean
Get the VolumeAvailable
Kind: Instance method of AudioControlCapabilities
Returns: Boolean - the KEY_VOLUME_AVAILABLE value
audioControlCapabilities.setEqualizerAvailable(available) ⇒ AudioControlCapabilities
Set the EqualizerAvailable
Kind: Instance method of AudioControlCapabilities
Returns: AudioControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of Equalizer Settings. - The desired EqualizerAvailable. |
audioControlCapabilities.setEqualizerMaxChannelId(id) ⇒ AudioControlCapabilities
Set the EqualizerMaxChannelId
Kind: Instance method of AudioControlCapabilities
Returns: AudioControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| id | Number |
Must be included if equalizerAvailable=true, and assume all IDs starting from 1 to this value are valid - The desired EqualizerMaxChannelId. {'num_min_value': 1, 'num_max_value': 100} |
audioControlCapabilities.setKeepContextAvailable(available) ⇒ AudioControlCapabilities
Set the KeepContextAvailable
Kind: Instance method of AudioControlCapabilities
Returns: AudioControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the keepContext parameter. - The desired KeepContextAvailable. |
audioControlCapabilities.setModuleInfo(info) ⇒ AudioControlCapabilities
Set the ModuleInfo
Kind: Instance method of AudioControlCapabilities
Returns: AudioControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| info | ModuleInfo |
Information about an RC module, including its id. - The desired ModuleInfo. |
audioControlCapabilities.setModuleName(name) ⇒ AudioControlCapabilities
Set the ModuleName
Kind: Instance method of AudioControlCapabilities
Returns: AudioControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| name | String |
The short friendly name of the audio control module. It should not be used to identify a module by mobile application. - The desired ModuleName. {'string_min_length': 1, 'string_max_length': 100} |
audioControlCapabilities.setSourceAvailable(available) ⇒ AudioControlCapabilities
Set the SourceAvailable
Kind: Instance method of AudioControlCapabilities
Returns: AudioControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of audio source. - The desired SourceAvailable. |
audioControlCapabilities.setVolumeAvailable(available) ⇒ AudioControlCapabilities
Set the VolumeAvailable
Kind: Instance method of AudioControlCapabilities
Returns: AudioControlCapabilities - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| available | Boolean |
Availability of the control of audio volume. - The desired VolumeAvailable. |