Frameset | ArcGIS REST APIs

URL:: https://<root>/services/serviceName/VideoServer/layerId/frameset
Methods:: POST
Version Introduced:: 12.0

Description

The frameset operation creates screenshots based upon specific times, or ranges of time, in a video layer.

Request parameters

Parameter Details

Parameter	Details
`timestamps` (Required if not using `timeRange`)	A list of comma-separated integers that represent the times, in seconds, that will be output into screenshots.
`timeRange` (Required if not using `timestamps`)	A JSON object that specifies the time range, in seconds, from which screenshots are collected. The JSON object requires a `start` value that specifies the beginning of the time range, an `end` value that specifies the end of the time range, and an `interval` value that determines the frequency at which a screenshot is collected. Example Use dark colors for code blocksCopy `1 2 3 4 5 timeRange={ "start": "12000", "end": "20000", "interval": "1000" }`
`expiry` (required)	The length of time, in minutes, the screenshots are retained in file storage after creation.
`async` (Required)	Determines whether the operation is run synchronously or asynchronously. Values: `true` \| `false`
`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.

timestamps

(Required if not using timeRange)

A list of comma-separated integers that represent the times, in seconds, that will be output into screenshots.

timeRange

(Required if not using timestamps)

A JSON object that specifies the time range, in seconds, from which screenshots are collected. The JSON object requires a start value that specifies the beginning of the time range, an end value that specifies the end of the time range, and an interval value that determines the frequency at which a screenshot is collected.

Example
Use dark colors for code blocksCopy
timeRange={
"start": "12000",
"end": "20000",
"interval": "1000"
}

expiry

(required)

The length of time, in minutes, the screenshots are retained in file storage after creation.

async

(Required)

Determines whether the operation is run synchronously or asynchronously.

Values: true | false

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.

Example usage

The following is a sample POST request for the frameset operation:

Use dark colors for code blocksCopy
POST /arcgis/rest/services/sampleService/VideoServer/01/frameset HTTP/1.1
Host: organization.example.com:21443
Content-Type: application/x-www-form-urlencoded
Content-Length: []

timeRange={
  "start": "12000",
  "end": "20000",
  "interval": "1000"
}&expiry=120&async=false&f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
    "expires": expiration_time,
    "framesetId": "<frameset_ID>",
    "created": creation_time,
    "serviceName": "{serviceName}",
    "results": {
        "total": 1,
        "frames": [{
            "corners": {
                "bottomLeft": {
                    "x": x_coordinate,
                    "y": y_coordinate,
                    "z": z_coordinate,
                    "spatialReference": {"wkid": 4326}
                },
                "bottomRight": {
                    "x": x_coordinate,
                    "y": y_coordinate,
                    "z": z_coordinate,
                    "spatialReference": {"wkid": 4326}
                },
                "topLeft": {
                    "x": x_coordinate,
                    "y": y_coordinate,
                    "z": z_coordinate,
                    "spatialReference": {"wkid": 4326}
                },
                "topRight": {
                    "x": x_coordinate,
                    "y": y_coordinate,
                    "z": z_coordinate,
                    "spatialReference": {"wkid": 4326}
                }
            },
            "rotation": rotation_value,
            "name": "frame.jpg",
            "url": "<frame URL>",
            "timestamp": 12012
        }],
        "num": 1,
        "start": 1,
        "nextStart": -1
    },
    "url": "<URL for frameset location>"
}

JSON Response example

Use dark colors for code blocksCopy
{
    "expires": 1761165496,
    "framesetId": "78794f8a-384c-4a11-98d7-d47a90989225",
    "created": 1761154696,
    "serviceName": "{serviceName}",
    "results": {
        "total": 1,
        "frames": [{
            "corners": {
                "bottomLeft": {
                    "x": -104.789620778,
                    "y": 41.138731434,
                    "z": 1853.5368,
                    "spatialReference": {"wkid": 4326}
                },
                "bottomRight": {
                    "x": -104.789630257,
                    "y": 41.1332045410001,
                    "z": 1853.5368,
                    "spatialReference": {"wkid": 4326}
                },
                "topLeft": {
                    "x": -104.780451935,
                    "y": 41.1390975480001,
                    "z": 1853.5368,
                    "spatialReference": {"wkid": 4326}
                },
                "topRight": {
                    "x": -104.780019418,
                    "y": 41.131515465,
                    "z": 1853.5368,
                    "spatialReference": {"wkid": 4326}
                }
            },
            "rotation": 93.860389044010162,
            "name": "78794f8a-384c-4a11-98d7-d47a90989225_12012.jpg",
            "url": "https://organization.example.com/arcgis/rest/services/TestOD01/VideoServer/0/content/frameset/78794f8a-384c-4a11-98d7-d47a90989225/78794f8a-384c-4a11-98d7-d47a90989225_12012.jpg",
            "timestamp": 12012
        }],
        "num": 1,
        "start": 1,
        "nextStart": -1
    },
    "url": "https://organization.example.com/arcgis/rest/services/TestOD01/VideoServer/0/frameset/78794f8a-384c-4a11-98d7-d47a90989225"
}