summaryrefslogtreecommitdiff
path: root/sdl_android/src/main/java/com/smartdevicelink/proxy/rpc/EqualizerSettings.java
blob: 78e76c808a7032b2a116c72e9f59df5f74a1dd31 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
package com.smartdevicelink.proxy.rpc;

import android.support.annotation.NonNull;

import com.smartdevicelink.proxy.RPCStruct;

import java.util.Hashtable;

/**
 * Defines the each Equalizer channel settings.
 */
public class EqualizerSettings extends RPCStruct {
	public static final String KEY_CHANNEL_ID = "channelId";
	public static final String KEY_CHANNEL_NAME = "channelName";
	public static final String KEY_CHANNEL_SETTING = "channelSetting";

	/**
	 * Constructs a newly allocated EqualizerSettings object
	 */
	public EqualizerSettings() {
	}

	/**
	 * Constructs a newly allocated EqualizerSettings object indicated by the Hashtable parameter
	 *
	 * @param hash The Hashtable to use
	 */
	public EqualizerSettings(Hashtable<String, Object> hash) {
		super(hash);
	}

	/**
	 * Constructs a newly allocated EqualizerSettings object
	 *
	 * @param channelId      Min: 0  Max: 100
	 * @param channelSetting Min: 0  Max: 100
	 */
	public EqualizerSettings(@NonNull Integer channelId, @NonNull Integer channelSetting) {
		this();
		setChannelId(channelId);
		setChannelSetting(channelSetting);
	}

	/**
	 * Sets the channelId portion of the EqualizerSettings class
	 *
	 * @param channelId
	 */
	public void setChannelId(@NonNull Integer channelId) {
		setValue(KEY_CHANNEL_ID, channelId);
	}

	/**
	 * Gets the channelId portion of the EqualizerSettings class
	 *
	 * @return Integer
	 */
	public Integer getChannelId() {
		return getInteger(KEY_CHANNEL_ID);
	}

	/**
	 * Sets the channelName portion of the EqualizerSettings class
	 *
	 * @param channelName Read-only channel / frequency name (e.i. "Treble, Midrange, Bass" or "125 Hz").
	 */
	public void setChannelName(String channelName) {
		setValue(KEY_CHANNEL_NAME, channelName);
	}

	/**
	 * Gets the channelName portion of the EqualizerSettings class
	 *
	 * @return String - Read-only channel / frequency name (e.i. "Treble, Midrange, Bass" or "125 Hz").
	 */
	public String getChannelName() {
		return getString(KEY_CHANNEL_NAME);
	}

	/**
	 * Sets the channelSetting portion of the EqualizerSettings class
	 *
	 * @param channelSetting Reflects the setting, from 0%-100%.
	 */
	public void setChannelSetting(@NonNull Integer channelSetting) {
		setValue(KEY_CHANNEL_SETTING, channelSetting);
	}

	/**
	 * Gets the channelSetting portion of the EqualizerSettings class
	 *
	 * @return Integer - Reflects the setting, from 0%-100%.
	 */
	public Integer getChannelSetting() {
		return getInteger(KEY_CHANNEL_SETTING);
	}
}