summaryrefslogtreecommitdiff
path: root/SmartDeviceLink/SDLAudioStreamingIndicator.h
blob: 61590002fb3974cab1bc855cc34b06f838d77310 (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
//  SDLAudioStreamingIndicator.h
//

#import "SDLEnum.h"


/**
 * Enumeration listing possible indicators of audio streaming changes
 *
 * @since SDL 4.6
 */
typedef SDLEnum SDLAudioStreamingIndicator SDL_SWIFT_ENUM;

/**
 * Default playback indicator.
 * By default the playback indicator should be PLAY_PAUSE when:
 * - the media app is newly registered on the head unit (after RegisterAppInterface)
 * - the media app was closed by the user (App enteres HMI_NONE)
 * - the app sends SetMediaClockTimer with audioStreamingIndicator not set to any value
 */
extern SDLAudioStreamingIndicator const SDLAudioStreamingIndicatorPlayPause;

/**
 * Indicates that a button press of the Play/Pause button starts the audio playback.
 */
extern SDLAudioStreamingIndicator const SDLAudioStreamingIndicatorPlay;

/**
 * Indicates that a button press of the Play/Pause button pauses the current audio playback.
 */
extern SDLAudioStreamingIndicator const SDLAudioStreamingIndicatorPause;

/**
 * Indicates that a button press of the Play/Pause button stops the current audio playback.
 */
extern SDLAudioStreamingIndicator const SDLAudioStreamingIndicatorStop;