Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
Sidebar

SDLSetMediaClockTimer Class Reference

Section Contents

Overview

Sets the media clock/timer value and the update method (e.g.count-up, count-down, etc.)

Function Group: Base

HMILevel needs to be FULL, LIMITIED or BACKGROUND

Since SmartDeviceLink 1.0

-initWithUpdateMode:hours:minutes:seconds:audioStreamingIndicator:

Undocumented

Objective-C

- (instancetype)initWithUpdateMode:(SDLUpdateMode)updateMode hours:(UInt8)hours minutes:(UInt8)minutes seconds:(UInt8)seconds audioStreamingIndicator:(SDLAudioStreamingIndicator)audioStreamingIndicator;

Swift

init(updateMode: SDLUpdateMode, hours: UInt8, minutes: UInt8, seconds: UInt8, audioStreamingIndicator: SDLAudioStreamingIndicator)

-initWithUpdateMode:hours:minutes:seconds:

Undocumented

Objective-C

- (instancetype)initWithUpdateMode:(SDLUpdateMode)updateMode hours:(UInt8)hours minutes:(UInt8)minutes seconds:(UInt8)seconds;

Swift

init(updateMode: SDLUpdateMode, hours: UInt8, minutes: UInt8, seconds: UInt8)

-initWithUpdateMode:

Undocumented

Objective-C

- (instancetype)initWithUpdateMode:(SDLUpdateMode)updateMode;

Swift

init(updateMode: SDLUpdateMode)

startTime

A Start Time with specifying hour, minute, second values

@discussion A startTime object with specifying hour, minute, second values

Notes:

  • If updateMode is COUNTUP or COUNTDOWN, this parameter must be provided
  • Will be ignored for PAUSE/RESUME and CLEAR

Objective-C

@property (readwrite, strong, nonatomic, nullable) SDLStartTime *startTime;

Swift

var startTime: SDLStartTime? { get set }

endTime

An END time of type SDLStartTime, specifying hour, minute, second values

@discussion An SDLStartTime object with specifying hour, minute, second values

Objective-C

@property (readwrite, strong, nonatomic, nullable) SDLStartTime *endTime;

Swift

var endTime: SDLStartTime? { get set }

updateMode

The media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)

@discussion a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME)

Notes:

  • When updateMode is PAUSE, RESUME or CLEAR, the start time value is ignored
  • When updateMode is RESUME, the timer resumes counting from the timer’s value when it was paused

Objective-C

@property (readwrite, strong, nonatomic) SDLUpdateMode _Nonnull updateMode;

Swift

var updateMode: SDLUpdateMode { get set }

audioStreamingIndicator

The audio streaming indicator used for a play/pause button.

@discussion Set the indicator icon of a play/pause button depending on the current audio playback. This parameter is optional. If omitted the last indicator sent will not change.

Objective-C

@property (readwrite, strong, nonatomic, nullable)
    SDLAudioStreamingIndicator audioStreamingIndicator;

Swift

var audioStreamingIndicator: SDLAudioStreamingIndicator? { get set }
View on GitHub.com
Previous Section Next Section