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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
/*
* Copyright (c) 2017 - 2019, SmartDeviceLink Consortium, Inc.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* Redistributions of source code must retain the above copyright notice, this
* list of conditions and the following disclaimer.
*
* Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following
* disclaimer in the documentation and/or other materials provided with the
* distribution.
*
* Neither the name of the SmartDeviceLink Consortium, Inc. nor the names of its
* contributors may be used to endorse or promote products derived from this
* software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
package com.smartdevicelink.proxy.rpc;
import androidx.annotation.NonNull;
import com.smartdevicelink.proxy.RPCStruct;
import java.util.Hashtable;
public class AudioControlCapabilities extends RPCStruct {
public static final String KEY_MODULE_NAME = "moduleName";
public static final String KEY_SOURCE_AVAILABLE = "sourceAvailable";
public static final String KEY_KEEP_CONTEXT_AVAILABLE = "keepContextAvailable";
public static final String KEY_VOLUME_AVAILABLE = "volumeAvailable";
public static final String KEY_EQUALIZER_AVAILABLE = "equalizerAvailable";
public static final String KEY_EQUALIZER_MAX_CHANNEL_ID = "equalizerMaxChannelId";
public static final String KEY_MODULE_INFO = "moduleInfo";
/**
* Constructs a newly allocated AudioControlCapabilities object
*/
public AudioControlCapabilities() {
}
/**
* Constructs a newly allocated AudioControlCapabilities object indicated by the Hashtable parameter
*
* @param hash The Hashtable to use
*/
public AudioControlCapabilities(Hashtable<String, Object> hash) {
super(hash);
}
/**
* Constructs a newly allocated AudioControlCapabilities object
*
* @param moduleName short friendly name of the light control module.
*/
public AudioControlCapabilities(@NonNull String moduleName) {
this();
setModuleName(moduleName);
}
/**
* Sets the moduleName portion of the AudioControlCapabilities class
*
* @param moduleName The short friendly name of the light control module. It should not be used to identify a module by mobile application.
*/
public AudioControlCapabilities setModuleName(@NonNull String moduleName) {
setValue(KEY_MODULE_NAME, moduleName);
return this;
}
/**
* Gets the moduleName portion of the AudioControlCapabilities class
*
* @return String - The short friendly name of the light control module. It should not be used to identify a module by mobile application.
*/
public String getModuleName() {
return getString(KEY_MODULE_NAME);
}
/**
* Sets the keepContextAvailable portion of the AudioControlCapabilities class
*
* @param keepContextAvailable Availability of the keepContext parameter.
*/
public AudioControlCapabilities setKeepContextAvailable(Boolean keepContextAvailable) {
setValue(KEY_KEEP_CONTEXT_AVAILABLE, keepContextAvailable);
return this;
}
/**
* Gets the keepContextAvailable portion of the AudioControlCapabilities class
*
* @return Boolean - Availability of the keepContext parameter.
*/
public Boolean getKeepContextAvailable() {
return getBoolean(KEY_KEEP_CONTEXT_AVAILABLE);
}
/**
* Sets the sourceAvailable portion of the AudioControlCapabilities class
*
* @param sourceAvailable Availability of the control of audio source.
*/
public AudioControlCapabilities setSourceAvailable(Boolean sourceAvailable) {
setValue(KEY_SOURCE_AVAILABLE, sourceAvailable);
return this;
}
/**
* Gets the sourceAvailable portion of the AudioControlCapabilities class
*
* @return Boolean - Availability of the control of audio source.
*/
public Boolean getSourceAvailable() {
return getBoolean(KEY_SOURCE_AVAILABLE);
}
/**
* Sets the volumeAvailable portion of the AudioControlCapabilities class
*
* @param volumeAvailable Availability of the control of audio volume.
*/
public AudioControlCapabilities setVolumeAvailable(Boolean volumeAvailable) {
setValue(KEY_VOLUME_AVAILABLE, volumeAvailable);
return this;
}
/**
* Gets the volumeAvailable portion of the AudioControlCapabilities class
*
* @return Boolean - Availability of the control of audio volume.
*/
public Boolean getVolumeAvailable() {
return getBoolean(KEY_VOLUME_AVAILABLE);
}
/**
* Sets the equalizerAvailable portion of the AudioControlCapabilities class
*
* @param equalizerAvailable Availability of the control of Equalizer Settings.
*/
public AudioControlCapabilities setEqualizerAvailable(Boolean equalizerAvailable) {
setValue(KEY_EQUALIZER_AVAILABLE, equalizerAvailable);
return this;
}
/**
* Gets the equalizerAvailable portion of the AudioControlCapabilities class
*
* @return Boolean - Availability of the control of Equalizer Settings.
*/
public Boolean getEqualizerAvailable() {
return getBoolean(KEY_EQUALIZER_AVAILABLE);
}
/**
* Sets the equalizerMaxChannelId portion of the AudioControlCapabilities class
*
* @param equalizerMaxChannelId Must be included if equalizerAvailable=true, and assume all IDs starting from 1 to this value are valid.
*/
public AudioControlCapabilities setEqualizerMaxChannelId(Integer equalizerMaxChannelId) {
setValue(KEY_EQUALIZER_MAX_CHANNEL_ID, equalizerMaxChannelId);
return this;
}
/**
* Gets the equalizerMaxChannelId portion of the AudioControlCapabilities class
*
* @return Integer - Must be included if equalizerAvailable=true, and assume all IDs starting from 1 to this value are valid.
*/
public Integer getEqualizerMaxChannelId() {
return getInteger(KEY_EQUALIZER_MAX_CHANNEL_ID);
}
/**
* Sets ModuleInfo for this capability
*
* @param info the ModuleInfo to be set
*/
public AudioControlCapabilities setModuleInfo(ModuleInfo info) {
setValue(KEY_MODULE_INFO, info);
return this;
}
/**
* Gets a ModuleInfo of this capability
*
* @return module info of this capability
*/
public ModuleInfo getModuleInfo() {
return (ModuleInfo) getObject(ModuleInfo.class, KEY_MODULE_INFO);
}
}
|
