Put Channel – Channels API – MediaKind
Put Channel
put /ui/connectors/channels-api/latest/channels/:channel_id/
Create or replace a channel. Configuration runs in background.
Path parameters
channel_idstringRequired
Request
This endpoint expects an object.
kindstringOptionalDefaults to BeamChannel
metadataobject ChannelMetadata Required
Show 2 propertiesHide 2 properties
namestringRequired
displayNamestringRequired
specobject ChannelSpec Required
Show 5 propertiesHide 5 properties
typeenum ChannelType Required
Allowed values:EncodingContributionEncodingDistributionReceptionDecodingReceptionGatewayEncodingStreaming
stateenum DesiredState OptionalDefaults to Stopped
Allowed values:RunningStopped
inputslist of objectsOptionalDefaults to []
Show 8 variantsHide 8 variants
Discriminated by type. Select one variant:
SRTCallerobject SrtCallerInput
typestringOptionalDefaults to SRTCaller
namestringRequired
transportobject SrtCallerTransport Required
Show 5 propertiesHide 5 properties
urlstringRequiredpattern: ^srt://
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenum SrtEncryptionStandard OptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenum DelayMode OptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenum DecryptType OptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum
Variant 1: enum
nullnull
Variant 2: null
bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
SRTListenerobject SrtListenerInput
typestringOptionalDefaults to SRTListener
namestringRequired
transportobject SrtListenerTransport Required
Show 6 propertiesHide 6 properties
interfacestringRequired
portintegerRequired256 to 65535
Port number
maxConnectionsintegerOptional>=1Defaults to 10
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenum SrtEncryptionStandard OptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenum DelayMode OptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenum DecryptType OptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum
Variant 1: enum
nullnull
Variant 2: null
bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
UDPobject UdpInput
typestringOptionalDefaults to UDP
namestringRequired
transportobject UdpTransport Required
Show 3 propertiesHide 3 properties
urlstringRequired
interfacestringRequired
unicastbooleanOptionalDefaults to false
payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenum DelayMode OptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenum DecryptType OptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum
Variant 1: enum
nullnull
Variant 2: null
bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
ASIobject AsiInput
typestringOptionalDefaults to ASI
namestringRequired
transportobject AsiInputTransport Required
Show 2 propertiesHide 2 properties
urlstringRequiredpattern: ^asi://
tsPacketSizeobjectOptional
Show 2 variantsHide 2 variants
TsPacketSizeenum
Variant 1: enum
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenum DelayMode OptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenum DecryptType OptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum
Variant 1: enum
nullnull
Variant 2: null
bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
SatDemodobject SatDemodInput
typestringOptionalDefaults to SatDemod
namestringRequired
transportobject SatDemodTransport Required
Show 10 propertiesHide 10 properties
urlstringRequiredpattern: ^rfdemod://
lnbFrequencyMHzintegerRequired
lnbVoltageenum LnbVoltage OptionalDefaults to Off
Allowed values:UnsyncedOff13V18V
lnbToneEnabledbooleanOptionalDefaults to false
tunerFrequencyHzintegerRequired
tunerSymbolRateintegerRequired
tunerSearchRangeHzintegerOptionalDefaults to 2000000
tunerMISEnabledbooleanOptionalDefaults to false
tunerGoldCodeintegerOptionalDefaults to 0
tunerMISStreamIdobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenum DelayMode OptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenum DecryptType OptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum
Variant 1: enum
nullnull
Variant 2: null
bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
Smpte2110object Smpte2110Input
typestringOptionalDefaults to Smpte2110
namestringRequired
transportobject Smpte2110InputTransport Required
Show 2 propertiesHide 2 properties
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nmosEnabledbooleanOptionalDefaults to false
payloadobjectOptional
Show 2 variantsHide 2 variants
Smpte2110Payloadobject
videoobjectOptional
Show 2 variantsHide 2 variants
Smpte2110VideoInputEssenceobject
typestringOptionalDefaults to video
transportFileobjectOptional
Show 2 variantsHide 2 variants
TransportFileobject
SDP transport file for an ST 2110 stream.
datastringRequired
Raw file contents; expects SDP format by default.
nullnull
Variant 2: null
sdpUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
streamIndexintegerOptional>=0Defaults to 0
nullnull
Variant 2: null
audioslist of objects Smpte2110AudioInputEssence OptionalDefaults to []
Show 6 propertiesHide 6 properties
typestringOptionalDefaults to audio
transportFileobjectOptional
Show 2 variantsHide 2 variants
TransportFileobject
SDP transport file for an ST 2110 stream.
datastringRequired
Raw file contents; expects SDP format by default.
nullnull
Variant 2: null
sdpUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
streamIndexintegerOptional>=0Defaults to 0
channelGroupIndexintegerOptional>=0Defaults to 0
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
SDIobject SdiInput
typestringOptionalDefaults to SDI
namestringRequired
transportobject SdiInputTransport Required
Show 1 propertyHide 1 property
urlstringRequiredpattern: ^sdi://
payloadobjectOptional
Show 2 variantsHide 2 variants
SdiPayloadobject
audioslist of objects SdiAudioInput OptionalDefaults to []
Show 2 propertiesHide 2 properties
namestringRequired
aggregationobjectOptionalDefaults to {"type":"None","pair":"G1P1"}
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
Noneobject SdiNoAggregation
typestringOptionalDefaults to None
pairenum SdiAudioPair RequiredDefaults to G1P1
Allowed values:UnsyncedG1P1G1P2G2P1G2P2G3P1G3P2G4P1G4P2
nullnull
Variant 2: null
Unsyncedobject UnsyncedInput
Input synced from a service config whose transport mode this version of the
schema does not implement. unsupportedValue is the discriminator value that
triggered it (e.g. "ristListener"). Read/display only — a channel containing
one cannot be deployed.
typestringOptionalDefaults to Unsynced
namestringRequired
unsupportedValuestringOptionalDefaults to
transformobjectOptional
Show 2 variantsHide 2 variants
TransformConfigobject
encodingobjectOptional
Show 2 variantsHide 2 variants
EncodingConfigobject
videoobject VideoEncoding Required
Show 4 propertiesHide 4 properties
codecenum VideoCodec RequiredDefaults to H264High
Allowed values:UnsyncedHEVCMainHEVCMain10bitHEVCMain422HEVCMain10bit422H264MainH264HighH264High422H264High10bitH264High10bit422H264BaselineMPEG2MPEG2422JPEGXSJPEGXS10bit
videoFormatenum VideoFormat RequiredDefaults to 1920x1080p
Allowed values:Unsynced3840x2160p1920x1080p1920x1080i1440x1080p1440x1080i1280x1080p1280x1080i960x1080p960x1080i1280x720p960x720p854x720p848x720p640x720p720x576p720x576i704x576p704x576i544x576p544x576i528x576p528x576i480x576p480x576i352x576p352x576i720x480p720x480i704x480p704x480i640x480p640x480i544x480p544x480i528x480p528x480i480x480p480x480i352x480p352x480i352x288p320x240p192x192p176x144p176x120p128x96p96x96p
bitrateintegerRequired100000 to 60000000Defaults to 6000000
frameRateobjectOptionalDefaults to TrueMotion
Show 2 variantsHide 2 variants
FrameRateenum
Variant 1: enum
nullnull
Variant 2: null
audioslist of objects AudioEncoding OptionalDefaults to []
Show 7 propertiesHide 7 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
inputNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
audioNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecenum AudioCodec RequiredDefaults to AC3
Allowed values:UnsyncedPassThroughSMPTE302PassThroughMPEG1Layer2AACHEAACHEAACv2AC3EAC3AC4
modeobjectOptionalDefaults to Stereo
Show 2 variantsHide 2 variants
AudioModeenum
Variant 1: enum
nullnull
Variant 2: null
bitrateobjectOptionalDefaults to 192000
Show 2 variantsHide 2 variants
AudioBitrateenum
Variant 1: enum
nullnull
Variant 2: null
ac4ConfigobjectOptional
Show 2 variantsHide 2 variants
Ac4Configobject
frameRatestringOptionalDefaults to 25
languagestringOptionalDefaults to auto
contentClassifierenum Ac4ContentClassifier OptionalDefaults to classCompleteMain
Allowed values:UnsyncedclassCompleteMainclassEmergencyclassMusicEffectclassMainAssociatedMix
nullnull
Variant 2: null
nullnull
Variant 2: null
abrEncodingobjectOptional
Show 2 variantsHide 2 variants
AbrEncodingConfigobject
representationslist of objects Representation OptionalDefaults to []
Show 2 propertiesHide 2 properties
videoobject VideoEncoding Required
Show 4 propertiesHide 4 properties
codecenum VideoCodec RequiredDefaults to H264High
videoFormatenum VideoFormat RequiredDefaults to 1920x1080p
bitrateintegerRequired100000 to 60000000Defaults to 6000000
frameRateobjectOptionalDefaults to TrueMotion
Show 2 variantsHide 2 variants
FrameRateenum
Variant 1: enum
nullnull
Variant 2: null
audioslist of objects AudioEncoding OptionalDefaults to []
Show 7 propertiesHide 7 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
inputNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
audioNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecenum AudioCodec RequiredDefaults to AC3
Allowed values:UnsyncedPassThroughSMPTE302PassThroughMPEG1Layer2AACHEAACHEAACv2AC3EAC3AC4
modeobjectOptionalDefaults to Stereo
Show 2 variantsHide 2 variants
AudioModeenum
Variant 1: enum
nullnull
Variant 2: null
bitrateobjectOptionalDefaults to 192000
Show 2 variantsHide 2 variants
AudioBitrateenum
Variant 1: enum
nullnull
Variant 2: null
ac4ConfigobjectOptional
Show 2 variantsHide 2 variants
Ac4Configobject
frameRatestringOptionalDefaults to 25
languagestringOptionalDefaults to auto
Allowed values:UnsyncedclassCompleteMainclassEmergencyclassMusicEffectclassMainAssociatedMix
nullnull
Variant 2: null
sharedAudioslist of objects AudioEncoding OptionalDefaults to []
Show 7 propertiesHide 7 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
inputNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
audioNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecenum AudioCodec RequiredDefaults to AC3
Allowed values:UnsyncedPassThroughSMPTE302PassThroughMPEG1Layer2AACHEAACHEAACv2AC3EAC3AC4
modeobjectOptionalDefaults to Stereo
Show 2 variantsHide 2 variants
AudioModeenum
Variant 1: enum
nullnull
Variant 2: null
bitrateobjectOptionalDefaults to 192000
Show 2 variantsHide 2 variants
AudioBitrateenum
Variant 1: enum
nullnull
Variant 2: null
ac4ConfigobjectOptional
Show 2 variantsHide 2 variants
Ac4Configobject
frameRatestringOptionalDefaults to 25
languagestringOptionalDefaults to auto
Allowed values:UnsyncedclassCompleteMainclassEmergencyclassMusicEffectclassMainAssociatedMix
nullnull
Variant 2: null
nullnull
Variant 2: null
multiplexingobjectOptional
Show 2 variantsHide 2 variants
MultiplexingConfigobject
enabledbooleanOptionalDefaults to false
nullnull
Variant 2: null
nullnull
Variant 2: null
outputslist of objectsOptionalDefaults to []
Show 9 variantsHide 9 variants
Discriminated by type. Select one variant:
SRTCallerobject SrtCallerOutput
typestringOptionalDefaults to SRTCaller
transportobject SrtCallerOutputTransport Required
Show 5 propertiesHide 5 properties
urlstringRequiredpattern: ^srt://
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenum SrtEncryptionStandard OptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
SRTListenerobject SrtListenerOutput
typestringOptionalDefaults to SRTListener
transportobject SrtListenerOutputTransport Required
Show 6 propertiesHide 6 properties
interfacestringRequired
portintegerRequired256 to 65535
Port number
maxConnectionsintegerOptional>=1Defaults to 10
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenum SrtEncryptionStandard OptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
UDPobject UdpOutput
typestringOptionalDefaults to UDP
transportobject UdpOutputTransport Required
Show 4 propertiesHide 4 properties
urlstringRequired
interfacestringRequired
sourceAddressobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
sourcePortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Port number
Variant 1: integer
nullnull
Variant 2: null
ASIobject AsiOutput
typestringOptionalDefaults to ASI
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
transportobject AsiOutputTransport Required
Show 1 propertyHide 1 property
urlstringRequiredpattern: ^asi://
RFobject RfOutput
typestringOptionalDefaults to RF
transportobject RfOutputTransport Required
Show 1 propertyHide 1 property
urlstringRequiredpattern: ^satmod://
SDIobject SdiOutput
typestringOptionalDefaults to SDI
transportobject SdiOutputTransport Required
Show 1 propertyHide 1 property
urlstringRequiredpattern: ^sdi://
processingobjectOptional
Show 2 variantsHide 2 variants
OutputProcessingobject
videoScalingenum VideoScaling OptionalDefaults to None
Allowed values:UnsyncedNone1080i
dynamicRangeConversionenum DynamicRangeConversion OptionalDefaults to None
Allowed values:UnsyncedNoneBT709
nullnull
Variant 2: null
HttpStreamingobject HttpStreamingOutput
typestringOptionalDefaults to HttpStreaming
Smpte2110object Smpte2110Output
typestringOptionalDefaults to Smpte2110
transportobject Smpte2110OutputTransport Required
Show 2 propertiesHide 2 properties
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nmosEnabledbooleanOptionalDefaults to false
processingobjectOptional
Show 2 variantsHide 2 variants
OutputProcessingobject
videoScalingenum VideoScaling OptionalDefaults to None
Allowed values:UnsyncedNone1080i
Allowed values:UnsyncedNoneBT709
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
Smpte2110OutputEssencesobject
videoobject Smpte2110VideoOutputEssence Required
Show 4 propertiesHide 4 properties
interfacestringRequired
destinationAddressstringRequiredformat: ipv4
destinationPortintegerRequired1024 to 65535
Port number
sourcePortintegerRequired1 to 65535
Port number
audioslist of objects Smpte2110AudioOutputEssence OptionalDefaults to []
Show 3 propertiesHide 3 properties
interfacestringRequired
destinationPortintegerRequired1024 to 65535
Port number
sourcePortintegerRequired1 to 65535
Port number
nullnull
Variant 2: null
Unsyncedobject UnsyncedOutput
Output counterpart of UnsyncedInput. See UnsyncedInput.
typestringOptionalDefaults to Unsynced
unsupportedValuestringOptionalDefaults to
Response
200Successful Response
kindstringOptionalDefaults to BeamChannel
metadataobject ChannelMetadataResponse Required
Show 3 propertiesHide 3 properties
namestringRequired
displayNamestringRequired
createdstringRequiredformat: date-time
specobjectOptional
Show 2 variantsHide 2 variants
ChannelSpecobject
typeenum ChannelType Required
Allowed values:EncodingContributionEncodingDistributionReceptionDecodingReceptionGatewayEncodingStreaming
stateenum DesiredState OptionalDefaults to Stopped
Allowed values:RunningStopped
inputslist of objectsOptionalDefaults to []
Show 8 variantsHide 8 variants
Discriminated by type. Select one variant:
SRTCallerobject SrtCallerInput
typestringOptionalDefaults to SRTCaller
namestringRequired
transportobject SrtCallerTransport Required
Show 5 propertiesHide 5 properties
urlstringRequiredpattern: ^srt://
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenum SrtEncryptionStandard OptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenum DelayMode OptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenum DecryptType OptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum
Variant 1: enum
nullnull
Variant 2: null
bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
SRTListenerobject SrtListenerInput
typestringOptionalDefaults to SRTListener
namestringRequired
transportobject SrtListenerTransport Required
Show 6 propertiesHide 6 properties
interfacestringRequired
portintegerRequired256 to 65535
Port number
maxConnectionsintegerOptional>=1Defaults to 10
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenum SrtEncryptionStandard OptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenum DelayMode OptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenum DecryptType OptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum
Variant 1: enum
nullnull
Variant 2: null
bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
UDPobject UdpInput
typestringOptionalDefaults to UDP
namestringRequired
transportobject UdpTransport Required
Show 3 propertiesHide 3 properties
urlstringRequired
interfacestringRequired
unicastbooleanOptionalDefaults to false
payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenum DelayMode OptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenum DecryptType OptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum
Variant 1: enum
nullnull
Variant 2: null
bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
ASIobject AsiInput
typestringOptionalDefaults to ASI
namestringRequired
transportobject AsiInputTransport Required
Show 2 propertiesHide 2 properties
urlstringRequiredpattern: ^asi://
tsPacketSizeobjectOptional
Show 2 variantsHide 2 variants
TsPacketSizeenum
Variant 1: enum
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenum DelayMode OptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenum DecryptType OptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum
Variant 1: enum
nullnull
Variant 2: null
bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
SatDemodobject SatDemodInput
typestringOptionalDefaults to SatDemod
namestringRequired
transportobject SatDemodTransport Required
Show 10 propertiesHide 10 properties
urlstringRequiredpattern: ^rfdemod://
lnbFrequencyMHzintegerRequired
lnbVoltageenum LnbVoltage OptionalDefaults to Off
Allowed values:UnsyncedOff13V18V
lnbToneEnabledbooleanOptionalDefaults to false
tunerFrequencyHzintegerRequired
tunerSymbolRateintegerRequired
tunerSearchRangeHzintegerOptionalDefaults to 2000000
tunerMISEnabledbooleanOptionalDefaults to false
tunerGoldCodeintegerOptionalDefaults to 0
tunerMISStreamIdobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringOptionalDefaults to 1
delayModeenum DelayMode OptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenum DecryptType OptionalDefaults to None
Allowed values:UnsyncedNoneBISSBISSCADVBCI
bissModeobjectOptional
Show 2 variantsHide 2 variants
BissModeenum
Variant 1: enum
nullnull
Variant 2: null
bissKeyobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissInjectedKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bissCAKeyIdobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
camSlotobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
camPortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
Smpte2110object Smpte2110Input
typestringOptionalDefaults to Smpte2110
namestringRequired
transportobject Smpte2110InputTransport Required
Show 2 propertiesHide 2 properties
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nmosEnabledbooleanOptionalDefaults to false
payloadobjectOptional
Show 2 variantsHide 2 variants
Smpte2110Payloadobject
videoobjectOptional
Show 2 variantsHide 2 variants
Smpte2110VideoInputEssenceobject
typestringOptionalDefaults to video
transportFileobjectOptional
Show 2 variantsHide 2 variants
TransportFileobject
SDP transport file for an ST 2110 stream.
datastringRequired
Raw file contents; expects SDP format by default.
nullnull
Variant 2: null
sdpUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
streamIndexintegerOptional>=0Defaults to 0
nullnull
Variant 2: null
Show 6 propertiesHide 6 properties
typestringOptionalDefaults to audio
transportFileobjectOptional
Show 2 variantsHide 2 variants
TransportFileobject
SDP transport file for an ST 2110 stream.
datastringRequired
Raw file contents; expects SDP format by default.
nullnull
Variant 2: null
sdpUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
streamIndexintegerOptional>=0Defaults to 0
channelGroupIndexintegerOptional>=0Defaults to 0
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
SDIobject SdiInput
typestringOptionalDefaults to SDI
namestringRequired
transportobject SdiInputTransport Required
Show 1 propertyHide 1 property
urlstringRequiredpattern: ^sdi://
payloadobjectOptional
Show 2 variantsHide 2 variants
SdiPayloadobject
audioslist of objects SdiAudioInput OptionalDefaults to []
Show 2 propertiesHide 2 properties
namestringRequired
aggregationobjectOptionalDefaults to {"type":"None","pair":"G1P1"}
Show 1 variantHide 1 variant
Discriminated by type. Select one variant:
Noneobject SdiNoAggregation
typestringOptionalDefaults to None
pairenum SdiAudioPair RequiredDefaults to G1P1
Allowed values:UnsyncedG1P1G1P2G2P1G2P2G3P1G3P2G4P1G4P2
nullnull
Variant 2: null
Unsyncedobject UnsyncedInput
typestringOptionalDefaults to Unsynced
namestringRequired
unsupportedValuestringOptionalDefaults to
transformobjectOptional
Show 2 variantsHide 2 variants
TransformConfigobject
encodingobjectOptional
Show 2 variantsHide 2 variants
EncodingConfigobject
videoobject VideoEncoding Required
Show 4 propertiesHide 4 properties
codecenum VideoCodec RequiredDefaults to H264High
videoFormatenum VideoFormat RequiredDefaults to 1920x1080p
bitrateintegerRequired100000 to 60000000Defaults to 6000000
frameRateobjectOptionalDefaults to TrueMotion
Show 2 variantsHide 2 variants
FrameRateenum
Variant 1: enum
nullnull
Variant 2: null
audioslist of objects AudioEncoding OptionalDefaults to []
Show 7 propertiesHide 7 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
inputNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
audioNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecenum AudioCodec RequiredDefaults to AC3
Allowed values:UnsyncedPassThroughSMPTE302PassThroughMPEG1Layer2AACHEAACHEAACv2AC3EAC3AC4
modeobjectOptionalDefaults to Stereo
Show 2 variantsHide 2 variants
AudioModeenum
Variant 1: enum
nullnull
Variant 2: null
bitrateobjectOptionalDefaults to 192000
Show 2 variantsHide 2 variants
AudioBitrateenum
Variant 1: enum
nullnull
Variant 2: null
ac4ConfigobjectOptional
Show 2 variantsHide 2 variants
Ac4Configobject
frameRatestringOptionalDefaults to 25
languagestringOptionalDefaults to auto
Allowed values:UnsyncedclassCompleteMainclassEmergencyclassMusicEffectclassMainAssociatedMix
nullnull
Variant 2: null
nullnull
Variant 2: null
abrEncodingobjectOptional
Show 2 variantsHide 2 variants
AbrEncodingConfigobject
representationslist of objects Representation OptionalDefaults to []
Show 2 propertiesHide 2 properties
videoobject VideoEncoding Required
Show 4 propertiesHide 4 properties
codecenum VideoCodec RequiredDefaults to H264High
videoFormatenum VideoFormat RequiredDefaults to 1920x1080p
bitrateintegerRequired100000 to 60000000Defaults to 6000000
frameRateobjectOptionalDefaults to TrueMotion
Show 2 variantsHide 2 variants
FrameRateenum
Variant 1: enum
nullnull
Variant 2: null
audioslist of objects AudioEncoding OptionalDefaults to []
Show 7 propertiesHide 7 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
inputNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
audioNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecenum AudioCodec RequiredDefaults to AC3
Allowed values:UnsyncedPassThroughSMPTE302PassThroughMPEG1Layer2AACHEAACHEAACv2AC3EAC3AC4
modeobjectOptionalDefaults to Stereo
Show 2 variantsHide 2 variants
AudioModeenum
Variant 1: enum
nullnull
Variant 2: null
bitrateobjectOptionalDefaults to 192000
Show 2 variantsHide 2 variants
AudioBitrateenum
Variant 1: enum
nullnull
Variant 2: null
ac4ConfigobjectOptional
Show 2 variantsHide 2 variants
Ac4Configobject
frameRatestringOptionalDefaults to 25
languagestringOptionalDefaults to auto
Allowed values:UnsyncedclassCompleteMainclassEmergencyclassMusicEffectclassMainAssociatedMix
nullnull
Variant 2: null
sharedAudioslist of objects AudioEncoding OptionalDefaults to []
Show 7 propertiesHide 7 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
inputNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
audioNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecenum AudioCodec RequiredDefaults to AC3
Allowed values:UnsyncedPassThroughSMPTE302PassThroughMPEG1Layer2AACHEAACHEAACv2AC3EAC3AC4
modeobjectOptionalDefaults to Stereo
Show 2 variantsHide 2 variants
AudioModeenum
Variant 1: enum
nullnull
Variant 2: null
bitrateobjectOptionalDefaults to 192000
Show 2 variantsHide 2 variants
AudioBitrateenum
Variant 1: enum
nullnull
Variant 2: null
ac4ConfigobjectOptional
Show 2 variantsHide 2 variants
Ac4Configobject
frameRatestringOptionalDefaults to 25
languagestringOptionalDefaults to auto
Allowed values:UnsyncedclassCompleteMainclassEmergencyclassMusicEffectclassMainAssociatedMix
nullnull
Variant 2: null
nullnull
Variant 2: null
multiplexingobjectOptional
Show 2 variantsHide 2 variants
MultiplexingConfigobject
enabledbooleanOptionalDefaults to false
nullnull
Variant 2: null
nullnull
Variant 2: null
outputslist of objectsOptionalDefaults to []
Show 9 variantsHide 9 variants
Discriminated by type. Select one variant:
SRTCallerobject SrtCallerOutput
typestringOptionalDefaults to SRTCaller
transportobject SrtCallerOutputTransport Required
Show 5 propertiesHide 5 properties
urlstringRequiredpattern: ^srt://
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenum SrtEncryptionStandard OptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
SRTListenerobject SrtListenerOutput
typestringOptionalDefaults to SRTListener
transportobject SrtListenerOutputTransport Required
Show 6 propertiesHide 6 properties
interfacestringRequired
portintegerRequired256 to 65535
Port number
maxConnectionsintegerOptional>=1Defaults to 10
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenum SrtEncryptionStandard OptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
UDPobject UdpOutput
typestringOptionalDefaults to UDP
transportobject UdpOutputTransport Required
Show 4 propertiesHide 4 properties
urlstringRequired
interfacestringRequired
sourceAddressobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
sourcePortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Port number
Variant 1: integer
nullnull
Variant 2: null
ASIobject AsiOutput
typestringOptionalDefaults to ASI
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
transportobject AsiOutputTransport Required
Show 1 propertyHide 1 property
urlstringRequiredpattern: ^asi://
RFobject RfOutput
typestringOptionalDefaults to RF
transportobject RfOutputTransport Required
Show 1 propertyHide 1 property
urlstringRequiredpattern: ^satmod://
SDIobject SdiOutput
typestringOptionalDefaults to SDI
transportobject SdiOutputTransport Required
Show 1 propertyHide 1 property
urlstringRequiredpattern: ^sdi://
processingobjectOptional
Show 2 variantsHide 2 variants
OutputProcessingobject
videoScalingenum VideoScaling OptionalDefaults to None
Allowed values:UnsyncedNone1080i
Allowed values:UnsyncedNoneBT709
nullnull
Variant 2: null
HttpStreamingobject HttpStreamingOutput
typestringOptionalDefaults to HttpStreaming
Smpte2110object Smpte2110Output
typestringOptionalDefaults to Smpte2110
transportobject Smpte2110OutputTransport Required
Show 2 propertiesHide 2 properties
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nmosEnabledbooleanOptionalDefaults to false
processingobjectOptional
Show 2 variantsHide 2 variants
OutputProcessingobject
videoScalingenum VideoScaling OptionalDefaults to None
Allowed values:UnsyncedNone1080i
Allowed values:UnsyncedNoneBT709
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
Smpte2110OutputEssencesobject
videoobject Smpte2110VideoOutputEssence Required
Show 4 propertiesHide 4 properties
interfacestringRequired
destinationAddressstringRequiredformat: ipv4
destinationPortintegerRequired1024 to 65535
Port number
sourcePortintegerRequired1 to 65535
Port number
Show 3 propertiesHide 3 properties
interfacestringRequired
destinationPortintegerRequired1024 to 65535
Port number
sourcePortintegerRequired1 to 65535
Port number
nullnull
Variant 2: null
Unsyncedobject UnsyncedOutput
Output counterpart of UnsyncedInput. See UnsyncedInput.
typestringOptionalDefaults to Unsynced
unsupportedValuestringOptionalDefaults to
nullnull
Variant 2: null
statusobjectOptional
Show 2 variantsHide 2 variants
ChannelStatusobject
Includes calculated fields such as thumbnailUrl.
stateenum ActualState OptionalDefaults to Stopped
Allowed values:RunningStopped
healthobject HealthStatus OptionalDefaults to {"severity":"Clear"}
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
inputslist of objectsOptionalDefaults to []
Show 8 variantsHide 8 variants
Discriminated by type. Select one variant:
SRTCallerobject SrtCallerInputStatus
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
thumbnailPresenceenum ThumbnailPresence OptionalDefaults to Unknown
Allowed values:UnsyncedPresentAbsentUnknown
metadataUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
InputMptsPayloadStatusobject
Input payload for MPTS transports. Adds MPTS programme/PID table.
videoStandardobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
videoobjectOptional
Show 2 variantsHide 2 variants
InputPayloadVideoobject
widthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
heightobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
aspectRatioobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
qualityobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects InputPayloadAudio OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
channelModeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
samplingRateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
serviceslist of objects InputService OptionalDefaults to []
Show 7 propertiesHide 7 properties
programNumberintegerRequired
serviceNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
providerNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
selectedbooleanOptionalDefaults to false
pmtPidobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pcrPidobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
elementaryStreamslist of objects InputElementaryStream OptionalDefaults to []
Show 4 propertiesHide 4 properties
pidintegerRequired
streamTypeintegerRequired
typestringRequired
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
typestringOptionalDefaults to SRTCaller
transportobjectOptional
Show 2 variantsHide 2 variants
SrtCallerInputTransportStatusobject
receivingbooleanRequired
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
activeConnectionsobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
connectionsobjectOptional
Show 2 variantsHide 2 variants
arraylist of objects
list of objects
nullnull
Variant 2: null
etr290objectOptional
Show 2 variantsHide 2 variants
Etr290Statsobject
ccErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
tsSyncLossobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
syncByteErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
transportErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pmtErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pidErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
SRTListenerobject SrtListenerInputStatus
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
thumbnailPresenceenum ThumbnailPresence OptionalDefaults to Unknown
Allowed values:UnsyncedPresentAbsentUnknown
metadataUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
InputMptsPayloadStatusobject
Input payload for MPTS transports. Adds MPTS programme/PID table.
videoStandardobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
videoobjectOptional
Show 2 variantsHide 2 variants
InputPayloadVideoobject
widthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
heightobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
aspectRatioobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
qualityobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects InputPayloadAudio OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
channelModeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
samplingRateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
serviceslist of objects InputService OptionalDefaults to []
Show 7 propertiesHide 7 properties
programNumberintegerRequired
serviceNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
providerNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
selectedbooleanOptionalDefaults to false
pmtPidobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pcrPidobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
Show 4 propertiesHide 4 properties
pidintegerRequired
streamTypeintegerRequired
typestringRequired
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
typestringOptionalDefaults to SRTListener
transportobjectOptional
Show 2 variantsHide 2 variants
SrtListenerInputTransportStatusobject
receivingbooleanRequired
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
activeConnectionsobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
connectionsobjectOptional
Show 2 variantsHide 2 variants
arraylist of objects
list of objects
nullnull
Variant 2: null
etr290objectOptional
Show 2 variantsHide 2 variants
Etr290Statsobject
ccErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
tsSyncLossobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
syncByteErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
transportErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pmtErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pidErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
UDPobject UdpInputStatus
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
thumbnailPresenceenum ThumbnailPresence OptionalDefaults to Unknown
Allowed values:UnsyncedPresentAbsentUnknown
metadataUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
InputMptsPayloadStatusobject
Input payload for MPTS transports. Adds MPTS programme/PID table.
videoStandardobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
videoobjectOptional
Show 2 variantsHide 2 variants
InputPayloadVideoobject
widthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
heightobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
aspectRatioobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
qualityobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects InputPayloadAudio OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
channelModeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
samplingRateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
serviceslist of objects InputService OptionalDefaults to []
Show 7 propertiesHide 7 properties
programNumberintegerRequired
serviceNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
providerNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
selectedbooleanOptionalDefaults to false
pmtPidobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pcrPidobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
Show 4 propertiesHide 4 properties
pidintegerRequired
streamTypeintegerRequired
typestringRequired
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
typestringOptionalDefaults to UDP
transportobjectOptional
Show 2 variantsHide 2 variants
UdpInputTransportStatusobject
receivingbooleanRequired
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
receivedPacketsobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
etr290objectOptional
Show 2 variantsHide 2 variants
Etr290Statsobject
ccErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
tsSyncLossobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
syncByteErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
transportErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pmtErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pidErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
fecobjectOptional
Show 2 variantsHide 2 variants
InputTransportFecobject
statusobjectOptional
Show 3 variantsHide 3 variants
FecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
correctedPacketsobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
unrecoveredPacketsobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
SDIobject SdiInputStatus
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
thumbnailPresenceenum ThumbnailPresence OptionalDefaults to Unknown
Allowed values:UnsyncedPresentAbsentUnknown
metadataUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
InputPayloadStatusobject
Base input payload. Applies to SDI and SMPTE 2110 (no MPTS layer).
videoStandardobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
videoobjectOptional
Show 2 variantsHide 2 variants
InputPayloadVideoobject
widthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
heightobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
aspectRatioobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
qualityobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects InputPayloadAudio OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
channelModeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
samplingRateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
typestringOptionalDefaults to SDI
transportobjectOptional
Show 2 variantsHide 2 variants
SdiInputTransportStatusobject
receivingbooleanRequired
nullnull
Variant 2: null
Smpte2110object Smpte2110InputStatus
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
thumbnailPresenceenum ThumbnailPresence OptionalDefaults to Unknown
Allowed values:UnsyncedPresentAbsentUnknown
metadataUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
InputPayloadStatusobject
Base input payload. Applies to SDI and SMPTE 2110 (no MPTS layer).
videoStandardobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
videoobjectOptional
Show 2 variantsHide 2 variants
InputPayloadVideoobject
widthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
heightobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
aspectRatioobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
qualityobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects InputPayloadAudio OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
channelModeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
samplingRateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
typestringOptionalDefaults to Smpte2110
transportobjectOptional
Show 2 variantsHide 2 variants
Smpte2110InputTransportStatusobject
receivingbooleanRequired
nullnull
Variant 2: null
ASIobject AsiInputStatus
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
thumbnailPresenceenum ThumbnailPresence OptionalDefaults to Unknown
Allowed values:UnsyncedPresentAbsentUnknown
metadataUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
InputMptsPayloadStatusobject
Input payload for MPTS transports. Adds MPTS programme/PID table.
videoStandardobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
videoobjectOptional
Show 2 variantsHide 2 variants
InputPayloadVideoobject
widthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
heightobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
aspectRatioobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
qualityobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects InputPayloadAudio OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
channelModeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
samplingRateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
serviceslist of objects InputService OptionalDefaults to []
Show 7 propertiesHide 7 properties
programNumberintegerRequired
serviceNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
providerNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
selectedbooleanOptionalDefaults to false
pmtPidobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pcrPidobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
Show 4 propertiesHide 4 properties
pidintegerRequired
streamTypeintegerRequired
typestringRequired
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
typestringOptionalDefaults to ASI
transportobjectOptional
Show 2 variantsHide 2 variants
AsiInputTransportStatusobject
receivingbooleanRequired
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
etr290objectOptional
Show 2 variantsHide 2 variants
Etr290Statsobject
ccErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
tsSyncLossobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
syncByteErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
transportErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pmtErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pidErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
fecobjectOptional
Show 2 variantsHide 2 variants
InputTransportFecobject
statusobjectOptional
Show 3 variantsHide 3 variants
FecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
correctedPacketsobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
unrecoveredPacketsobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
nullnull
Variant 2: null
SatDemodobject SatDemodInputStatus
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
thumbnailPresenceenum ThumbnailPresence OptionalDefaults to Unknown
Allowed values:UnsyncedPresentAbsentUnknown
metadataUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
InputMptsPayloadStatusobject
Input payload for MPTS transports. Adds MPTS programme/PID table.
videoStandardobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
videoobjectOptional
Show 2 variantsHide 2 variants
InputPayloadVideoobject
widthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
heightobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
aspectRatioobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
qualityobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects InputPayloadAudio OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
channelModeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
samplingRateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
serviceslist of objects InputService OptionalDefaults to []
Show 7 propertiesHide 7 properties
programNumberintegerRequired
serviceNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
providerNameobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
selectedbooleanOptionalDefaults to false
pmtPidobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
pcrPidobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
Show 4 propertiesHide 4 properties
pidintegerRequired
streamTypeintegerRequired
typestringRequired
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
typestringOptionalDefaults to SatDemod
transportobjectOptional
Show 2 variantsHide 2 variants
SatDemodInputTransportStatusobject
receivingbooleanRequired
nullnull
Variant 2: null
Unsyncedobject UnsyncedInputStatus
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
thumbnailPresenceenum ThumbnailPresence OptionalDefaults to Unknown
Allowed values:UnsyncedPresentAbsentUnknown
metadataUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
InputPayloadStatusobject
Base input payload. Applies to SDI and SMPTE 2110 (no MPTS layer).
videoStandardobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
videoobjectOptional
Show 2 variantsHide 2 variants
InputPayloadVideoobject
widthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
heightobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
aspectRatioobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
qualityobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects InputPayloadAudio OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
channelModeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
samplingRateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
typestringOptionalDefaults to Unsynced
outputslist of objectsOptionalDefaults to []
Show 9 variantsHide 9 variants
Discriminated by type. Select one variant:
SRTCallerobject SrtCallerOutputStatus
namestringOptionalDefaults to
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to SRTCaller
transportobjectOptional
Show 2 variantsHide 2 variants
SrtCallerOutputTransportStatusobject
urlstringRequired
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
latencydoubleOptionalDefaults to 0.125
encryptionStandardstringOptionalDefaults to None
activeConnectionsintegerOptionalDefaults to 0
connectionslist of objects SrtConnectionStats OptionalDefaults to []
Show 6 propertiesHide 6 properties
remoteAddressobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
sendBitrateMbpsobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
packetsLostobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
packetsRetransmittedobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
rttMsobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
bandwidthMbpsobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
OutputPayloadStatusobject
Single-service output payload. Applies to SRT, UDP, ASI, RF, SDI, SMPTE 2110.
videoobjectOptional
Show 2 variantsHide 2 variants
OutputVideoPayloadobject
Video payload status from statistics-api.
resolutionobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
frameRateobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects OutputAudioPayload OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
modeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
SRTListenerobject SrtListenerOutputStatus
namestringOptionalDefaults to
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to SRTListener
transportobjectOptional
Show 2 variantsHide 2 variants
SrtListenerOutputTransportStatusobject
interfacestringRequired
portintegerRequired
maxConnectionsintegerOptionalDefaults to 10
latencydoubleOptionalDefaults to 0.125
encryptionStandardstringOptionalDefaults to None
activeConnectionsintegerOptionalDefaults to 0
connectionslist of objects SrtConnectionStats OptionalDefaults to []
Show 6 propertiesHide 6 properties
remoteAddressobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
sendBitrateMbpsobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
packetsLostobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
packetsRetransmittedobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
rttMsobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
bandwidthMbpsobjectOptional
Show 2 variantsHide 2 variants
numberdouble
Variant 1: double
nullnull
Variant 2: null
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
OutputPayloadStatusobject
Single-service output payload. Applies to SRT, UDP, ASI, RF, SDI, SMPTE 2110.
videoobjectOptional
Show 2 variantsHide 2 variants
OutputVideoPayloadobject
Video payload status from statistics-api.
resolutionobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
frameRateobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects OutputAudioPayload OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
modeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
UDPobject UdpOutputStatus
namestringOptionalDefaults to
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to UDP
transportobjectOptional
Show 2 variantsHide 2 variants
UdpOutputTransportobject
urlstringRequired
interfacestringRequired
sourceAddressobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
sourcePortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Port number
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
OutputPayloadStatusobject
Single-service output payload. Applies to SRT, UDP, ASI, RF, SDI, SMPTE 2110.
videoobjectOptional
Show 2 variantsHide 2 variants
OutputVideoPayloadobject
Video payload status from statistics-api.
resolutionobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
frameRateobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects OutputAudioPayload OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
modeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
ASIobject AsiOutputStatus
namestringOptionalDefaults to
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to ASI
transportobjectOptional
Show 2 variantsHide 2 variants
AsiOutputTransportobject
urlstringRequiredpattern: ^asi://
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
OutputPayloadStatusobject
Single-service output payload. Applies to SRT, UDP, ASI, RF, SDI, SMPTE 2110.
videoobjectOptional
Show 2 variantsHide 2 variants
OutputVideoPayloadobject
Video payload status from statistics-api.
resolutionobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
frameRateobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects OutputAudioPayload OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
modeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
RFobject RfOutputStatus
namestringOptionalDefaults to
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to RF
transportobjectOptional
Show 2 variantsHide 2 variants
RfOutputTransportobject
urlstringRequiredpattern: ^satmod://
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
OutputPayloadStatusobject
Single-service output payload. Applies to SRT, UDP, ASI, RF, SDI, SMPTE 2110.
videoobjectOptional
Show 2 variantsHide 2 variants
OutputVideoPayloadobject
Video payload status from statistics-api.
resolutionobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
frameRateobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects OutputAudioPayload OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
modeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
SDIobject SdiOutputStatus
namestringOptionalDefaults to
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to SDI
transportobjectOptional
Show 2 variantsHide 2 variants
SdiOutputTransportobject
urlstringRequiredpattern: ^sdi://
nullnull
Variant 2: null
processingobjectOptional
Show 2 variantsHide 2 variants
OutputProcessingobject
videoScalingenum VideoScaling OptionalDefaults to None
Allowed values:UnsyncedNone1080i
Allowed values:UnsyncedNoneBT709
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
OutputPayloadStatusobject
Single-service output payload. Applies to SRT, UDP, ASI, RF, SDI, SMPTE 2110.
videoobjectOptional
Show 2 variantsHide 2 variants
OutputVideoPayloadobject
Video payload status from statistics-api.
resolutionobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
frameRateobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects OutputAudioPayload OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
modeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
Smpte2110object Smpte2110OutputStatus
namestringOptionalDefaults to
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to Smpte2110
transportobjectOptional
Show 2 variantsHide 2 variants
Smpte2110OutputTransportobject
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nmosEnabledbooleanOptionalDefaults to false
nullnull
Variant 2: null
processingobjectOptional
Show 2 variantsHide 2 variants
OutputProcessingobject
videoScalingenum VideoScaling OptionalDefaults to None
Allowed values:UnsyncedNone1080i
Allowed values:UnsyncedNoneBT709
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
OutputPayloadStatusobject
Single-service output payload. Applies to SRT, UDP, ASI, RF, SDI, SMPTE 2110.
videoobjectOptional
Show 2 variantsHide 2 variants
OutputVideoPayloadobject
Video payload status from statistics-api.
resolutionobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
frameRateobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects OutputAudioPayload OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
modeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
HttpStreamingobject HttpStreamingOutputStatus
namestringOptionalDefaults to
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to HttpStreaming
transportobjectOptional
Show 2 variantsHide 2 variants
HttpStreamingOutputTransportStatusobject
endpointslist of objects HttpStreamingEndpoint OptionalDefaults to []
Show 2 propertiesHide 2 properties
segmentationTypeenum SegmentationType Required
Packaging format advertised on a HttpStreaming output endpoint.
Derived from the packager catalog output type (hls|cmaf) + manifestType (hls|dash): cmaf+hls -> HLSfMP4, cmaf+dash -> DASHfMP4, hls -> HLSTS (HLS-TS not yet emitted).
Allowed values:HLSTSHLSfMP4DASHfMP4
urlstringRequired
nullnull
Variant 2: null
payloadobjectOptional
Show 2 variantsHide 2 variants
OutputHttpStreamingPayloadStatusobject
HTTP streaming output payload. Adds ABR representation ladder.
videoobjectOptional
Show 2 variantsHide 2 variants
OutputVideoPayloadobject
Video payload status from statistics-api.
resolutionobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
frameRateobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects OutputAudioPayload OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
modeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
representationslist of objects OutputRepresentationPayload OptionalDefaults to []
Show 2 propertiesHide 2 properties
videoobjectOptional
Show 2 variantsHide 2 variants
OutputVideoPayloadobject
Video payload status from statistics-api.
resolutionobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
frameRateobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
codecobjectOptional
Show 3 variantsHide 3 variants
VideoCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
bitDepthobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
chromaFormatobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
nullnull
Variant 2: null
audioslist of objects OutputAudioPayload OptionalDefaults to []
Show 5 propertiesHide 5 properties
codecobjectOptional
Show 3 variantsHide 3 variants
AudioCodecStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
modeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum
Variant 1: enum
stringstring
Variant 2: string
nullnull
Variant 3: null
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
languageobjectOptional
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
nullnull
Variant 2: null
channelCountobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Variant 1: integer
nullnull
Variant 2: null
nullnull
Variant 2: null
Unsyncedobject UnsyncedOutputStatus
namestringOptionalDefaults to
healthobject HealthStatus Required
Show 1 propertyHide 1 property
severityenum Severity Required
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to Unsynced
syncStateenum SyncState OptionalDefaults to Ok
Allowed values:OkConfiguringConfigFailedSyncFailedFailedFieldError
syncErrorlist of stringsOptionalDefaults to []
nullnull
Variant 2: null
serviceIdsobjectOptional
Show 2 variantsHide 2 variants
arraylist of strings
Variant 1: list of strings
nullnull
Variant 2: null
Errors
422Validation Error
detaillist of objects ValidationError Optional
Show 5 propertiesHide 5 properties
loclist of objectsRequired
Show 2 variantsHide 2 variants
stringstring
Variant 1: string
integerinteger
Variant 2: integer
msgstringRequired
typestringRequired
inputanyOptional
ctxobjectOptional
503Service unavailable
No response body.