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

getContentCount (v1.1)

Estimated reading time: 1 minute

This API provides the count of contents in the source. For example, this API returns the number of external inputs by indicating "extInput:hdmi" as the source.

Syntax

http://<Base URL>/avContent

Authentication Level

private

Request

params' Elements
An object composed of the following pair(s).
name type multiplicity default description
source string 1
Source name composed of the URI with a scheme and path. Refer to here to learn the source and URI structure in detail.
type string ? ""
(Refer to the type parameter of GetContentList)
target string ? ""
(Refer to the type parameter of GetContentList)
JSON Example
{
    "method": "getContentCount",
    "id": 11,
    "params": [{"source": "extInput:hdmi"}],
    "version": "1.1"
}

Response

result's Elements
An object composed of the following pair(s).
name type multiplicity default description
count integer 1
The number of contents in the source.
JSON Example
{
    "result": [{"count": 4}],
    "id": 11
}
Error Code
No additional error codes are defined. Refer to error code for common errors.
Last modified: 26 Jul 2024