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

SetVideoConfig

Type
Function
Sender
SDL
Purpose
Negotiate parameters for a new video stream

UI.SetVideoConfig represents a request from the app to determine whether a given video streaming configuration is supported by the HMI.

Must

The HMI must return a SUCCESS result code if it is able to handle a stream with the provided parameters.

Must

The HMI must return a REJECTED result code if it is not able to handle a stream with the provided parameters, with any such parameters being included in rejectedParams.

Request

Parameters

Name Type Mandatory Additional
config Common.VideoConfig true
appID Integer true

Response

Parameters

Name Type Mandatory Additional
rejectedParams String true array: true
minsize: 1
maxsize: 1000

Sequence Diagrams

Example Request

{
  "id" : 70,
  "jsonrpc" : "2.0",
  "method" : "UI.SetVideoConfig",
  "params" :
  {
    "config" : 
    {
      "codec": "H264",
      "protocol": "RTP",
      "width": 800,
      "height": 600
    },
    "appID" : 65464
  }
}

Example Response

{
  "id" : 70,
  "jsonrpc" : "2.0",
  "result" :
  {
    "code" : 0,
    "method" : "UI.SetVideoConfig"
  }
}

Example Error

{
  "id" : 70,
  "jsonrpc" : "2.0",
  "result" :
  {
    "code" : 4,
    "rejectedParams": ["codec", "width"],
    "method" : "UI.SetVideoConfig"
  }
}
View on GitHub.com
Previous Section Next Section