com.smartdevicelink.proxy.rpc

Class EqualizerSettings

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.rpc.EqualizerSettings

All Implemented Interfaces:

Cloneable

public class EqualizerSettings
extends RPCStruct

Defines the each Equalizer channel settings.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_CHANNEL_ID
static String	KEY_CHANNEL_NAME
static String	KEY_CHANNEL_SETTING

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Integer	getChannelId() Gets the channelId portion of the EqualizerSettings class
String	getChannelName() Gets the channelName portion of the EqualizerSettings class
Integer	getChannelSetting() Gets the channelSetting portion of the EqualizerSettings class
EqualizerSettings	setChannelId(Integer channelId) Sets the channelId portion of the EqualizerSettings class
EqualizerSettings	setChannelName(String channelName) Sets the channelName portion of the EqualizerSettings class
EqualizerSettings	setChannelSetting(Integer channelSetting) Sets the channelSetting portion of the EqualizerSettings 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_CHANNEL_ID

public static final String KEY_CHANNEL_ID

See Also:

Constant Field Values

KEY_CHANNEL_NAME

public static final String KEY_CHANNEL_NAME

See Also:

Constant Field Values

KEY_CHANNEL_SETTING

public static final String KEY_CHANNEL_SETTING

See Also:

Constant Field Values

Constructor Detail

EqualizerSettings

public EqualizerSettings()

Constructs a newly allocated EqualizerSettings object

EqualizerSettings

public EqualizerSettings(Hashtable<String,Object> hash)

Constructs a newly allocated EqualizerSettings object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

EqualizerSettings

public EqualizerSettings(@NonNull
                         Integer channelId,
                         @NonNull
                         Integer channelSetting)

Constructs a newly allocated EqualizerSettings object

Parameters:

channelId - Min: 0 Max: 100

channelSetting - Min: 0 Max: 100

Method Detail

setChannelId

public EqualizerSettings setChannelId(@NonNull
                                      Integer channelId)

Sets the channelId portion of the EqualizerSettings class

Parameters:

channelId - ID that represents the channel these settings should be applied

getChannelId

public Integer getChannelId()

Gets the channelId portion of the EqualizerSettings class

Returns:

Integer

setChannelName

public EqualizerSettings setChannelName(String channelName)

Sets the channelName portion of the EqualizerSettings class

Parameters:

channelName - Read-only channel / frequency name (e.i. "Treble, MidRange, Bass" or "125 Hz").

getChannelName

public String getChannelName()

Gets the channelName portion of the EqualizerSettings class

Returns:

String - Read-only channel / frequency name (e.i. "Treble, MidRange, Bass" or "125 Hz").

setChannelSetting

public EqualizerSettings setChannelSetting(@NonNull
                                           Integer channelSetting)

Sets the channelSetting portion of the EqualizerSettings class

Parameters:

channelSetting - Reflects the setting, from 0%-100%.

getChannelSetting

public Integer getChannelSetting()

Gets the channelSetting portion of the EqualizerSettings class

Returns:

Integer - Reflects the setting, from 0%-100%.