java.lang.Object
com.smartdevicelink.proxy.RPCStruct
com.smartdevicelink.proxy.RPCMessage
com.smartdevicelink.proxy.RPCRequest
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} |
Quick Jump
FieldsKEY_START_TIMEpublic static final java.lang.String KEY_START_TIME
KEY_END_TIMEpublic static final java.lang.String KEY_END_TIME
KEY_UPDATE_MODEpublic static final java.lang.String KEY_UPDATE_MODE
KEY_AUDIO_STREAMING_INDICATORpublic static final java.lang.String KEY_AUDIO_STREAMING_INDICATOR
KEY_COUNT_RATEpublic static final java.lang.String KEY_COUNT_RATE
KEY_FORWARD_SEEK_INDICATORpublic static final java.lang.String KEY_FORWARD_SEEK_INDICATOR
KEY_BACK_SEEK_INDICATORpublic static final java.lang.String KEY_BACK_SEEK_INDICATOR
Inherited FieldsConstructorsSetMediaClockTimer()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)
Constructor Parameters
SetMediaClockTimer( UpdateMode updateMode )Constructs a new SetMediaClockTimer object public SetMediaClockTimer(UpdateMode updateMode)
Constructor Parameters
MethodscountUpFromStartTimeInterval( 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)
Method Parameters
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)
Method Parameters
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)
Method Parameters
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)
Method Parameters
pauseWithPlayPauseIndicator( AudioStreamingIndicator audioStreamingIndicator )Pause an existing (counting up / down) media clock timer public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer pauseWithPlayPauseIndicator(AudioStreamingIndicator audioStreamingIndicator)
Method Parameters
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)
Method Parameters
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)
Method Parameters
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)
Method Parameters
clearWithPlayPauseIndicator( AudioStreamingIndicator audioStreamingIndicator )Remove a media clock timer from the screen public static com.smartdevicelink.proxy.rpc.SetMediaClockTimer clearWithPlayPauseIndicator(AudioStreamingIndicator audioStreamingIndicator)
Method Parameters
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)
Method Parameters
getEndTime()
public com.smartdevicelink.proxy.rpc.StartTime getEndTime()
setEndTime( StartTime endTime )
public com.smartdevicelink.proxy.rpc.SetMediaClockTimer setEndTime(StartTime endTime)
Method Parameters
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)
Method Parameters
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)
Method Parameters
setCountRate( Float countRate )Sets the countRate. public com.smartdevicelink.proxy.rpc.SetMediaClockTimer setCountRate(Float countRate)
Method Parameters
getCountRate()Gets the countRate. public java.lang.Float getCountRate()
setForwardSeekIndicator( SeekStreamingIndicator forwardSeekIndicator )Sets the forwardSeekIndicator. public com.smartdevicelink.proxy.rpc.SetMediaClockTimer setForwardSeekIndicator(SeekStreamingIndicator forwardSeekIndicator)
Method Parameters
getForwardSeekIndicator()Gets the forwardSeekIndicator. public com.smartdevicelink.proxy.rpc.SeekStreamingIndicator getForwardSeekIndicator()
setBackSeekIndicator( SeekStreamingIndicator backSeekIndicator )Sets the backSeekIndicator. public com.smartdevicelink.proxy.rpc.SetMediaClockTimer setBackSeekIndicator(SeekStreamingIndicator backSeekIndicator)
Method Parameters
getBackSeekIndicator()Gets the backSeekIndicator. public com.smartdevicelink.proxy.rpc.SeekStreamingIndicator getBackSeekIndicator()
Inherited Methods
|