Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

REST query

REST query example

REST response example

Response states

Description

/vod/startup

Code Block
languagejs
themeRDark
{
 "uri":"vod-live://sample.mp4"
 "localStreamName": "test"
}

409 - Conflict

500 - Internal error


Capture VOD stream from file


/vod/find
Code Block
languagejs
themeRDark
{
 "localStreamName": "test"

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

200 – OK

404 – not found

Find VOD streams by criteria

/vod/find_all


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

200 – OK

404 – not found

Find all VOD streams

/vod/terminate

Code Block
languagejs
themeRDark
{
 "uri":"vod://sample.mp4"
 "localStreamName": "test"
}

200 - Stream is stopped

404 - Stream not found

Stop VOD stream

...

Name

Description

Example

uri

File name to capture

vod://sample.mp4
localStreamNameStream name
test

status

Stream status

PROCESSED_LOCAL
localMediaSessionIdMediasession Id
29ec3236-1093-42bb-88d6-d4ac37af3ac0
hasAudioStream has audio
true
hasVideoStream has video
true
recordStream is recording
false

Known limits

/rest-api/vod/startup query can be used for VOD live translations creation only. However, find, find_all and terminate queries can be applied both to VOD and VOD live translations.

Known issues

1. AAC frames of type 0 are not supported by decoder and will be ignored while stream pulled playback

...