com.smartdevicelink.proxy.rpc

Class AudioControlData

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.AudioControlData

All Implemented Interfaces:

Cloneable

public class AudioControlData
extends RPCStruct

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_EQUALIZER_SETTINGS
static String	KEY_KEEP_CONTEXT
static String	KEY_SOURCE
static String	KEY_VOLUME

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
List<EqualizerSettings>	getEqualizerSettings() Gets the equalizerSettings portion of the AudioControlData class
Boolean	getKeepContext() Gets the keepContext portion of the AudioControlData class
PrimaryAudioSource	getSource() Gets the source portion of the AudioControlData class
Integer	getVolume() Gets the volume portion of the AudioControlData class
AudioControlData	setEqualizerSettings(List<EqualizerSettings> equalizerSettings) Sets the equalizerSettings portion of the AudioControlData class
AudioControlData	setKeepContext(Boolean keepContext) Sets the keepContext portion of the AudioControlData class
AudioControlData	setSource(PrimaryAudioSource source) Sets the source portion of the AudioControlData class
AudioControlData	setVolume(Integer volume) Sets the volume portion of the AudioControlData 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_SOURCE

public static final String KEY_SOURCE

See Also:

Constant Field Values

KEY_KEEP_CONTEXT

public static final String KEY_KEEP_CONTEXT

See Also:

Constant Field Values

KEY_VOLUME

public static final String KEY_VOLUME

See Also:

Constant Field Values

KEY_EQUALIZER_SETTINGS

public static final String KEY_EQUALIZER_SETTINGS

See Also:

Constant Field Values

Constructor Detail

AudioControlData

public AudioControlData()

Constructs a newly allocated AudioControlData object

AudioControlData

public AudioControlData(Hashtable<String,Object> hash)

Constructs a newly allocated AudioControlData object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

Method Detail

setSource

public AudioControlData setSource(PrimaryAudioSource source)

Sets the source portion of the AudioControlData class

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

public PrimaryAudioSource getSource()

Gets the source portion of the AudioControlData class

Returns:

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.

setKeepContext

public AudioControlData setKeepContext(Boolean keepContext)

Sets the keepContext portion of the AudioControlData class

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

public Boolean getKeepContext()

Gets the keepContext portion of the AudioControlData class

Returns:

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.

setVolume

public AudioControlData setVolume(Integer volume)

Sets the volume portion of the AudioControlData class

Parameters:

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

getVolume

public Integer getVolume()

Gets the volume portion of the AudioControlData class

Returns:

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

getEqualizerSettings

public List<EqualizerSettings> getEqualizerSettings()

Gets the equalizerSettings portion of the AudioControlData class

Returns:

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

setEqualizerSettings

public AudioControlData setEqualizerSettings(List<EqualizerSettings> equalizerSettings)

Sets the equalizerSettings portion of the AudioControlData class

Parameters:

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