summaryrefslogtreecommitdiff
path: root/SmartDeviceLink-iOS/SmartDeviceLink/SDLUpdateMode.h
blob: 3ff84a2e9124da6b7a4142e1e179afdfea804b9e (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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
//  SDLUpdateMode.h
//


#import "SDLEnum.h"

/**
 * Specifies what function should be performed on the media clock/counter
 *
 * @since SDL 1.0
 */
@interface SDLUpdateMode : SDLEnum {
}

/**
 * Convert String to SDLUpdateMode
 * @param value The value of the string to get an object for
 * @return SDLUpdateMode
 */
+ (SDLUpdateMode *)valueOf:(NSString *)value;

/**
 * @abstract Store the enumeration of all possible SDLUpdateMode
 * @return an array that store all possible SDLUpdateMode
 */
+ (NSArray *)values;

/**
 * @abstract Starts the media clock timer counting upward, in increments of 1 second.
 * @return SDLUpdateMode with value of *COUNTUP*
 */
+ (SDLUpdateMode *)COUNTUP;

/**
 * @abstract Starts the media clock timer counting downward, in increments of 1 second.
 * @return SDLUpdateMode with value of *COUNTDOWN*
 */
+ (SDLUpdateMode *)COUNTDOWN;

/**
 * @abstract Pauses the media clock timer.
 * @return SDLUpdateMode with value of *PAUSE*
 */
+ (SDLUpdateMode *)PAUSE;

/**
 * @abstract Resumes the media clock timer. The timer resumes counting in whatever mode was in effect before pausing (i.e. COUNTUP or COUNTDOWN).
 * @return SDLUpdateMode with value of *RESUME*
 */
+ (SDLUpdateMode *)RESUME;

/**
 * @abstract Clear the media clock timer.
 */
+ (SDLUpdateMode *)CLEAR;

@end