com.smartdevicelink.proxy.rpc

Class AudioControlCapabilities

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.AudioControlCapabilities

All Implemented Interfaces:

Cloneable

public class AudioControlCapabilities
extends RPCStruct

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_EQUALIZER_AVAILABLE
static String	KEY_EQUALIZER_MAX_CHANNEL_ID
static String	KEY_KEEP_CONTEXT_AVAILABLE
static String	KEY_MODULE_INFO
static String	KEY_MODULE_NAME
static String	KEY_SOURCE_AVAILABLE
static String	KEY_VOLUME_AVAILABLE

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
AudioControlCapabilities() Constructs a newly allocated AudioControlCapabilities object
AudioControlCapabilities(Hashtable<String,Object> hash) Constructs a newly allocated AudioControlCapabilities object indicated by the Hashtable parameter
AudioControlCapabilities(String moduleName) Constructs a newly allocated AudioControlCapabilities object

Method Summary

Modifier and Type	Method and Description
Boolean	getEqualizerAvailable() Gets the equalizerAvailable portion of the AudioControlCapabilities class
Integer	getEqualizerMaxChannelId() Gets the equalizerMaxChannelId portion of the AudioControlCapabilities class
Boolean	getKeepContextAvailable() Gets the keepContextAvailable portion of the AudioControlCapabilities class
ModuleInfo	getModuleInfo() Gets a ModuleInfo of this capability
String	getModuleName() Gets the moduleName portion of the AudioControlCapabilities class
Boolean	getSourceAvailable() Gets the sourceAvailable portion of the AudioControlCapabilities class
Boolean	getVolumeAvailable() Gets the volumeAvailable portion of the AudioControlCapabilities class
AudioControlCapabilities	setEqualizerAvailable(Boolean equalizerAvailable) Sets the equalizerAvailable portion of the AudioControlCapabilities class
AudioControlCapabilities	setEqualizerMaxChannelId(Integer equalizerMaxChannelId) Sets the equalizerMaxChannelId portion of the AudioControlCapabilities class
AudioControlCapabilities	setKeepContextAvailable(Boolean keepContextAvailable) Sets the keepContextAvailable portion of the AudioControlCapabilities class
AudioControlCapabilities	setModuleInfo(ModuleInfo info) Sets ModuleInfo for this capability
AudioControlCapabilities	setModuleName(String moduleName) Sets the moduleName portion of the AudioControlCapabilities class
AudioControlCapabilities	setSourceAvailable(Boolean sourceAvailable) Sets the sourceAvailable portion of the AudioControlCapabilities class
AudioControlCapabilities	setVolumeAvailable(Boolean volumeAvailable) Sets the volumeAvailable portion of the AudioControlCapabilities class

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBoolean, getBulkData, getDouble, getFloat, getInteger, getLong, getMessageTypeName, getObject, getStore, getStoreValue, getString, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_MODULE_NAME

public static final String KEY_MODULE_NAME

See Also:

Constant Field Values

KEY_SOURCE_AVAILABLE

public static final String KEY_SOURCE_AVAILABLE

See Also:

Constant Field Values

KEY_KEEP_CONTEXT_AVAILABLE

public static final String KEY_KEEP_CONTEXT_AVAILABLE

See Also:

Constant Field Values

KEY_VOLUME_AVAILABLE

public static final String KEY_VOLUME_AVAILABLE

See Also:

Constant Field Values

KEY_EQUALIZER_AVAILABLE

public static final String KEY_EQUALIZER_AVAILABLE

See Also:

Constant Field Values

KEY_EQUALIZER_MAX_CHANNEL_ID

public static final String KEY_EQUALIZER_MAX_CHANNEL_ID

See Also:

Constant Field Values

KEY_MODULE_INFO

public static final String KEY_MODULE_INFO

See Also:

Constant Field Values

Constructor Detail

AudioControlCapabilities

public AudioControlCapabilities()

Constructs a newly allocated AudioControlCapabilities object

AudioControlCapabilities

public AudioControlCapabilities(Hashtable<String,Object> hash)

Constructs a newly allocated AudioControlCapabilities object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

AudioControlCapabilities

public AudioControlCapabilities(@NonNull
                                String moduleName)

Constructs a newly allocated AudioControlCapabilities object

Parameters:

moduleName - short friendly name of the audio control module.

Method Detail

setModuleName

public AudioControlCapabilities setModuleName(@NonNull
                                              String moduleName)

Sets the moduleName portion of the AudioControlCapabilities class

Parameters:

moduleName - The short friendly name of the audio control module. It should not be used to identify a module by mobile application.

getModuleName

public String getModuleName()

Gets the moduleName portion of the AudioControlCapabilities class

Returns:

String - The short friendly name of the audio control module. It should not be used to identify a module by mobile application.

setKeepContextAvailable

public AudioControlCapabilities setKeepContextAvailable(Boolean keepContextAvailable)

Sets the keepContextAvailable portion of the AudioControlCapabilities class

Parameters:

keepContextAvailable - Availability of the keepContext parameter.

getKeepContextAvailable

public Boolean getKeepContextAvailable()

Gets the keepContextAvailable portion of the AudioControlCapabilities class

Returns:

Boolean - Availability of the keepContext parameter.

setSourceAvailable

public AudioControlCapabilities setSourceAvailable(Boolean sourceAvailable)

Sets the sourceAvailable portion of the AudioControlCapabilities class

Parameters:

sourceAvailable - Availability of the control of audio source.

getSourceAvailable

public Boolean getSourceAvailable()

Gets the sourceAvailable portion of the AudioControlCapabilities class

Returns:

Boolean - Availability of the control of audio source.

setVolumeAvailable

public AudioControlCapabilities setVolumeAvailable(Boolean volumeAvailable)

Sets the volumeAvailable portion of the AudioControlCapabilities class

Parameters:

volumeAvailable - Availability of the control of audio volume.

getVolumeAvailable

public Boolean getVolumeAvailable()

Gets the volumeAvailable portion of the AudioControlCapabilities class

Returns:

Boolean - Availability of the control of audio volume.

setEqualizerAvailable

public AudioControlCapabilities setEqualizerAvailable(Boolean equalizerAvailable)

Sets the equalizerAvailable portion of the AudioControlCapabilities class

Parameters:

equalizerAvailable - Availability of the control of Equalizer Settings.

getEqualizerAvailable

public Boolean getEqualizerAvailable()

Gets the equalizerAvailable portion of the AudioControlCapabilities class

Returns:

Boolean - Availability of the control of Equalizer Settings.

setEqualizerMaxChannelId

public AudioControlCapabilities setEqualizerMaxChannelId(Integer equalizerMaxChannelId)

Sets the equalizerMaxChannelId portion of the AudioControlCapabilities class

Parameters:

equalizerMaxChannelId - Must be included if equalizerAvailable=true, and assume all IDs starting from 1 to this value are valid.

getEqualizerMaxChannelId

public Integer getEqualizerMaxChannelId()

Gets the equalizerMaxChannelId portion of the AudioControlCapabilities class

Returns:

Integer - Must be included if equalizerAvailable=true, and assume all IDs starting from 1 to this value are valid.

setModuleInfo

public AudioControlCapabilities setModuleInfo(ModuleInfo info)

Sets ModuleInfo for this capability

Parameters:

info - the ModuleInfo to be set

getModuleInfo

public ModuleInfo getModuleInfo()

Gets a ModuleInfo of this capability

Returns:

module info of this capability