Page History

...

REST query

REST query example

REST response example

Response states

Description

/vod/startup

Code Block

language	js
theme	RDark

{
 "uri":"vod-live://sample.mp4",
 "localStreamName": "test"
}

409 - Conflict

500 - Internal error

Capture VOD stream from file

/vod/find

Code Block

language	js
theme	RDark

{
 "localStreamName": "test"
}

Code Block

language	js
theme	RDark

[
    {
        "localMediaSessionId": "29ec3236-1093-42bb-88d6-d4ac37af3ac0",
        "localStreamName": "test",
        "uri": "vod-live://sample.mp4",
        "status": "PROCESSED_LOCAL",
        "hasAudio": true,
        "hasVideo": true,
        "record": false,
        "loop": false
    }
]

200 – OK

404 – not found

Find VOD streams by criteria

/vod/find_all

Code Block

language	js
theme	RDark

[
    {
        "localMediaSessionId": "29ec3236-1093-42bb-88d6-d4ac37af3ac0",
        "localStreamName": "test",
        "uri": "vod-live://sample.mp4",
        "status": "PROCESSED_LOCAL",
        "hasAudio": true,
        "hasVideo": true,
        "record": false,
        "loop": false
    }
]

200 – OK

404 – not found

Find all VOD streams

/vod/terminate

Code Block

language	js
theme	RDark

{
 "uri":"vod://sample.mp4",
 "localStreamName": "test"
}

200 - Stream is stopped

404 - Stream not found

Stop VOD stream

Parameters

Name	Description	Example
uri	File name to capture	vod://sample.mp4
localStreamName	Stream name	test
status	Stream status	PROCESSED_LOCAL
localMediaSessionId	Mediasession Id	29ec3236-1093-42bb-88d6-d4ac37af3ac0
hasAudio	Stream has audio	true
hasVideo	Stream has video	true
record	Stream is recording	false
loop	VOD is looped	`false`

...

Space shortcuts

Page tree

Versions Compared

Old Version 14

New Version Current

Key

Parameters