com.smartdevicelink.proxy.rpc

Class SetMediaClockTimer

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.SetMediaClockTimer

All Implemented Interfaces:

Cloneable

public class SetMediaClockTimer
extends RPCRequest

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, LIMITED or BACKGROUND

Parameter List

Param Name	Type	Description	Req.	Notes	Version Available
startTime	StartTime	StartTime struct specifying hour, minute, second values to which media clock timer is set.	N		SmartDeviceLink 1.0
endTime	StartTime	EndTime can be provided for "COUNTUP" and "COUNTDOWN"; to be used to calculate any visual progress bar (if not provided, this feature is ignored) If endTime is greater than startTime for COUNTDOWN or less than startTime for COUNTUP, then the request will return an INVALID_DATA. endTime will be ignored for "RESUME", and "CLEAR" endTime can be sent for "PAUSE", in which case it will update the paused endTime	N	Array must have at least one element. Only optional it helpPrompt has been specified minsize: 1; maxsize: 100	SmartDeviceLink 1.0
updateMode	UpdateMode	Specifies how the media clock/timer is to be updated (COUNTUP/COUNTDOWN/PAUSE/RESUME), based at the startTime.	Y	If "updateMode" is COUNTUP or COUNTDOWN, this parameter must be provided. Will be ignored for PAUSE,RESUME and CLEAR	SmartDeviceLink 1.0
audioStreamingIndicator	AudioStreamingIndicator		N		SmartDeviceLink 5.0
countRate	Float	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.	N	{"num_min_value": 0.1, "num_max_value": 100.0}	Since: SmartDeviceLink 7.1.0
forwardSeekIndicator	SeekStreamingIndicator	Used to control the forward seek button to either skip forward a set amount of time or to the next track.	N		, SmartDeviceLink 7.1.0
backSeekIndicator	SeekStreamingIndicator	Used to control the forward seek button to either skip back a set amount of time or to the previous track.	N		, SmartDeviceLink 7.1.0

Response

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

IGNORED

, SmartDeviceLink 1.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_AUDIO_STREAMING_INDICATOR
static String	KEY_BACK_SEEK_INDICATOR
static String	KEY_COUNT_RATE
static String	KEY_END_TIME
static String	KEY_FORWARD_SEEK_INDICATOR
static String	KEY_START_TIME
static String	KEY_UPDATE_MODE

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
SetMediaClockTimer() Constructs a new SetMediaClockTimer object
SetMediaClockTimer(Hashtable<String,Object> hash) Constructs a new SetMediaClockTimer object indicated by the Hashtable parameter
SetMediaClockTimer(UpdateMode updateMode) Constructs a new SetMediaClockTimer object

Method Summary

Modifier and Type	Method and Description
static SetMediaClockTimer	clearWithPlayPauseIndicator(AudioStreamingIndicator audioStreamingIndicator) Remove a media clock timer from the screen
static SetMediaClockTimer	countDownFromStartTime(StartTime startTime, StartTime endTime, AudioStreamingIndicator audioStreamingIndicator) Create a media clock timer that counts down, e.g.
static SetMediaClockTimer	countDownFromStartTimeInterval(Integer startTimeInterval, Integer endTimeInterval, AudioStreamingIndicator audioStreamingIndicator) Create a media clock timer that counts down, e.g.
static SetMediaClockTimer	countUpFromStartTime(StartTime startTime, StartTime endTime, AudioStreamingIndicator audioStreamingIndicator) Create a media clock timer that counts up, e.g from 0:00 to 4:18.
static SetMediaClockTimer	countUpFromStartTimeInterval(Integer startTimeInterval, Integer endTimeInterval, AudioStreamingIndicator audioStreamingIndicator) Create a media clock timer that counts up, e.g from 0:00 to 4:18.
AudioStreamingIndicator	getAudioStreamingIndicator() Gets the playback status of a media app
SeekStreamingIndicator	getBackSeekIndicator() Gets the backSeekIndicator.
Float	getCountRate() Gets the countRate.
StartTime	getEndTime()
SeekStreamingIndicator	getForwardSeekIndicator() Gets the forwardSeekIndicator.
StartTime	getStartTime() Gets the Start Time which media clock timer is set
UpdateMode	getUpdateMode() Gets the media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)
static SetMediaClockTimer	pauseWithPlayPauseIndicator(AudioStreamingIndicator audioStreamingIndicator) Pause an existing (counting up / down) media clock timer
static SetMediaClockTimer	resumeWithPlayPauseIndicator(AudioStreamingIndicator audioStreamingIndicator) Resume a paused media clock timer.
SetMediaClockTimer	setAudioStreamingIndicator(AudioStreamingIndicator audioStreamingIndicator) Sets the playback status of a media app
SetMediaClockTimer	setBackSeekIndicator(SeekStreamingIndicator backSeekIndicator) Sets the backSeekIndicator.
SetMediaClockTimer	setCountRate(Float countRate) Sets the countRate.
SetMediaClockTimer	setEndTime(StartTime endTime)
SetMediaClockTimer	setForwardSeekIndicator(SeekStreamingIndicator forwardSeekIndicator) Sets the forwardSeekIndicator.
SetMediaClockTimer	setStartTime(StartTime startTime) Sets a Start Time with specifying hour, minute, second values
SetMediaClockTimer	setUpdateMode(UpdateMode updateMode) Sets the media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)
static SetMediaClockTimer	updatePauseWithNewStartTime(StartTime startTime, StartTime endTime, AudioStreamingIndicator audioStreamingIndicator) Update a pause time (or pause and update the time) on a media clock timer
static SetMediaClockTimer	updatePauseWithNewStartTimeInterval(Integer startTimeInterval, Integer endTimeInterval, AudioStreamingIndicator audioStreamingIndicator) Update a pause time (or pause and update the time) on a media clock timer

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_START_TIME

public static final String KEY_START_TIME

See Also:

Constant Field Values

KEY_END_TIME

public static final String KEY_END_TIME

See Also:

Constant Field Values

KEY_UPDATE_MODE

public static final String KEY_UPDATE_MODE

See Also:

Constant Field Values

KEY_AUDIO_STREAMING_INDICATOR

public static final String KEY_AUDIO_STREAMING_INDICATOR

See Also:

Constant Field Values

KEY_COUNT_RATE

public static final String KEY_COUNT_RATE

See Also:

Constant Field Values

KEY_FORWARD_SEEK_INDICATOR

public static final String KEY_FORWARD_SEEK_INDICATOR

See Also:

Constant Field Values

KEY_BACK_SEEK_INDICATOR

public static final String KEY_BACK_SEEK_INDICATOR

See Also:

Constant Field Values

Constructor Detail

SetMediaClockTimer

public SetMediaClockTimer()

Constructs a new SetMediaClockTimer object

SetMediaClockTimer

public SetMediaClockTimer(Hashtable<String,Object> hash)

Constructs a new SetMediaClockTimer object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

SetMediaClockTimer

public SetMediaClockTimer(@NonNull
                          UpdateMode updateMode)

Constructs a new SetMediaClockTimer object

Parameters:

updateMode - 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

Method Detail

countUpFromStartTimeInterval

public static SetMediaClockTimer countUpFromStartTimeInterval(@NonNull
                                                              Integer startTimeInterval,
                                                              @NonNull
                                                              Integer endTimeInterval,
                                                              @Nullable
                                                              AudioStreamingIndicator audioStreamingIndicator)

Create a media clock timer that counts up, e.g from 0:00 to 4:18.

Parameters:

startTimeInterval - The start time interval, e.g. (0) 0:00

endTimeInterval - The end time interval, e.g. (258) 4:18

audioStreamingIndicator - playPauseIndicator An optional audio indicator to change the play/pause button

Returns:

An object of SetMediaClockTimer

countUpFromStartTime

public static SetMediaClockTimer countUpFromStartTime(@NonNull
                                                      StartTime startTime,
                                                      @NonNull
                                                      StartTime endTime,
                                                      @Nullable
                                                      AudioStreamingIndicator audioStreamingIndicator)

Create a media clock timer that counts up, e.g from 0:00 to 4:18.

Parameters:

startTime - The start time interval, e.g. 0:00

endTime - The end time interval, e.g. 4:18

audioStreamingIndicator - An optional audio indicator to change the play/pause button

Returns:

An object of SetMediaClockTimer

countDownFromStartTimeInterval

public static SetMediaClockTimer countDownFromStartTimeInterval(@NonNull
                                                                Integer startTimeInterval,
                                                                @NonNull
                                                                Integer endTimeInterval,
                                                                @Nullable
                                                                AudioStreamingIndicator audioStreamingIndicator)

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

Parameters:

startTimeInterval - The start time interval, e.g. (258) 4:18

endTimeInterval - The end time interval, e.g. (0) 0:00

audioStreamingIndicator - An optional audio indicator to change the play/pause button

Returns:

An object of SetMediaClockTimer

countDownFromStartTime

public static SetMediaClockTimer countDownFromStartTime(@NonNull
                                                        StartTime startTime,
                                                        @NonNull
                                                        StartTime endTime,
                                                        @Nullable
                                                        AudioStreamingIndicator audioStreamingIndicator)

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

Parameters:

startTime - The start time interval, e.g. 4:18

endTime - The end time interval, e.g. 0:00

audioStreamingIndicator - An optional audio indicator to change the play/pause button

Returns:

An object of SetMediaClockTimer

pauseWithPlayPauseIndicator

public static SetMediaClockTimer pauseWithPlayPauseIndicator(@Nullable
                                                             AudioStreamingIndicator audioStreamingIndicator)

Pause an existing (counting up / down) media clock timer

Parameters:

audioStreamingIndicator - An optional audio indicator to change the play/pause button

Returns:

An object of SetMediaClockTimer

updatePauseWithNewStartTimeInterval

public static SetMediaClockTimer updatePauseWithNewStartTimeInterval(@NonNull
                                                                     Integer startTimeInterval,
                                                                     @NonNull
                                                                     Integer endTimeInterval,
                                                                     @Nullable
                                                                     AudioStreamingIndicator audioStreamingIndicator)

Update a pause time (or pause and update the time) on a media clock timer

Parameters:

startTimeInterval - The new start time interval

endTimeInterval - The new end time interval

audioStreamingIndicator - An optional audio indicator to change the play/pause button

Returns:

An object of SetMediaClockTimer

updatePauseWithNewStartTime

public static SetMediaClockTimer updatePauseWithNewStartTime(@NonNull
                                                             StartTime startTime,
                                                             @NonNull
                                                             StartTime endTime,
                                                             @Nullable
                                                             AudioStreamingIndicator audioStreamingIndicator)

Update a pause time (or pause and update the time) on a media clock timer

Parameters:

startTime - The new start time

endTime - The new end time

audioStreamingIndicator - An optional audio indicator to change the play/pause button

Returns:

An object of SetMediaClockTimer

resumeWithPlayPauseIndicator

public static SetMediaClockTimer resumeWithPlayPauseIndicator(@Nullable
                                                              AudioStreamingIndicator audioStreamingIndicator)

Resume a paused media clock timer. It resumes at the same time at which it was paused.

Parameters:

audioStreamingIndicator - An optional audio indicator to change the play/pause button

Returns:

An object of SetMediaClockTimer

clearWithPlayPauseIndicator

public static SetMediaClockTimer clearWithPlayPauseIndicator(@Nullable
                                                             AudioStreamingIndicator audioStreamingIndicator)

Remove a media clock timer from the screen

Parameters:

audioStreamingIndicator - An optional audio indicator to change the play/pause button

Returns:

An object of SetMediaClockTimer

getStartTime

public StartTime getStartTime()

Gets the Start Time which media clock timer is set

Returns:

StartTime -a StartTime object specifying hour, minute, second values

setStartTime

public SetMediaClockTimer setStartTime(StartTime startTime)

Sets a Start Time with specifying hour, minute, second values

Parameters:

startTime - 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

getEndTime

public StartTime getEndTime()

setEndTime

public SetMediaClockTimer setEndTime(StartTime endTime)

getUpdateMode

public UpdateMode getUpdateMode()

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

Returns:

UpdateMode -a Enumeration value (COUNTUP/COUNTDOWN/PAUSE/RESUME)

setUpdateMode

public SetMediaClockTimer setUpdateMode(@NonNull
                                        UpdateMode updateMode)

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

Parameters:

updateMode - 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

getAudioStreamingIndicator

public AudioStreamingIndicator getAudioStreamingIndicator()

Gets the playback status of a media app

Returns:

AudioStreamingIndicator - a Enumeration value

setAudioStreamingIndicator

public SetMediaClockTimer setAudioStreamingIndicator(AudioStreamingIndicator audioStreamingIndicator)

Sets the playback status of a media app

setCountRate

public SetMediaClockTimer setCountRate(Float countRate)

Sets the countRate.

Parameters:

countRate - 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}

Since:

SmartDeviceLink 7.1.0

getCountRate

public Float getCountRate()

Gets the countRate.

Returns:

Float 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}

Since:

SmartDeviceLink 7.1.0

setForwardSeekIndicator

public SetMediaClockTimer setForwardSeekIndicator(SeekStreamingIndicator forwardSeekIndicator)

Sets the forwardSeekIndicator.

Parameters:

forwardSeekIndicator - Used to control the forward seek button to either skip forward a set amount of time or to the next track.

Since:

SmartDeviceLink 7.1.0

getForwardSeekIndicator

public SeekStreamingIndicator getForwardSeekIndicator()

Gets the forwardSeekIndicator.

Returns:

SeekStreamingIndicator Used to control the forward seek button to either skip forward a set amount of time or to the next track.

Since:

SmartDeviceLink 7.1.0

setBackSeekIndicator

public SetMediaClockTimer setBackSeekIndicator(SeekStreamingIndicator backSeekIndicator)

Sets the backSeekIndicator.

Parameters:

backSeekIndicator - Used to control the forward seek button to either skip back a set amount of time or to the previous track.

Since:

SmartDeviceLink 7.1.0

getBackSeekIndicator

public SeekStreamingIndicator getBackSeekIndicator()

Gets the backSeekIndicator.

Returns:

SeekStreamingIndicator Used to control the forward seek button to either skip back a set amount of time or to the previous track.

Since:

SmartDeviceLink 7.1.0