com.smartdevicelink.proxy.rpc

Class OnHMIStatus

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCNotification

com.smartdevicelink.proxy.rpc.OnHMIStatus

All Implemented Interfaces:

Cloneable

public class OnHMIStatus
extends RPCNotification

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 (HMILevel, AudioStreamingState or SystemContext) for the application

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.

There are no guarantees about the timeliness or latency of the OnHMIStatus notification. Therefore, for example, information such as AudioStreamingState may not indicate that the audio stream became inaudible to the user exactly when the OnHMIStatus notification was received.

Parameter List:

Name	Type	Description	SmartDeviceLink Ver Available
hmiLevel	HMILevel	The current HMI Level in effect for the application.	SmartDeviceLink 1.0
audioStreamingState	AudioStreamingState	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).	SmartDeviceLink 1.0
videoStreamingState	VideoStreamingState	If it is NOT_STREAMABLE, the app must stop streaming video to SDL Core(stop service).	SmartDeviceLink 5.0
systemContext	SystemContext	Indicates that a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN)	SmartDeviceLink 1.0

Since:

SmartDeviceLink 1.0

See Also:

RegisterAppInterface

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_AUDIO_STREAMING_STATE
static String	KEY_HMI_LEVEL
static String	KEY_SYSTEM_CONTEXT
static String	KEY_VIDEO_STREAMING_STATE
static String	KEY_WINDOW_ID

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
OnHMIStatus() Constructs a newly allocated OnHMIStatus object
OnHMIStatus(Hashtable<String,Object> hash) Constructs a newly allocated OnHMIStatus object indicated by the Hashtable parameter
OnHMIStatus(HMILevel hmiLevel, AudioStreamingState audioStreamingState, SystemContext systemContext) Constructs a newly allocated OnHMIStatus object

Method Summary

Modifier and Type	Method and Description
void	format(Version rpcVersion, boolean formatParams) This method should clean the the RPC to make sure it is compliant with the spec.
AudioStreamingState	getAudioStreamingState() Get current state of audio streaming for the application
Boolean	getFirstRun() Query whether it's the first run
HMILevel	getHmiLevel() Get HMILevel in effect for the application
SystemContext	getSystemContext() Get the System Context
VideoStreamingState	getVideoStreamingState() Get current state of video streaming for the application
Integer	getWindowID() Get the windowID value
OnHMIStatus	setAudioStreamingState(AudioStreamingState audioStreamingState) Set the audio streaming state
OnHMIStatus	setFirstRun(Boolean firstRun) Set the firstRun value
OnHMIStatus	setHmiLevel(HMILevel hmiLevel) Set the HMILevel of OnHMIStatus
OnHMIStatus	setSystemContext(SystemContext systemContext) Set the System Context of OnHMIStatus
OnHMIStatus	setVideoStreamingState(VideoStreamingState videoStreamingState) Set the video streaming state
OnHMIStatus	setWindowID(Integer windowID) Set the windowID value

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, 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_AUDIO_STREAMING_STATE

public static final String KEY_AUDIO_STREAMING_STATE

See Also:

Constant Field Values

KEY_VIDEO_STREAMING_STATE

public static final String KEY_VIDEO_STREAMING_STATE

See Also:

Constant Field Values

KEY_SYSTEM_CONTEXT

public static final String KEY_SYSTEM_CONTEXT

See Also:

Constant Field Values

KEY_HMI_LEVEL

public static final String KEY_HMI_LEVEL

See Also:

Constant Field Values

KEY_WINDOW_ID

public static final String KEY_WINDOW_ID

See Also:

Constant Field Values

Constructor Detail

OnHMIStatus

public OnHMIStatus()

Constructs a newly allocated OnHMIStatus object

OnHMIStatus

public OnHMIStatus(Hashtable<String,Object> hash)

Constructs a newly allocated OnHMIStatus object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

OnHMIStatus

public OnHMIStatus(@NonNull
                   HMILevel hmiLevel,
                   @NonNull
                   AudioStreamingState audioStreamingState,
                   @NonNull
                   SystemContext systemContext)

Constructs a newly allocated OnHMIStatus object

Parameters:

hmiLevel - the HMILevel to set

audioStreamingState - the state of audio streaming of the application

systemContext - Indicates that a user-initiated interaction is in-progress

Method Detail

format

public void format(Version rpcVersion,
                   boolean formatParams)

Description copied from class: RPCStruct

This method should clean the the RPC to make sure it is compliant with the spec.

NOTE: Super needs to be called at the END of the method

Overrides:

format in class RPCStruct

Parameters:

rpcVersion - the rpc spec version that has been negotiated. If value is null the the max value of RPC spec version this library supports should be used.

formatParams - if true, the format method will be called on subsequent params

getHmiLevel

public HMILevel getHmiLevel()

Get HMILevel in effect for the application

Returns:

HMILevel the current HMI Level in effect for the application

setHmiLevel

public OnHMIStatus setHmiLevel(@NonNull
                               HMILevel hmiLevel)

Set the HMILevel of OnHMIStatus

Parameters:

hmiLevel - the HMILevel to set

getAudioStreamingState

public AudioStreamingState getAudioStreamingState()

Get current state of audio streaming for the application

Returns:

AudioStreamingState Returns current state of audio streaming for the application

setAudioStreamingState

public OnHMIStatus setAudioStreamingState(@NonNull
                                          AudioStreamingState audioStreamingState)

Set the audio streaming state

Parameters:

audioStreamingState - the state of audio streaming of the application

getVideoStreamingState

public VideoStreamingState getVideoStreamingState()

Get current state of video streaming for the application

Returns:

VideoStreamingState Returns current state of video streaming for the application

setVideoStreamingState

public OnHMIStatus setVideoStreamingState(VideoStreamingState videoStreamingState)

Set the video streaming state

Parameters:

videoStreamingState - the state of video streaming of the application

getSystemContext

public SystemContext getSystemContext()

Get the System Context

Returns:

SystemContext whether a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN).

setSystemContext

public OnHMIStatus setSystemContext(@NonNull
                                    SystemContext systemContext)

Set the System Context of OnHMIStatus

Parameters:

systemContext - Indicates that a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN)

getFirstRun

public Boolean getFirstRun()

Query whether it's the first run

Returns:

boolean whether it's the first run

setFirstRun

public OnHMIStatus setFirstRun(Boolean firstRun)

Set the firstRun value

Parameters:

firstRun - True if it is the first run, False or not

setWindowID

public OnHMIStatus setWindowID(Integer windowID)

Set the windowID value

Parameters:

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

getWindowID

public Integer getWindowID()

Get the windowID value

Returns:

Integer This is the unique ID assigned to the window that this RPC is intended.

Since:

6.0