SmartDeviceLink - HMI Documentation

SetMediaClockTimer

Type: Function
Sender: SDL
Purpose: Set a value and update mode for the media clock of a media application.

The UI.SetMediaClock timer request indicates either an initial value for the media clock timer for a media application or an update to this value. The request may come for the application which is not currently active on the HMI.

Request

Must

Perform the update type indicated by the updateMode parameter:
- If the application is not active, the HMI must still store the values to be calculated for later display on the HMI.
- If the application is active, the updates must begin immediately.
Exhibit the following behavior based on the updateMode parameter:
- COUNTUP/COUNTDOWN modes:
  - Start counting up or down from the requested startTime value with a step of 1 second;
  - Continue counting up or down until:
    - The next request of SetMediaClockTimer with appropriate parameters comes;
    - Zero is reached in the case of COUNTDOWN.
- PAUSE mode:
  - Pause the timer that is counting up or down;
  - If startTime or endTime parameters are provided, the values must be updated on the HMI.
- CLEAR mode:
  - Clear startTime to 00:00:00 in the case that the startTime parameter is not provided in the request, otherwise, startTime must be updated with a new value. It is up to HMI to determine the way the media clock timer is cleared: either to remove it from display or to set it to zero.
Respond with the result code (see response section) correspondingly to the results of this RPC execution.

Note

SDL will not send this request if the mediaClock field is not indicated as supported in UI.GetCapabilities.
HMI must remember the mode and the value (continuing to update it in case of COUNTUP / COUNTDOWN) of the media clock timer associated with appID and display the accurate values whenever the appID application is activated after having been deactivated.
Initially, the appID together with other application-related information is provided by SDL within one of UpdateAppList and OnAppRegistered RPCs.

Parameters

Name	Type	Mandatory	Description
startTime	Common.TimeFormat	false	startTime must be provided together with modes: "COUNTUP", "COUNTDOWN", "PAUSE" to HMI. startTime will be ignored for "RESUME", and "CLEAR".
endTime	Common.TimeFormat	false	endTime can be provided together with modes: "COUNTUP", "COUNTDOWN", "PAUSE" to HMI. 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 "PAUSE", "RESUME", and "CLEAR".
updateMode	Common.ClockUpdateMode	true	Enumeration to control the media clock. In case of pause, resume, or clear, the start time value is ignored and shall be left out. For resume, the time continues with the same value as it was when paused.
audioStreamingIndicator	Common.AudioStreamingIndicator	false	Indicates that a button press of the Play/Pause button would play, pause or stop the current playback.
appID	Integer	true

Response

Parameters

Result	Description	Message type WebSocket	Message type D-Bus	Message Params	Notes
Success	SUCCESS: 1. HMI has started counting up or down the media clock from the requested value (in case of COUNTUP or COUNTDOWN requested mode). 2. HMI has paused the media clock value (PAUSE requested mode). 3. HMI has resumed the media clock in the mode that had been in effect before pausing, i.e. has started counting up or down (RESUME requested mode). 4. HMI has cleared the existing media clock value (CLEAR requested mode).	JSON response	Method return	code: 0	HMI must respond right after the action requested with updateMode parameter has been performed.
Failure	IGNORED: 1. Request with RESUME mode arrives when the media clock is counting, already resumed or cleared with the previous request. 2. Request with PAUSE mode arrives when the media clock is paused or cleared with the previous request.	JSON error message	Method return	code: 6	Applicable to this RPC result codes.
Failure	INVALID_DATA: The data sent is invalid (invalid JSON syntax or parameters out of bounds or of wrong type)	JSON error message	Method return	code: 11	Applicable to this RPC result codes.
Failure	INVALID_ID: appID is invalid (e.g. doesn’t exist)	JSON error message	Method return	code: 13	Applicable to this RPC result codes.
Failure	GENERIC_ERROR: The unknown issue occurred or other codes are not applicable.	JSON error message	Method return	code: 22	Applicable to this RPC result codes.

Sequence Diagrams

Sequence Diagram

SetMediaClockTimer COUNTUP and COUNTDOWN for Full and Background applications

View Diagram

Sequence Diagram

SetMediaClockTimer Pause and Resume for Active Application

View Diagram

Sequence Diagram

SetMediaClockTimer COUNTDOWN for a deactivated application

View Diagram

Example Request

{
  "id" : 109,
  "jsonrpc" : "2.0",
  "method" : "UI.SetMediaClockTimer",
  "params" :
  {
    "startTime" :
    {
         "hours" : 0,
         "minutes" : 18,
         "seconds" : 17
    },
    "updateMode" : "COUNTUP",
    "audioStreamingIndicator" : "PAUSE",
    "appID" : 65146
  }
}

Example Response

{
  "id" : 109,
  "jsonrpc" : "2.0",
  "result" :
  {
    "code" : 0,
    "method" : "UI.SetMediaClockTimer"
  }
}

Example Error

{
  "id" : 109,
  "jsonrpc" : "2.0",
  "error" :
  {
    "code" : 11,
    "message" : "Invalid data",
    "data" :
    {
      "method" : "UI.SetMediaClockTimer"
    }
  }
}

View on GitHub.com

Previous Section Next Section