Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
IsReady

IsReady

Type
Function
Sender
SDL
Purpose
Request ready state of VR Module

Request

Note
  1. SDL sends VR.IsReady request after HMI confirms its readiness via BC.OnReady notification.
  2. If HMI responds with "available":false, SDL will not further communicate over VR interface with HMI.
  3. If HMI does not respond during SDL's default timeout, SDL will continue to send RPCs over VR interface to HMI.

Parameters

This RPC has no additional parameter requirements

Response

Must
  1. Check whether VR module is available and ready.
  2. Respond correspondingly to results of this check.

Parameters

Name Type Mandatory Additional
available Boolean true

Sequence Diagrams

JSON Message Examples

Example Request

{
  "id" : 45,
  "jsonrpc" : "2.0",
  "method" : "VR.IsReady"
}

Example Response

{
  "id" : 45,
  "jsonrpc" : "2.0",
  "result" :
  {
    "available" : true,
    "code" : 0,
    "method" : "VR.IsReady"
  }
}

Example Error

{
  "id" : 45,
  "jsonrpc" : "2.0",
  "error" :
  {
    "code" : 11,
    "message" : "Invalid data",
    "data" :
    {
      "method" : "VR.IsReady"
    }
  }
}
View on GitHub.com
Previous Section Next Section