diff options
Diffstat (limited to 'SmartDeviceLink/public/SDLSetMediaClockTimer.h')
| -rw-r--r-- | SmartDeviceLink/public/SDLSetMediaClockTimer.h | 124 |
1 files changed, 118 insertions, 6 deletions
diff --git a/SmartDeviceLink/public/SDLSetMediaClockTimer.h b/SmartDeviceLink/public/SDLSetMediaClockTimer.h index 4c8ccdd89..b79bda1f5 100644 --- a/SmartDeviceLink/public/SDLSetMediaClockTimer.h +++ b/SmartDeviceLink/public/SDLSetMediaClockTimer.h @@ -5,6 +5,7 @@ #import "SDLUpdateMode.h" #import "SDLAudioStreamingIndicator.h" +#import "SDLSeekStreamingIndicator.h" @class SDLStartTime; @@ -33,7 +34,34 @@ NS_ASSUME_NONNULL_BEGIN @param playPauseIndicator An optional audio indicator to change the play/pause button @return An object of SetMediaClockTimer */ -+ (instancetype)countUpFromStartTimeInterval:(NSTimeInterval)startTime toEndTimeInterval:(NSTimeInterval)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(countUp(from:to:playPauseIndicator:)); ++ (instancetype)countUpFromStartTimeInterval:(NSTimeInterval)startTime toEndTimeInterval:(NSTimeInterval)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(countUp(from:to:playPauseIndicator:)) __deprecated_msg("Use countUpFromStartTimeInterval:toEndTimeInterval:playPauseIndicator:forwardSeekIndicator:backSeekIndicator:countRate: instead"); + +/** + Create a media clock timer that counts up, e.g from 0:00 to 4:18. + + This will fail if startTime is greater than endTime + + @param startTime The start time interval, e.g. (0) 0:00 + @param endTime The end time interval, e.g. (258) 4:18 + @param playPauseIndicator An optional audio indicator to change the play/pause button + @param countRate set the media playback timer, if `nil`, will default to 1.0 + @param forwardSeekIndicator - forwardSeekIndicator + @param backSeekIndicator - backSeekIndicator + @return An object of SetMediaClockTimer + */ ++ (instancetype)countUpFromStartTimeInterval:(NSTimeInterval)startTime toEndTimeInterval:(NSTimeInterval)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator forwardSeekIndicator:(nullable SDLSeekStreamingIndicator *)forwardSeekIndicator backSeekIndicator:(nullable SDLSeekStreamingIndicator *)backSeekIndicator countRate:(nullable NSNumber<SDLFloat> *)countRate NS_SWIFT_NAME(countUp(from:to:playPauseIndicator:forwardSeekIndicator:backSeekIndicator:countRate:)); + +/** + Create a media clock timer that counts up, e.g from 0:00 to 4:18. + + This will fail if startTime is greater than endTime + + @param startTime The start time interval, e.g. 0:00 + @param endTime The end time interval, e.g. 4:18 + @param playPauseIndicator An optional audio indicator to change the play/pause button + @return An object of SetMediaClockTimer + */ ++ (instancetype)countUpFromStartTime:(SDLStartTime *)startTime toEndTime:(SDLStartTime *)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(countUp(from:to:playPauseIndicator:)) __deprecated_msg("Use countUpFromStartTime:toEndTime:playPauseIndicator:forwardSeekIndicator:backSeekIndicator:countRate: instead"); /** Create a media clock timer that counts up, e.g from 0:00 to 4:18. @@ -43,9 +71,12 @@ NS_ASSUME_NONNULL_BEGIN @param startTime The start time interval, e.g. 0:00 @param endTime The end time interval, e.g. 4:18 @param playPauseIndicator An optional audio indicator to change the play/pause button + @param forwardSeekIndicator - forwardSeekIndicator + @param backSeekIndicator - backSeekIndicator + @param countRate set the media playback timer, if `nil`, will default to 1.0 @return An object of SetMediaClockTimer */ -+ (instancetype)countUpFromStartTime:(SDLStartTime *)startTime toEndTime:(SDLStartTime *)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(countUp(from:to:playPauseIndicator:)); ++ (instancetype)countUpFromStartTime:(SDLStartTime *)startTime toEndTime:(SDLStartTime *)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator forwardSeekIndicator:(nullable SDLSeekStreamingIndicator *)forwardSeekIndicator backSeekIndicator:(nullable SDLSeekStreamingIndicator *)backSeekIndicator countRate:(nullable NSNumber<SDLFloat> *)countRate NS_SWIFT_NAME(countUp(from:to:playPauseIndicator:forwardSeekIndicator:backSeekIndicator:countRate:)); /** Create a media clock timer that counts down, e.g. from 4:18 to 0:00 @@ -57,7 +88,34 @@ NS_ASSUME_NONNULL_BEGIN @param playPauseIndicator An optional audio indicator to change the play/pause button @return An object of SetMediaClockTimer */ -+ (instancetype)countDownFromStartTimeInterval:(NSTimeInterval)startTime toEndTimeInterval:(NSTimeInterval)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(countDown(from:to:playPauseIndicator:)); ++ (instancetype)countDownFromStartTimeInterval:(NSTimeInterval)startTime toEndTimeInterval:(NSTimeInterval)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(countDown(from:to:playPauseIndicator:)) __deprecated_msg("Use countDownFromStartTimeInterval:toEndTimeInterval:playPauseIndicator:forwardSeekIndicator:backSeekIndicator:countRate: instead"); + +/** + Create a media clock timer that counts down, e.g. from 4:18 to 0:00 + + This will fail if endTime is greater than startTime + + @param startTime The start time interval, e.g. (258) 4:18 + @param endTime The end time interval, e.g. (0) 0:00 + @param playPauseIndicator An optional audio indicator to change the play/pause button + @param forwardSeekIndicator - forwardSeekIndicator + @param backSeekIndicator - backSeekIndicator + @param countRate set the media playback timer, if `nil`, will default to 1.0 + @return An object of SetMediaClockTimer + */ ++ (instancetype)countDownFromStartTimeInterval:(NSTimeInterval)startTime toEndTimeInterval:(NSTimeInterval)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator forwardSeekIndicator:(nullable SDLSeekStreamingIndicator *)forwardSeekIndicator backSeekIndicator:(nullable SDLSeekStreamingIndicator *)backSeekIndicator countRate:(nullable NSNumber<SDLFloat> *)countRate NS_SWIFT_NAME(countDown(from:to:playPauseIndicator:forwardSeekIndicator:backSeekIndicator:countRate:)); + +/** + Create a media clock timer that counts down, e.g. from 4:18 to 0:00 + + This will fail if endTime is greater than startTime + + @param startTime The start time interval, e.g. 4:18 + @param endTime The end time interval, e.g. 0:00 + @param playPauseIndicator An optional audio indicator to change the play/pause button + @return An object of SetMediaClockTimer + */ ++ (instancetype)countDownFromStartTime:(SDLStartTime *)startTime toEndTime:(SDLStartTime *)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(countDown(from:to:playPauseIndicator:)) __deprecated_msg("Use countDownFromStartTime:toEndTime:playPauseIndicator:forwardSeekIndicator:backSeekIndicator:countRate: instead"); /** Create a media clock timer that counts down, e.g. from 4:18 to 0:00 @@ -67,9 +125,12 @@ NS_ASSUME_NONNULL_BEGIN @param startTime The start time interval, e.g. 4:18 @param endTime The end time interval, e.g. 0:00 @param playPauseIndicator An optional audio indicator to change the play/pause button + @param forwardSeekIndicator - forwardSeekIndicator + @param backSeekIndicator - backSeekIndicator + @param countRate set the media playback timer, if `nil`, will default to 1.0 @return An object of SetMediaClockTimer */ -+ (instancetype)countDownFromStartTime:(SDLStartTime *)startTime toEndTime:(SDLStartTime *)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(countDown(from:to:playPauseIndicator:)); ++ (instancetype)countDownFromStartTime:(SDLStartTime *)startTime toEndTime:(SDLStartTime *)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator forwardSeekIndicator:(nullable SDLSeekStreamingIndicator *)forwardSeekIndicator backSeekIndicator:(nullable SDLSeekStreamingIndicator *)backSeekIndicator countRate:(nullable NSNumber<SDLFloat> *)countRate NS_SWIFT_NAME(countDown(from:to:playPauseIndicator:forwardSeekIndicator:backSeekIndicator:countRate:)); /** Pause an existing (counting up / down) media clock timer @@ -105,7 +166,18 @@ NS_ASSUME_NONNULL_BEGIN @param playPauseIndicator An optional audio indicator to change the play/pause button @return An object of SetMediaClockTimer */ -+ (instancetype)resumeWithPlayPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(resume(playPauseIndicator:)); ++ (instancetype)resumeWithPlayPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(resume(playPauseIndicator:)) __deprecated_msg("Use resumeWithPlayPauseIndicator:playPauseIndicator:forwardSeekIndicator:backSeekIndicator:countRate:"); + +/** + Resume a paused media clock timer. It resumes at the same time at which it was paused. + + @param playPauseIndicator An optional audio indicator to change the play/pause button + @param forwardSeekIndicator - forwardSeekIndicator + @param backSeekIndicator - backSeekIndicator + @param countRate set the media playback timer + @return An object of SetMediaClockTimer, if `nil`, will default to 1.0 + */ ++ (instancetype)resumeWithPlayPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator forwardSeekIndicator:(nullable SDLSeekStreamingIndicator *)forwardSeekIndicator backSeekIndicator:(nullable SDLSeekStreamingIndicator *)backSeekIndicator countRate:(nullable NSNumber<SDLFloat> *)countRate NS_SWIFT_NAME(resume(playPauseIndicator:forwardSeekIndicator:backSeekIndicator:countRate:)); /** Remove a media clock timer from the screen @@ -116,6 +188,12 @@ NS_ASSUME_NONNULL_BEGIN + (instancetype)clearWithPlayPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(clear(playPauseIndicator:)); /** + * @param updateMode - updateMode + * @return A SDLSetMediaClockTimer object + */ +- (instancetype)initWithUpdateMode:(SDLUpdateMode)updateMode; + +/** Create a SetMediaClockTimer RPC with all available parameters. It's recommended to use the specific initializers above. @param updateMode The type of SetMediaClockTimer RPC @@ -124,7 +202,19 @@ NS_ASSUME_NONNULL_BEGIN @param playPauseIndicator The display of the play/pause button @return An object of SetMediaClockTimer */ -- (instancetype)initWithUpdateMode:(SDLUpdateMode)updateMode startTime:(nullable SDLStartTime *)startTime endTime:(nullable SDLStartTime *)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(init(updateMode:startTime:endTime:playPauseIndicator:)); +- (instancetype)initWithUpdateMode:(SDLUpdateMode)updateMode startTime:(nullable SDLStartTime *)startTime endTime:(nullable SDLStartTime *)endTime playPauseIndicator:(nullable SDLAudioStreamingIndicator)playPauseIndicator NS_SWIFT_NAME(init(updateMode:startTime:endTime:playPauseIndicator:)) __deprecated_msg("Use initWithUpdateMode:startTime:endTime:audioStreamingIndicator:forwardSeekIndicator:backSeekIndicator:countRate: instead"); + +/** + * @param updateMode - updateMode + * @param startTime - startTime + * @param endTime - endTime + * @param audioStreamingIndicator - audioStreamingIndicator + * @param forwardSeekIndicator - forwardSeekIndicator + * @param backSeekIndicator - backSeekIndicator + * @param countRate - countRate + * @return A SDLSetMediaClockTimer object + */ +- (instancetype)initWithUpdateMode:(SDLUpdateMode)updateMode startTime:(nullable SDLStartTime *)startTime endTime:(nullable SDLStartTime *)endTime audioStreamingIndicator:(nullable SDLAudioStreamingIndicator)audioStreamingIndicator forwardSeekIndicator:(nullable SDLSeekStreamingIndicator *)forwardSeekIndicator backSeekIndicator:(nullable SDLSeekStreamingIndicator *)backSeekIndicator countRate:(nullable NSNumber<SDLFloat> *)countRate; /** * A Start Time with specifying hour, minute, second values @@ -169,6 +259,28 @@ NS_ASSUME_NONNULL_BEGIN */ @property (strong, nonatomic, nullable) SDLAudioStreamingIndicator audioStreamingIndicator; +/** + * Used to control the forward seek button to either skip forward a set amount of time or to the next track. + * + * @added in SmartDeviceLink 7.1.0 + */ +@property (nullable, strong, nonatomic) SDLSeekStreamingIndicator *forwardSeekIndicator; + +/** + * Used to control the back seek button to either skip back a set amount of time or to the previous track. + * + * @added in SmartDeviceLink 7.1.0 + */ +@property (nullable, strong, nonatomic) SDLSeekStreamingIndicator *backSeekIndicator; + +/** + * The value of this parameter is the amount that the media clock timer will advance per 1.0 seconds of real time. Values less than 1.0 will therefore advance the timer slower than real-time, while values greater than 1.0 will advance the timer faster than real-time. e.g. If this parameter is set to `0.5`, the timer will advance one second per two seconds real-time, or at 50% speed. If this parameter is set to `2.0`, the timer will advance two seconds per one second real-time, or at 200% speed. + * {"num_min_value": 0.1, "num_max_value": 100.0, "default_value": 1.0} + * + * @added in SmartDeviceLink 7.1.0 + */ +@property (nullable, strong, nonatomic) NSNumber<SDLFloat> *countRate; + @end NS_ASSUME_NONNULL_END |