Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Documentation

Class OnHMIStatus





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



public static final java.lang.String KEY_AUDIO_STREAMING_STATE
Constant Value


public static final java.lang.String KEY_VIDEO_STREAMING_STATE
Constant Value


public static final java.lang.String KEY_SYSTEM_CONTEXT
Constant Value


public static final java.lang.String KEY_HMI_LEVEL
Constant Value


public static final java.lang.String KEY_WINDOW_ID
Constant Value

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCMessage KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store



Constructs a newly allocated OnHMIStatus object

public OnHMIStatus()

OnHMIStatus( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a newly allocated OnHMIStatus object indicated by the Hashtable parameter

public OnHMIStatus(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

The Hashtable to use

OnHMIStatus( HMILevel hmiLevel, AudioStreamingState audioStreamingState, SystemContext systemContext )

Constructs a newly allocated OnHMIStatus object

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

Constructor Parameters

the HMILevel to set
the state of audio streaming of the application
Indicates that a user-initiated interaction is in-progress


format( Version rpcVersion, boolean formatParams )

public void format(Version rpcVersion,boolean formatParams)

Method Parameters



Get HMILevel in effect for the application

public com.smartdevicelink.proxy.rpc.enums.HMILevel getHmiLevel()

setHmiLevel( HMILevel hmiLevel )

Set the HMILevel of OnHMIStatus

public com.smartdevicelink.proxy.rpc.OnHMIStatus setHmiLevel(HMILevel hmiLevel)

Method Parameters

the HMILevel to set


Get current state of audio streaming for the application

public com.smartdevicelink.proxy.rpc.enums.AudioStreamingState getAudioStreamingState()

setAudioStreamingState( AudioStreamingState audioStreamingState )

Set the audio streaming state

public com.smartdevicelink.proxy.rpc.OnHMIStatus setAudioStreamingState(AudioStreamingState audioStreamingState)

Method Parameters

the state of audio streaming of the application


Get current state of video streaming for the application

public com.smartdevicelink.proxy.rpc.enums.VideoStreamingState getVideoStreamingState()

setVideoStreamingState( VideoStreamingState videoStreamingState )

Set the video streaming state

public com.smartdevicelink.proxy.rpc.OnHMIStatus setVideoStreamingState(VideoStreamingState videoStreamingState)

Method Parameters

the state of video streaming of the application


Get the System Context

public com.smartdevicelink.proxy.rpc.enums.SystemContext getSystemContext()

setSystemContext( SystemContext systemContext )

Set the System Context of OnHMIStatus

public com.smartdevicelink.proxy.rpc.OnHMIStatus setSystemContext(SystemContext systemContext)

Method Parameters

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


Query whether it's the first run

public java.lang.Boolean getFirstRun()

setFirstRun( Boolean firstRun )

Set the firstRun value

public com.smartdevicelink.proxy.rpc.OnHMIStatus setFirstRun(Boolean firstRun)

Method Parameters

True if it is the first run, False or not

setWindowID( Integer windowID )

Set the windowID value

public com.smartdevicelink.proxy.rpc.OnHMIStatus setWindowID(Integer windowID)

Method Parameters

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.


Get the windowID value

public java.lang.Integer getWindowID()

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCMessage getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section