Playout

Download OpenAPI specification:Download

Job

Job related operations

Search for jobs

Returns queued jobs that match search criteria

query Parameters
organization
Array of strings

Organization Id

providerId
string
userId
string

User ID

status
Array of strings
Items Enum: "PENDING" "PROCESSING" "SUCCEEDED" "FAILED" "CANCELED"

Job status filter

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get job

Returns queued job

path Parameters
jobId
required
integer <int64>

Job id

query Parameters
providerId
string

Organization Id

organization
Array of strings

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Playout

Playout management API, provides API various endpoints to interact with playouts

Get cache contents by playoutIds

Get cache contents by playoutIds

query Parameters
id
Array of strings
organization
Array of strings

Organization Id

providerId
string
full
boolean
Default: false

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Get playout detailed statuses

Get playout detailed statuses

query Parameters
organization
Array of strings

Organization Id

providerId
string
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get playout statuses

Get playout statuses

query Parameters
organization
Array of strings

Organization Id

providerId
string
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get cache contents by playoutId

Get cache contents by playoutId

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string
full
boolean
Default: false

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Publish cache status

Publishes cache status to playout

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string
Request Body schema: application/json
required
assetsInProgress
integer <int64>
assetsNotCached
integer <int64>
cachedAssets
integer <int64>
failedAssets
integer <int64>
filesDownloading
integer <int64>
filesPendingProcessing
integer <int64>
filesProcessing
integer <int64>
gapEventId
string
gapIndex
integer <int32>
gapIsBetweenEvents
boolean
nextToProcess
string
serviceReady
boolean
timeTillFirstGap
integer <int64>
totalAssets
integer <int64>
uploadsInProgress
integer <int64>
version
string
cachedPercentage
number <double>
freeSpacePercentage
number <double>
Array of objects (LocationStatus)

Responses

Request samples

Content type
application/json
{
  • "assetsInProgress": 0,
  • "assetsNotCached": 0,
  • "cachedAssets": 0,
  • "failedAssets": 0,
  • "filesDownloading": 0,
  • "filesPendingProcessing": 0,
  • "filesProcessing": 0,
  • "gapEventId": "string",
  • "gapIndex": 0,
  • "gapIsBetweenEvents": true,
  • "nextToProcess": "string",
  • "serviceReady": true,
  • "timeTillFirstGap": 0,
  • "totalAssets": 0,
  • "uploadsInProgress": 0,
  • "version": "string",
  • "cachedPercentage": 0,
  • "freeSpacePercentage": 0,
  • "locationStatuses": [
    ]
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Delete asset from cache

Removes asset from playout's cache by asset id

path Parameters
id
required
string
assetId
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Delete asset's file

Removes file from asset date by asset id, file name and extension

path Parameters
id
required
string
assetId
required
string
fileName
required
string
extension
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get asset journal

Returns asset journal for given playout and asset id

path Parameters
id
required
string
assetId
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reset asset status in cache

Reset asset status in cache

path Parameters
id
required
string
assetId
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get cache configuration by playoutId

Get cache configuration by playoutId

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "assetExpiration": 0,
  • "concurrentDownloads": 0,
  • "locations": [
    ],
  • "maxDownloadAttempts": 0,
  • "maxTimeInCache": 0,
  • "storeLocation": "string",
  • "storePassword": "string",
  • "storeUsername": "string"
}

Reset cache

Reset cache

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get cache status

Get asset cache status of playout

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "assetsInProgress": 0,
  • "assetsNotCached": 0,
  • "cachedAssets": 0,
  • "failedAssets": 0,
  • "filesDownloading": 0,
  • "filesPendingProcessing": 0,
  • "filesProcessing": 0,
  • "gapEventId": "string",
  • "gapIndex": 0,
  • "gapIsBetweenEvents": true,
  • "nextToProcess": "string",
  • "serviceReady": true,
  • "timeTillFirstGap": 0,
  • "totalAssets": 0,
  • "uploadsInProgress": 0,
  • "version": "string",
  • "cachedPercentage": 0,
  • "freeSpacePercentage": 0,
  • "locationStatuses": [
    ]
}

Get playout detailed config

Get playout detailed config

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "avMonConfig": {
    },
  • "cacheConfiguration": {
    },
  • "emergencyPlaylistName": "string",
  • "graphicProjectAssetName": "string",
  • "name": "string",
  • "playoutId": "string",
  • "timeGenerated": "2019-08-24T14:15:22Z",
  • "videoBoardConfig": {
    }
}

Get playout extended status

Get playout extended status, containing composite of various statuses from palyout service

path Parameters
id
required
string

Id of playout

query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "avmon": {
    },
  • "cache": {
    },
  • "cacheStatus": {
    },
  • "captionPackage": {
    },
  • "currentAsset": {
    },
  • "currentGraphicPlaylist": {
    },
  • "emergencyModeDetails": {
    },
  • "emergencyTemplate": {
    },
  • "errors": [
    ],
  • "general": {
    },
  • "identification": {
    },
  • "lastGraphicPlaylist": {
    },
  • "liveInputStatus": [
    ],
  • "liveModeStatus": {
    },
  • "name": "string",
  • "nextAsset": {
    },
  • "nextLiveAsset": {
    },
  • "osPerf": {
    },
  • "playoutId": "string",
  • "preview": {
    },
  • "recordingStatus": [
    ],
  • "timeGenerated": "2019-08-24T14:15:22Z",
  • "timeline": {
    },
  • "titleProject": {
    },
  • "version": {
    },
  • "zixiStatus": [
    ]
}

Get emergency mode

Get emergency mode

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "automaticEmergency": true,
  • "exitConditions": {
    },
  • "manualEmergency": true,
  • "reason": "string"
}

Get graphics project by playoutId

Retrieves graphics project by playoutId

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "active": {
    },
  • "assigned": {
    }
}

Get live manifest

Get live manifest

path Parameters
id
required
string
quality
required
string
playlistId
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get live segment

Get live segment

path Parameters
id
required
string
quality
required
string
segmentId
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Publish playout performance

Publishes playout performance to playout

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string
Request Body schema: application/json
required
clock_drift_ms
number
cpu_usage
number <double>
disk_free_percent
number <double>
disk_use_time_percent
number
file_descriptors
integer <int32>
object
ram_free_bytes
number <double>
ram_used_bytes
integer <int64>
shared_ram_bytes
integer <int64>
uptime_seconds
number

Responses

Request samples

Content type
application/json
{
  • "clock_drift_ms": 0,
  • "cpu_usage": 0,
  • "disk_free_percent": 0,
  • "disk_use_time_percent": 0,
  • "file_descriptors": 0,
  • "inputs": {
    },
  • "ram_free_bytes": 0,
  • "ram_used_bytes": 0,
  • "shared_ram_bytes": 0,
  • "uptime_seconds": 0
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Change playout mode

Change playout mode

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string
Request Body schema: application/json
required
object (ExitConditions)
liveId
string
Array of objects (SCTE35SignalDTO)
startAnchor
string
Enum: "FROM_START" "FROM_END"
startEventId
string
startTime
string <date-time>
status
string
Enum: "LIVE" "EMERGENCY" "PLAYING"

Responses

Request samples

Content type
application/json
{
  • "exitConditions": {
    },
  • "liveId": "string",
  • "scte35Signals": [
    ],
  • "startAnchor": "FROM_START",
  • "startEventId": "string",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "LIVE"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get live recordings

Get live recordings

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Delete recording

Removes recording from playout by recording id

path Parameters
id
required
string
recordingId
required
integer <int64>
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Cancel recording processing

Cancels recording processing by recording id

path Parameters
id
required
string
recordingId
required
integer <int64>
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get playout status

Get playout simple status containing only basic availability information

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "currentAsset": {
    },
  • "liveId": "string",
  • "mode": "STOPPED",
  • "modeLiveId": "string",
  • "name": "string",
  • "nextAsset": {
    },
  • "nextLiveAsset": {
    },
  • "overallStatus": {
    },
  • "pendingLiveId": "string",
  • "pendingStatus": "STOPPED",
  • "pendingStatusChangeTime": "2019-08-24T14:15:22Z",
  • "playoutId": "string",
  • "recording": true,
  • "status": "STOPPED",
  • "timeGenerated": "2019-08-24T14:15:22Z",
  • "timelineVersion": 0,
  • "version": "string"
}

Publish playout status

Publishes playout status to playout

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string
Request Body schema: application/json
required
object (PlayoutEventStatusDTO)
object (GraphicPlaylistStatusDTO)
object (PlayoutEmergencyStatusDTO)
Array of objects (PlayoutErrorsDTO) unique
object (PlayoutGeneralStatusDTO)
object (GraphicPlaylistStatusDTO)
object (PlayoutLiveStatusDTO)
Array of objects (LiveInputStatusDTO)
object (PlayoutEventStatusDTO)
object (PlayoutGapStatus)
object (PlayoutEventStatusDTO)
object (PreviewDTO)
Array of objects (PlayoutRecordingStatusDTO) unique
object (PlayoutVersionStatusDTO)

Responses

Request samples

Content type
application/json
{
  • "currentEvent": {
    },
  • "currentGraphicPlaylist": {
    },
  • "emergency": {
    },
  • "errors": [
    ],
  • "general": {
    },
  • "lastGraphicPlaylist": {
    },
  • "live": {
    },
  • "liveInputs": [
    ],
  • "nextEvent": {
    },
  • "nextGap": {
    },
  • "nextLiveEvent": {
    },
  • "preview": {
    },
  • "recording": [
    ],
  • "version": {
    }
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Get playout timeline

Get playout timeline

path Parameters
id
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string
required
object (Pageable)

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "empty": true,
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "pageable": {
    },
  • "size": 0,
  • "sort": {
    },
  • "totalElements": 0,
  • "totalPages": 0
}

Evaluate secondary event parameters

Evaluate secondary event parameters

path Parameters
id
required
string
query Parameters
onAirTimeFrom
required
integer <int64>
organization
Array of strings

Organization Id

providerId
string
Request Body schema: application/json
required
command
string
Enum: "ON" "OFF"
objectName
string
offset
integer <int64>
origin
string
Enum: "FROM_START" "FROM_END"
object
object

Responses

Request samples

Content type
application/json
{
  • "command": "ON",
  • "objectName": "string",
  • "offset": 0,
  • "origin": "FROM_START",
  • "parameters": {
    },
  • "substitution": {
    }
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Playout Cache log export

Returns CSV file of playout cache log

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string

Responses

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Playout As Run log export

Starts as run log export job

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings

Organization Id

format
string
Default: "CSV"

Format

providerId
string
Request Body schema: application/json
required
from
string <date-time>
to
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Download EPG report XML file

Returns XML file containing EPG report

path Parameters
playoutId
required
string

playout id

query Parameters
organization
Array of strings
period
integer <int64>
Default: 604800000
providerId
string

Responses

Response samples

Content type
{ }

Download live pipelines

Returns live pipelines

path Parameters
playoutId
required
string

playout id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
{ }

Download logs

Returns logs

path Parameters
playoutId
required
string

playout id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
{ }

Download pipeline

Returns playouts output pipelines

path Parameters
playoutId
required
string

playout id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
{ }

Download run as log (url or data) CSV file

Returns CSV file containing run as log

path Parameters
playoutId
required
string

playout id

fileName
required
string

File name

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
{ }

Playout Custom Report log export

Starts as custom report export job

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string
Request Body schema: application/json
required
from
string <date-time>
to
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "from": "2019-08-24T14:15:22Z",
  • "to": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "dateCreated": "2019-08-24T14:15:22Z",
  • "dateFinished": "2019-08-24T14:15:22Z",
  • "entityId": "string",
  • "fileName": "string",
  • "id": "string",
  • "jobType": "string",
  • "messages": [
    ],
  • "organization": "string",
  • "resourceExtension": "string",
  • "resourceLink": "string",
  • "serviceProviderId": "string",
  • "status": "PENDING",
  • "uniqueId": "string",
  • "userId": "string"
}

Download run as log (url or data) CSV file

Returns CSV file containing run as log

path Parameters
playoutId
required
string

playout id

fileName
required
string

File name

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
{ }

Download run as log (url or data) JSON file

Returns JSON file containing run as log

path Parameters
playoutId
required
string

playout id

fileName
required
string

File name

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{ }

List playout graphs

Returns a list of graphs on given playout

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Start or stop playout graph

Sends a graph control command to playout

path Parameters
playoutId
required
string

Playout id

query Parameters
name
required
string

Graph name

command
required
string
Enum: "START" "STOP"

Graph control command

organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ],
  • "status": "NONE"
}

Get playout graph statistics

Retrieves playout graph statistics

path Parameters
playoutId
required
string

Playout id

query Parameters
name
required
string

Graph name

organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "playoutId": "string",
  • "timeGenerated": "2019-08-24T14:15:22Z"
}

Playout Live MJPEG Input Stream

Returns live input stream in MJPEG format

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string
framerate
string
Default: "25"

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Playout Live MJPEG Input Stream

Returns live input stream in MJPEG format

path Parameters
playoutId
required
string
liveId
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string
framerate
string
Default: "25"

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

List playout media connect output statuses

path Parameters
playoutId
required
string

Playout id

query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Playout MJPEG output Stream

Returns output stream in MJPEG format

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings

Organization Id

providerId
string
framerate
string
Default: "25"

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}

Preview

Preview API

Get input stream preview token

Get input stream preview token

path Parameters
playoutId
required
string
inputId
required
string
query Parameters
organization
Array of strings
providerId
string
temporary
boolean

Responses

Response samples

Content type
application/json
{
  • "delay": 0,
  • "streamId": "string",
  • "tokenId": "string",
  • "type": "string"
}

Reload input stream preview

Reload input stream preview

path Parameters
playoutId
required
string
inputId
required
string
query Parameters
organization
Array of strings
providerId
string
temporary
boolean

Responses

Response samples

Content type
application/json
{
  • "delay": 0,
  • "streamId": "string",
  • "tokenId": "string",
  • "type": "string"
}

Get output stream preview token

Get output stream preview token

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{
  • "delay": 0,
  • "streamId": "string",
  • "tokenId": "string",
  • "type": "string"
}

Reload output stream preview

Reload output stream preview

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings
providerId
string

Responses

Response samples

Content type
application/json
{
  • "delay": 0,
  • "streamId": "string",
  • "tokenId": "string",
  • "type": "string"
}

Request WebRTC preview

Request WebRTC preview

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
candidate
string
sdp
string
sdpMLineIndex
string
sdpMid
string
streamId
string
token
string
type
string

Responses

Request samples

Content type
application/json
{
  • "candidate": "string",
  • "sdp": "string",
  • "sdpMLineIndex": "string",
  • "sdpMid": "string",
  • "streamId": "string",
  • "token": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "candidate": "string",
  • "sdp": "string",
  • "sdpMLineIndex": "string",
  • "sdpMid": "string",
  • "streamId": "string",
  • "token": "string",
  • "type": "string"
}

Send WebRTC candidate

Send WebRTC candidate

path Parameters
playoutId
required
string
query Parameters
organization
Array of strings
providerId
string
Request Body schema: application/json
required
candidate
string
sdp
string
sdpMLineIndex
string
sdpMid
string
streamId
string
token
string
type
string

Responses

Request samples

Content type
application/json
{
  • "candidate": "string",
  • "sdp": "string",
  • "sdpMLineIndex": "string",
  • "sdpMid": "string",
  • "streamId": "string",
  • "token": "string",
  • "type": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "messages": [
    ]
}