Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

Class AudioControlData

Hierarchy

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

Package
com.smartdevicelink.proxy.rpc

Fields

KEY_SOURCE

public static final java.lang.String KEY_SOURCE
Constant Value
"source"

KEY_KEEP_CONTEXT

public static final java.lang.String KEY_KEEP_CONTEXT
Constant Value
"keepContext"

KEY_VOLUME

public static final java.lang.String KEY_VOLUME
Constant Value
"volume"

KEY_EQUALIZER_SETTINGS

public static final java.lang.String KEY_EQUALIZER_SETTINGS
Constant Value
"equalizerSettings"

Inherited Fields

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

Constructors

AudioControlData()

Constructs a newly allocated AudioControlData object

public AudioControlData()

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

Constructs a newly allocated AudioControlData object indicated by the Hashtable parameter

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

Parameters

hash
The Hashtable to use

Methods

setSource( PrimaryAudioSource source )

Sets the source portion of the AudioControlData class

public void setSource(PrimaryAudioSource source)

Parameters

source
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.

getSource()

Gets the source portion of the AudioControlData class

public com.smartdevicelink.proxy.rpc.enums.PrimaryAudioSource getSource()

setKeepContext( Boolean keepContext )

Sets the keepContext portion of the AudioControlData class

public void setKeepContext(Boolean keepContext)

Parameters

keepContext
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.

getKeepContext()

Gets the keepContext portion of the AudioControlData class

public java.lang.Boolean getKeepContext()

setVolume( Integer volume )

Sets the volume portion of the AudioControlData class

public void setVolume(Integer volume)

Parameters

volume
Reflects the volume of audio, from 0%-100%.

getVolume()

Gets the volume portion of the AudioControlData class

public java.lang.Integer getVolume()

getEqualizerSettings()

Gets the equalizerSettings portion of the AudioControlData class

public java.util.List getEqualizerSettings()

setEqualizerSettings( java.util.List<com.smartdevicelink.proxy.rpc.EqualizerSettings> equalizerSettings )

Sets the equalizerSettings portion of the AudioControlData class

public void setEqualizerSettings(java.util.List<com.smartdevicelink.proxy.rpc.EqualizerSettings> equalizerSettings)

Parameters

equalizerSettings
Defines the list of supported channels (band) and their current/desired settings on HMI.

Inherited Methods

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