ホーム > 開発 > IP コントロール > REST API > APIリスト

getCurrentExternalInputsStatus (v1.0)

Estimated reading time: 2 minutes

This API provides information on the current status of all external input sources of the device.

Syntax

http://<Base URL>/avContent

Authentication Level

none

Request

params' Elements
Not necessary.
JSON Example
{
    "method": "getCurrentExternalInputsStatus",
    "id": 105,
    "params": [],
    "version": "1.0"
}

Response

result's Elements
An array of objects composed of the following pairs.
name type multiplicity default description
uri string 1 URI to identify the content. Refer to here to learn the URI structure in detail.
  • (ex) "extInput:hdmi?port=2"
title string 1 Name of input.
  • (ex) "HDMI 2"
  • (ex) "Component 1"
connection boolean 1 Input connection status.
  • true - connected
  • false - not connected
label string 1 Label name of the input set by the user.
  • (ex) "Game"
icon string 1 Icon type to give a hint to the application which icon to show for the user. The type is indicated by a "meta" URI format and implies that the developers of the client side should prepare some actual images with respect to the meta URI. The following meta URIs are defined.
  • "meta:composite" - Composite input
  • "meta:svideo" - S-Video input
  • "meta:composite_componentd" - Composite and D-Component combined input
  • "meta:component" - Component input (Y and Pb/Cb and Pr/Cr connectors)
  • "meta:componentd" - D-Component input
  • "meta:scart" - SCART input
  • "meta:hdmi" - HDMI input
  • "meta:dsub15" - D-subminiature 15pin input
  • "meta:tuner" - Tuner device is connected.
  • "meta:tape" - Tape player device is connected.
  • "meta:disc" - Disk player device is connected.
  • "meta:complex" - Complex device is connected.
  • "meta:avamp" - AV amp device is connected.
  • "meta:hometheater" - Home theater device is connected.
  • "meta:game" - Game player is connected.
  • "meta:camcoder" - Video camera is connected.
  • "meta:digitalcamera" - Still camera is connected.
  • "meta:pc" - Personal computer is connected.
  • "meta:tv" - TV-type CEC device is connected.
  • "meta:audiosystem" - Audio system-type CEC device is connected.
  • "meta:recordingdevice" - Recording-type CEC device is connected.
  • "meta:playbackdevice" - Playback-type CEC device is connected.
  • "meta:tunerdevice" - Tuner-type CEC device is connected.
  • "meta:wifidisplay" - WiFi Display input
JSON Example
{
    "result": [[
        {
            "icon": "meta:game",
            "connection": false,
            "label": "GAME",
            "title": "Component1",
            "uri": "extInput:component?port=1"
        },
        {
            "icon": "meta:component",
            "connection": true,
            "label": "",
            "title": "Component2",
            "uri": "extInput:component?port=2"
        },
        {
            "icon": "meta:hdmi",
            "connection": true,
            "label": "",
            "title": "HDMI1",
            "uri": "extInput:hdmi?port=1"
        },
        {
            "icon": "meta:recordingdevice",
            "connection": true,
            "label": "BDPlayer",
            "title": "Player1",
            "uri": "extInputs:cec?type=player&port=1"
        }
    ]],
    "id": 105
}
Error Code
No additional error codes are defined. Refer to error code for common errors.
Last modified: 26 Jul 2024