Class SetMediaClockTimer

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct
         com.smartdevicelink.proxy.RPCMessage
             com.smartdevicelink.proxy.RPCRequest

Package: com.smartdevicelink.proxy.rpc

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, 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 then 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

Response

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

TOO_MANY_PENDING_REQUESTS

APPLICATION_NOT_REGISTERED

GENERIC_ERROR

REJECTED

IGNORED

Quick Jump

Fields

KEY_START_TIME
KEY_END_TIME
KEY_UPDATE_MODE
KEY_AUDIO_STREAMING_INDICATOR

Constructors

SetMediaClockTimer()
SetMediaClockTimer( java.util.Hashtable<java.lang.String, java.lang.Object> hash )
SetMediaClockTimer( UpdateMode updateMode )

Methods

countUpFromStartTimeInterval(Integer startTimeInterval,Integer endTimeInterval,AudioStreamingIndicator audioStreamingIndicator)
countUpFromStartTime(StartTime startTime,StartTime endTime,AudioStreamingIndicator audioStreamingIndicator)
countDownFromStartTimeInterval(Integer startTimeInterval,Integer endTimeInterval,AudioStreamingIndicator audioStreamingIndicator)
countDownFromStartTime(StartTime startTime,StartTime endTime,AudioStreamingIndicator audioStreamingIndicator)
pauseWithPlayPauseIndicator(AudioStreamingIndicator audioStreamingIndicator)
updatePauseWithNewStartTimeInterval(Integer startTimeInterval,Integer endTimeInterval,AudioStreamingIndicator audioStreamingIndicator)
updatePauseWithNewStartTime(StartTime startTime,StartTime endTime,AudioStreamingIndicator audioStreamingIndicator)
resumeWithPlayPauseIndicator(AudioStreamingIndicator audioStreamingIndicator)
clearWithPlayPauseIndicator(AudioStreamingIndicator audioStreamingIndicator)
getStartTime()
setStartTime(StartTime startTime)
getEndTime()
setEndTime(StartTime endTime)
getUpdateMode()
setUpdateMode(UpdateMode updateMode)
getAudioStreamingIndicator()
setAudioStreamingIndicator(AudioStreamingIndicator audioStreamingIndicator)

Fields

KEY_START_TIME

public static final java.lang.String KEY_START_TIME

Constant Value: "startTime"

KEY_END_TIME

public static final java.lang.String KEY_END_TIME

Constant Value: "endTime"

KEY_UPDATE_MODE

public static final java.lang.String KEY_UPDATE_MODE

Constant Value: "updateMode"

KEY_AUDIO_STREAMING_INDICATOR

public static final java.lang.String KEY_AUDIO_STREAMING_INDICATOR

Constant Value: "audioStreamingIndicator"

Inherited Fields

From Class	Fields
com.smartdevicelink.proxy.RPCRequest	onResponseListener
com.smartdevicelink.proxy.RPCMessage	KEY_REQUEST, KEY_RESPONSE, KEY_NOTIFICATION, KEY_FUNCTION_NAME, KEY_PARAMETERS, KEY_CORRELATION_ID, messageType, parameters, function
com.smartdevicelink.proxy.RPCStruct	KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

SetMediaClockTimer()

Constructs a new SetMediaClockTimer object

public SetMediaClockTimer()

SetMediaClockTimer( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a new SetMediaClockTimer object indicated by the Hashtable parameter

public SetMediaClockTimer(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Parameters

hash: The Hashtable to use

SetMediaClockTimer( UpdateMode updateMode )

Constructs a new SetMediaClockTimer object

public SetMediaClockTimer(UpdateMode updateMode)

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

Methods

countUpFromStartTimeInterval( Integer startTimeInterval, Integer endTimeInterval, AudioStreamingIndicator audioStreamingIndicator )

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

public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer countUpFromStartTimeInterval(Integer startTimeInterval,Integer endTimeInterval,AudioStreamingIndicator audioStreamingIndicator)

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

countUpFromStartTime( StartTime startTime, StartTime endTime, AudioStreamingIndicator audioStreamingIndicator )

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

public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer countUpFromStartTime(StartTime startTime,StartTime endTime,AudioStreamingIndicator audioStreamingIndicator)

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

countDownFromStartTimeInterval( Integer startTimeInterval, Integer endTimeInterval, 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

public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer countDownFromStartTimeInterval(Integer startTimeInterval,Integer endTimeInterval,AudioStreamingIndicator audioStreamingIndicator)

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

countDownFromStartTime( StartTime startTime, StartTime endTime, 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

public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer countDownFromStartTime(StartTime startTime,StartTime endTime,AudioStreamingIndicator audioStreamingIndicator)

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

pauseWithPlayPauseIndicator( AudioStreamingIndicator audioStreamingIndicator )

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

public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer pauseWithPlayPauseIndicator(AudioStreamingIndicator audioStreamingIndicator)

Parameters

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

updatePauseWithNewStartTimeInterval( Integer startTimeInterval, Integer endTimeInterval, AudioStreamingIndicator audioStreamingIndicator )

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

public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer updatePauseWithNewStartTimeInterval(Integer startTimeInterval,Integer endTimeInterval,AudioStreamingIndicator audioStreamingIndicator)

Parameters

startTimeInterval: The new start time interval
endTimeInterval: The new end time interval
audioStreamingIndicator: An optional audio indicator to change the play/pause button

updatePauseWithNewStartTime( StartTime startTime, StartTime endTime, AudioStreamingIndicator audioStreamingIndicator )

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

public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer updatePauseWithNewStartTime(StartTime startTime,StartTime endTime,AudioStreamingIndicator audioStreamingIndicator)

Parameters

startTime: The new start time
endTime: The new end time
audioStreamingIndicator: An optional audio indicator to change the play/pause button

resumeWithPlayPauseIndicator( AudioStreamingIndicator audioStreamingIndicator )

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

public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer resumeWithPlayPauseIndicator(AudioStreamingIndicator audioStreamingIndicator)

Parameters

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

clearWithPlayPauseIndicator( AudioStreamingIndicator audioStreamingIndicator )

Remove a media clock timer from the screen

public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer clearWithPlayPauseIndicator(AudioStreamingIndicator audioStreamingIndicator)

Parameters

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

getStartTime()

Gets the Start Time which media clock timer is set

public com.smartdevicelink.proxy.rpc.StartTime getStartTime()

setStartTime( StartTime startTime )

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

public com.smartdevicelink.proxy.rpc.SetMediaClockTimer setStartTime(StartTime startTime)

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 com.smartdevicelink.proxy.rpc.StartTime getEndTime()

setEndTime( StartTime endTime )

public com.smartdevicelink.proxy.rpc.SetMediaClockTimer setEndTime(StartTime endTime)

Parameters

endTime

getUpdateMode()

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

public com.smartdevicelink.proxy.rpc.enums.UpdateMode getUpdateMode()

setUpdateMode( UpdateMode updateMode )

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

public com.smartdevicelink.proxy.rpc.SetMediaClockTimer setUpdateMode(UpdateMode updateMode)

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()

Gets the playback status of a media app

public com.smartdevicelink.proxy.rpc.enums.AudioStreamingIndicator getAudioStreamingIndicator()

setAudioStreamingIndicator( AudioStreamingIndicator audioStreamingIndicator )

Sets the playback status of a media app

public com.smartdevicelink.proxy.rpc.SetMediaClockTimer setAudioStreamingIndicator(AudioStreamingIndicator audioStreamingIndicator)

Parameters

audioStreamingIndicator

Inherited Methods

From Class	Methods
com.smartdevicelink.proxy.RPCRequest	getCorrelationID, setCorrelationID, setOnRPCResponseListener, getOnRPCResponseListener
com.smartdevicelink.proxy.RPCMessage	getFunctionID, getFunctionName, setFunctionName, getMessageType, setParameters, getParameters, getObject, getString, getInteger, getFloat, getDouble, getBoolean, getLong
com.smartdevicelink.proxy.RPCStruct	getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong
java.lang.Object	getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize

View on GitHub.com

Previous Section Next Section