Layer | ArcGIS REST APIs | Esri Developer

URL:: https://<root>/services/serviceName/VideoServer/<layerID>
Methods:: GET
Operations:: Update Camera, Update Layer, Update Poster, Start, Stop, Process, Clip, Frameset
Version Introduced:: 12.0

Description

The resource endpoint for a specific video service layer returns the properties associated with the layer.

Request parameters

Parameter Details

Parameter	Details
`f` (Required)	The output format for this operation. The default value is `html`. Values: `html` \| `json` \| `pjson`
`token` (Required)	Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

f

(Required)

The output format for this operation. The default value is html.

Values: html | json | pjson

token

(Required)

Users interacting programmatically with this endpoint must generate a token that must be included as a request parameter. A token can be obtained using the Generate Token operation.

Response properties

Property	Details
`serviceType`	The type of service associated with the layer. Values: `ondemand` \| `livestream`
`description`	A string provided as a description of the layer.
`livestreamInfo`	The `livestreamInfo` property contains information regarding livestream layers. In the case of `ondemand` layers, the property will appear as `null`. Livestream layers will contain the `sourceUrl`, `active`, `supportsConversion`, and `bufferSize` properties. These can be updated manually via the Update Layer operation.
`sourceQuality`	The video quality of the video used to create the layer. Values: `sd` \| `hd` \| `fhd` \| `uhd`
`connectionUrl`	When a layer is created, a HLS connection URL is generated that points to the `ABR.m3u8` file generated during layer creation. This URL is a direct link to the video's location on the server.
`id`	The ID of the selected layer. This is generated at the time of layer creation and counts up from `0` as integers.
`supportsMensuration`	Indicates whether a layer supports mensuration or not. Values: `true` \| `false`
`fullExtent`	This property includes details related to the full extent of the layer's spatial footprint. It includes `ymin`, `xmin`, `ymax`, `xmax`, and `spatialReference`. The `spatialReference` property is indicated by the `wkid` property, defaulting to 4326, WGS84.
`elevationSource`	The `elevationSource` property indicates the layer's elevation source type. If an elevation service has been manually added to the portal and ArcGIS Video Server, it will include the `serviceItemId` property. If the default elevation source is used, it will appear with the `esri/elevation/base` `fileSystem` property.
`created`	The Unix timestamp of when the layer was created, in seconds.
`codecs`	The `codecs` property outputs the `audio`, `text`, and `video` codecs used in the video associated with the layer. These will vary based upon the initial video input.
`currentVersion`	The version of ArcGIS Video Server utilized by a video layer. When ArcGIS Video server is upgraded to a newer version, layers should automatically be upgraded to the new version. Example Use dark colors for code blocksCopy `1 "currentVersion": "12.0.0" //Version information for 12.0`
`playbackInfo`	The `playbackInfo` JSON object lists detailed playback information about the video associated with the layer. The `klv` properties indicate the KLV encoding methods supported by the video, while `framerate` indicates the framerate at which a video was recorded at. The `containerFormat` property refers to the file extension of the video, such as "MPEG-TS". The `gop` property refers to the number of images between frames, and `aspectRatio` covers the aspect ratio the video was recorded at.
`frameCount`	The `frameCount` property outputs the total number of frames contained in a video layer.
`supportsExportFrameset`	Indicates whether a layer supports exporting framesets with the Framset operation. Values: `true` \| `false`
`supportsExportClip`	Indicates whether or not a layer supports exporting clips with the Clip operation. Values: `true` \| `false`
`supportedQueryFormats`	Lists supported formats for queries. The current supported method is `json`.
`initialExtent`	This property includes details related to the initial extent of the layer's spatial footprint. It includes `ymin`, `xmin`, `ymax`, `xmax`, and `spatialReference`. The spatialReference parameter is indicated by the `wkid` property, defaulting to 4326, WGS84.
`supportsPreviews`	Indicates whether a layer supports generating preview images. Values: `true` \| `false`
`name`	The layer's name.
`qualities`	The qualities, or resolutions, a layer has available for playback. Values: `sd` \| `hd` \| `fhd` \| `uhd`
`copyrightText`	The copyright text associated with a layer, provided as a string.
`time`	The `time` JSON object includes the `duration`, `timezone`, `start`, and `end` properties. The `duration` property is listed in milliseconds. The `timezone` property provides the time zone used in the layer's metadata. The `start` and `end` properties contain the local times, based upon the `timezone`, at which the video began recording and ended.
`poster`	The URL at which the layer's poster can be viewed.
`cameraInfo`	The `cameraInfo` JSON object includes all associated `cameraInfo` properties. To learn more about these properties, see the Update Camera documentation.

Example usage

The following is a sample request URL used to access the resource for an individual layer:

Use dark colors for code blocksCopy
https://organization.example.com:21443/arcgis/rest/services/sampleService/VideoServer/0?f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
    "serviceType": "< ondemand | livestream >",
    "description": "Test description",
    "livestreamInfo": "livestream information",
    "sourceQuality": "< sd | hd | fhd | uhd >",
    "connectionUrl": {"hls": "https://organization.example.com/video/rest/services/sampleVideo/VideoServer/0/content/ABR.m3u8"},
    "id": 0,
    "supportsMensuration": "< true | false >",
    "fullExtent": {
        "ymin": "ymin coordinate",
        "xmin": "xmin coordinate",
        "ymax": "ymax coordinate",
        "xmax": "xmax coordinate",
        "spatialReference": {
            "latestWkid": 4326,
            "wkid": 4326
        }
    },
    "elevationSource": {
        "serviceItemId": "associated service Item ID",
        "fileSystem": "esri/elevation/base"
    },
    "created": "unix time",
    "codecs": {
        "audio": "aac",
        "text": "vtt",
        "video": "h264"
    },
    "currentVersion": "12.0.0",
    "playbackInfo": {
        "klv": {
            "0601": "< true | false >",
            "0102": "< true | false >",
            "0903": "< true | false >"
        },
        "framerate": "framerate",
        "containerFormat": "<video file extension>",
        "gop": "integer",
        "aspectRatio": "16:9"
    },
    "frameCount": "integer of frames",
    "supportsExportFrameset": "< true | false >",
    "supportsExportClip": "< true | false >",
    "supportedQueryFormats": "json",
    "initialExtent": {
        "ymin": "ymin coordinate",
        "xmin": "xmin coordinate",
        "ymax": "ymax coordinate",
        "xmax": "xmax coordinate",
        "spatialReference": {
            "latestWkid": 4326,
            "wkid": 4326
        }
    },
    "supportsPreviews": "< true | false >",
    "name": "sampleVideoLayer",
    "qualities": "< sd | hd | fhd | uhd >",
    "copyrightText": "copyright text string",
    "time": {
        "duration": "<video layer length>",
        "timezone": "<time zone, eg EST, CST, MST, PST>",
        "start": "epoch time",
        "end": "epoch time"
    },
    "poster": "https://organization.example.com/video/rest/services/sampleVideo/VideoServer/0/poster/poster.jpg",
    "cameraInfo": {
      "farDistance": "integer",
      "heading": "integer",
      "tilt": "integer",
      "position": {
          "x": "epoch time",
          "y": "epoch time"
      },
      "fov": "integer",
      "height": "integer"
    }
}

JSON Response example

Use dark colors for code blocksCopy
{
    "serviceType": "ondemand",
    "description": "",
    "livestreamInfo": null,
    "sourceQuality": "fhd",
    "connectionUrl": {"hls": "https://organization.example.com/video/rest/services/sampleVideo/VideoServer/0/content/ABR.m3u8"},
    "id": 0,
    "supportsMensuration": false,
    "fullExtent": {
        "ymin": 41.129212653176928,
        "xmin": -104.79965893131883,
        "ymax": 41.1803497417905,
        "xmax": -104.74690735124661,
        "spatialReference": {
            "latestWkid": 4326,
            "wkid": 4326
        }
    },
    "elevationSource": {
        "serviceItemId": null,
        "fileSystem": "esri/elevation/base"
    },
    "created": 1764090917456,
    "codecs": {
        "audio": "aac",
        "text": "vtt",
        "video": "h264"
    },
    "currentVersion": "12.0.0",
    "playbackInfo": {
        "klv": {
            "0601": true,
            "0102": true,
            "0903": false
        },
        "framerate": "29.97",
        "containerFormat": "MPEG-TS (MPEG-2 Transport Stream)",
        "gop": 120,
        "aspectRatio": "16:9"
    },
    "frameCount": 2494,
    "supportsExportFrameset": true,
    "supportsExportClip": true,
    "supportedQueryFormats": "json",
    "initialExtent": {
        "ymin": 41.133196112621967,
        "xmin": -104.78971332825435,
        "ymax": 41.141752806410537,
        "xmax": -104.77931187068111,
        "spatialReference": {
            "latestWkid": 4326,
            "wkid": 4326
        }
    },
    "supportsPreviews": true,
    "name": "sampleVideoLayer",
    "qualities": ["fhd"],
    "copyrightText": "",
    "time": {
        "duration": 85141.333,
        "timezone": "UTC",
        "start": 1348087245993,
        "end": 1348087329176
    },
    "poster": "https://organization.example.com/video/rest/services/sampleVideo/VideoServer/0/poster/poster.jpg",
    "cameraInfo": {
      "farDistance": "300",
      "heading": "17",
      "tilt": "-30",
      "position": {
          "x": -76.5074522056152,
          "y": 39.0022906300187
      },
      "fov": "90",
      "height": "45"
    }
}