Configuration

Download OpenAPI specification:Download

URL: https://veset.tv/ Terms of Service

Services

Ingest - Library - Channel - Schedule - Playout - Audit - Accounts - Reporting - Monitoring - Configuration - Metrics

Service provider resource

Get service provider audit connector configurations

Returns service provider audit connector configurations

path Parameters

providerId

required

string

Responses

Response samples

Content type

application/json

[{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"organizationId": "string",
"port": 0,
"serviceProviderId": "string",
"token": "string",
"type": "SPLUNK",
"url": "string"
}
]

Create service provider audit connector configuration

Returns created service provider audit connector configuration

path Parameters

providerId

required

string

Request Body schema: application/json
required

dateCreated	string <date-time>
dateUpdated	string <date-time>
enabled	boolean
id	string
organizationId	string
port	integer <int32>
serviceProviderId	string
token	string
type	string Value: "SPLUNK"
url	string

Responses

Request samples

Payload

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"organizationId": "string",
"port": 0,
"serviceProviderId": "string",
"token": "string",
"type": "SPLUNK",
"url": "string"
}

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"organizationId": "string",
"port": 0,
"serviceProviderId": "string",
"token": "string",
"type": "SPLUNK",
"url": "string"
}

Delete service provider audit connector configuration

Returns deleted service provider audit connector configuration

path Parameters

providerId required	string
connectorId required	string

Responses

Response samples

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Get service provider audit connector configurations

Returns service provider audit connector configurations

path Parameters

providerId required	string
connectorId required	string

Responses

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"organizationId": "string",
"port": 0,
"serviceProviderId": "string",
"token": "string",
"type": "SPLUNK",
"url": "string"
}

Update service provider audit connector configuration

Returns updated service provider audit connector configuration

path Parameters

providerId required	string
connectorId required	string

Request Body schema: application/json
required

dateCreated	string <date-time>
dateUpdated	string <date-time>
enabled	boolean
id	string
organizationId	string
port	integer <int32>
serviceProviderId	string
token	string
type	string Value: "SPLUNK"
url	string

Responses

Request samples

Payload

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"organizationId": "string",
"port": 0,
"serviceProviderId": "string",
"token": "string",
"type": "SPLUNK",
"url": "string"
}

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"organizationId": "string",
"port": 0,
"serviceProviderId": "string",
"token": "string",
"type": "SPLUNK",
"url": "string"
}

HLS Steering resource

HLS steering api

Creates HLS steering configuration

Creates steering configuration

query Parameters

organization	string
providerId	string

Request Body schema: application/json
required

	object (HlsDistributionConfiguration) Distribution configuration of the HLS steering configuration
enabled	boolean Whether the HLS steering configuration is enabled
id	string
name	string Name of the HLS steering configuration
organizationId	string Organization ID of the HLS steering configuration
serviceProviderId	string
	Array of objects (HlsSource) Sources of the HLS steering configuration

Responses

Request samples

Payload

Content type

application/json

{"dateCreated": 18277373633,
"dateUpdated": 18277373633,
"distributionConfiguration": {"manifestServingEnabled": true,
"uploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
]
},
"enabled": true,
"id": "string",
"name": "string",
"organizationId": "string",
"sources": [{"abrName": "string",
"playoutId": "string"
}
]
}

Response samples

Content type

application/json

{"dateCreated": 18277373633,
"dateUpdated": 18277373633,
"distributionConfiguration": {"manifestServingEnabled": true,
"uploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
]
},
"enabled": true,
"id": "string",
"name": "string",
"organizationId": "string",
"sources": [{"abrName": "string",
"playoutId": "string"
}
]
}

Deletes HLS steering configuration

Deletes steering configuration

path Parameters

required

string

query Parameters

organization	string
providerId	string

Responses

Response samples

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Gets HLS steering configuration

Gets steering configuration

path Parameters

required

string

query Parameters

organization	string
providerId	string

Responses

Response samples

Content type

application/json

{"dateCreated": 18277373633,
"dateUpdated": 18277373633,
"distributionConfiguration": {"manifestServingEnabled": true,
"uploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
]
},
"enabled": true,
"id": "string",
"name": "string",
"organizationId": "string",
"sources": [{"abrName": "string",
"playoutId": "string"
}
]
}

Updates HLS steering configuration

Updates steering configuration

path Parameters

required

string

query Parameters

organization	string
providerId	string

Request Body schema: application/json
required

	object (HlsDistributionConfiguration) Distribution configuration of the HLS steering configuration
enabled	boolean Whether the HLS steering configuration is enabled
id	string
name	string Name of the HLS steering configuration
organizationId	string Organization ID of the HLS steering configuration
serviceProviderId	string
	Array of objects (HlsSource) Sources of the HLS steering configuration

Responses

Request samples

Payload

Content type

application/json

{"dateCreated": 18277373633,
"dateUpdated": 18277373633,
"distributionConfiguration": {"manifestServingEnabled": true,
"uploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
]
},
"enabled": true,
"id": "string",
"name": "string",
"organizationId": "string",
"sources": [{"abrName": "string",
"playoutId": "string"
}
]
}

Response samples

Content type

application/json

{"dateCreated": 18277373633,
"dateUpdated": 18277373633,
"distributionConfiguration": {"manifestServingEnabled": true,
"uploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
]
},
"enabled": true,
"id": "string",
"name": "string",
"organizationId": "string",
"sources": [{"abrName": "string",
"playoutId": "string"
}
]
}

Gets HLS steering configurations

Gets steering configurations

query Parameters

organization	string
providerId	string

Responses

Response samples

Content type

application/json

[{"dateCreated": 18277373633,
"dateUpdated": 18277373633,
"distributionConfiguration": {"manifestServingEnabled": true,
"uploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
]
},
"enabled": true,
"id": "string",
"name": "string",
"organizationId": "string",
"sources": [{"abrName": "string",
"playoutId": "string"
}
]
}
]

Gets HLS master manifest from HLS Steering configuration by token, authentication not required

Gets hls manifest via secret token

path Parameters

token

required

string

Responses

Response samples

Content type

application/json

{ }

User resource

Get user configuration

Returns user configuration

Responses

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string"
}

Update user configuration

Returns user configuration

Request Body schema: application/json
required

dateCreated	string <date-time>
dateUpdated	string <date-time>
id	string
	object

Responses

Request samples

Payload

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"properties": {"property1": { },
"property2": { }
}
}

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string"
}

Get server time

Returns server time

Responses

Response samples

Content type

application/json

{ }

Get user configuration

Returns user configuration

path Parameters

userId

required

string

query Parameters

providerId

string

Responses

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string"
}

Transformation script resource

Get transformation scripts

Returns transformation scripts that are available for organization

query Parameters

organization required	string Organization Id
enabled	boolean Enabled/Disabled

Responses

Response samples

Content type

application/json

[{"author": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"image": "string",
"name": "string",
"organizationId": "string",
"scriptBody": "string",
"scriptType": "GROOVY",
"serviceProviderId": "string",
"type": "PLAYLIST",
"version": 0
}
]

Update transformation script

Updates transformation script with given ID

Request Body schema: application/json
required

author	string
dateCreated	string <date-time>
dateUpdated	string <date-time>
enabled	boolean
id	string
image	string
name required	string
organizationId	string
scriptBody required	string
scriptType	string Value: "GROOVY"
serviceProviderId	string
type	string Enum: "PLAYLIST" "SIDECAR" "EPG"
version	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"author": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"image": "string",
"name": "string",
"organizationId": "string",
"scriptBody": "string",
"scriptType": "GROOVY",
"serviceProviderId": "string",
"type": "PLAYLIST",
"version": 0
}

Response samples

Content type

application/json

{"author": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"image": "string",
"name": "string",
"organizationId": "string",
"scriptBody": "string",
"scriptType": "GROOVY",
"serviceProviderId": "string",
"type": "PLAYLIST",
"version": 0
}

Search transformation scripts

Returns transformations search by provided filters

query Parameters

organization

required

string

Organization Id

Request Body schema: application/json
required

enabled	boolean
type	string Enum: "PLAYLIST" "SIDECAR" "EPG"

Responses

Request samples

Payload

Content type

application/json

{"enabled": true,
"type": "PLAYLIST"
}

Response samples

Content type

application/json

[{"author": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"image": "string",
"name": "string",
"organizationId": "string",
"scriptBody": "string",
"scriptType": "GROOVY",
"serviceProviderId": "string",
"type": "PLAYLIST",
"version": 0
}
]

Get transformation script

Returns transformation script with given ID

path Parameters

scriptId

required

string

Transformation script Id

query Parameters

organization

required

Array of strings

Organization Id

Responses

Response samples

Content type

application/json

{"author": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"image": "string",
"name": "string",
"organizationId": "string",
"scriptBody": "string",
"scriptType": "GROOVY",
"serviceProviderId": "string",
"type": "PLAYLIST",
"version": 0
}

Playout deployment resource

Get playout deployment

path Parameters

playoutId

required

string

Responses

Response samples

Content type

application/json

{ }

Publish playout deployment credentials

path Parameters

playoutId

required

string

Request Body schema: application/json
required

httpPassword	string
httpUser	string

Responses

Request samples

Payload

Content type

application/json

{"httpPassword": "string",
"httpUser": "string"
}

Response samples

Content type

application/json

{ }

Get playout deployment status

path Parameters

playoutId

required

string

Responses

Response samples

Content type

application/json

{ }

Publish playout deployment status

path Parameters

playoutId

required

string

Request Body schema: application/json
required

message	string
status	string Enum: "MISSING" "IN_PROGRESS" "PENDING_UPGRADE" "ERROR" "READY" "DELETING"
timestamp	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"message": "string",
"status": "MISSING",
"timestamp": "2019-08-24T14:15:22Z"
}

Response samples

Content type

application/json

{ }

Playout

Playout management

Create playout

query Parameters

organization

Array of strings

Request Body schema: application/json
required

	object (PlayoutAutomaticSwitchingDTO)
backupType	string Enum: "HOT" "WARM"
	object (PlayoutConfigurationDTO)
	object (DeploymentRequest)
healthyPeriod	integer <int64>
	object (CreateInstanceRequest) Instance request
instanceType	string Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"
mode	string Enum: "DEMO" "PROD"
name	string
presetId	string
type	string Enum: "SD" "HD" "UHD"
unhealthyPeriod	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"backupType": "HOT",
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"deploymentRequest": {"cacheSize": 0,
"cacheVersion": "string",
"hlsSize": 0,
"playoutLogSize": 0,
"playoutVersion": "string"
},
"healthyPeriod": 0,
"instanceRequest": {"armArch": true,
"cdiSupportEnabled": true,
"cloudType": "AWS",
"deploymentType": "DOCKER",
"dns": "string",
"experimental": true,
"externalIp": "string",
"externalIpReservationId": "string",
"instanceName": "string",
"instancePort": 0,
"instanceType": "string",
"licenseId": "string",
"nixEnabled": true,
"region": "string",
"remoteId": "string",
"reuseIp": true,
"sdiSupportEnabled": true,
"skipInstall": true,
"slots": 0,
"sshKey": "string",
"systemPassword": "string",
"systemUser": "string",
"type": "SD",
"vmType": "WINDOWS",
"volumeSize": 0,
"zixiSettings": {"mcFeederEnabled": true,
"mcFeederLicense": "string",
"mcReceiverEnabled": true,
"mcReceiverLicense": "string"
},
"zone": "string"
},
"instanceType": "AWS",
"mode": "DEMO",
"name": "string",
"presetId": "string",
"type": "SD",
"unhealthyPeriod": 0
}

Response samples

Content type

application/json

{ }

Retrieve supported playout cloud types

query Parameters

organization

string

Responses

Response samples

Content type

application/json

["AWS"
]

Get Playouts features

query Parameters

organization	Array of strings
providerId	string

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"property1": {"aribPassthrough": true,
"customSubtitleStyles": true,
"dolby": true,
"instantGraphics": true,
"jpegXsEncoder": true,
"mc265Encoder": true,
"mpeg2": true,
"multipleAudioTracksSameLanguage": true,
"multipleLangPreviews": true,
"previewAlarms": true,
"previewSubtitles": true,
"reuseVideoEncoders": true,
"sdiSupported": true,
"supportAllFeature": true,
"timelineBlocks": true,
"webrtc": true,
"webrtcServerSelect": true
},
"property2": {"aribPassthrough": true,
"customSubtitleStyles": true,
"dolby": true,
"instantGraphics": true,
"jpegXsEncoder": true,
"mc265Encoder": true,
"mpeg2": true,
"multipleAudioTracksSameLanguage": true,
"multipleLangPreviews": true,
"previewAlarms": true,
"previewSubtitles": true,
"reuseVideoEncoders": true,
"sdiSupported": true,
"supportAllFeature": true,
"timelineBlocks": true,
"webrtc": true,
"webrtcServerSelect": true
}
}

Retrieve supported playout cloud regions

query Parameters

organization

string

Responses

Response samples

Content type

application/json

{"property1": {"property1": { },
"property2": { }
},
"property2": {"property1": { },
"property2": { }
}
}

Get playouts all

query Parameters

organization	Array of strings
providerId	string
apiVersion	integer <int32> Default: 1

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

[{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}
]

Retrieve playout versions

query Parameters

vmType	string Default: "LINUX" Enum: "WINDOWS" "LINUX"
features	Array of strings

Responses

Response samples

Content type

application/json

[{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"organizationId": "string",
"serviceProviderId": "string",
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
]

Get playout

path Parameters

playoutId

required

string

query Parameters

organization	Array of strings
providerId	string
apiVersion	integer <int32> Default: 1

Responses

Response samples

Content type

application/json

{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}

Upgrade playout

path Parameters

playoutId

required

string

query Parameters

organization	Array of strings
providerId	string

Request Body schema: application/json
required

keepOldInstance	boolean Keep old instance after replace, only usable in conjunction with replace : true
nixEnabled	boolean Enable NIX, this will enable NIX on playout
osUpgradeAllowed	boolean Allow OS upgrade, this will upgrade OS to latest version
reinstall	boolean Reinstall playout this will reinstall all software on playout
replace	boolean Replace playout instance with new one, this will create new instance and delete old one
targetCloud	string Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE" Change playout cloud type, only usable in conjunction with replace : true
targetDeployment	string Enum: "DOCKER" "KUBERNETES" Change playout deployment type, only usable in conjunction with replace : true
targetInstanceType	string Change playout instance type, only usable in conjunction with replace : true
targetRegion	string Change playout region, only usable in conjunction with replace : true
	object (PlayoutVersionDTO) Upgrade playout object
targetVolumeSize	integer <int32> Change playout volume size, only usable in conjunction with replace : true
targetZone	string Change playout availability zone, only usable in conjunction with replace : true

Responses

Request samples

Payload

Content type

application/json

{"keepOldInstance": true,
"nixEnabled": true,
"osUpgradeAllowed": true,
"reinstall": true,
"replace": true,
"targetCloud": "AWS",
"targetDeployment": "DOCKER",
"targetInstanceType": "string",
"targetRegion": "string",
"targetVersion": {"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
},
"targetVolumeSize": 0,
"targetZone": "string"
}

Response samples

Content type

application/json

{ }

Get playout inbound access rights

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

Content type

application/json

[{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
]

Configure inbound access rights

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Request Body schema: application/json
required

Array

fromPort	integer <int32>
ipRange	string
name	string
port	integer <int32>
protocol	string
securityGroupId	string
toPort	integer <int32>

Responses

Request samples

Payload

Content type

application/json

[{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
]

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": [{"message": "string",
"type": "OK"
}
],
"organization": "string",
"resourceExtension": "string",
"resourceLink": "string",
"serviceProviderId": "string",
"status": "PENDING",
"uniqueId": "string",
"userId": "string"
}

Export firewall settings as JSON

Export firewall settings into JSON format

path Parameters

playoutId

required

string

query Parameters

organization	string
providerId	string

Responses

Response samples

Content type

application/json

{ }

Get a list of playout ad insertion configurations

Returns a list of playout ad insertion configurations, with state of configuration from ad decision provider

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

Content type

application/json

[{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
]

Bulk update playout ad insertion configuration

Returns a list of playout ad insertion configurations, synced with ad decision provider

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Request Body schema: application/json
required

Array

abrGroup required	string ABR group name of one or multiple playout HLS outputs
adDecisionServerUrl required	string Decision server url, from which to serve ad decision XML
adMarkerPassthrough	boolean
	object Aliases for ad insertion configuration
availSuppressionMode	string Enum: "OFF" "BEHIND_LIVE_EDGE" "AFTER_LIVE_EDGE" "OFF" "BEHIND_LIVE_EDGE" "AFTER_LIVE_EDGE" Avail suppression mode
availSuppressionValue	string Avail suppression value, in format HH:MM:SS
bumperEndUrl	string Bumper end url for ad insertion
bumperStartUrl	string Bumper start url for ad insertion
cdnAdSegmentPrefix	string
cdnContentSegmentPrefix	string
dashMpdLocation	string Enum: "EMT_DEFAULT" "DISABLED"
dashOriginType	string Enum: "MULTI_PERIOD" "SINGLE_PERIOD"
livePrerollDecsiionServerUrl	string
livePrerollDecsionServerUrl	string Decision server url for live preroll
livePrerollMaximumDuration	integer <int32> Live preroll maximum duration
name required	string Ad insertion configuration name
personalizedThreshold	integer <int32> Ad insertion personalized threshold
region required	string Ad insertion configuration region
sessionLogPercent	integer <int32> [ 0 .. 100 ] Default: 0 Logging percent for session requests
slateAssetId	string Asset id from library for slate asset
slateAssetUrl	string Asset url for slate asset
transcodeProfileName	string Transcode profile name for ad insertion

Responses

Request samples

Payload

Content type

application/json

[{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"transcodeProfileName": "transcode-profile-1"
}
]

Response samples

Content type

application/json

[{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
]

Create playout backup

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Request Body schema: application/json
required

backupType required	string Enum: "HOT" "WARM"
	Array of objects (PlayoutGraph)
healthyPeriod	integer <int64>
	object (CreateInstanceRequest) Instance request
instanceType required	string Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"
mode	string Enum: "DEMO" "PROD"
name required	string
unhealthyPeriod	integer <int64>

Responses

Request samples

Payload

Content type

application/json

{"backupType": "HOT",
"graphs": [{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"licences": [{"id": "string",
"mode": "DEMO",
"name": "string"
}
],
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"playoutGraphStatus": {"graphName": "string",
"status": "NONE"
},
"playoutId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}
],
"healthyPeriod": 0,
"instanceRequest": {"armArch": true,
"cdiSupportEnabled": true,
"cloudType": "AWS",
"deploymentType": "DOCKER",
"dns": "string",
"experimental": true,
"externalIp": "string",
"externalIpReservationId": "string",
"instanceName": "string",
"instancePort": 0,
"instanceType": "string",
"licenseId": "string",
"nixEnabled": true,
"region": "string",
"remoteId": "string",
"reuseIp": true,
"sdiSupportEnabled": true,
"skipInstall": true,
"slots": 0,
"sshKey": "string",
"systemPassword": "string",
"systemUser": "string",
"type": "SD",
"vmType": "WINDOWS",
"volumeSize": 0,
"zixiSettings": {"mcFeederEnabled": true,
"mcFeederLicense": "string",
"mcReceiverEnabled": true,
"mcReceiverLicense": "string"
},
"zone": "string"
},
"instanceType": "AWS",
"mode": "DEMO",
"name": "string",
"unhealthyPeriod": 0
}

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": [{"message": "string",
"type": "OK"
}
],
"organization": "string",
"resourceExtension": "string",
"resourceLink": "string",
"serviceProviderId": "string",
"status": "PENDING",
"uniqueId": "string",
"userId": "string"
}

Get playout cdn configurations

Returns a list of playout cdn configurations

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

Content type

application/json

[{"abrGroup": "string",
"adInsertionName": "string",
"connectionAttempts": 0,
"connectionTimeout": 0,
"contentUrl": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"defaultTTL": 0,
"id": "string",
"keepAliveTimeout": 0,
"maxTTL": 0,
"minTTL": 0,
"name": "string",
"originSegmentUrl": "string",
"originShieldEnabled": true,
"originShieldRegion": "string",
"responseTimeout": 0,
"state": "UNKNOWN"
}
]

Update playout cdn configurations

Updates all playout cdn configurations, removes all that are not included in body, returns async job

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Request Body schema: application/json
required

Array

abrGroup	string ABR group of playout's output, can only be set if adInsertionName is not set
adInsertionName	string Ad insertion name, can only be set if abrGroup is not set
connectionAttempts	integer <int32>
connectionTimeout	integer <int32>
dateCreated	string <date-time>
dateUpdated	string <date-time>
defaultTTL	integer <int64>
id	string
keepAliveTimeout	integer <int32>
maxTTL	integer <int64>
minTTL	integer <int64>
name	string
originSegmentUrl	string
originShieldEnabled	boolean
originShieldRegion	string
responseTimeout	integer <int32>
state	string Enum: "UNKNOWN" "PENDING_DELETION" "DELETING_IN_PROGRESS" "DELETED" "PENDING_MODIFICATION" "MODIFICATION_IN_PROGRESS" "INVALID_CONFIGURATION" "ACTIVE"

Responses

Request samples

Payload

Content type

application/json

[{"abrGroup": "string",
"adInsertionName": "string",
"connectionAttempts": 0,
"connectionTimeout": 0,
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"defaultTTL": 0,
"id": "string",
"keepAliveTimeout": 0,
"maxTTL": 0,
"minTTL": 0,
"name": "string",
"originSegmentUrl": "string",
"originShieldEnabled": true,
"originShieldRegion": "string",
"responseTimeout": 0,
"state": "UNKNOWN"
}
]

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": [{"message": "string",
"type": "OK"
}
],
"organization": "string",
"resourceExtension": "string",
"resourceLink": "string",
"serviceProviderId": "string",
"status": "PENDING",
"uniqueId": "string",
"userId": "string"
}

Clone playout

Clones existing playout, creating new copy of it

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Request Body schema: application/json
required

	Array of objects (PlayoutGraph)
	object (CreateInstanceRequest) Instance request
instanceType required	string Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"
mode	string Enum: "DEMO" "PROD"
name required	string

Responses

Request samples

Payload

Content type

application/json

{"graphs": [{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"licences": [{"id": "string",
"mode": "DEMO",
"name": "string"
}
],
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"playoutGraphStatus": {"graphName": "string",
"status": "NONE"
},
"playoutId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}
],
"instanceRequest": {"armArch": true,
"cdiSupportEnabled": true,
"cloudType": "AWS",
"deploymentType": "DOCKER",
"dns": "string",
"experimental": true,
"externalIp": "string",
"externalIpReservationId": "string",
"instanceName": "string",
"instancePort": 0,
"instanceType": "string",
"licenseId": "string",
"nixEnabled": true,
"region": "string",
"remoteId": "string",
"reuseIp": true,
"sdiSupportEnabled": true,
"skipInstall": true,
"slots": 0,
"sshKey": "string",
"systemPassword": "string",
"systemUser": "string",
"type": "SD",
"vmType": "WINDOWS",
"volumeSize": 0,
"zixiSettings": {"mcFeederEnabled": true,
"mcFeederLicense": "string",
"mcReceiverEnabled": true,
"mcReceiverLicense": "string"
},
"zone": "string"
},
"instanceType": "AWS",
"mode": "DEMO",
"name": "string"
}

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": [{"message": "string",
"type": "OK"
}
],
"organization": "string",
"resourceExtension": "string",
"resourceLink": "string",
"serviceProviderId": "string",
"status": "PENDING",
"uniqueId": "string",
"userId": "string"
}

Download playout related settings

Returns JSON file containing exported output or firewall settings

path Parameters

playoutId required	string Playout id
fileName required	string File name

query Parameters

organization

string

Organization Id

Responses

Response samples

Content type

application/json

{ }

Export output properties as JSON

Export output properties into JSON format

path Parameters

playoutId

required

string

query Parameters

organization	string Organization Id
apiVersion	integer <int32> Default: 1

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": [{"message": "string",
"type": "OK"
}
],
"organization": "string",
"resourceExtension": "string",
"resourceLink": "string",
"serviceProviderId": "string",
"status": "PENDING",
"uniqueId": "string",
"userId": "string"
}

Get Playout features

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

Content type

application/json

{"aribPassthrough": true,
"customSubtitleStyles": true,
"dolby": true,
"instantGraphics": true,
"jpegXsEncoder": true,
"mc265Encoder": true,
"mpeg2": true,
"multipleAudioTracksSameLanguage": true,
"multipleLangPreviews": true,
"previewAlarms": true,
"previewSubtitles": true,
"reuseVideoEncoders": true,
"sdiSupported": true,
"supportAllFeature": true,
"timelineBlocks": true,
"webrtc": true,
"webrtcServerSelect": true
}

Export input properties as JSON

Export input properties into JSON format

path Parameters

playoutId

required

string

query Parameters

organization	string Organization Id
apiVersion	integer <int32>

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": [{"message": "string",
"type": "OK"
}
],
"organization": "string",
"resourceExtension": "string",
"resourceLink": "string",
"serviceProviderId": "string",
"status": "PENDING",
"uniqueId": "string",
"userId": "string"
}

Change instance size

path Parameters

playoutId

required

string

query Parameters

organization	Array of strings
providerId	string

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

Content type

application/json

{ }

Bulk update playout live input configuration

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string
apiVersion	integer <int32> Default: 1

Request Body schema: application/json
required

Array

decoder	string Enum: "AUTO" "AVC" "MPEG"
defaultAribOverride	boolean
defaultAudioOverride	boolean
defaultInput	boolean
delay	integer <int64>
destinationArn	string
deviceNumber	integer <int32>
	object (PlaylistEventSCTE35Filter)
emergencyLive	boolean
enabled	boolean
encryptionKey	string
id	string
mediaFlowArn	string
normalizeLoudness	boolean
port	integer <int32>
port2	integer <int32>
presetId	string
primarySCTESource	boolean
recording	boolean
routeId	string
scteListenerStrategy	string Deprecated Enum: "IGNORE" "MANUAL_END" "BASED_ON_EVENT_SCTE_TRIGGER"
srtLatency	integer <int64>
srtStreamId	string
	object (StreamSettingsDTO)
streamingProtocol	string Enum: "UDP" "RTPUDP" "RTMP_SERVER" "RTMP_CLIENT" "HTTP" "HLS" "HLS_PUSH" "RTP_FEC_2D" "SRT_CALLER" "SRT_LISTENER" "CDI" "DUAL_RTP" "DUAL_RTP_FEC_2D" "SDI"
synchronizeWith	string
type	string Enum: "REGULAR" "MEDIA_CONNECT"
url	string

Responses

Request samples

Payload

Content type

application/json

[{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
]

Response samples

Content type

application/json

{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}

List mediaconnect flows

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

Content type

application/json

[{"egressIp": "string",
"id": "string",
"ingressIp": "string",
"name": "string",
"portsInUse": {"property1": [0
],
"property2": [0
]
},
"status": "string"
}
]

Reboot playout

path Parameters

playoutId

required

string

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

Content type

application/json

{ }

Get a list of playout outputs

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string
fetchFromPlayout	boolean
apiVersion	integer <int32> Default: 1

Responses

Response samples

Content type

application/json

[{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
]

Bulk update playout output configuration

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string
rebootImmediately	boolean
apiVersion	integer <int32> Default: 1

Request Body schema: application/json
required

Array

	Array of objects (NameNoPid)
	Array of objects (AudioStreamSettingsDTO)
	Array of objects (NameLang)
	Array of objects (ContentAdvisoryType) unique
disableOnEmergency	boolean
disableOnEmergencyDelayMs	integer <int32>
enabled	boolean Deprecated
	object (EncoderSettings)
ignoreComplianceRecording	boolean Deprecated
	Array of objects (MediaConnectDestination) unique Deprecated
mediaConnectFlowArn	string Deprecated
	object (MuxerSettings)
name	string
	Array of objects (OutputStream)
presetId	string
	object (StreamSettingsDTO)
	Array of objects (NameLangStyle)
	Array of objects (NameLang)
	Array of objects (NameLang)
	Array of objects (LangStyle)
	Array of objects (NameLang)
	object (TransportSettings)
type	string Deprecated Enum: "REGULAR" "PREVIEW" "MEDIA_CONNECT"
	object (VideoCaps)

Responses

Request samples

Payload

Content type

application/json

[{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
]

Response samples

Content type

application/json

{ }

Reboot playout

path Parameters

playoutId

required

string

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

Content type

application/json

{ }

Reset failed instance to default state

path Parameters

playoutId

required

string

query Parameters

organization	Array of strings
providerId	string

Request Body schema: application/json
required

keepOldInstance	boolean Keep old instance after replace, only usable in conjunction with replace : true
nixEnabled	boolean Enable NIX, this will enable NIX on playout
osUpgradeAllowed	boolean Allow OS upgrade, this will upgrade OS to latest version
reinstall	boolean Reinstall playout this will reinstall all software on playout
replace	boolean Replace playout instance with new one, this will create new instance and delete old one
targetCloud	string Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE" Change playout cloud type, only usable in conjunction with replace : true
targetDeployment	string Enum: "DOCKER" "KUBERNETES" Change playout deployment type, only usable in conjunction with replace : true
targetInstanceType	string Change playout instance type, only usable in conjunction with replace : true
targetRegion	string Change playout region, only usable in conjunction with replace : true
	object (PlayoutVersionDTO) Upgrade playout object
targetVolumeSize	integer <int32> Change playout volume size, only usable in conjunction with replace : true
targetZone	string Change playout availability zone, only usable in conjunction with replace : true

Responses

Request samples

Payload

Content type

application/json

{"keepOldInstance": true,
"nixEnabled": true,
"osUpgradeAllowed": true,
"reinstall": true,
"replace": true,
"targetCloud": "AWS",
"targetDeployment": "DOCKER",
"targetInstanceType": "string",
"targetRegion": "string",
"targetVersion": {"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
},
"targetVolumeSize": 0,
"targetZone": "string"
}

Response samples

Content type

application/json

{ }

Get a list of playout scte-35 triggers

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Responses

Response samples

Content type

application/json

[{"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
],
"exitConditions": {"exitOnScteTake": true
},
"id": "string",
"manualLiveId": "string",
"scte35Signals": [{"archiveAllowedFlag": true,
"autoReturn": true,
"availNum": 0,
"availsExpected": 0,
"command": "ON",
"deviceGroupRestriction": 0,
"duration": 0,
"hasSegment": true,
"noRegionalBlackoutFlag": true,
"offset": 0,
"origin": "FROM_START",
"programId": 0,
"scteEventType": "SPLICE",
"segmentNum": 0,
"segmentationEventId": 0,
"segmentationTypeId": 0,
"segmentationUpid": "string",
"segmentationUpidType": 0,
"segmentsExpected": 0,
"spliceEventId": 0,
"webDeliveryAllowedFlag": true
}
],
"syncSourceLiveId": "string",
"type": "SYNC"
}
]

Modify playout scte-35 triggers

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Request Body schema: application/json
required

	Array of objects (PlayoutSCTE35Trigger)
deleted	Array of strings
	Array of objects (PlayoutSCTE35Trigger)

Responses

Request samples

Payload

Content type

application/json

{"created": [{"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
],
"exitConditions": {"exitOnScteTake": true
},
"id": "string",
"manualLiveId": "string",
"scte35Signals": [{"archiveAllowedFlag": true,
"autoReturn": true,
"availNum": 0,
"availsExpected": 0,
"command": "ON",
"deviceGroupRestriction": 0,
"duration": 0,
"hasSegment": true,
"noRegionalBlackoutFlag": true,
"offset": 0,
"origin": "FROM_START",
"programId": 0,
"scteEventType": "SPLICE",
"segmentNum": 0,
"segmentationEventId": 0,
"segmentationTypeId": 0,
"segmentationUpid": "string",
"segmentationUpidType": 0,
"segmentsExpected": 0,
"spliceEventId": 0,
"webDeliveryAllowedFlag": true
}
],
"syncSourceLiveId": "string",
"type": "SYNC"
}
],
"deleted": ["string"
],
"updated": [{"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
],
"exitConditions": {"exitOnScteTake": true
},
"id": "string",
"manualLiveId": "string",
"scte35Signals": [{"archiveAllowedFlag": true,
"autoReturn": true,
"availNum": 0,
"availsExpected": 0,
"command": "ON",
"deviceGroupRestriction": 0,
"duration": 0,
"hasSegment": true,
"noRegionalBlackoutFlag": true,
"offset": 0,
"origin": "FROM_START",
"programId": 0,
"scteEventType": "SPLICE",
"segmentNum": 0,
"segmentationEventId": 0,
"segmentationTypeId": 0,
"segmentationUpid": "string",
"segmentationUpidType": 0,
"segmentsExpected": 0,
"spliceEventId": 0,
"webDeliveryAllowedFlag": true
}
],
"syncSourceLiveId": "string",
"type": "SYNC"
}
]
}

Response samples

Content type

application/json

[{"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
],
"exitConditions": {"exitOnScteTake": true
},
"id": "string",
"manualLiveId": "string",
"scte35Signals": [{"archiveAllowedFlag": true,
"autoReturn": true,
"availNum": 0,
"availsExpected": 0,
"command": "ON",
"deviceGroupRestriction": 0,
"duration": 0,
"hasSegment": true,
"noRegionalBlackoutFlag": true,
"offset": 0,
"origin": "FROM_START",
"programId": 0,
"scteEventType": "SPLICE",
"segmentNum": 0,
"segmentationEventId": 0,
"segmentationTypeId": 0,
"segmentationUpid": "string",
"segmentationUpidType": 0,
"segmentsExpected": 0,
"spliceEventId": 0,
"webDeliveryAllowedFlag": true
}
],
"syncSourceLiveId": "string",
"type": "SYNC"
}
]

Connection status check

path Parameters

playoutId

required

string

Playout id

Request Body schema: application/json
required

accessKey	string
containerName	string
encryptionKey	string
errorCorrectionOverhead	integer <int32>
fecColumns	integer <int32>
fecRows	integer <int32>
hlsAbrGroup	string
hlsAbrUrl	string
hlsAudioStreams	boolean
hlsPushDestinationType	string Enum: "WEBDAV" "MEDIA_PACKAGE" "S3" "S3_PAIRED"
hlsPushPassword	string
hlsPushUser	string
hlsSegmentCount	integer <int32>
hlsSegmentDuration	number <float>
hlsSegmentTtl	integer <int32>
host	string
host2	string
insertScte35IntoMpegTs	boolean
mediaConnectOutputIp	string
mediaconnectHost	string
outputName	string
outputStreamName	string
password	string
port	integer <int32>
port2	integer <int32>
region	string
scteAheadTimes	Array of integers <int64> [ items <int64 > ]
scteNullInterval	integer <int32>
scteNullPeriod	integer <int64>
scteTagFormat	string Enum: "NONE" "ADOBE" "ELEMENTAL" "ENHANCED" "GOOGLE_AD_MANAGER" "ZAPPN" "MPEG_TS" "GOOGLE_AD_MANAGER_INCL_DATETIME" "ENHANCED_INCL_DATETIME"
secretKey	string
sourcePath	string
srtLatency	integer <int64>
srtStreamId	string
transportType	string Enum: "UDP" "RTPUDP" "RTMP_SERVER" "RTMP_CLIENT" "HTTP" "HLS" "HLS_PUSH" "RTP_FEC_2D" "SRT_CALLER" "SRT_LISTENER" "CDI" "DUAL_RTP" "DUAL_RTP_FEC_2D" "SDI"
username	string

Responses

Request samples

Payload

Content type

application/json

{"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"outputName": "string",
"outputStreamName": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
}

Response samples

Content type

application/json

{"message": "string",
"status": "OK"
}

Configure zixi licenses

path Parameters

playoutId

required

string

Playout id

query Parameters

organization	Array of strings
providerId	string

Request Body schema: application/json
required

mcFeederEnabled	boolean
mcFeederLicense	string
mcReceiverEnabled	boolean
mcReceiverLicense	string

Responses

Request samples

Payload

Content type

application/json

{"mcFeederEnabled": true,
"mcFeederLicense": "string",
"mcReceiverEnabled": true,
"mcReceiverLicense": "string"
}

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": [{"message": "string",
"type": "OK"
}
],
"organization": "string",
"resourceExtension": "string",
"resourceLink": "string",
"serviceProviderId": "string",
"status": "PENDING",
"uniqueId": "string",
"userId": "string"
}

Retrieve playout latest version

path Parameters

type

required

string

Enum: "WINDOWS" "LINUX"

Responses

Response samples

Content type

application/json

{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"organizationId": "string",
"serviceProviderId": "string",
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}

Retrieve latest stable playout version

path Parameters

type

required

string

Enum: "WINDOWS" "LINUX"

Responses

Response samples

Content type

application/json

{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"organizationId": "string",
"serviceProviderId": "string",
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}

Playout configuration resource

Get playouts for organization

Returns playouts

query Parameters

organization	Array of strings
providerId	string
apiVersion	integer <int32> Default: 1
emergencyPlaylist	string Search by emergencyPlaylist asset name.
placeholderPlaylist	string Search by placeholderPlaylist asset name.
graphicsProject	string Search by graphicsProject.
emergencyTemplate	string Search by emergencyTemplate.
name	string Search by playout name
readyOnly	boolean Search for running instances
enabled	boolean Search by enabled flag
backup	boolean Search by backup flag
unassigned	boolean Search for playouts not assigned to any organization
instanceTypes	string Search by instance types
backupSettings.backupPlayoutIds	string Search by backup playout ids

Responses

Response samples

Content type

application/json

[{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}
]

Search for playouts

Returns playouts

query Parameters

organization	Array of strings
providerId	string
apiVersion	integer <int32> Default: 1
size	integer Number of items per page (defaults to 20)
page	integer Page number (defaults to 0)
sort	string Properties that should be sorted by in the format property,property(,ASC\|DESC). Default sort direction is ascending. Use multiple sort parameters if you want to switch directions, e.g. ?sort=firstname&sort=lastname,asc

Request Body schema: application/json

	object (PlayoutAutomaticSwitchingSearch)
backup	boolean
	object (BackupSettingsSearch)
channelName	string
deprecatedVersion	boolean
emergencyPlaylist	Array of strings
emergencyTemplate	string
enabled	boolean
graphicsProject	string
graphicsProjectV2	string
	object (PlayoutInstanceInfoSearch)
instanceTypes	Array of strings unique Items Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"
mode	string Enum: "DEMO" "PROD"
multimediaPackage	string
name	string
placeholderPlaylist	Array of strings
readyOnly	boolean
	object (PlayoutStatusSearch)
unassigned	boolean

Responses

Request samples

Payload

Content type

application/json

{"automaticSwitching": {"emptyTimelineSwitchOff": true
},
"backup": true,
"backupSettings": {"backupPlayoutIds": ["string"
]
},
"channelName": "string",
"deprecatedVersion": true,
"emergencyPlaylist": ["string"
],
"emergencyTemplate": "string",
"enabled": true,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"instanceInfo": {"buildVersion": "string",
"instanceConfigurationId": "string",
"vmType": "WINDOWS"
},
"instanceTypes": ["AWS"
],
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"placeholderPlaylist": ["string"
],
"readyOnly": true,
"status": {"avmon": "ERROR",
"cache": "ERROR",
"connection": "ERROR",
"cpu": "ERROR",
"playback": "ERROR",
"storage": "ERROR"
},
"unassigned": true
}

Response samples

Content type

application/json

{"content": [{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": [null
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": null,
"pid": null
}
],
"audio": [{"enabled": null,
"name": null,
"pid": null
}
],
"closedCaptionsCea608": [{"name": null,
"trackId": null
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": null,
"pid": null
}
],
"subtitlesArib": [{"name": null,
"pid": null
}
],
"subtitlesAribB40": [{"name": null,
"pid": null
}
],
"subtitlesVTT": [{"name": null,
"pid": null
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": [{"ascending": true,
"direction": "string",
"ignoreCase": true,
"nullHandling": "string",
"property": "string"
}
],
"unpaged": true
},
"size": 0,
"sort": [{"ascending": true,
"direction": "string",
"ignoreCase": true,
"nullHandling": "string",
"property": "string"
}
],
"totalElements": 0,
"totalPages": 0
}

Get playouts by id

Returns playouts

query Parameters

organization	Array of strings
apiVersion	integer <int32> Default: 1

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

[{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}
]

Get playout

Returns playout

path Parameters

playoutId

required

string

Playout id

query Parameters

providerId	string
organization	Array of strings
apiVersion	integer <int32> Default: 1

Responses

Response samples

Content type

application/json

{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}

Update playout

path Parameters

playoutId

required

string

query Parameters

providerId	string
organization required	Array of strings
apiVersion	integer <int32> Default: 1

Request Body schema: application/json
required

	Array of objects (AdInsertionConfiguration)
assetExpireHours	integer <int32>
authToken	string
	object (PlayoutAutomaticSwitchingDTO)
	object (PlayoutAvmonSettingsDTO)
backup	boolean
	object (PlayoutBackupSettingsDTO)
backupType	string Enum: "HOT" "WARM"
bandwidthLimit	integer <int64> >= 1
cacheLength	string
caching	boolean
closedCaptionsPassthrough	boolean
	object (PlayoutComplianceRecordingSettings)
concurrentDownloads	integer <int32>
	object (PlayoutConfigurationDTO)
dateCreated	string <date-time>
dateUpdated	string <date-time>
	object (DeploymentInfo)
emergencyTemplate	string
enabled	boolean
fps	number <double>
graphicsProject	string
graphicsProjectV2	string
hardwareId	string Deprecated
id	string
ignoreTimecode	boolean
	object (InstanceInfoDTO)
instanceType	string Enum: "AWS" "AWS_PAIRED" "TELIA" "ALIBABA" "EDGE" "AZURE"
internal	boolean
ip	string
licenseId	integer <int32>
	Array of objects (PlayoutLiveInputDTO)
localCacheId	string
localPlayoutId	string
	object (PlayoutMjpegSettingsDTO)
mode required	string Enum: "DEMO" "PROD"
multimediaPackage	string
name required	string
organizationId	string
	Array of objects (PlayoutOutputDTO)
password	string
port	integer <int32>
presetId	string
	object (PreviewAlarmSettings)
	object (PlayoutPreviewSubtitleSettings)
previewV2Enabled	boolean
pushNotificationEnabled	boolean
	object (RendererConfiguration)
scteListenerStrategy	string Enum: "IGNORE" "MANUAL_END" "SCTE_TRIGGER" "LIVE_SWITCHING" "LIVE_SWITCHING_FAST"
serviceProviderId	string
	object (StatusConfiguration)
	object (PlayoutTimeBarSettingsDTO)
type	string Enum: "SD" "HD" "UHD"
uploadBandwidthLimit	integer <int64> >= 1
username	string
version	integer <int32>
zixiEnabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
],
"unknownProperties": {"property1": { },
"property2": { }
}
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}

Response samples

Content type

application/json

{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}

Assign playout to organization

Assign playout to organization by Id

path Parameters

playoutId

required

string

Playout id

query Parameters

providerId	string
apiVersion	integer <int32> Default: 1

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

Content type

application/json

{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}

Updates playout warm backup failover state

path Parameters

playoutId

required

string

Updated playout object

query Parameters

organization	Array of strings
providerId	string
apiVersion	integer <int32> Default: 1

Request Body schema: application/json
required

boolean

Responses

Request samples

Payload

Content type

application/json

true

Response samples

Content type

application/json

{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}

Clear playout

Clears timeline, removes all configuration like graphics project, emergency playouts etc.

path Parameters

playoutId

required

string

Playout id

query Parameters

organizationId

required

string

Responses

Response samples

Content type

application/json

{ }

Delete playout

Delete playout by Id

path Parameters

playoutId

required

string

Playout id

query Parameters

organization required	Array of strings
providerId	string

Request Body schema: application/json

string

Responses

Request samples

Payload

Content type

application/json

"string"

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": [{"message": "string",
"type": "OK"
}
],
"organization": "string",
"resourceExtension": "string",
"resourceLink": "string",
"serviceProviderId": "string",
"status": "PENDING",
"uniqueId": "string",
"userId": "string"
}

Remove emergency playlist

Removes emergency playlist of a playout.

path Parameters

playoutId

required

string

Playout id

query Parameters

organizationId

required

string

Responses

Response samples

Content type

application/json

{ }

Get emergency playlist

Returns emergency playlist of a playout.

path Parameters

playoutId

required

string

Playout id

query Parameters

organizationId

required

string

Responses

Response samples

Content type

application/json

[{"assetName": "string",
"duration": 0,
"maxExtendedDuration": 0,
"orderNumber": 0,
"som": 0,
"timecodeIn": 0
}
]

Get assigned Playout graphs

path Parameters

playoutId

required

string

Playout id

query Parameters

organization required	Array of strings
fetchPlayoutStatuses	boolean Default: false Whether to fetch graph statuses from playout

Responses

Response samples

Content type

application/json

[{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"licences": [{"id": "string",
"mode": "DEMO",
"name": "string"
}
],
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"playoutGraphStatus": {"graphName": "string",
"status": "NONE"
},
"playoutId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}
]

createPlayoutGraph

path Parameters

playoutId

required

string

Playout id

query Parameters

organization required	Array of strings
providerId	string
overwriteExisting	boolean Default: false

Request Body schema: application/json
required

dateCreated	string <date-time>
dateUpdated	string <date-time>
	Array of objects (Edge)
id	string
	Array of objects (GraphLicence)
	object
name	string
	Array of objects (Node)
	object (PlayoutGraphStatus) PlayoutGraphStatus
playoutId	string
rootId	string
serviceProviderId	string
type	string Enum: "SOFTLAB" "DIRECTSHOW" "GSTREAMER"
version	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"licences": [{"id": "string",
"mode": "DEMO",
"name": "string"
}
],
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"playoutGraphStatus": {"graphName": "string",
"status": "NONE"
},
"playoutId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"licences": [{"id": "string",
"mode": "DEMO",
"name": "string"
}
],
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"playoutGraphStatus": {"graphName": "string",
"status": "NONE"
},
"playoutId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}

Delete graph from playout

Deletes graph with given name from playout.

path Parameters

playoutId required	string Playout id
graphId required	string

query Parameters

organization

required

Array of strings

Responses

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"licences": [{"id": "string",
"mode": "DEMO",
"name": "string"
}
],
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"playoutGraphStatus": {"graphName": "string",
"status": "NONE"
},
"playoutId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}

Get assigned playout graph id

path Parameters

playoutId required	string Playout id
graphId required	string

query Parameters

organization

required

Array of strings

Responses

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"licences": [{"id": "string",
"mode": "DEMO",
"name": "string"
}
],
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"playoutGraphStatus": {"graphName": "string",
"status": "NONE"
},
"playoutId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}

updatePlayoutGraph

path Parameters

playoutId required	string Playout id
graphId required	string

query Parameters

organization required	Array of strings
providerId	string

Request Body schema: application/json
required

dateCreated	string <date-time>
dateUpdated	string <date-time>
	Array of objects (Edge)
id	string
	Array of objects (GraphLicence)
	object
name	string
	Array of objects (Node)
	object (PlayoutGraphStatus) PlayoutGraphStatus
playoutId	string
rootId	string
serviceProviderId	string
type	string Enum: "SOFTLAB" "DIRECTSHOW" "GSTREAMER"
version	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"licences": [{"id": "string",
"mode": "DEMO",
"name": "string"
}
],
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"playoutGraphStatus": {"graphName": "string",
"status": "NONE"
},
"playoutId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"licences": [{"id": "string",
"mode": "DEMO",
"name": "string"
}
],
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"playoutGraphStatus": {"graphName": "string",
"status": "NONE"
},
"playoutId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}

Update playout graph licence mode

Sets new mode for all playout graph licences. Returns graph licence list

path Parameters

playoutId required	string Playout id
graphId required	string

query Parameters

organization

required

Array of strings

Request Body schema: application/json
required

string

Enum: "DEMO" "PROD"

Responses

Request samples

Payload

Content type

application/json

"DEMO"

Response samples

Content type

application/json

[{"id": "string",
"mode": "DEMO",
"name": "string"
}
]

Get placeholder playlist

Returns placeholder playlist of a playout.

path Parameters

playoutId

required

string

Playout id

query Parameters

organizationId

required

string

Responses

Response samples

Content type

application/json

[{"items": [{"assetName": "string",
"duration": 0,
"maxExtendedDuration": 0,
"orderNumber": 0,
"som": 0,
"timecodeIn": 0
}
],
"name": "string",
"playlistId": 0,
"id": "string",
"playoutId": "string"
}
]

Get playout renderer configuration

path Parameters

playoutId

required

string

Playout id

query Parameters

organizationId

required

string

Responses

Response samples

Content type

application/json

{"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
}

Update playout renderer configuration

path Parameters

playoutId

required

string

Playout id

query Parameters

organizationId required	string
apiVersion	integer <int32> Default: 1

Request Body schema: application/json
required

aspect-ratio	integer <int32>
	Array of objects (RendererAudioConfig)
board-index	integer <int32>
board-name	string
frame-rate	number <double>
licenseId	integer <int32>
resolution-height	integer <int32>
resolution-width	integer <int32>
scan-type	integer <int32>
	Array of objects (RendererSubtitleConfig)
	object

Responses

Request samples

Payload

Content type

application/json

{"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
],
"unknownProperties": {"property1": { },
"property2": { }
}
}

Response samples

Content type

application/json

{"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
}

Reset playout instance

Reset playout instance config

path Parameters

playoutId

required

string

Updated playout object

query Parameters

organization required	Array of strings
providerId	string
apiVersion	integer <int32> Default: 1

Responses

Response samples

Content type

application/json

{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}

Start playout instance

path Parameters

playoutId

required

string

Updated playout object

query Parameters

organization required	Array of strings
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": [{"message": "string",
"type": "OK"
}
],
"organization": "string",
"resourceExtension": "string",
"resourceLink": "string",
"serviceProviderId": "string",
"status": "PENDING",
"uniqueId": "string",
"userId": "string"
}

Stop playout instance

path Parameters

playoutId

required

string

Updated playout object

query Parameters

silentStop	boolean Default: false
organization required	Array of strings
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": [{"message": "string",
"type": "OK"
}
],
"organization": "string",
"resourceExtension": "string",
"resourceLink": "string",
"serviceProviderId": "string",
"status": "PENDING",
"uniqueId": "string",
"userId": "string"
}

Un-assign playout from organization

Assign playout to organization by Id

path Parameters

playoutId

required

string

Playout id

query Parameters

providerId	string
apiVersion	integer <int32> Default: 1

Responses

Response samples

Content type

application/json

{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}

Organization resource

Get organizations

Returns organizations

query Parameters

providerId

string

Service Provider Id

Responses

Response samples

Content type

application/json

[{"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"serviceProviderId": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true,
"organizationId": "string",
"serviceProviderId": "string"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"ingest": {"sources": [{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"status": {"failedAttempts": 0,
"id": "11222333",
"ingestSourceId": "1122333",
"lastAttempt": 1594137600000,
"nextAttempt": 1594137600000,
"status": "PENDING_CHECK"
},
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}
]
},
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"serviceProviderId": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestQueueItemLimit": 0,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"settings": {"eventAudioFadingConfiguration": {"attenuation": 0,
"fadeInAttack": 0,
"fadeInOffset": 0,
"fadeOutAttack": 0,
"fadeOutOffset": 0
},
"fps": 0.1,
"libraryCleanupConfiguration": {"daysNotModified": 0,
"daysNotScheduled": 0,
"libraryCleanupEnabled": true,
"type": "REMOVE"
},
"schedulingTimelineLockDays": 0,
"thresholdsConfiguration": {"assetThresholds": {"audioVideoError": 0,
"audioVideoWarning": 0
},
"eventThresholds": {"deviation": 0,
"gapOverlap": 0,
"programmeSteps": 0
}
},
"timeZone": "string",
"timeZones": [{"hidden": true,
"key": "string",
"readable": "string",
"timeZone": "string"
}
]
}
}
]

Retrieve allowed mediaStoreTypes by service provider ID

query Parameters

providerId

string

Responses

Response samples

Content type

application/json

{"property1": ["S3"
],
"property2": ["S3"
]
}

Get organization

Returns organization found by Id

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

{"cloudConfigurations": [{"accessKey": "string",
"additionalRegions": ["string"
],
"apiKey": "string",
"apiUrl": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"domainKey": "string",
"id": "string",
"ingestInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeTag": "string",
"keyName": "string",
"password": "string",
"region": "string",
"securityGroupId": "string",
"subnetId": "string",
"useInternalIp": true,
"userData": "string",
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"mediaStoreSettings": {"accessKey": "string",
"secretKey": "string",
"url": "string"
},
"organizationId": "string",
"playoutInstanceConfiguration": {"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"availabilityZone": "string",
"diskSize": 0,
"instanceType": "string",
"instanceTypeHd": "string",
"instanceTypeSd": "string",
"instanceTypeUhd": "string",
"keyName": "string",
"password": "string",
"region": "string",
"subnetId": "string",
"useInternalIp": true,
"username": "string",
"volumeId": "string",
"vpcId": "string"
},
"providerId": "string",
"region": "string",
"secretKey": "string",
"serviceProviderId": "string",
"type": "AWS",
"vmConfigs": [{"accessRights": [{"fromPort": 0,
"ipRange": "string",
"name": "string",
"port": 0,
"protocol": "string",
"securityGroupId": "string",
"toPort": 0
}
],
"amiId": "string",
"instanceType": "string",
"keyData": "string",
"keyName": "string",
"linuxAmiId": "string",
"region": "string",
"subnets": {"property1": "string",
"property2": "string"
},
"useInternalIp": true,
"volumeId": "string",
"vpcId": "string"
}
]
}
],
"complianceRecordingSettings": {"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true,
"organizationId": "string",
"serviceProviderId": "string"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"enabled": true,
"id": "string",
"ingest": {"sources": [{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"status": {"failedAttempts": 0,
"id": "11222333",
"ingestSourceId": "1122333",
"lastAttempt": 1594137600000,
"nextAttempt": 1594137600000,
"status": "PENDING_CHECK"
},
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}
]
},
"mediaStoreInfo": {"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"serviceProviderId": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
},
"name": "string",
"resourceLimits": {"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestQueueItemLimit": 0,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
},
"serviceProviderId": "string",
"settings": {"eventAudioFadingConfiguration": {"attenuation": 0,
"fadeInAttack": 0,
"fadeInOffset": 0,
"fadeOutAttack": 0,
"fadeOutOffset": 0
},
"fps": 0.1,
"libraryCleanupConfiguration": {"daysNotModified": 0,
"daysNotScheduled": 0,
"libraryCleanupEnabled": true,
"type": "REMOVE"
},
"schedulingTimelineLockDays": 0,
"thresholdsConfiguration": {"assetThresholds": {"audioVideoError": 0,
"audioVideoWarning": 0
},
"eventThresholds": {"deviation": 0,
"gapOverlap": 0,
"programmeSteps": 0
}
},
"timeZone": "string",
"timeZones": [{"hidden": true,
"key": "string",
"readable": "string",
"timeZone": "string"
}
]
}
}

Get organization block categories

Returns block categories used by organization

path Parameters

organization

required

string

Organization id

query Parameters

sort

required

string

Properties that should be sorted by in the format property,property(,ASC|DESC). Default sort direction is ascending. Use multiple sort parameters if you want to switch directions, e.g. ?sort=firstname&sort=lastname,asc

Responses

Response samples

Content type

application/json

[{"color": "^#(AAAAAA|AAA)$",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organizationId": "string",
"serviceProviderId": "string"
}
]

Create organization block category

Returns block categories used by organization

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

color required	string^#([A-Fa-f0-9]{6}\|[A-Fa-f0-9]{3})$
dateCreated	string <date-time>
dateUpdated	string <date-time>
id	string
name required	string
organizationId	string
serviceProviderId	string

Responses

Request samples

Payload

Content type

application/json

{"color": "^#(AAAAAA|AAA)$",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organizationId": "string",
"serviceProviderId": "string"
}

Response samples

Content type

application/json

{"color": "^#(AAAAAA|AAA)$",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organizationId": "string",
"serviceProviderId": "string"
}

Delete organization tag

path Parameters

organization required	string Organization id
blockCategoryId required	string Category id

query Parameters

ignoreUsage

boolean

Ignore category usage in a block

Responses

Response samples

Content type

application/json

{ }

Get organization block category

Returns block category

path Parameters

organization required	string Organization id
blockCategoryId required	string Category id

Responses

Response samples

Content type

application/json

{"color": "^#(AAAAAA|AAA)$",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organizationId": "string",
"serviceProviderId": "string"
}

Updates organization block category

path Parameters

organization required	string Organization id
blockCategoryId required	string Category id

Request Body schema: application/json
required

color required	string^#([A-Fa-f0-9]{6}\|[A-Fa-f0-9]{3})$
dateCreated	string <date-time>
dateUpdated	string <date-time>
id	string
name required	string
organizationId	string
serviceProviderId	string

Responses

Request samples

Payload

Content type

application/json

{"color": "^#(AAAAAA|AAA)$",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organizationId": "string",
"serviceProviderId": "string"
}

Response samples

Content type

application/json

{"color": "^#(AAAAAA|AAA)$",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"name": "string",
"organizationId": "string",
"serviceProviderId": "string"
}

Get organization cluster token

Returns token to manage edge playouts

path Parameters

organization

required

string

query Parameters

providerId

string

Responses

Response samples

Content type

application/json

{"token": "string"
}

Get organization compliance recording config

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

{"enabled": true,
"externalUploadDestinations": [{"accessKey": "string",
"bucketName": "string",
"id": "string",
"prefix": "string",
"region": "string",
"secretKey": "string",
"type": "S3",
"url": "string"
}
],
"internalUploadEnabled": true,
"organizationId": "string",
"serviceProviderId": "string"
}

Get organization custom metadata fields

Returns custom metadata fields by organization

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

[{"name": "string",
"serviceProviderId": "string",
"title": "string"
}
]

Create organization custom metadata field

Returns custom metadata fields in organization

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

name	string
serviceProviderId	string
title	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"serviceProviderId": "string",
"title": "string"
}

Response samples

Content type

application/json

{"name": "string",
"serviceProviderId": "string",
"title": "string"
}

Delete organization custom metadata field

path Parameters

organization required	string Organization id
name required	string

Responses

Response samples

Content type

application/json

{ }

Get organization custom metadata field

Returns custom metadata field by organization and name

path Parameters

organization required	string Organization id
name required	string Field name

Responses

Response samples

Content type

application/json

{"name": "string",
"serviceProviderId": "string",
"title": "string"
}

Edit organization custom metadata field

path Parameters

organization required	string Organization id
name required	string

Request Body schema: application/json
required

name	string
title	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"title": "string"
}

Response samples

Content type

application/json

{"name": "string",
"serviceProviderId": "string",
"title": "string"
}

Get organization ingest

Returns ingest related configuration for organization

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

{"sources": [{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"status": {"failedAttempts": 0,
"id": "11222333",
"ingestSourceId": "1122333",
"lastAttempt": 1594137600000,
"nextAttempt": 1594137600000,
"status": "PENDING_CHECK"
},
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}
]
}

Get graphics upload ingest source

Returns ingest source configuration for graphics upload

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"status": {"failedAttempts": 0,
"id": "11222333",
"ingestSourceId": "1122333",
"lastAttempt": 1594137600000,
"nextAttempt": 1594137600000,
"status": "PENDING_CHECK"
},
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}

Get organization ingest qc rules

Returns ingest related configuration for organization

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

[{"allowEmpty": false,
"critical": false,
"mediaType": "AUDIO",
"modifiable": true,
"operand": "<",
"property": "duration",
"resultMessage": "test",
"ruleId": "test",
"sourceCondition": { },
"targetValue": "3",
"targetValueType": "AUDIO_STREAM",
"validatorType": "VALUE"
}
]

Create organization ingest qc rules

Create ingest qc rule

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

allowEmpty	boolean
critical	boolean
mediaType	string Enum: "VIDEO" "AUDIO" "SUBTITLE" "IMAGE" "AE_TEMPLATE" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SIDE_CAR_XML" "SCHEDULE" "COMPLIANCE_RECORDING" "UNKNOWN" "THUMBNAIL_IMAGE" "THUMBNAIL_VIDEO" "FONT"
operand	string
property	string
resultMessage	string
ruleId	string
	object
targetValue	string
targetValueType	string Enum: "FILE" "VIDEO_STREAM" "AUDIO_STREAM" "TEXT_STREAM" "AUDIO_LOUDNESS" "CUSTOM_DATA" "MEDIA"
validatorType	string Enum: "VALUE" "LENGTH" "LANGUAGE_CODE" "LIST" "TIME_CODE" "ADAM_ID"
dateCreated	string <date-time> Date when rule was created
dateUpdated	string <date-time> Date when rule was updated
id	string Rule ID
modifiable	boolean Is rule modifiable
organizationId	string Organization ID
serviceProviderId	string

Responses

Request samples

Payload

Content type

application/json

{"allowEmpty": false,
"critical": false,
"mediaType": "AUDIO",
"modifiable": true,
"operand": "<",
"property": "duration",
"resultMessage": "test",
"ruleId": "test",
"sourceCondition": { },
"targetValue": "3",
"targetValueType": "AUDIO_STREAM",
"validatorType": "VALUE"
}

Response samples

Content type

application/json

{"allowEmpty": false,
"critical": false,
"mediaType": "AUDIO",
"modifiable": true,
"operand": "<",
"property": "duration",
"resultMessage": "test",
"ruleId": "test",
"sourceCondition": { },
"targetValue": "3",
"targetValueType": "AUDIO_STREAM",
"validatorType": "VALUE"
}

Delete organization ingest qc rule

Delete ingest related configuration

path Parameters

organization required	string Organization id
ruleId required	string

Responses

Response samples

Content type

application/json

{ }

Get organization ingest qc rules

Returns ingest related configuration for organization

path Parameters

organization required	string Organization id
ruleId required	string

Responses

Response samples

Content type

application/json

{"allowEmpty": false,
"critical": false,
"mediaType": "AUDIO",
"modifiable": true,
"operand": "<",
"property": "duration",
"resultMessage": "test",
"ruleId": "test",
"sourceCondition": { },
"targetValue": "3",
"targetValueType": "AUDIO_STREAM",
"validatorType": "VALUE"
}

Update organization ingest qc rules

Returns ingest related configuration for organization

path Parameters

organization required	string Organization id
ruleId required	string

Request Body schema: application/json
required

allowEmpty	boolean
critical	boolean
mediaType	string Enum: "VIDEO" "AUDIO" "SUBTITLE" "IMAGE" "AE_TEMPLATE" "GRAPHICS_PROJECT" "MULTI_MEDIA_CAPTION_PACKAGE" "SIDE_CAR_XML" "SCHEDULE" "COMPLIANCE_RECORDING" "UNKNOWN" "THUMBNAIL_IMAGE" "THUMBNAIL_VIDEO" "FONT"
operand	string
property	string
resultMessage	string
ruleId	string
	object
targetValue	string
targetValueType	string Enum: "FILE" "VIDEO_STREAM" "AUDIO_STREAM" "TEXT_STREAM" "AUDIO_LOUDNESS" "CUSTOM_DATA" "MEDIA"
validatorType	string Enum: "VALUE" "LENGTH" "LANGUAGE_CODE" "LIST" "TIME_CODE" "ADAM_ID"
dateCreated	string <date-time> Date when rule was created
dateUpdated	string <date-time> Date when rule was updated
id	string Rule ID
modifiable	boolean Is rule modifiable
organizationId	string Organization ID
serviceProviderId	string

Responses

Request samples

Payload

Content type

application/json

{"allowEmpty": false,
"critical": false,
"mediaType": "AUDIO",
"modifiable": true,
"operand": "<",
"property": "duration",
"resultMessage": "test",
"ruleId": "test",
"sourceCondition": { },
"targetValue": "3",
"targetValueType": "AUDIO_STREAM",
"validatorType": "VALUE"
}

Response samples

Content type

application/json

{"allowEmpty": false,
"critical": false,
"mediaType": "AUDIO",
"modifiable": true,
"operand": "<",
"property": "duration",
"resultMessage": "test",
"ruleId": "test",
"sourceCondition": { },
"targetValue": "3",
"targetValueType": "AUDIO_STREAM",
"validatorType": "VALUE"
}

Get organization ingest sources

Returns ingest sources configuration for organization

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

[{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"status": {"failedAttempts": 0,
"id": "11222333",
"ingestSourceId": "1122333",
"lastAttempt": 1594137600000,
"nextAttempt": 1594137600000,
"status": "PENDING_CHECK"
},
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}
]

Create organization ingest source

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

accessKey	string
cirrusSource	boolean
containerName	string
dateCreated	string <date-time>
dateUpdated	string <date-time>
emptyAssetsSource	boolean
enabled	boolean
expiration	string <date-time>
	Array of objects (IngestFileNameMapping) unique
graphicsUploadSource	boolean
host	string
id	string
internal	boolean
internalUploadSource	boolean
	object (JumpHostSettings)
manualListing	boolean
musicKitIntegration	boolean
name	string
nullifySubtitleTimecode	boolean
passwordChanged	boolean
pollingFrequency	integer <int64>
port	integer <int32>
priority	integer <int32>
privateKey	string
privateKeyChanged	boolean
	object
readOnly	boolean
region	string
scanOnly	boolean
scheduleAutoApplyEnabled	boolean
scheduleFileMask	string
scheduleTransformationScriptId	string
scheduledMissingOnly	boolean
secretKey	string
secretKeyChanged	boolean
serviceProviderId	string
sideCarFileMask	string
sideCarXmlTransformationScriptId	string
sourcePassword	string
sourcePath	string
sourceUserName	string
storefrontRegion	string
subtitleEncoding	string
subtitleTimecodeOffset	string
	Array of objects (Tag) unique
timecodeIn	integer <int64>
type required	string Enum: "FTP" "S3" "S3_PAIRED" "SFTP" "TELIA_S3" "ALIBABA" "AZURE" "S3_GENERIC" "DOT_STUDIO"
videoConversionEnabled	boolean
videoConversionExtensions	Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}

Response samples

Content type

application/json

{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"status": {"failedAttempts": 0,
"id": "11222333",
"ingestSourceId": "1122333",
"lastAttempt": 1594137600000,
"nextAttempt": 1594137600000,
"status": "PENDING_CHECK"
},
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}

Delete organization ingest source by id

path Parameters

organization required	string Organization id
sourceId required	string Source id

Responses

Response samples

Content type

application/json

{ }

Get organization ingest source by id

Returns organization ingest source configuration

path Parameters

organization required	string Organization id
sourceId required	string Source id

Responses

Response samples

Content type

application/json

{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"status": {"failedAttempts": 0,
"id": "11222333",
"ingestSourceId": "1122333",
"lastAttempt": 1594137600000,
"nextAttempt": 1594137600000,
"status": "PENDING_CHECK"
},
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}

Update organization ingest source

path Parameters

organization required	string Organization id
sourceId required	string Source id

Request Body schema: application/json
required

accessKey	string
cirrusSource	boolean
containerName	string
dateCreated	string <date-time>
dateUpdated	string <date-time>
emptyAssetsSource	boolean
enabled	boolean
expiration	string <date-time>
	Array of objects (IngestFileNameMapping) unique
graphicsUploadSource	boolean
host	string
id	string
internal	boolean
internalUploadSource	boolean
	object (JumpHostSettings)
manualListing	boolean
musicKitIntegration	boolean
name	string
nullifySubtitleTimecode	boolean
passwordChanged	boolean
pollingFrequency	integer <int64>
port	integer <int32>
priority	integer <int32>
privateKey	string
privateKeyChanged	boolean
	object
readOnly	boolean
region	string
scanOnly	boolean
scheduleAutoApplyEnabled	boolean
scheduleFileMask	string
scheduleTransformationScriptId	string
scheduledMissingOnly	boolean
secretKey	string
secretKeyChanged	boolean
serviceProviderId	string
sideCarFileMask	string
sideCarXmlTransformationScriptId	string
sourcePassword	string
sourcePath	string
sourceUserName	string
storefrontRegion	string
subtitleEncoding	string
subtitleTimecodeOffset	string
	Array of objects (Tag) unique
timecodeIn	integer <int64>
type required	string Enum: "FTP" "S3" "S3_PAIRED" "SFTP" "TELIA_S3" "ALIBABA" "AZURE" "S3_GENERIC" "DOT_STUDIO"
videoConversionEnabled	boolean
videoConversionExtensions	Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}

Response samples

Content type

application/json

{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"status": {"failedAttempts": 0,
"id": "11222333",
"ingestSourceId": "1122333",
"lastAttempt": 1594137600000,
"nextAttempt": 1594137600000,
"status": "PENDING_CHECK"
},
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}

Get organization ingest upload source

Returns ingest sources for web based uploads

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"status": {"failedAttempts": 0,
"id": "11222333",
"ingestSourceId": "1122333",
"lastAttempt": 1594137600000,
"nextAttempt": 1594137600000,
"status": "PENDING_CHECK"
},
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}

Update organization ingest upload source

Returns ingest sources for web based uploads

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

accessKey	string
cirrusSource	boolean
containerName	string
dateCreated	string <date-time>
dateUpdated	string <date-time>
emptyAssetsSource	boolean
enabled	boolean
expiration	string <date-time>
	Array of objects (IngestFileNameMapping) unique
graphicsUploadSource	boolean
host	string
id	string
internal	boolean
internalUploadSource	boolean
	object (JumpHostSettings)
manualListing	boolean
musicKitIntegration	boolean
name	string
nullifySubtitleTimecode	boolean
passwordChanged	boolean
pollingFrequency	integer <int64>
port	integer <int32>
priority	integer <int32>
privateKey	string
privateKeyChanged	boolean
	object
readOnly	boolean
region	string
scanOnly	boolean
scheduleAutoApplyEnabled	boolean
scheduleFileMask	string
scheduleTransformationScriptId	string
scheduledMissingOnly	boolean
secretKey	string
secretKeyChanged	boolean
serviceProviderId	string
sideCarFileMask	string
sideCarXmlTransformationScriptId	string
sourcePassword	string
sourcePath	string
sourceUserName	string
storefrontRegion	string
subtitleEncoding	string
subtitleTimecodeOffset	string
	Array of objects (Tag) unique
timecodeIn	integer <int64>
type required	string Enum: "FTP" "S3" "S3_PAIRED" "SFTP" "TELIA_S3" "ALIBABA" "AZURE" "S3_GENERIC" "DOT_STUDIO"
videoConversionEnabled	boolean
videoConversionExtensions	Array of strings unique

Responses

Request samples

Payload

Content type

application/json

{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}

Response samples

Content type

application/json

{"accessKey": "string",
"cirrusSource": true,
"containerName": "string",
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"emptyAssetsSource": true,
"enabled": true,
"expiration": "2019-08-24T14:15:22Z",
"fileNameReplacementMappings": [{"filePattern": "string",
"replacement": "string"
}
],
"graphicsUploadSource": true,
"host": "string",
"id": "string",
"internal": true,
"internalUploadSource": true,
"jumpHostSettings": {"enabled": true,
"host": "string",
"password": "string",
"port": 0,
"privateKey": "string",
"username": "string"
},
"manualListing": true,
"musicKitIntegration": true,
"name": "string",
"nullifySubtitleTimecode": true,
"passwordChanged": true,
"pollingFrequency": 0,
"port": 0,
"priority": 0,
"privateKey": "string",
"privateKeyChanged": true,
"properties": {"property1": { },
"property2": { }
},
"readOnly": true,
"region": "string",
"scanOnly": true,
"scheduleAutoApplyEnabled": true,
"scheduleFileMask": "string",
"scheduleTransformationScriptId": "string",
"scheduledMissingOnly": true,
"secretKey": "string",
"secretKeyChanged": true,
"serviceProviderId": "string",
"sideCarFileMask": "string",
"sideCarXmlTransformationScriptId": "string",
"sourcePassword": "string",
"sourcePath": "string",
"sourceUserName": "string",
"status": {"failedAttempts": 0,
"id": "11222333",
"ingestSourceId": "1122333",
"lastAttempt": 1594137600000,
"nextAttempt": 1594137600000,
"status": "PENDING_CHECK"
},
"storefrontRegion": "string",
"subtitleEncoding": "string",
"subtitleTimecodeOffset": "string",
"tags": [{"name": "string",
"serviceProviderId": "string"
}
],
"timecodeIn": 0,
"type": "FTP",
"videoConversionEnabled": true,
"videoConversionExtensions": ["string"
]
}

Get organization live input routes

Returns live input routes

path Parameters

organization

required

string

query Parameters

providerId

string

Responses

Response samples

Content type

application/json

[{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"destinationPlayouts": ["string"
],
"id": "string",
"input": {"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
},
"inputAddresses": [{"address": "string",
"port": 0
}
],
"name": "string",
"organizationId": "string",
"serviceProviderId": "string"
}
]

Create organization live input route

Returns live input routes used by organization

path Parameters

organization

required

string

query Parameters

providerId

string

Request Body schema: application/json
required

dateCreated	string <date-time>
dateUpdated	string <date-time>
destinationPlayouts	Array of strings unique Live route destination playouts
id	string Live input route id
	object (PlayoutLiveInputDTO)
	Array of objects (InputAddress) unique
name	string Live input route name
organizationId	string
serviceProviderId	string

Responses

Request samples

Payload

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"destinationPlayouts": ["string"
],
"id": "string",
"input": {"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
},
"inputAddresses": [{"address": "string",
"port": 0
}
],
"name": "string",
"organizationId": "string",
"serviceProviderId": "string"
}

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"destinationPlayouts": ["string"
],
"id": "string",
"input": {"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
},
"inputAddresses": [{"address": "string",
"port": 0
}
],
"name": "string",
"organizationId": "string",
"serviceProviderId": "string"
}

Delete organization live input route

path Parameters

organization required	string
liveInputRouteId required	string Live input route id

query Parameters

providerId

string

Responses

Response samples

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Get organization live input route

Returns live input route found by Id

path Parameters

organization required	string
liveInputRouteId required	string Live input route id

query Parameters

providerId

string

Responses

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"destinationPlayouts": ["string"
],
"id": "string",
"input": {"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
},
"inputAddresses": [{"address": "string",
"port": 0
}
],
"name": "string",
"organizationId": "string",
"serviceProviderId": "string"
}

Update organization live input route

path Parameters

organization required	string
liveInputRouteId required	string Live input route id

query Parameters

providerId

string

Request Body schema: application/json
required

dateCreated	string <date-time>
dateUpdated	string <date-time>
destinationPlayouts	Array of strings unique Live route destination playouts
id	string Live input route id
	object (PlayoutLiveInputDTO)
	Array of objects (InputAddress) unique
name	string Live input route name
organizationId	string
serviceProviderId	string

Responses

Request samples

Payload

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"destinationPlayouts": ["string"
],
"id": "string",
"input": {"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
},
"inputAddresses": [{"address": "string",
"port": 0
}
],
"name": "string",
"organizationId": "string",
"serviceProviderId": "string"
}

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"destinationPlayouts": ["string"
],
"id": "string",
"input": {"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
},
"inputAddresses": [{"address": "string",
"port": 0
}
],
"name": "string",
"organizationId": "string",
"serviceProviderId": "string"
}

Get organization media store config

Returns media store related configuration for organization

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

{"archiveContainerName": "string",
"cloudId": "string",
"containerName": "string",
"containerOwnedByUser": true,
"credentials": "string",
"identity": "string",
"liveRecordingPrefix": "string",
"name": "string",
"oauthTokenStore": "string",
"objectValidityTime": 0,
"organizationId": "string",
"region": "string",
"serviceProviderId": "string",
"storeHostName": "string",
"storePort": 0,
"tenantName": "string",
"type": "S3"
}

Get playouts for organization

Returns playouts

path Parameters

organization

required

string

query Parameters

apiVersion

integer <int32>

Default: 1

Responses

Response samples

Content type

application/json

[{"adInsertionConfigurations": [{"abrGroup": "MAIN",
"adDecisionServerUrl": "http://decision-server.com/decision.xml",
"adMarkerPassthrough": true,
"aliases": {"alias1": {"key1": "value1"
}
},
"availSuppressionMode": "OFF",
"availSuppressionValue": "00:00:00",
"bumperEndUrl": "https://bumper-end.com/bumper-end.mp4",
"bumperStartUrl": "https://bumper-start.com/bumper-start.mp4",
"cdnAdSegmentPrefix": "string",
"cdnContentSegmentPrefix": "string",
"contentSourceUrl": "string",
"dashManifestUrl": "string",
"dashMpdLocation": "EMT_DEFAULT",
"dashOriginType": "MULTI_PERIOD",
"hlsManifestUrl": "https://hls-manifest.com/manifest.m3u8",
"livePrerollDecsiionServerUrl": "string",
"livePrerollDecsionServerUrl": "http://live-preroll-decision-server.com/decision.xml",
"livePrerollMaximumDuration": 100,
"name": "ad-insertion-configuration-1",
"personalizedThreshold": 100,
"region": "us-east-1",
"sessionLogPercent": 0,
"slateAssetId": "10000001",
"slateAssetUrl": "https://slate-asset.com/slate.mp4",
"state": "IN_SYNC",
"transcodeProfileName": "transcode-profile-1"
}
],
"assetExpireHours": 0,
"authToken": "string",
"automaticSwitching": {"emptyTimelineSwitchOff": true,
"emptyTimelineSwitchOffDelayMin": 0
},
"avmonSettings": {"audioTrackChannelCount": 0,
"audioTrackCount": 0,
"blackDurationThreshold": 0.1,
"blackValueThreshold": 0.1,
"freezeDurationThreshold": 0.1,
"freezeValueThreshold": 0.1,
"inputDeviceName": "string",
"resolutionHeight": 0,
"resolutionWidth": 0,
"silenceDurationThreshold": 0.1,
"silenceValueThreshold": 0.1,
"timecodeOverlay": true
},
"backup": true,
"backupSettings": {"backupPlayoutId": "string",
"backupType": "HOT",
"cacheForHours": 0,
"failoverDisabled": true,
"healthyPeriod": 0,
"maxWarmBackupUptimeHours": 0,
"startCachingMillis": 0,
"unhealthyPeriod": 0,
"wakeUpForCaching": true,
"wakeUpOnTimelineChange": true
},
"backupType": "HOT",
"bandwidthLimit": 1,
"cacheLength": "string",
"caching": true,
"closedCaptionsPassthrough": true,
"complianceRecordingSettings": {"bitrate": 0,
"enabled": true,
"includeSubtitles": true,
"timecodeOverlay": true
},
"concurrentDownloads": 0,
"configuration": {"audioFallbackLanguages": {"defaultLanguage": "string",
"mapping": {"property1": "string",
"property2": "string"
}
},
"audioLoudness": 0.1,
"audioLoudnessNormalizationEnabled": true,
"channelId": "string",
"channelName": "string",
"gapOverlap": 0,
"hdPreviewEnabled": true,
"liveRecordingSettings": {"enabled": true,
"fileNamePattern": "string",
"fragmentDurationSec": 0,
"maxStoragePercent": 0
},
"organizationId": "string",
"organizationName": "string",
"playoutId": "string",
"playoutName": "string",
"providerId": "string",
"providerName": "string",
"rtmpPreviewEnabled": true,
"stunServer": {"host": "string",
"password": "string",
"port": 0,
"username": "string"
},
"timelineType": "NIMBUS"
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"deploymentInfo": {"cacheResources": {"cpu": "string",
"memory": "string"
},
"cacheSize": 0,
"cacheVersion": "string",
"hlsResources": {"cpu": "string",
"memory": "string"
},
"hlsSize": 0,
"lastChange": "2019-08-24T14:15:22Z",
"playoutLogSize": 0,
"playoutResources": {"cpu": "string",
"memory": "string"
},
"playoutVersion": "string",
"restartRequired": true,
"rtmpResources": {"cpu": "string",
"memory": "string"
},
"rtmpVersion": "string",
"status": "MISSING",
"type": "DOCKER"
},
"emergencyTemplate": "string",
"enabled": true,
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"hardwareId": "string",
"id": "string",
"ignoreTimecode": true,
"instanceInfo": {"availabilityZone": "string",
"buildVersion": "string",
"cdiSupportEnabled": true,
"created": "2019-08-24T14:15:22Z",
"externalIp": "string",
"instanceConfigurationId": "string",
"instanceId": "string",
"instanceSize": "string",
"messages": [{"message": "string",
"timeStamp": "2019-08-24T14:15:22Z"
}
],
"region": "string",
"sdiSupportEnabled": true,
"securityGroupId": "string",
"started": "2019-08-24T14:15:22Z",
"state": "REQUESTED",
"versionHistory": [{"build": "string",
"changelog": [{"description": "string",
"ticketId": "string",
"timestamp": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"dateCreated": "2019-08-24T14:15:22Z",
"environment": "string",
"features": ["string"
],
"id": "string",
"major": 0,
"minor": 0,
"sprint": 0,
"status": "STABLE",
"versionString": "string",
"vmType": "WINDOWS"
}
],
"vmType": "WINDOWS",
"volumeSize": 0
},
"instanceType": "AWS",
"internal": true,
"ip": "string",
"licenseId": 0,
"liveInputs": [{"decoder": "AUTO",
"defaultAribOverride": true,
"defaultAudioOverride": true,
"defaultInput": true,
"delay": 0,
"destinationArn": "string",
"deviceNumber": 0,
"emergencyFilter": {"activeFrom": "2019-08-24T14:15:22Z",
"activeTo": "2019-08-24T14:15:22Z",
"criteria": [{"field": "SPLICE_EVENT_ID",
"value": "string"
}
]
},
"emergencyLive": true,
"enabled": true,
"encryptionKey": "string",
"id": "string",
"mediaFlowArn": "string",
"normalizeLoudness": true,
"port": 0,
"port2": 0,
"presetId": "string",
"primarySCTESource": true,
"recording": true,
"routeId": "string",
"scteListenerStrategy": "IGNORE",
"srtLatency": 0,
"srtStreamId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"streamingProtocol": "UDP",
"synchronizeWith": "string",
"type": "REGULAR",
"url": "string"
}
],
"localCacheId": "string",
"localPlayoutId": "string",
"mjpegSettings": {"jpegHeight": 0,
"jpegQuality": 0,
"jpegWidth": 0,
"mjpegFrameRate": 0
},
"mode": "DEMO",
"multimediaPackage": "string",
"name": "string",
"organizationId": "string",
"outputs": [{"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"name": "string"
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"encoderSettings": {"bitrate": 0,
"bitrateBufferMs": 0,
"deviceNumber": 0,
"encoderType": "MJPEG",
"getbFrames": 0,
"gopSize": 0,
"interlaced": true,
"interlacingOptions": {"topFieldFirst": true
},
"optionString": "string",
"quality": 0,
"sdiMode": "SDI1080P25",
"timestampOffsetMs": 0,
"x264Profile": "AUTOMATIC"
},
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"outputStreams": [{"disableOnEmergency": true,
"disableOnEmergencyDelayMs": 0,
"enabled": true,
"ignoreComplianceRecording": true,
"mediaConnectDestinations": [{"cidrAllowList": ["string"
],
"ip": "string",
"maxLatency": 0,
"name": "string",
"outputArn": "string",
"port": 0,
"protocol": "ZIXI_PUSH",
"publicIp": "string",
"remoteId": "string",
"smoothingLatency": 0,
"streamId": "string"
}
],
"mediaConnectFlowArn": "string",
"muxerSettings": {"muxerType": "MPEG_TS",
"pcrOffsetMs": 0,
"pmtPid": 0,
"programName": "string",
"programNumber": 0,
"totalBitrate": 0
},
"name": "string",
"streamSettings": {"anc2038": [{"name": "string",
"pid": 0
}
],
"audio": [{"enabled": true,
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"name": "string",
"trackId": 0
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"name": "string",
"pid": 0
}
],
"subtitlesArib": [{"name": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"name": "string",
"pid": 0
}
],
"subtitlesVTT": [{"name": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR"
}
],
"presetId": "string",
"streamSettings": {"anc2038": [{"pid": 0
}
],
"audio": [{"advancedAc3Settings": {"dialogueNormalization": "PASSTHROUGH",
"lineModeProfile": "PASSTHROUGH",
"loRoCenterMixLevel": "PASSTHROUGH",
"loRoSurroundMixLevel": "PASSTHROUGH",
"ltRtCenterMixLevel": "PASSTHROUGH",
"ltRtSurroundMixLevel": "PASSTHROUGH",
"rfModeProfile": "PASSTHROUGH",
"stereoDownmixMode": "PASSTHROUGH",
"surroundAttenuationFlag": "PASSTHROUGH",
"surroundPhaseShiftFlag": "PASSTHROUGH"
},
"audioEncoderSettings": {"bitrate": 0,
"channelConfiguration": "string",
"encoderType": "AAC",
"sampleRate": 0
},
"languageCode": "string",
"name": "string",
"pid": 0
}
],
"closedCaptionsCea608": [{"languageCode": "string",
"trackId": 0
}
],
"contentAdvisory": [{"format": "MPA"
}
],
"scte": {"enabled": true,
"pid": 0
},
"subtitles": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesArib": [{"languageCode": "string",
"pid": 0
}
],
"subtitlesAribB40": [{"pid": 0
}
],
"subtitlesBurn": [{"languageCode": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"pid": 0
}
],
"video": {"pid": 0
}
},
"subtitles": [{"languageCode": "string",
"name": "string",
"style": "string"
}
],
"subtitlesArib": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesAribB40": [{"languageCode": "string",
"name": "string"
}
],
"subtitlesBurn": [{"languageCode": "string",
"style": "string"
}
],
"subtitlesVTT": [{"languageCode": "string",
"name": "string"
}
],
"transportSettings": {"accessKey": "string",
"containerName": "string",
"encryptionKey": "string",
"errorCorrectionOverhead": 0,
"fecColumns": 0,
"fecRows": 0,
"hlsAbrGroup": "string",
"hlsAbrUrl": "string",
"hlsAudioStreams": true,
"hlsPushDestinationType": "WEBDAV",
"hlsPushPassword": "string",
"hlsPushUser": "string",
"hlsSegmentCount": 0,
"hlsSegmentDuration": 0.1,
"hlsSegmentTtl": 0,
"host": "string",
"host2": "string",
"insertScte35IntoMpegTs": true,
"mediaConnectOutputIp": "string",
"mediaconnectHost": "string",
"password": "string",
"port": 0,
"port2": 0,
"region": "string",
"scteAheadTimes": [0
],
"scteNullInterval": 0,
"scteNullPeriod": 0,
"scteTagFormat": "NONE",
"secretKey": "string",
"sourcePath": "string",
"srtLatency": 0,
"srtStreamId": "string",
"transportType": "UDP",
"username": "string"
},
"type": "REGULAR",
"videoCaps": {"colorSpace": "I420",
"deinterlace": true,
"framerate": 0,
"framerateDivider": 0,
"height": 0,
"maxGopSize": 0,
"screenAspectRatioH": 0,
"screenAspectRatioW": 0,
"width": 0
}
}
],
"password": "string",
"port": 0,
"presetId": "string",
"previewAlarmSettings": {"blackTime": 0,
"bottomWarningText": true,
"displayPreviewWarnings": true,
"enabled": true,
"freezeSensitivity": 0.1,
"freezeTime": 0,
"maxAudioDb": 0,
"maxAudioTime": 0,
"minAudioDb": 0,
"minAudioTime": 0
},
"previewSubtitleSettings": {"enabled": true,
"language": "string"
},
"previewV2Enabled": true,
"pushNotificationEnabled": true,
"rendererConfiguration": {"aspect-ratio": 0,
"audio": [{"language-code": "string",
"solo": true,
"track-index": 0,
"variant-index": 0
}
],
"board-index": 0,
"board-name": "string",
"frame-rate": 0.1,
"licenseId": 0,
"resolution-height": 0,
"resolution-width": 0,
"scan-type": 0,
"subtitles": [{"language-code": "string",
"track-index": 0,
"variant-index": 0
}
]
},
"scteListenerStrategy": "IGNORE",
"serviceProviderId": "string",
"statusConfiguration": {"cacheLimitError": 0.1,
"cacheLimitWarning": 0.1,
"cpuLoadError": 0.1,
"cpuLoadWarning": 0.1,
"diskSpaceError": 0.1,
"diskSpaceWarning": 0.1,
"timeTillFirstGapError": 0,
"timeTillFirstGapWarning": 0
},
"timeBarSettings": {"label": "string",
"latency": 0
},
"type": "SD",
"uploadBandwidthLimit": 1,
"username": "string",
"version": 0,
"zixiEnabled": true
}
]

Get playout

Returns playout found by Id

path Parameters

organization required	string
playoutId required	string Playout id

query Parameters

apiVersion

integer <int32>

Default: 1

Responses

Response samples

Content type

application/json

{ }

Get organization resource limits

Returns organization resource limits

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

{"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestQueueItemLimit": 0,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
}

Update organization resource limits

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

accountNumber	integer <int32>
	object (ChannelLimitations)
dolbyFeaturesEnabled	boolean
enableLiveRecording	boolean
expirationDate	string <date-time>
graphicEditorModuleEnabled	boolean
ingestQueueItemLimit	integer <int64>
ingestSize	integer <int64>
ingestSources	integer <int32>
legacyIngestSourcesEnabled	boolean
liveEnabled	boolean
maxCloudPlayouts	integer <int32>
maxConcurrentIngests	integer <int32>
maxWarmBackupUptimeHours	integer <int32>
mediaStoreSize	integer <int64>
planningModuleEnabled	boolean
twitchIntegrationEnabled	boolean
unlimitedWebrtcSessions	boolean
windowsFeaturesEnabled	boolean

Responses

Request samples

Payload

Content type

application/json

{"accountNumber": 0,
"channelLimitations": {"backupRequirement": {"property1": 0,
"property2": 0
},
"maxChannelPlayouts": 0,
"maxOrganizationChannels": 0,
"minOrganizationChannels": 0
},
"dolbyFeaturesEnabled": true,
"enableLiveRecording": true,
"expirationDate": "2019-08-24T14:15:22Z",
"graphicEditorModuleEnabled": true,
"ingestQueueItemLimit": 0,
"ingestSize": 0,
"ingestSources": 0,
"legacyIngestSourcesEnabled": true,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 0,
"maxWarmBackupUptimeHours": 0,
"mediaStoreSize": 0,
"planningModuleEnabled": true,
"twitchIntegrationEnabled": true,
"unlimitedWebrtcSessions": true,
"windowsFeaturesEnabled": true
}

Response samples

Content type

application/json

{ }

Apply resource limit pack to organization

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

string

Id of resource limit pack to apply

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

Content type

application/json

{"accountNumber": 0,
"daysToExpiration": 0,
"id": "string",
"ingestSize": 0,
"ingestSources": 0,
"liveEnabled": true,
"maxCloudPlayouts": 0,
"maxConcurrentIngests": 1,
"mediaStoreSize": 0,
"name": "string",
"windowsFeaturesEnabled": true
}

Get organization secondary event templates

Returns secondary event templates related configuration for organization

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

[{"audioTransition": {"attenuation": 0,
"fadeInAttack": 0,
"fadeInOffset": 0,
"fadeOutAttack": 0,
"fadeOutOffset": 0
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"id": "string",
"name": "string",
"organizationId": "string",
"overrideAudioTransition": true,
"overrideScte35Signals": true,
"overrideSecondaryEvents": true,
"overrideTwitchRPCList": true,
"scte35Signals": [{"archiveAllowedFlag": true,
"autoReturn": true,
"availNum": 0,
"availsExpected": 0,
"command": "ON",
"deviceGroupRestriction": 0,
"duration": 0,
"hasSegment": true,
"noRegionalBlackoutFlag": true,
"offset": 0,
"origin": "FROM_START",
"programId": 0,
"scteEventType": "SPLICE",
"segmentNum": 0,
"segmentationEventId": 0,
"segmentationTypeId": 0,
"segmentationUpid": "string",
"segmentationUpidType": 0,
"segmentsExpected": 0,
"spliceEventId": 0,
"webDeliveryAllowedFlag": true
}
],
"secondaryEvents": [{"command": "ON",
"objectName": "string",
"offset": 0,
"origin": "FROM_START",
"parameters": {"property1": "string",
"property2": "string"
},
"substitution": {"property1": "string",
"property2": "string"
}
}
],
"serviceProviderId": "string",
"twitchRPCList": [{"broadcasterLanguage": "string",
"duration": 0,
"gameId": "string",
"offset": 0,
"origin": "FROM_START",
"procedure": "START_COMMERCIAL",
"title": "string"
}
]
}
]

Create organization secondary event template

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

	object (AudioTransitionDTO)
dateCreated	string <date-time>
dateUpdated	string <date-time>
fps	number <float>
graphicsProject	string
graphicsProjectV2	string
id	string
name required	string
organizationId	string
overrideAudioTransition	boolean
overrideScte35Signals	boolean
overrideSecondaryEvents	boolean
overrideTwitchRPCList	boolean
	Array of objects (SCTE35SignalDTO)
	Array of objects (SecondaryEventDTO)
serviceProviderId	string
	Array of objects (TwitchRPCDTO)

Responses

Request samples

Payload

Content type

application/json

{"audioTransition": {"attenuation": 0,
"fadeInAttack": 0,
"fadeInOffset": 0,
"fadeOutAttack": 0,
"fadeOutOffset": 0
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"id": "string",
"name": "string",
"organizationId": "string",
"overrideAudioTransition": true,
"overrideScte35Signals": true,
"overrideSecondaryEvents": true,
"overrideTwitchRPCList": true,
"scte35Signals": [{"archiveAllowedFlag": true,
"autoReturn": true,
"availNum": 0,
"availsExpected": 0,
"command": "ON",
"deviceGroupRestriction": 0,
"duration": 0,
"hasSegment": true,
"noRegionalBlackoutFlag": true,
"offset": 0,
"origin": "FROM_START",
"programId": 0,
"scteEventType": "SPLICE",
"segmentNum": 0,
"segmentationEventId": 0,
"segmentationTypeId": 0,
"segmentationUpid": "string",
"segmentationUpidType": 0,
"segmentsExpected": 0,
"spliceEventId": 0,
"webDeliveryAllowedFlag": true
}
],
"secondaryEvents": [{"command": "ON",
"objectName": "string",
"offset": 0,
"origin": "FROM_START",
"parameters": {"property1": "string",
"property2": "string"
},
"substitution": {"property1": "string",
"property2": "string"
}
}
],
"serviceProviderId": "string",
"twitchRPCList": [{"broadcasterLanguage": "string",
"duration": 0,
"gameId": "string",
"offset": 0,
"origin": "FROM_START",
"procedure": "START_COMMERCIAL",
"title": "string"
}
]
}

Response samples

Content type

application/json

{"audioTransition": {"attenuation": 0,
"fadeInAttack": 0,
"fadeInOffset": 0,
"fadeOutAttack": 0,
"fadeOutOffset": 0
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"id": "string",
"name": "string",
"organizationId": "string",
"overrideAudioTransition": true,
"overrideScte35Signals": true,
"overrideSecondaryEvents": true,
"overrideTwitchRPCList": true,
"scte35Signals": [{"archiveAllowedFlag": true,
"autoReturn": true,
"availNum": 0,
"availsExpected": 0,
"command": "ON",
"deviceGroupRestriction": 0,
"duration": 0,
"hasSegment": true,
"noRegionalBlackoutFlag": true,
"offset": 0,
"origin": "FROM_START",
"programId": 0,
"scteEventType": "SPLICE",
"segmentNum": 0,
"segmentationEventId": 0,
"segmentationTypeId": 0,
"segmentationUpid": "string",
"segmentationUpidType": 0,
"segmentsExpected": 0,
"spliceEventId": 0,
"webDeliveryAllowedFlag": true
}
],
"secondaryEvents": [{"command": "ON",
"objectName": "string",
"offset": 0,
"origin": "FROM_START",
"parameters": {"property1": "string",
"property2": "string"
},
"substitution": {"property1": "string",
"property2": "string"
}
}
],
"serviceProviderId": "string",
"twitchRPCList": [{"broadcasterLanguage": "string",
"duration": 0,
"gameId": "string",
"offset": 0,
"origin": "FROM_START",
"procedure": "START_COMMERCIAL",
"title": "string"
}
]
}

Delete organization secondary event template

path Parameters

organization required	string Organization id
templateId required	string Template id

Responses

Response samples

Content type

application/json

{ }

Get organization secondary event template

Returns secondary event template related configuration for organization

path Parameters

organization required	string Organization id
templateId required	string Template id

Responses

Response samples

Content type

application/json

{"audioTransition": {"attenuation": 0,
"fadeInAttack": 0,
"fadeInOffset": 0,
"fadeOutAttack": 0,
"fadeOutOffset": 0
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"id": "string",
"name": "string",
"organizationId": "string",
"overrideAudioTransition": true,
"overrideScte35Signals": true,
"overrideSecondaryEvents": true,
"overrideTwitchRPCList": true,
"scte35Signals": [{"archiveAllowedFlag": true,
"autoReturn": true,
"availNum": 0,
"availsExpected": 0,
"command": "ON",
"deviceGroupRestriction": 0,
"duration": 0,
"hasSegment": true,
"noRegionalBlackoutFlag": true,
"offset": 0,
"origin": "FROM_START",
"programId": 0,
"scteEventType": "SPLICE",
"segmentNum": 0,
"segmentationEventId": 0,
"segmentationTypeId": 0,
"segmentationUpid": "string",
"segmentationUpidType": 0,
"segmentsExpected": 0,
"spliceEventId": 0,
"webDeliveryAllowedFlag": true
}
],
"secondaryEvents": [{"command": "ON",
"objectName": "string",
"offset": 0,
"origin": "FROM_START",
"parameters": {"property1": "string",
"property2": "string"
},
"substitution": {"property1": "string",
"property2": "string"
}
}
],
"serviceProviderId": "string",
"twitchRPCList": [{"broadcasterLanguage": "string",
"duration": 0,
"gameId": "string",
"offset": 0,
"origin": "FROM_START",
"procedure": "START_COMMERCIAL",
"title": "string"
}
]
}

Update organization secondary event template

path Parameters

organization required	string Organization id
templateId required	string Template id

Request Body schema: application/json
required

	object (AudioTransitionDTO)
dateCreated	string <date-time>
dateUpdated	string <date-time>
fps	number <float>
graphicsProject	string
graphicsProjectV2	string
id	string
name required	string
organizationId	string
overrideAudioTransition	boolean
overrideScte35Signals	boolean
overrideSecondaryEvents	boolean
overrideTwitchRPCList	boolean
	Array of objects (SCTE35SignalDTO)
	Array of objects (SecondaryEventDTO)
serviceProviderId	string
	Array of objects (TwitchRPCDTO)

Responses

Request samples

Payload

Content type

application/json

{"audioTransition": {"attenuation": 0,
"fadeInAttack": 0,
"fadeInOffset": 0,
"fadeOutAttack": 0,
"fadeOutOffset": 0
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"id": "string",
"name": "string",
"organizationId": "string",
"overrideAudioTransition": true,
"overrideScte35Signals": true,
"overrideSecondaryEvents": true,
"overrideTwitchRPCList": true,
"scte35Signals": [{"archiveAllowedFlag": true,
"autoReturn": true,
"availNum": 0,
"availsExpected": 0,
"command": "ON",
"deviceGroupRestriction": 0,
"duration": 0,
"hasSegment": true,
"noRegionalBlackoutFlag": true,
"offset": 0,
"origin": "FROM_START",
"programId": 0,
"scteEventType": "SPLICE",
"segmentNum": 0,
"segmentationEventId": 0,
"segmentationTypeId": 0,
"segmentationUpid": "string",
"segmentationUpidType": 0,
"segmentsExpected": 0,
"spliceEventId": 0,
"webDeliveryAllowedFlag": true
}
],
"secondaryEvents": [{"command": "ON",
"objectName": "string",
"offset": 0,
"origin": "FROM_START",
"parameters": {"property1": "string",
"property2": "string"
},
"substitution": {"property1": "string",
"property2": "string"
}
}
],
"serviceProviderId": "string",
"twitchRPCList": [{"broadcasterLanguage": "string",
"duration": 0,
"gameId": "string",
"offset": 0,
"origin": "FROM_START",
"procedure": "START_COMMERCIAL",
"title": "string"
}
]
}

Response samples

Content type

application/json

{"audioTransition": {"attenuation": 0,
"fadeInAttack": 0,
"fadeInOffset": 0,
"fadeOutAttack": 0,
"fadeOutOffset": 0
},
"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"fps": 0.1,
"graphicsProject": "string",
"graphicsProjectV2": "string",
"id": "string",
"name": "string",
"organizationId": "string",
"overrideAudioTransition": true,
"overrideScte35Signals": true,
"overrideSecondaryEvents": true,
"overrideTwitchRPCList": true,
"scte35Signals": [{"archiveAllowedFlag": true,
"autoReturn": true,
"availNum": 0,
"availsExpected": 0,
"command": "ON",
"deviceGroupRestriction": 0,
"duration": 0,
"hasSegment": true,
"noRegionalBlackoutFlag": true,
"offset": 0,
"origin": "FROM_START",
"programId": 0,
"scteEventType": "SPLICE",
"segmentNum": 0,
"segmentationEventId": 0,
"segmentationTypeId": 0,
"segmentationUpid": "string",
"segmentationUpidType": 0,
"segmentsExpected": 0,
"spliceEventId": 0,
"webDeliveryAllowedFlag": true
}
],
"secondaryEvents": [{"command": "ON",
"objectName": "string",
"offset": 0,
"origin": "FROM_START",
"parameters": {"property1": "string",
"property2": "string"
},
"substitution": {"property1": "string",
"property2": "string"
}
}
],
"serviceProviderId": "string",
"twitchRPCList": [{"broadcasterLanguage": "string",
"duration": 0,
"gameId": "string",
"offset": 0,
"origin": "FROM_START",
"procedure": "START_COMMERCIAL",
"title": "string"
}
]
}

Get organization settings

Returns organization settings

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

{"eventAudioFadingConfiguration": {"attenuation": 0,
"fadeInAttack": 0,
"fadeInOffset": 0,
"fadeOutAttack": 0,
"fadeOutOffset": 0
},
"fps": 0.1,
"libraryCleanupConfiguration": {"daysNotModified": 0,
"daysNotScheduled": 0,
"libraryCleanupEnabled": true,
"type": "REMOVE"
},
"schedulingTimelineLockDays": 0,
"thresholdsConfiguration": {"assetThresholds": {"audioVideoError": 0,
"audioVideoWarning": 0
},
"eventThresholds": {"deviation": 0,
"gapOverlap": 0,
"programmeSteps": 0
}
},
"timeZone": "string",
"timeZones": [{"hidden": true,
"key": "string",
"readable": "string",
"timeZone": "string"
}
]
}

Update organization settings

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

	object (EventAudioFadingConfiguration)
fps	number <float>
	object (LibraryCleanupConfigurationDTO) New settings
schedulingTimelineLockDays	integer <int32>
	object (ThresholdsConfigurationDTO) New thresholds
timeZone	string
	Array of objects (TimeZoneDTO)

Responses

Request samples

Payload

Content type

application/json

{"eventAudioFadingConfiguration": {"attenuation": 0,
"fadeInAttack": 0,
"fadeInOffset": 0,
"fadeOutAttack": 0,
"fadeOutOffset": 0
},
"fps": 0.1,
"libraryCleanupConfiguration": {"daysNotModified": 0,
"daysNotScheduled": 0,
"libraryCleanupEnabled": true,
"type": "REMOVE"
},
"schedulingTimelineLockDays": 0,
"thresholdsConfiguration": {"assetThresholds": {"audioVideoError": 0,
"audioVideoWarning": 0
},
"eventThresholds": {"deviation": 0,
"gapOverlap": 0,
"programmeSteps": 0
}
},
"timeZone": "string",
"timeZones": [{"hidden": true,
"key": "string",
"readable": "string",
"timeZone": "string"
}
]
}

Response samples

Content type

application/json

{"eventAudioFadingConfiguration": {"attenuation": 0,
"fadeInAttack": 0,
"fadeInOffset": 0,
"fadeOutAttack": 0,
"fadeOutOffset": 0
},
"fps": 0.1,
"libraryCleanupConfiguration": {"daysNotModified": 0,
"daysNotScheduled": 0,
"libraryCleanupEnabled": true,
"type": "REMOVE"
},
"schedulingTimelineLockDays": 0,
"thresholdsConfiguration": {"assetThresholds": {"audioVideoError": 0,
"audioVideoWarning": 0
},
"eventThresholds": {"deviation": 0,
"gapOverlap": 0,
"programmeSteps": 0
}
},
"timeZone": "string",
"timeZones": [{"hidden": true,
"key": "string",
"readable": "string",
"timeZone": "string"
}
]
}

Get organization library cleanup configuration

Returns organization library cleanup configuration

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

{"daysNotModified": 0,
"daysNotScheduled": 0,
"libraryCleanupEnabled": true,
"type": "REMOVE"
}

Update organization library cleanup configuration

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

daysNotModified	integer <int32>
daysNotScheduled	integer <int32>
libraryCleanupEnabled	boolean
type	string Enum: "REMOVE" "ARCHIVE"

Responses

Request samples

Payload

Content type

application/json

{"daysNotModified": 0,
"daysNotScheduled": 0,
"libraryCleanupEnabled": true,
"type": "REMOVE"
}

Response samples

Content type

application/json

{"daysNotModified": 0,
"daysNotScheduled": 0,
"libraryCleanupEnabled": true,
"type": "REMOVE"
}

Update organization scheduling timeline lock period

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

integer <int32>

Responses

Request samples

Payload

Content type

application/json

0

Response samples

Content type

application/json

0

Get organization thresholds

Returns organization thresholds

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

{"assetThresholds": {"audioVideoError": 0,
"audioVideoWarning": 0
},
"eventThresholds": {"deviation": 0,
"gapOverlap": 0,
"programmeSteps": 0
}
}

Update organization thresholds

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

	object (AssetThresholdsDTO)
	object (EventThresholdsDTO)

Responses

Request samples

Payload

Content type

application/json

{"assetThresholds": {"audioVideoError": 0,
"audioVideoWarning": 0
},
"eventThresholds": {"deviation": 0,
"gapOverlap": 0,
"programmeSteps": 0
}
}

Response samples

Content type

application/json

{"assetThresholds": {"audioVideoError": 0,
"audioVideoWarning": 0
},
"eventThresholds": {"deviation": 0,
"gapOverlap": 0,
"programmeSteps": 0
}
}

Delete organization tag

path Parameters

organization

required

string

Organization id

query Parameters

name

required

string

Responses

Response samples

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Get organization tags

Returns tags used by organization

path Parameters

organization

required

string

Organization id

Responses

Response samples

Content type

application/json

[{"name": "string",
"serviceProviderId": "string"
}
]

Create organization tags

Returns tags used by organization

path Parameters

organization

required

string

Organization id

Request Body schema: application/json
required

Array

name	string
serviceProviderId	string

Responses

Request samples

Payload

Content type

application/json

[{"name": "string",
"serviceProviderId": "string"
}
]

Response samples

Content type

application/json

[{"name": "string",
"serviceProviderId": "string"
}
]

Edit organization tag

path Parameters

organization

required

string

Organization id

query Parameters

name

required

string

Request Body schema: application/json
required

name	string
serviceProviderId	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"serviceProviderId": "string"
}

Response samples

Content type

application/json

{"code": 0,
"messages": ["string"
]
}

Graphs

Graphs API

Get graph templates

Returns graph templates that are available for organization

query Parameters

organization	Array of strings Organization Id
providerId	string
include	Array of strings
name	string Search by graph template name

Responses

Response samples

Content type

application/json

[{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"organizationId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}
]

Create a new graph template

Creates a new graph template

query Parameters

organization	Array of strings Organization Id
providerId	string

Request Body schema: application/json
required

dateCreated	string <date-time>
dateUpdated	string <date-time>
	Array of objects (Edge)
id	string
	object
name	string
	Array of objects (Node)
organizationId	string
rootId	string
serviceProviderId	string
type	string Enum: "SOFTLAB" "DIRECTSHOW" "GSTREAMER"
version	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"organizationId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"organizationId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}

Download exported graph template file

Returns graph template in json format

path Parameters

fileName

required

string

File name

Responses

Response samples

Content type

application/json

{ }

Import graph template from xml

Creates a new graph template

query Parameters

organization	Array of strings Organization Id
providerId	string

Request Body schema: application/json

file

required

string <binary>

Responses

Request samples

Payload

Content type

application/json

{"file": "string"
}

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"organizationId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}

Delete graph template

Deletes graph template with given ID

path Parameters

graphId

required

string

Graph template Id

query Parameters

organization	Array of strings Organization Id
providerId	string

Responses

Response samples

Content type

application/json

{ }

Get graph template

Returns graph template with given ID

path Parameters

graphId

required

string

Graph Template Id

query Parameters

organization	Array of strings Organization Id
providerId	string

Responses

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"organizationId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}

Update graph template

Update the graph template with given ID

path Parameters

graphId

required

string

Graph template Id

query Parameters

organization	Array of strings Organization Id
providerId	string Service provider Id

Request Body schema: application/json
required

dateCreated	string <date-time>
dateUpdated	string <date-time>
	Array of objects (Edge)
id	string
	object
name	string
	Array of objects (Node)
organizationId	string
rootId	string
serviceProviderId	string
type	string Enum: "SOFTLAB" "DIRECTSHOW" "GSTREAMER"
version	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"organizationId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"edges": [{"directed": true,
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"relation": "string",
"source": "string",
"target": "string"
}
],
"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"nodes": [{"id": "string",
"metadata": {"property1": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
},
"property2": {"copyable": true,
"description": "string",
"displayName": "string",
"evaluateToType": "INTEGER",
"name": "string",
"nullable": true,
"propertyClass": "string",
"rawType": "string",
"readOnly": true,
"type": "INTEGER",
"value": { },
"values": [{"caption": "string",
"value": "string"
}
],
"visible": true
}
},
"name": "string",
"type": "string"
}
],
"organizationId": "string",
"rootId": "string",
"serviceProviderId": "string",
"type": "SOFTLAB",
"version": 0
}

Export graph template

Exports graph template with given ID

path Parameters

graphId

required

string

Graph template Id

query Parameters

organization	Array of strings Organization Id
providerId	string Service provider Id

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": [{"message": "string",
"type": "OK"
}
],
"organization": "string",
"resourceExtension": "string",
"resourceLink": "string",
"serviceProviderId": "string",
"status": "PENDING",
"uniqueId": "string",
"userId": "string"
}

internal

crypto

Ingest cluster resource

Cloud Instance resource

License resource

Resource limit pack resource

Preset resource

Find all presets

Find presets

Responses

Response samples

Content type

application/json

[{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"inputCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"inputs": [{"decoder": {"allowedValues": ["AUTO"
],
"defaultValue": "AUTO",
"editable": true,
"maxValue": "AUTO",
"minValue": "AUTO",
"nullable": true,
"regex": "string"
},
"defaultInput": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"emergencyLive": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"enabled": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"id": "string",
"name": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"port": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"primarySCTESource": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"required": true,
"streamSettings": {"audio": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"audioCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"closedCaptionsCea608": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"trackId": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"closedCaptionsCea608Count": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"scte": {"enabled": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"subtitle": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"subtitleCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"subtitleVTT": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"subtitleVTTCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"video": {"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
}
},
"streamingProtocol": {"allowedValues": ["UDP"
],
"defaultValue": "UDP",
"editable": true,
"maxValue": "UDP",
"minValue": "UDP",
"nullable": true,
"regex": "string"
},
"type": {"allowedValues": ["REGULAR"
],
"defaultValue": "REGULAR",
"editable": true,
"maxValue": "REGULAR",
"minValue": "REGULAR",
"nullable": true,
"regex": "string"
},
"unique": true,
"url": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
}
}
],
"instancePreset": {"diskSize": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"instanceType": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
}
},
"name": "string",
"organizationId": "string",
"outputCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"outputs": [{"audioEncoderSettings": {"bitrate": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"encoderType": {"allowedValues": ["AAC"
],
"defaultValue": "AAC",
"editable": true,
"maxValue": "AAC",
"minValue": "AAC",
"nullable": true,
"regex": "string"
},
"sampleRate": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"enabled": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"encoderSettings": {"bitrate": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"getbFrames": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"gopSize": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"interlaced": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"interlacingOptions": {"topFieldFirst": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
}
},
"quality": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"timestampOffsetMs": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"type": {"allowedValues": ["MJPEG"
],
"defaultValue": "MJPEG",
"editable": true,
"maxValue": "MJPEG",
"minValue": "MJPEG",
"nullable": true,
"regex": "string"
},
"x264Profile": {"allowedValues": ["AUTOMATIC"
],
"defaultValue": "AUTOMATIC",
"editable": true,
"maxValue": "AUTOMATIC",
"minValue": "AUTOMATIC",
"nullable": true,
"regex": "string"
}
},
"id": "string",
"muxerSettings": {"pmtPid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"programName": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"programNumber": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"totalBitrate": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"name": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"required": true,
"streamSettings": {"audio": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"audioCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"closedCaptionsCea608": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"trackId": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"closedCaptionsCea608Count": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"scte": {"enabled": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"subtitle": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"subtitleCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"subtitleVTT": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"subtitleVTTCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"video": {"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
}
},
"transportSettings": {"errorCorrectionOverhead": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"fecColumns": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"fecRows": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"hlsSegmentDuration": {"allowedValues": [0.1
],
"defaultValue": 0.1,
"editable": true,
"maxValue": 0.1,
"minValue": 0.1,
"nullable": true,
"regex": "string"
},
"host": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"password": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"port": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"scteAheadTimes": {"allowedValues": [[0
]
],
"defaultValue": [0
],
"editable": true,
"maxValue": [0
],
"minValue": [0
],
"nullable": true,
"regex": "string"
},
"scteTagFormat": {"allowedValues": ["NONE"
],
"defaultValue": "NONE",
"editable": true,
"maxValue": "NONE",
"minValue": "NONE",
"nullable": true,
"regex": "string"
},
"transportType": {"allowedValues": ["UDP"
],
"defaultValue": "UDP",
"editable": true,
"maxValue": "UDP",
"minValue": "UDP",
"nullable": true,
"regex": "string"
},
"username": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
}
},
"type": {"allowedValues": ["REGULAR"
],
"defaultValue": "REGULAR",
"editable": true,
"maxValue": "REGULAR",
"minValue": "REGULAR",
"nullable": true,
"regex": "string"
},
"unique": true,
"videoCaps": {"colorSpace": {"allowedValues": ["I420"
],
"defaultValue": "I420",
"editable": true,
"maxValue": "I420",
"minValue": "I420",
"nullable": true,
"regex": "string"
},
"deinterlace": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"framerate": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"framerateDivider": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"height": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"screenAspectRatioH": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"screenAspectRatioW": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"width": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
}
}
],
"scteListenerStrategy": {"allowedValues": ["IGNORE"
],
"defaultValue": "IGNORE",
"editable": true,
"maxValue": "IGNORE",
"minValue": "IGNORE",
"nullable": true,
"regex": "string"
},
"serviceProviderId": "string",
"zixiEnabled": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
}
}
]

Find preset by id

Find preset

path Parameters

required

string

Preset id

Responses

Response samples

Content type

application/json

{"dateCreated": "2019-08-24T14:15:22Z",
"dateUpdated": "2019-08-24T14:15:22Z",
"id": "string",
"inputCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"inputs": [{"decoder": {"allowedValues": ["AUTO"
],
"defaultValue": "AUTO",
"editable": true,
"maxValue": "AUTO",
"minValue": "AUTO",
"nullable": true,
"regex": "string"
},
"defaultInput": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"emergencyLive": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"enabled": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"id": "string",
"name": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"port": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"primarySCTESource": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"required": true,
"streamSettings": {"audio": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"audioCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"closedCaptionsCea608": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"trackId": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"closedCaptionsCea608Count": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"scte": {"enabled": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"subtitle": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"subtitleCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"subtitleVTT": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"subtitleVTTCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"video": {"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
}
},
"streamingProtocol": {"allowedValues": ["UDP"
],
"defaultValue": "UDP",
"editable": true,
"maxValue": "UDP",
"minValue": "UDP",
"nullable": true,
"regex": "string"
},
"type": {"allowedValues": ["REGULAR"
],
"defaultValue": "REGULAR",
"editable": true,
"maxValue": "REGULAR",
"minValue": "REGULAR",
"nullable": true,
"regex": "string"
},
"unique": true,
"url": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
}
}
],
"instancePreset": {"diskSize": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"instanceType": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
}
},
"name": "string",
"organizationId": "string",
"outputCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"outputs": [{"audioEncoderSettings": {"bitrate": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"encoderType": {"allowedValues": ["AAC"
],
"defaultValue": "AAC",
"editable": true,
"maxValue": "AAC",
"minValue": "AAC",
"nullable": true,
"regex": "string"
},
"sampleRate": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"enabled": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"encoderSettings": {"bitrate": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"getbFrames": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"gopSize": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"interlaced": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"interlacingOptions": {"topFieldFirst": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
}
},
"quality": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"timestampOffsetMs": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"type": {"allowedValues": ["MJPEG"
],
"defaultValue": "MJPEG",
"editable": true,
"maxValue": "MJPEG",
"minValue": "MJPEG",
"nullable": true,
"regex": "string"
},
"x264Profile": {"allowedValues": ["AUTOMATIC"
],
"defaultValue": "AUTOMATIC",
"editable": true,
"maxValue": "AUTOMATIC",
"minValue": "AUTOMATIC",
"nullable": true,
"regex": "string"
}
},
"id": "string",
"muxerSettings": {"pmtPid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"programName": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"programNumber": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"totalBitrate": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"name": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"required": true,
"streamSettings": {"audio": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"audioCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"closedCaptionsCea608": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"trackId": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"closedCaptionsCea608Count": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"scte": {"enabled": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"subtitle": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"subtitleCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"subtitleVTT": {"languageCode": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
},
"subtitleVTTCount": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"video": {"pid": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
}
},
"transportSettings": {"errorCorrectionOverhead": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"fecColumns": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"fecRows": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"hlsSegmentDuration": {"allowedValues": [0.1
],
"defaultValue": 0.1,
"editable": true,
"maxValue": 0.1,
"minValue": 0.1,
"nullable": true,
"regex": "string"
},
"host": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"password": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
},
"port": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"scteAheadTimes": {"allowedValues": [[0
]
],
"defaultValue": [0
],
"editable": true,
"maxValue": [0
],
"minValue": [0
],
"nullable": true,
"regex": "string"
},
"scteTagFormat": {"allowedValues": ["NONE"
],
"defaultValue": "NONE",
"editable": true,
"maxValue": "NONE",
"minValue": "NONE",
"nullable": true,
"regex": "string"
},
"transportType": {"allowedValues": ["UDP"
],
"defaultValue": "UDP",
"editable": true,
"maxValue": "UDP",
"minValue": "UDP",
"nullable": true,
"regex": "string"
},
"username": {"allowedValues": ["string"
],
"defaultValue": "string",
"editable": true,
"maxValue": "string",
"minValue": "string",
"nullable": true,
"regex": "string"
}
},
"type": {"allowedValues": ["REGULAR"
],
"defaultValue": "REGULAR",
"editable": true,
"maxValue": "REGULAR",
"minValue": "REGULAR",
"nullable": true,
"regex": "string"
},
"unique": true,
"videoCaps": {"colorSpace": {"allowedValues": ["I420"
],
"defaultValue": "I420",
"editable": true,
"maxValue": "I420",
"minValue": "I420",
"nullable": true,
"regex": "string"
},
"deinterlace": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
},
"framerate": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"framerateDivider": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"height": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"screenAspectRatioH": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"screenAspectRatioW": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
},
"width": {"allowedValues": [0
],
"defaultValue": 0,
"editable": true,
"maxValue": 0,
"minValue": 0,
"nullable": true,
"regex": "string"
}
}
}
],
"scteListenerStrategy": {"allowedValues": ["IGNORE"
],
"defaultValue": "IGNORE",
"editable": true,
"maxValue": "IGNORE",
"minValue": "IGNORE",
"nullable": true,
"regex": "string"
},
"serviceProviderId": "string",
"zixiEnabled": {"allowedValues": [true
],
"defaultValue": true,
"editable": true,
"maxValue": true,
"minValue": true,
"nullable": true,
"regex": "string"
}
}

Configuration

Services

Service provider resource

Get service provider audit connector configurations

path Parameters

Responses

Response samples

Create service provider audit connector configuration

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete service provider audit connector configuration

path Parameters

Responses

Response samples

Get service provider audit connector configurations

path Parameters

Responses

Response samples

Update service provider audit connector configuration

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

HLS Steering resource

Creates HLS steering configuration

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Deletes HLS steering configuration

path Parameters

query Parameters

Responses

Response samples

Gets HLS steering configuration

path Parameters

query Parameters

Responses

Response samples

Updates HLS steering configuration

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Gets HLS steering configurations

query Parameters

Responses

Response samples

Gets HLS master manifest from HLS Steering configuration by token, authentication not required

path Parameters

Responses

Response samples

User resource

Get user configuration

Responses

Response samples

Update user configuration

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get server time

Responses

Response samples

Get user configuration

path Parameters

query Parameters

Responses

Response samples

Transformation script resource

Get transformation scripts

query Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required