Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation
AudioControlCapabilities

Class AudioControlCapabilities

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Quick Jump

Fields
Constructors
Methods

Fields

KEY_MODULE_NAME

public static final java.lang.String KEY_MODULE_NAME
Constant Value
"moduleName"

KEY_SOURCE_AVAILABLE

public static final java.lang.String KEY_SOURCE_AVAILABLE
Constant Value
"sourceAvailable"

KEY_KEEP_CONTEXT_AVAILABLE

public static final java.lang.String KEY_KEEP_CONTEXT_AVAILABLE
Constant Value
"keepContextAvailable"

KEY_VOLUME_AVAILABLE

public static final java.lang.String KEY_VOLUME_AVAILABLE
Constant Value
"volumeAvailable"

KEY_EQUALIZER_AVAILABLE

public static final java.lang.String KEY_EQUALIZER_AVAILABLE
Constant Value
"equalizerAvailable"

KEY_EQUALIZER_MAX_CHANNEL_ID

public static final java.lang.String KEY_EQUALIZER_MAX_CHANNEL_ID
Constant Value
"equalizerMaxChannelId"

KEY_MODULE_INFO

public static final java.lang.String KEY_MODULE_INFO
Constant Value
"moduleInfo"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

AudioControlCapabilities()

Constructs a newly allocated AudioControlCapabilities object 

public AudioControlCapabilities()

AudioControlCapabilities( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a newly allocated AudioControlCapabilities object indicated by the Hashtable parameter 

public AudioControlCapabilities(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

hash
The Hashtable to use

AudioControlCapabilities( String moduleName )

Constructs a newly allocated AudioControlCapabilities object 

public AudioControlCapabilities(String moduleName)

Constructor Parameters

moduleName
short friendly name of the audio control module.

Methods

setModuleName( String moduleName )

Sets the moduleName portion of the AudioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.AudioControlCapabilities setModuleName(String moduleName)

Method Parameters

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

getModuleName()

Gets the moduleName portion of the AudioControlCapabilities class 

public java.lang.String getModuleName()

setKeepContextAvailable( Boolean keepContextAvailable )

Sets the keepContextAvailable portion of the AudioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.AudioControlCapabilities setKeepContextAvailable(Boolean keepContextAvailable)

Method Parameters

keepContextAvailable
Availability of the keepContext parameter.

getKeepContextAvailable()

Gets the keepContextAvailable portion of the AudioControlCapabilities class 

public java.lang.Boolean getKeepContextAvailable()

setSourceAvailable( Boolean sourceAvailable )

Sets the sourceAvailable portion of the AudioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.AudioControlCapabilities setSourceAvailable(Boolean sourceAvailable)

Method Parameters

sourceAvailable
Availability of the control of audio source.

getSourceAvailable()

Gets the sourceAvailable portion of the AudioControlCapabilities class 

public java.lang.Boolean getSourceAvailable()

setVolumeAvailable( Boolean volumeAvailable )

Sets the volumeAvailable portion of the AudioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.AudioControlCapabilities setVolumeAvailable(Boolean volumeAvailable)

Method Parameters

volumeAvailable
Availability of the control of audio volume.

getVolumeAvailable()

Gets the volumeAvailable portion of the AudioControlCapabilities class 

public java.lang.Boolean getVolumeAvailable()

setEqualizerAvailable( Boolean equalizerAvailable )

Sets the equalizerAvailable portion of the AudioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.AudioControlCapabilities setEqualizerAvailable(Boolean equalizerAvailable)

Method Parameters

equalizerAvailable
Availability of the control of Equalizer Settings.

getEqualizerAvailable()

Gets the equalizerAvailable portion of the AudioControlCapabilities class 

public java.lang.Boolean getEqualizerAvailable()

setEqualizerMaxChannelId( Integer equalizerMaxChannelId )

Sets the equalizerMaxChannelId portion of the AudioControlCapabilities class 

public com.smartdevicelink.proxy.rpc.AudioControlCapabilities setEqualizerMaxChannelId(Integer equalizerMaxChannelId)

Method Parameters

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

getEqualizerMaxChannelId()

Gets the equalizerMaxChannelId portion of the AudioControlCapabilities class 

public java.lang.Integer getEqualizerMaxChannelId()

setModuleInfo( ModuleInfo info )

Sets ModuleInfo for this capability 

public com.smartdevicelink.proxy.rpc.AudioControlCapabilities setModuleInfo(ModuleInfo info)

Method Parameters

info
the ModuleInfo to be set

getModuleInfo()

Gets a ModuleInfo of this capability 

public com.smartdevicelink.proxy.rpc.ModuleInfo getModuleInfo()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section