Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
HMI Documentation
GetCapabilities

GetCapabilities

Type
Function
Sender
SDL
Purpose
Get the capabilities of buttons in the vehicle.

Request

SDL requests HMI to provide capabilities of supported buttons and saves received capabilities internally.

Parameters

This RPC has no additional parameter requirements

Response

Must

Check hmi_capabilities, and respond to SDL providing the capabilities of supported buttons.

Parameters

Name Type Mandatory Additional
capabilities Common.ButtonCapabilities true array: true
minsize: 1
maxsize: 100
presetBankCapabilities Common.PresetBankCapabilities false

Sequence Diagrams

JSON Message Examples

Example Request

{
  "id" : 20,
  "jsonrpc" : "2.0",
  "method" : "Buttons.GetCapabilities"
}

Example Response

{
  "id" : 20,
  "jsonrpc" : "2.0",
  "result" :
  {
    "capabilities" :
    [
      {
        "name" : "OK",
        "shortPressAvailable" : true,
        "longPressAvailable" : true,
        "upDownAvailable" : true
      },
      {
        "name" : "SEEKLEFT",
        "shortPressAvailable" : true,
        "longPressAvailable" : true,
        "upDownAvailable" : true
      },
      {
        "name" : "SEEKRIGHT",
        "shortPressAvailable" : true,
        "longPressAvailable" : true,
        "upDownAvailable" : true
      },
      {
        "name" : "TUNEUP",
        "shortPressAvailable" : true,
        "longPressAvailable" : true,
        "upDownAvailable" : true
      },
      {
        "name" : "TUNEDOWN",
        "shortPressAvailable" : true,
        "longPressAvailable" : true,
        "upDownAvailable" : true
      }
    ],
    "presetBankCapabilities" :
    {
      "onScreenPresetsAvailable" : true
    },
    "code" : 0,
    "method" : "Buttons.GetCapabilities"
  }
}

Example Error

{
  "id" : 20,
  "jsonrpc" : "2.0",
  "error" :
  {
    "code" : 9,
    "message" : "The requested data is not available",
    "data" :
    {
      "method" : "Buttons.GetCapabilities"
    }
  }
}
View on GitHub.com
Previous Section Next Section