Skip to main content
API docs by Redocly

Neo-TCP Video Service (1.0.0)

Download OpenAPI specification:Download

Video streaming and transcoding service.

Liveness probe

Returns 200 OK if the service is running.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Readiness probe

Returns 200 OK if the service is ready to accept traffic.

Responses

Response samples

Content type
application/json
{
  • "status": "ready"
}

Prometheus metrics

Returns service metrics in Prometheus format.

Responses

Stream/Transcode video

Streams a video file, optionally transcoding it on-the-fly.

path Parameters
path
required
string

Relative path to the video file on the WebDAV server.

query Parameters
resolution
string^\d+[x:]\d+$
Example: resolution=1280x720

Target resolution (WxH or W:H). Requires REENCODE=on.

fps
number [ 1 .. 120 ]

Target frame rate. Requires REENCODE=on.

duration
number >= 1

Duration of the output video in seconds. Works with REENCODE=off (uses stream copy).

start
number >= 0

Start time of the video in seconds. Works with REENCODE=off (uses stream copy).

Responses

Response samples

Content type
application/problem+json
{}

Get video playlist

Proxies request to cloud server to get video playlist.

path Parameters
clientId
required
string
deviceId
required
string
startTime
required
integer <int64>
endTime
required
integer <int64>
playbackRate
required
number

Responses

Response samples

Content type
application/json
{
  • "paths": [
    ],
  • "durations": [
    ]
}