OnHMIStatus Class Reference
Constructors
Instance Methods
- getAudioStreamingState() ⇒
AudioStreamingState - getHmiLevel() ⇒
HMILevel - getSystemContext() ⇒
SystemContext - getVideoStreamingState() ⇒
VideoStreamingState - getWindowID() ⇒
Number - setAudioStreamingState(state) ⇒
OnHMIStatus - setHmiLevel(level) ⇒
OnHMIStatus - setSystemContext(context) ⇒
OnHMIStatus - setVideoStreamingState(state) ⇒
OnHMIStatus - setWindowID(id) ⇒
OnHMIStatus
Instance Methods
onHMIStatus.getAudioStreamingState() ⇒ AudioStreamingState
Get the AudioStreamingState
Kind: Instance method of OnHMIStatus
Returns: AudioStreamingState - the KEY_AUDIO_STREAMING_STATE value
onHMIStatus.getHmiLevel() ⇒ HMILevel
Get the HmiLevel
Kind: Instance method of OnHMIStatus
Returns: HMILevel - the KEY_HMI_LEVEL value
onHMIStatus.getSystemContext() ⇒ SystemContext
Get the SystemContext
Kind: Instance method of OnHMIStatus
Returns: SystemContext - the KEY_SYSTEM_CONTEXT value
onHMIStatus.getVideoStreamingState() ⇒ VideoStreamingState
Get the VideoStreamingState
Kind: Instance method of OnHMIStatus
Returns: VideoStreamingState - the KEY_VIDEO_STREAMING_STATE value
onHMIStatus.getWindowID() ⇒ Number
Get the WindowID
Kind: Instance method of OnHMIStatus
Returns: Number - the KEY_WINDOW_ID value
onHMIStatus.setAudioStreamingState(state) ⇒ OnHMIStatus
Set the AudioStreamingState
Kind: Instance method of OnHMIStatus
Returns: OnHMIStatus - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| state | AudioStreamingState |
See AudioStreamingState - The desired AudioStreamingState. |
onHMIStatus.setHmiLevel(level) ⇒ OnHMIStatus
Set the HmiLevel
Kind: Instance method of OnHMIStatus
Returns: OnHMIStatus - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| level | HMILevel |
See HMILevel - The desired HmiLevel. |
onHMIStatus.setSystemContext(context) ⇒ OnHMIStatus
Set the SystemContext
Kind: Instance method of OnHMIStatus
Returns: OnHMIStatus - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| context | SystemContext |
See SystemContext - The desired SystemContext. |
onHMIStatus.setVideoStreamingState(state) ⇒ OnHMIStatus
Set the VideoStreamingState
Kind: Instance method of OnHMIStatus
Returns: OnHMIStatus - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| state | VideoStreamingState |
See VideoStreamingState. If it is NOT_STREAMABLE, the app must stop streaming video to SDL Core(stop service). - The desired VideoStreamingState. {'default_value': 'STREAMABLE'} |
onHMIStatus.setWindowID(id) ⇒ OnHMIStatus
Set the WindowID
Kind: Instance method of OnHMIStatus
Returns: OnHMIStatus - The class instance for method chaining.
| Param | Type | Description |
|---|---|---|
| id | Number |
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. - The desired WindowID. |