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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
|
/*
* 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.protocol.enums.FunctionID;
import com.smartdevicelink.proxy.RPCNotification;
import com.smartdevicelink.proxy.rpc.enums.AudioStreamingState;
import com.smartdevicelink.proxy.rpc.enums.HMILevel;
import com.smartdevicelink.proxy.rpc.enums.SystemContext;
import com.smartdevicelink.proxy.rpc.enums.VideoStreamingState;
import java.util.Hashtable;
/**
* <p>Notifies an application that HMI conditions have changed for the application. This indicates whether the application
* can speak phrases, display text, perform interactions, receive button presses and events, stream audio, etc. This
* notification will be sent to the application when there has been a change in any one or several of the indicated
* states ({@linkplain HMILevel}, {@linkplain AudioStreamingState} or {@linkplain SystemContext}) for the application</p>
* <p>All three values are, in principle, independent of each other (though there may be some relationships). A value for
* one parameter should not be interpreted from the value of another parameter.</p>
* <p>There are no guarantees about the timeliness or latency of the OnHMIStatus notification. Therefore, for example,
* information such as {@linkplain AudioStreamingState} may not indicate that the audio stream became inaudible to the user
* exactly when the OnHMIStatus notification was received.</p>
*
* <p>
* <b>Parameter List:</b>
* <table border="1" rules="all">
* <tr>
* <th>Name</th>
* <th>Type</th>
* <th>Description</th>
* <th>SmartDeviceLink Ver Available</th>
* </tr>
* <tr>
* <td>hmiLevel</td>
* <td>{@linkplain HMILevel}</td>
* <td>The current HMI Level in effect for the application.</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>audioStreamingState</td>
* <td>{@linkplain AudioStreamingState}</td>
* <td>Current state of audio streaming for the application.
* When this parameter has a value of NOT_AUDIBLE,
* the application must stop streaming audio to SDL.
* Informs app whether any currently streaming audio is
* audible to user (AUDIBLE) or not (NOT_AUDIBLE). A
* value of NOT_AUDIBLE means that either the
* application's audio will not be audible to the user, or
* that the application's audio should not be audible to
* the user (i.e. some other application on the mobile
* device may be streaming audio and the application's
* audio would be blended with that other audio). </td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* <tr>
* <td>videoStreamingState</td>
* <td>{@linkplain VideoStreamingState}</td>
* <td>If it is NOT_STREAMABLE, the app must stop streaming video to SDL Core(stop service).</td>
* <td>SmartDeviceLink 5.0</td>
* </tr>
* <tr>
* <td>systemContext</td>
* <td>{@linkplain SystemContext}</td>
* <td>Indicates that a user-initiated interaction is in-progress
* (VRSESSION or MENU), or not (MAIN)</td>
* <td>SmartDeviceLink 1.0</td>
* </tr>
* </table>
* </p>
* @since SmartDeviceLink 1.0
* @see RegisterAppInterface
*/
public class OnHMIStatus extends RPCNotification {
public static final String KEY_AUDIO_STREAMING_STATE = "audioStreamingState";
public static final String KEY_VIDEO_STREAMING_STATE = "videoStreamingState";
public static final String KEY_SYSTEM_CONTEXT = "systemContext";
public static final String KEY_HMI_LEVEL = "hmiLevel";
public static final String KEY_WINDOW_ID = "windowID";
private Boolean firstRun;
/**
*Constructs a newly allocated OnHMIStatus object
*/
public OnHMIStatus() {
super(FunctionID.ON_HMI_STATUS.toString());
}
/**
*<p>Constructs a newly allocated OnHMIStatus object indicated by the Hashtable parameter</p>
*@param hash The Hashtable to use
*/
public OnHMIStatus(Hashtable<String, Object> hash) {
super(hash);
}
/**
*Constructs a newly allocated OnHMIStatus object
* @param hmiLevel the HMILevel to set
* @param audioStreamingState the state of audio streaming of the application
* @param systemContext Indicates that a user-initiated interaction is in-progress
*/
public OnHMIStatus(@NonNull HMILevel hmiLevel, @NonNull AudioStreamingState audioStreamingState, @NonNull SystemContext systemContext) {
this();
setHmiLevel(hmiLevel);
setAudioStreamingState(audioStreamingState);
setSystemContext(systemContext);
}
@Override
public void format(com.smartdevicelink.util.Version rpcVersion, boolean formatParams){
if(rpcVersion.getMajor() < 5){
if(getVideoStreamingState() == null){
setVideoStreamingState(VideoStreamingState.STREAMABLE);
}
}
super.format(rpcVersion,formatParams);
}
/**
* <p>Get HMILevel in effect for the application</p>
* @return {@linkplain HMILevel} the current HMI Level in effect for the application
*/
public HMILevel getHmiLevel() {
return (HMILevel) getObject(HMILevel.class, KEY_HMI_LEVEL);
}
/**
* <p>Set the HMILevel of OnHMIStatus</p>
* @param hmiLevel the HMILevel to set
*/
public OnHMIStatus setHmiLevel(@NonNull HMILevel hmiLevel) {
setParameters(KEY_HMI_LEVEL, hmiLevel);
return this;
}
/**
* <p>Get current state of audio streaming for the application</p>
* @return {@linkplain AudioStreamingState} Returns current state of audio streaming for the application
*/
public AudioStreamingState getAudioStreamingState() {
return (AudioStreamingState) getObject(AudioStreamingState.class, KEY_AUDIO_STREAMING_STATE);
}
/**
* <p>Set the audio streaming state</p>
* @param audioStreamingState the state of audio streaming of the application
*/
public OnHMIStatus setAudioStreamingState(@NonNull AudioStreamingState audioStreamingState) {
setParameters(KEY_AUDIO_STREAMING_STATE, audioStreamingState);
return this;
}
/**
* <p>Get current state of video streaming for the application</p>
* @return {@linkplain VideoStreamingState} Returns current state of video streaming for the application
*/
public VideoStreamingState getVideoStreamingState() {
return (VideoStreamingState) getObject(VideoStreamingState.class, KEY_VIDEO_STREAMING_STATE);
}
/**
* <p>Set the video streaming state</p>
* @param videoStreamingState the state of video streaming of the application
*/
public OnHMIStatus setVideoStreamingState( VideoStreamingState videoStreamingState) {
setParameters(KEY_VIDEO_STREAMING_STATE, videoStreamingState);
return this;
}
/**
* <p>Get the System Context</p>
* @return {@linkplain SystemContext} whether a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN).
*/
public SystemContext getSystemContext() {
return (SystemContext) getObject(SystemContext.class, KEY_SYSTEM_CONTEXT);
}
/**
* <p>Set the System Context of OnHMIStatus</p>
* @param systemContext Indicates that a user-initiated interaction is in-progress
* (VRSESSION or MENU), or not (MAIN)
*/
public OnHMIStatus setSystemContext(@NonNull SystemContext systemContext) {
setParameters(KEY_SYSTEM_CONTEXT, systemContext);
return this;
}
/**
* <p>Query whether it's the first run</p>
* @return boolean whether it's the first run
*/
public Boolean getFirstRun() {
return this.firstRun;
}
/**
* <p>Set the firstRun value</p>
* @param firstRun True if it is the first run, False or not
*/
public OnHMIStatus setFirstRun( Boolean firstRun) {
this.firstRun = firstRun;
return this;
}
/**
* <p>Set the windowID value</p>
* @param windowID This is the unique ID assigned to the window that this RPC is intended.
* If this param is not included, it will be assumed that this request is specifically for the main window on the main display.
* See PredefinedWindows enum.
* @since 6.0
*/
public OnHMIStatus setWindowID( Integer windowID) {
setParameters(KEY_WINDOW_ID, windowID);
return this;
}
/**
* <p>Get the windowID value</p>
* @return Integer This is the unique ID assigned to the window that this RPC is intended.
* @since 6.0
*/
public Integer getWindowID() {
return getInteger(KEY_WINDOW_ID);
}
}
|
