//  SDLOnHMIStatus.h
//

#import "SDLRPCNotification.h"

#import "SDLAudioStreamingState.h"
#import "SDLHMILevel.h"
#import "SDLSystemContext.h"
#import "SDLVideoStreamingState.h"

/**
 * 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 (<i>SDLHMILevel</i>, <i>SDLAudioStreamingState</i> or <i>SDLSystemContext</i>) 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 <i>SDLAudioStreamingState</i> may not indicate that the audio stream became inaudible to the user exactly when the SDLOnHMIStatus notification was received.

 @since SDL 1.0
 */

NS_ASSUME_NONNULL_BEGIN

@interface SDLOnHMIStatus : SDLRPCNotification

/**
 SDLHMILevel in effect for the application
 */
@property (strong, nonatomic) SDLHMILevel hmiLevel;

/**
 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).
 */
@property (strong, nonatomic) SDLAudioStreamingState audioStreamingState;

/**
 Current availability of video streaming for the application. When this parameter is NOT_STREAMABLE, the application must stop video streaming to SDL.
 */
@property (strong, nonatomic, nullable) SDLVideoStreamingState videoStreamingState;

/**
 Whether a user-initiated interaction is in-progress (VRSESSION or MENU), or not (MAIN)
 */
@property (strong, nonatomic) SDLSystemContext systemContext;

/**
 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
 */
@property (strong, nonatomic, nullable) NSNumber<SDLUInt> *windowID;

/// Initialize an SDLOnHMIStatus RPC with initial parameters
/// @param hmiLevel The HMI level
/// @param systemContext The system context
/// @param audioStreamingState The ability for an audio app to be heard
/// @param videoStreamingState The ability for a video streaming app to stream
/// @param windowID Which window this status relates to
- (instancetype)initWithHMILevel:(SDLHMILevel)hmiLevel systemContext:(SDLSystemContext)systemContext audioStreamingState:(SDLAudioStreamingState)audioStreamingState videoStreamingState:(nullable SDLVideoStreamingState)videoStreamingState windowID:(nullable NSNumber<SDLUInt> *)windowID;

@end

NS_ASSUME_NONNULL_END