summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLSystemContext.h
blob: 83fc8e43ccca8cd4e95b76654e5646353472ae6a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
//  SDLSystemContext.h
//


#import "SDLEnum.h"

/**
 * Indicates whether or not a user-initiated interaction is in progress, and if so, in what mode (i.e. MENU or VR). Used in OnHMIStatus
 *
 * @since SDL 1.0
 */
typedef SDLEnum SDLSystemContext SDL_SWIFT_ENUM;

/**
 * No user interaction (user-initiated or app-initiated) is in progress.
 */
extern SDLSystemContext const SDLSystemContextMain;

/**
 * VR-oriented, user-initiated or app-initiated interaction is in-progress.
 */
extern SDLSystemContext const SDLSystemContextVoiceRecognitionSession;

/**
 * Menu-oriented, user-initiated or app-initiated interaction is in-progress.
 */
extern SDLSystemContext const SDLSystemContextMenu;

/**
 * The app's display HMI is currently being obscured by either a system or other app's overlay.
 *
 * @since SDL 2.0
 */
extern SDLSystemContext const SDLSystemContextHMIObscured;

/**
 * Broadcast only to whichever app has an alert currently being displayed.
 *
 * @since SDL 2.0
 */
extern SDLSystemContext const SDLSystemContextAlert;