java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
Function Group: Base
HMILevel needs to be FULL, LIMITIED 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
public static final java.lang.String KEY_START_TIME
public static final java.lang.String KEY_END_TIME
public static final java.lang.String KEY_UPDATE_MODE
public static final java.lang.String KEY_AUDIO_STREAMING_INDICATOR
Constructs a new SetMediaClockTimer object
public SetMediaClockTimer()
Constructs a new SetMediaClockTimer object indicated by the Hashtable parameter
public SetMediaClockTimer(java.util.Hashtable<java.lang.String, java.lang.Object> hash)
Constructs a new SetMediaClockTimer object
public SetMediaClockTimer(UpdateMode updateMode)
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)
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)
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)
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)
Pause an existing (counting up / down) media clock timer
public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer pauseWithPlayPauseIndicator(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)
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)
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)
Remove a media clock timer from the screen
public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer clearWithPlayPauseIndicator(AudioStreamingIndicator audioStreamingIndicator)
Gets the Start Time which media clock timer is set
public com.smartdevicelink.proxy.rpc.StartTime getStartTime()
Sets a Start Time with specifying hour, minute, second values
public void setStartTime(StartTime startTime)
public com.smartdevicelink.proxy.rpc.StartTime getEndTime()
public void setEndTime(StartTime endTime)
Gets the media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)
public com.smartdevicelink.proxy.rpc.enums.UpdateMode getUpdateMode()
Sets the media clock/timer update mode (COUNTUP/COUNTDOWN/PAUSE/RESUME)
public void setUpdateMode(UpdateMode updateMode)
Gets the playback status of a media app
public com.smartdevicelink.proxy.rpc.enums.AudioStreamingIndicator getAudioStreamingIndicator()
Sets the playback status of a media app
public void setAudioStreamingIndicator(AudioStreamingIndicator audioStreamingIndicator)
| 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, deserializeJSONObject, 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 |