iOS Documentation

SDLOnHMIStatus Class Reference

Section Contents

hmiLevel
audioStreamingState
videoStreamingState
systemContext
windowID
-initWithHMILevel:systemContext:audioStreamingState:videoStreamingState:windowID:

Overview

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 (SDLHMILevel, SDLAudioStreamingState or SDLSystemContext) 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 SDLOnHMIStatus notification. Therefore, for example, information such as SDLAudioStreamingState may not indicate that the audio stream became inaudible to the user exactly when the SDLOnHMIStatus notification was received.

@since SDL 1.0

hmiLevel

SDLHMILevel in effect for the application

Objective-C

@property (nonatomic, strong) SDLHMILevel _Nonnull hmiLevel;

Swift

var hmiLevel: SDLHMILevel { get set }

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).

Objective-C

@property (nonatomic, strong) SDLAudioStreamingState _Nonnull audioStreamingState;

Swift

var audioStreamingState: SDLAudioStreamingState { get set }

videoStreamingState

Current availability of video streaming for the application. When this parameter is NOT_STREAMABLE, the application must stop video streaming to SDL.

Objective-C

@property (nonatomic, strong, nullable) SDLVideoStreamingState videoStreamingState;

Swift

var videoStreamingState: SDLVideoStreamingState? { get set }

systemContext

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

Objective-C

@property (nonatomic, strong) SDLSystemContext _Nonnull systemContext;

Swift

var systemContext: SDLSystemContext { get set }

windowID

This is the unique ID assigned to the window that this RPC is intended for. 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 SDL 6.0

Objective-C

@property (nonatomic, strong, nullable) NSNumber<SDLUInt> *windowID;

Swift

var windowID: (NSNumber & SDLUInt)? { get set }

-initWithHMILevel:systemContext:audioStreamingState:videoStreamingState:windowID:

Initialize an SDLOnHMIStatus RPC with initial parameters

Objective-C

- (nonnull instancetype)
       initWithHMILevel:(nonnull SDLHMILevel)hmiLevel
          systemContext:(nonnull SDLSystemContext)systemContext
    audioStreamingState:(nonnull SDLAudioStreamingState)audioStreamingState
    videoStreamingState:(nullable SDLVideoStreamingState)videoStreamingState
               windowID:(nullable NSNumber<SDLUInt> *)windowID;

Swift

init(hmiLevel: SDLHMILevel, systemContext: SDLSystemContext, audioStreamingState: SDLAudioStreamingState, videoStreamingState: SDLVideoStreamingState?, windowID: (NSNumber & SDLUInt)?)

Parameters

hmiLevel: The HMI level
systemContext: The system context
audioStreamingState: The ability for an audio app to be heard
videoStreamingState: The ability for a video streaming app to stream
windowID: Which window this status relates to

View on GitHub.com

Previous Section Next Section