Skip to content
URL:
https://<root>/services/serviceName/VideoServer/layerId/start
Methods:
POST
Version Introduced:
12.0

Description

The start operation enables a livestream listener on a specific video layer, effectively beginning the livestream on ArcGIS Video Server. This operation is only available if the livestream listener is not currently running on the chosen layer.

Request parameters

ParameterDetails

stopOn

(Required)

This parameter sets how a livestream should stop. The options are request, which requires manually using the (Stop)[/stop] operation, or automatic, which will detect when a livestream ends and stop the listener automatically.

f

(Required)

The response 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 start operation:

Use dark colors for code blocksCopy
1
2
3
4
5
6
POST /arcgis/rest/services/sampleService/VideoServer/layerId/start HTTP/1.1
Host: organization.example.com:21443
Content-Type: application/x-www-form-urlencoded
Content-Length: []

stopOn=request&f=pjson&token=<token>

JSON Response syntax

Use dark colors for code blocksCopy
1
2
3
{
    "success": <true | false>
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
{
    "success": true
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.