summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLAudioStreamingState.h
blob: eed0c3772c5fec4021c9b6fe09dbb86194dd7a27 (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
//  SDLAudioStreamingState.h
//


#import "SDLEnum.h"

/**
 * Describes whether or not streaming audio is currently audible to the user. Though provided in every OnHMIStatus notification, this information is only relevant for applications that declare themselves as media apps in RegisterAppInterface
 *
 * @since SDL 1.0
 */
typedef SDLEnum SDLAudioStreamingState NS_EXTENSIBLE_STRING_ENUM;

/**
 * @abstract Currently streaming audio, if any, is audible to user.
 */
extern SDLAudioStreamingState SDLAudioStreamingStateAudible;

/**
 * @abstract Some kind of audio mixing is taking place. Currently streaming audio, if any, is audible to the user at a lowered volume.
 *
 * @since SDL 2.0
 */
extern SDLAudioStreamingState SDLAudioStreamingStateAttenuated;

/**
 * @abstract Currently streaming audio, if any, is not audible to user. made via VR session.
 */
extern SDLAudioStreamingState SDLAudioStreamingStateNotAudible;