Get Channel

get /api/channels/:channel_id/

Get a single channel.

Path parameters

channel_id string Required

Response

200 Successful Response
kindstringOptionalDefaults to BeamChannel
metadataobjectChannelMetadataResponseRequired
Show 3 propertiesHide 3 properties
namestringRequired1-64 characters
displayNamestringRequired1-255 characters
createdstringRequiredformat: date-time
specobjectOptional
Show 2 variantsHide 2 variants
ChannelSpecobject
typeenumChannelTypeRequired
Allowed values:EncodingContributionEncodingDistributionReceptionDecodingReceptionGatewayEncodingStreaming
stateenumDesiredStateOptionalDefaults to Stopped
Allowed values:RunningStopped
inputslist of objectsOptionalDefaults to []
Show 8 variantsHide 8 variants

Discriminated by type. Select one variant:

SRTCallerobjectSrtCallerInput
typestringOptionalDefaults to SRTCaller
namestringRequired1-32 characters
transportobjectSrtCallerTransportRequired
Show 5 propertiesHide 5 properties
urlstringRequired<=2048 characterspattern: ^srt://
interfaceobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenumSrtEncryptionStandardOptionalDefaults 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
programNumberstringRequiredpattern: ^(Auto|[1-9]\d*)$Defaults to Auto
delayModeenumDelayModeOptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
videoobjectMptsVideoConfigRequired
Show 1 propertyHide 1 property
pidstringRequiredpattern: ^(Auto|[1-9]\d*)$
audioslist of objectsMptsAudioConfigOptional0-8 itemsDefaults to []
Show 3 propertiesHide 3 properties
namestringRequired1-32 characters
modeenumMptsAudioModeRequired
Allowed values:stereo165.1passthrough
pidstringRequiredpattern: ^(Auto|[1-9]\d*)$
audioAutoSelectbooleanRequired
resolutionModeenumReceiverInputResolutionRequired
Allowed values:UHDHDSD
nullnull

Variant 2: null

decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenumDecryptTypeOptionalDefaults 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

camUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

nullnull

Variant 2: null

SRTListenerobjectSrtListenerInput
typestringOptionalDefaults to SRTListener
namestringRequired1-32 characters
transportobjectSrtListenerTransportRequired
Show 5 propertiesHide 5 properties
interfacestringRequired<=32 characters
portintegerRequired256 to 65535
Port number
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenumSrtEncryptionStandardOptionalDefaults 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
programNumberstringRequiredpattern: ^(Auto|[1-9]\d*)$Defaults to Auto
delayModeenumDelayModeOptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
videoobjectMptsVideoConfigRequired
Show 1 propertyHide 1 property
pidstringRequiredpattern: ^(Auto|[1-9]\d*)$
audioslist of objectsMptsAudioConfigOptional0-8 itemsDefaults to []
Show 3 propertiesHide 3 properties
namestringRequired1-32 characters
modeenumMptsAudioModeRequired
Allowed values:stereo165.1passthrough
pidstringRequiredpattern: ^(Auto|[1-9]\d*)$
audioAutoSelectbooleanRequired
resolutionModeenumReceiverInputResolutionRequired
Allowed values:UHDHDSD
nullnull

Variant 2: null

decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenumDecryptTypeOptionalDefaults 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

camUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

nullnull

Variant 2: null

UDPobjectUdpInput
typestringOptionalDefaults to UDP
namestringRequired1-32 characters
transportobjectUdpTransportRequired
Show 2 propertiesHide 2 properties
urlstringRequired<=128 characters
udp://[sourceAddress@]destinationAddress:port. sourceAddress is optional and enables source-specific multicast filtering (currently only applied by CP inputs).
interfacestringRequired<=32 characters
payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringRequiredpattern: ^(Auto|[1-9]\d*)$Defaults to Auto
delayModeenumDelayModeOptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
videoobjectMptsVideoConfigRequired
Show 1 propertyHide 1 property
pidstringRequiredpattern: ^(Auto|[1-9]\d*)$
audioslist of objectsMptsAudioConfigOptional0-8 itemsDefaults to []
Show 3 propertiesHide 3 properties
namestringRequired1-32 characters
modeenumMptsAudioModeRequired
Allowed values:stereo165.1passthrough
pidstringRequiredpattern: ^(Auto|[1-9]\d*)$
audioAutoSelectbooleanRequired
resolutionModeenumReceiverInputResolutionRequired
Allowed values:UHDHDSD
nullnull

Variant 2: null

decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenumDecryptTypeOptionalDefaults 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

camUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

nullnull

Variant 2: null

ASIobjectAsiInput
typestringOptionalDefaults to ASI
namestringRequired1-32 characters
transportobjectAsiInputTransportRequired
Show 2 propertiesHide 2 properties
urlstringRequired<=128 characterspattern: ^asi://
tsPacketSizeobjectOptional
Show 2 variantsHide 2 variants
TsPacketSizeenum

Variant 1: enum

nullnull

Variant 2: null

payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringRequiredpattern: ^(Auto|[1-9]\d*)$Defaults to Auto
delayModeenumDelayModeOptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
videoobjectMptsVideoConfigRequired
Show 1 propertyHide 1 property
pidstringRequiredpattern: ^(Auto|[1-9]\d*)$
audioslist of objectsMptsAudioConfigOptional0-8 itemsDefaults to []
Show 3 propertiesHide 3 properties
namestringRequired1-32 characters
modeenumMptsAudioModeRequired
Allowed values:stereo165.1passthrough
pidstringRequiredpattern: ^(Auto|[1-9]\d*)$
audioAutoSelectbooleanRequired
resolutionModeenumReceiverInputResolutionRequired
Allowed values:UHDHDSD
nullnull

Variant 2: null

decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenumDecryptTypeOptionalDefaults 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

camUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

nullnull

Variant 2: null

SatDemodobjectSatDemodInput
typestringOptionalDefaults to SatDemod
namestringRequired1-32 characters
transportobjectSatDemodTransportRequired
Show 10 propertiesHide 10 properties
urlstringRequired<=128 characterspattern: ^rfdemod://
lnbVoltageenumLnbVoltageOptionalDefaults to Off
Allowed values:UnsyncedOff13V18V
lnbToneEnabledbooleanOptionalDefaults to false
tunerSymbolRateSpsintegerRequired0 to 95000000
tunerSearchRangeHzintegerOptional2000000 to 10000000Defaults to 2000000
tunerMISEnabledbooleanOptionalDefaults to false
tunerGoldCodeintegerOptional0 to 262142Defaults to 0
lnbFrequencyHzintegerRequired0 to 18000000000
tunerFrequencyHzintegerRequired0 to 18000000000
tunerMISStreamIdobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

payloadobjectOptional
Show 2 variantsHide 2 variants
MptsPayloadobject
programNumberstringRequiredpattern: ^(Auto|[1-9]\d*)$Defaults to Auto
delayModeenumDelayModeOptionalDefaults to Standard
Allowed values:UnsyncedStandardLowSuperLow
videoobjectMptsVideoConfigRequired
Show 1 propertyHide 1 property
pidstringRequiredpattern: ^(Auto|[1-9]\d*)$
audioslist of objectsMptsAudioConfigOptional0-8 itemsDefaults to []
Show 3 propertiesHide 3 properties
namestringRequired1-32 characters
modeenumMptsAudioModeRequired
Allowed values:stereo165.1passthrough
pidstringRequiredpattern: ^(Auto|[1-9]\d*)$
audioAutoSelectbooleanRequired
resolutionModeenumReceiverInputResolutionRequired
Allowed values:UHDHDSD
nullnull

Variant 2: null

decryptobjectOptional
Show 2 variantsHide 2 variants
DecryptConfigobject
typeenumDecryptTypeOptionalDefaults 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

camUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

nullnull

Variant 2: null

Smpte2110objectSmpte2110Input
typestringOptionalDefaults to Smpte2110
namestringRequired1-32 characters
transportobjectSmpte2110InputTransportRequired
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<=8192 characters
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>=1Defaults to 1
nullnull

Variant 2: null

audioslist of objectsSmpte2110AudioInputEssenceOptionalDefaults 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<=8192 characters
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>=1Defaults to 1
channelGroupIndexintegerOptional>=1Defaults to 1
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

nullnull

Variant 2: null

SDIobjectSdiInput
typestringOptionalDefaults to SDI
namestringRequired1-32 characters
transportobjectSdiInputTransportRequired
Show 1 propertyHide 1 property
urlstringRequired<=128 characterspattern: ^sdi://
payloadobjectOptional
Show 2 variantsHide 2 variants
SdiPayloadobject
audioslist of objectsSdiAudioInputOptionalDefaults to []
Show 2 propertiesHide 2 properties
namestringRequired1-32 characters
aggregationobjectOptionalDefaults to {"type":"None","pair":"G1P1"}
Show 1 variantHide 1 variant

Discriminated by type. Select one variant:

NoneobjectSdiNoAggregation
typestringOptionalDefaults to None
pairenumSdiAudioPairRequiredDefaults to G1P1
Allowed values:UnsyncedG1P1G1P2G2P1G2P2G3P1G3P2G4P1G4P2
nullnull

Variant 2: null

UnsyncedobjectUnsyncedInput
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
namestringRequired1-32 characters
unsupportedValuestringOptionalDefaults to
transformobjectOptional
Show 2 variantsHide 2 variants
TransformConfigobject
encodingobjectOptional
Show 2 variantsHide 2 variants
EncodingConfigobject
videoobjectVideoEncodingRequired
Show 4 propertiesHide 4 properties
codecenumVideoCodecRequiredDefaults to H264High
Allowed values:UnsyncedHEVCMainHEVCMain10bitHEVCMain422HEVCMain10bit422H264MainH264HighH264High422H264High10bitH264High10bit422H264BaselineMPEG2MPEG2422JPEGXSJPEGXS10bit
videoFormatenumVideoFormatRequiredDefaults to 1920x1080p
Allowed values:Unsynced3840x2160p1920x1080p1920x1080i1440x1080p1440x1080i1280x1080p1280x1080i960x1080p960x1080i1280x720p960x720p854x720p848x720p640x720p720x576p720x576i704x576p704x576i544x576p544x576i528x576p528x576i480x576p480x576i352x576p352x576i720x480p720x480i704x480p704x480i640x480p640x480i544x480p544x480i528x480p528x480i480x480p480x480i352x480p352x480i352x288p320x240p192x192p176x144p176x120p128x96p96x96p
bitrateintegerRequired100000 to 4000000000Defaults to 6000000
frameRateobjectOptionalDefaults to TrueMotion
Show 2 variantsHide 2 variants
FrameRateenum

Variant 1: enum

nullnull

Variant 2: null

audioslist of objectsAudioEncodingOptionalDefaults 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

codecenumAudioCodecRequiredDefaults 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
frameRatestringOptional<=16 charactersDefaults to 25
languagestringOptional<=16 charactersDefaults to auto
contentClassifierenumAc4ContentClassifierOptionalDefaults to classCompleteMain
Allowed values:UnsyncedclassCompleteMainclassEmergencyclassMusicEffectclassMainAssociatedMix
nullnull

Variant 2: null

nullnull

Variant 2: null

abrEncodingobjectOptional
Show 2 variantsHide 2 variants
AbrEncodingConfigobject
representationslist of objectsRepresentationOptionalDefaults to []
Show 2 propertiesHide 2 properties
videoobjectVideoEncodingRequired
Show 4 propertiesHide 4 properties
codecenumVideoCodecRequiredDefaults to H264High
Allowed values:UnsyncedHEVCMainHEVCMain10bitHEVCMain422HEVCMain10bit422H264MainH264HighH264High422H264High10bitH264High10bit422H264BaselineMPEG2MPEG2422JPEGXSJPEGXS10bit
videoFormatenumVideoFormatRequiredDefaults to 1920x1080p
Allowed values:Unsynced3840x2160p1920x1080p1920x1080i1440x1080p1440x1080i1280x1080p1280x1080i960x1080p960x1080i1280x720p960x720p854x720p848x720p640x720p720x576p720x576i704x576p704x576i544x576p544x576i528x576p528x576i480x576p480x576i352x576p352x576i720x480p720x480i704x480p704x480i640x480p640x480i544x480p544x480i528x480p528x480i480x480p480x480i352x480p352x480i352x288p320x240p192x192p176x144p176x120p128x96p96x96p
bitrateintegerRequired100000 to 4000000000Defaults to 6000000
frameRateobjectOptionalDefaults to TrueMotion
Show 2 variantsHide 2 variants
FrameRateenum

Variant 1: enum

nullnull

Variant 2: null

audioslist of objectsAudioEncodingOptionalDefaults 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

codecenumAudioCodecRequiredDefaults 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
frameRatestringOptional<=16 charactersDefaults to 25
languagestringOptional<=16 charactersDefaults to auto
contentClassifierenumAc4ContentClassifierOptionalDefaults to classCompleteMain
Allowed values:UnsyncedclassCompleteMainclassEmergencyclassMusicEffectclassMainAssociatedMix
nullnull

Variant 2: null

sharedAudioslist of objectsAudioEncodingOptionalDefaults 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

codecenumAudioCodecRequiredDefaults 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
frameRatestringOptional<=16 charactersDefaults to 25
languagestringOptional<=16 charactersDefaults to auto
contentClassifierenumAc4ContentClassifierOptionalDefaults to classCompleteMain
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:

SRTCallerobjectSrtCallerOutput
typestringOptionalDefaults to SRTCaller
transportobjectSrtCallerOutputTransportRequired
Show 4 propertiesHide 4 properties
urlstringRequired<=2048 characterspattern: ^srt://
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenumSrtEncryptionStandardOptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

SRTListenerobjectSrtListenerOutput
typestringOptionalDefaults to SRTListener
transportobjectSrtListenerOutputTransportRequired
Show 6 propertiesHide 6 properties
interfacestringRequired<=32 characters
portintegerRequired256 to 65535
Port number
maxConnectionsintegerOptional>=1Defaults to 10
latencydoubleOptional0.06 to 8Defaults to 0.125
encryptionStandardenumSrtEncryptionStandardOptionalDefaults to None
Allowed values:UnsyncedNoneAES128AES192AES256
passPhraseobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

UDPobjectUdpOutput
typestringOptionalDefaults to UDP
transportobjectUdpOutputTransportRequired
Show 4 propertiesHide 4 properties
urlstringRequired<=128 characters
udp://[sourceAddress@]destinationAddress:port. sourceAddress is optional and enables source-specific multicast filtering (currently only applied by CP inputs).
interfacestringRequired<=32 characters
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

ASIobjectAsiOutput
typestringOptionalDefaults to ASI
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

transportobjectAsiOutputTransportRequired
Show 1 propertyHide 1 property
urlstringRequired<=128 characterspattern: ^asi://
RFobjectRfOutput
typestringOptionalDefaults to RF
SDIobjectSdiOutput
typestringOptionalDefaults to SDI
transportobjectSdiOutputTransportRequired
Show 2 propertiesHide 2 properties
urlstringRequired<=128 characterspattern: ^sdi://
linkModeobjectOptional
Show 2 variantsHide 2 variants
SDIUHDLinkModeenum

Variant 1: enum

nullnull

Variant 2: null

processingobjectOptional
Show 2 variantsHide 2 variants
OutputProcessingobject
videoScalingobjectOptional
Show 2 variantsHide 2 variants
VideoScalingenum

Variant 1: enum

nullnull

Variant 2: null

dynamicRangeConversionenumDynamicRangeConversionOptionalDefaults to None
Allowed values:UnsyncedNoneBT709
nullnull

Variant 2: null

payloadobjectOptional
Show 2 variantsHide 2 variants
SdiOutputPayloadobject
audioslist of objectsSdiOutputAudioConfigOptionalDefaults to []
Show 3 propertiesHide 3 properties
inputNamestringRequired1-32 characters
audioInputNamestringRequired1-32 characters
embeddingenumSdiAudioEmbeddingRequired
Allowed values:UnsyncedG1P1G1P2G2P1G2P2G3P1G3P2G4P1G4P2G1P1ToG2P1G1P2ToG2P2G2P1ToG3P1G2P2ToG3P2G3P1ToG4P1G3P2ToG4P2G1P1ToG4P2
nullnull

Variant 2: null

HttpStreamingobjectHttpStreamingOutput
typestringOptionalDefaults to HttpStreaming
Smpte2110objectSmpte2110Output
typestringOptionalDefaults to Smpte2110
transportslist of objectsSmpte2110OutputTransportRequired
Show 5 propertiesHide 5 properties
namestringRequired1-32 characters
interfacestringRequired<=32 characters
destinationAddressstringRequiredformat: ipv4
destinationPortintegerRequired1024 to 65535
Port number
sourcePortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Port number

Variant 1: integer

nullnull

Variant 2: null

processingobjectOptional
Show 2 variantsHide 2 variants
OutputProcessingobject
videoScalingobjectOptional
Show 2 variantsHide 2 variants
VideoScalingenum

Variant 1: enum

nullnull

Variant 2: null

dynamicRangeConversionenumDynamicRangeConversionOptionalDefaults to None
Allowed values:UnsyncedNoneBT709
nullnull

Variant 2: null

payloadobjectSmpte2110OutputPayloadRequired
Show 1 propertyHide 1 property
essenceslist of objectsRequired
Show 3 variantsHide 3 variants

Discriminated by essenceType. Select one variant:

VideoobjectSmpte2110VideoEssence
essenceTypestringOptionalDefaults to Video
transportNamestringRequired1-32 characters
AudioAES3objectSmpte2110AudioEssence
essenceTypeenumOptionalDefaults to AudioPCM
Allowed values:AudioPCMAudioAES3
transportNamestringRequired1-32 characters
packetTimeenumPacketTimeOptionalDefaults to PT_1ms
Allowed values:PT_1msPT_125us
audioslist of objectsSmpte2110OutputAudioOptional0-32 itemsDefaults to []
Show 2 propertiesHide 2 properties
inputNamestringRequired1-32 characters
audioInputNamestringRequired1-32 characters
AudioPCMobjectSmpte2110AudioEssence
essenceTypeenumOptionalDefaults to AudioPCM
Allowed values:AudioPCMAudioAES3
transportNamestringRequired1-32 characters
packetTimeenumPacketTimeOptionalDefaults to PT_1ms
Allowed values:PT_1msPT_125us
audioslist of objectsSmpte2110OutputAudioOptional0-32 itemsDefaults to []
Show 2 propertiesHide 2 properties
inputNamestringRequired1-32 characters
audioInputNamestringRequired1-32 characters
UnsyncedobjectUnsyncedOutput
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.
stateenumActualStateOptionalDefaults to Stopped
Allowed values:RunningStopped
healthobjectHealthStatusOptionalDefaults to {"severity":"Clear"}
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
inputslist of objectsOptionalDefaults to []
Show 8 variantsHide 8 variants

Discriminated by type. Select one variant:

SRTCallerobjectSrtCallerInputStatus
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired1-32 characters
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

thumbnailPresenceenumThumbnailPresenceOptionalDefaults 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

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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

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 objectsInputPayloadAudioOptionalDefaults to []
Show 8 propertiesHide 8 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

serviceslist of objectsInputServiceOptionalDefaults 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 objectsInputElementaryStreamOptionalDefaults 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

SRTListenerobjectSrtListenerInputStatus
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired1-32 characters
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

thumbnailPresenceenumThumbnailPresenceOptionalDefaults 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

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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

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 objectsInputPayloadAudioOptionalDefaults to []
Show 8 propertiesHide 8 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

serviceslist of objectsInputServiceOptionalDefaults 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 objectsInputElementaryStreamOptionalDefaults 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 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

UDPobjectUdpInputStatus
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired1-32 characters
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

thumbnailPresenceenumThumbnailPresenceOptionalDefaults 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

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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

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 objectsInputPayloadAudioOptionalDefaults to []
Show 8 propertiesHide 8 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

serviceslist of objectsInputServiceOptionalDefaults 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 objectsInputElementaryStreamOptionalDefaults 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 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

SDIobjectSdiInputStatus
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired1-32 characters
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

thumbnailPresenceenumThumbnailPresenceOptionalDefaults 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

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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

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 objectsInputPayloadAudioOptionalDefaults to []
Show 8 propertiesHide 8 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

bitrateobjectOptional
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

Smpte2110objectSmpte2110InputStatus
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired1-32 characters
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

thumbnailPresenceenumThumbnailPresenceOptionalDefaults 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

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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

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 objectsInputPayloadAudioOptionalDefaults to []
Show 8 propertiesHide 8 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

bitrateobjectOptional
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

ASIobjectAsiInputStatus
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired1-32 characters
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

thumbnailPresenceenumThumbnailPresenceOptionalDefaults 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

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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

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 objectsInputPayloadAudioOptionalDefaults to []
Show 8 propertiesHide 8 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

serviceslist of objectsInputServiceOptionalDefaults 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 objectsInputElementaryStreamOptionalDefaults 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 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

SatDemodobjectSatDemodInputStatus
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired1-32 characters
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

thumbnailPresenceenumThumbnailPresenceOptionalDefaults 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

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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

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 objectsInputPayloadAudioOptionalDefaults to []
Show 8 propertiesHide 8 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

serviceslist of objectsInputServiceOptionalDefaults 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 objectsInputElementaryStreamOptionalDefaults 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 SatDemod
transportobjectOptional
Show 2 variantsHide 2 variants
SatDemodInputTransportStatusobject
receivingbooleanRequired
bitrateobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

berobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

cnMarginobjectOptional
Show 2 variantsHide 2 variants
numberdouble

Variant 1: double

nullnull

Variant 2: null

fecErrorsobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

fecRateobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

inversionobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

nullnull

Variant 2: null

modulationobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

pilotobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

nullnull

Variant 2: null

rollOffobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

signalStrengthobjectOptional
Show 2 variantsHide 2 variants
numberdouble

Variant 1: double

nullnull

Variant 2: null

deliverySystemobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

ccErrorobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

nullnull

Variant 2: null

UnsyncedobjectUnsyncedInputStatus
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
namestringRequired1-32 characters
thumbnailUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

thumbnailPresenceenumThumbnailPresenceOptionalDefaults 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

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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

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 objectsInputPayloadAudioOptionalDefaults to []
Show 8 propertiesHide 8 properties
nameobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

bitrateobjectOptional
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:

SRTCallerobjectSrtCallerOutputStatus
namestringOptionalDefaults to
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
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 objectsSrtConnectionStatsOptionalDefaults 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.
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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 objectsOutputAudioPayloadOptionalDefaults to []
Show 6 propertiesHide 6 properties
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

SRTListenerobjectSrtListenerOutputStatus
namestringOptionalDefaults to
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to SRTListener
transportobjectOptional
Show 2 variantsHide 2 variants
SrtListenerOutputTransportStatusobject
interfacestringRequired<=32 characters
portintegerRequired
maxConnectionsintegerOptionalDefaults to 10
latencydoubleOptionalDefaults to 0.125
encryptionStandardstringOptionalDefaults to None
activeConnectionsintegerOptionalDefaults to 0
connectionslist of objectsSrtConnectionStatsOptionalDefaults 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.
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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 objectsOutputAudioPayloadOptionalDefaults to []
Show 6 propertiesHide 6 properties
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

UDPobjectUdpOutputStatus
namestringOptionalDefaults to
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to UDP
transportobjectOptional
Show 2 variantsHide 2 variants
UdpOutputTransportobject
urlstringRequired<=128 characters
udp://[sourceAddress@]destinationAddress:port. sourceAddress is optional and enables source-specific multicast filtering (currently only applied by CP inputs).
interfacestringRequired<=32 characters
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.
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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 objectsOutputAudioPayloadOptionalDefaults to []
Show 6 propertiesHide 6 properties
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

ASIobjectAsiOutputStatus
namestringOptionalDefaults to
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to ASI
transportobjectOptional
Show 2 variantsHide 2 variants
AsiOutputTransportobject
urlstringRequired<=128 characterspattern: ^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.
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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 objectsOutputAudioPayloadOptionalDefaults to []
Show 6 propertiesHide 6 properties
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

RFobjectRfOutputStatus
namestringOptionalDefaults to
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to RF
transportobjectOptional
Show 2 variantsHide 2 variants
RfOutputTransportobject
urlstringRequired<=128 characterspattern: ^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.
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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 objectsOutputAudioPayloadOptionalDefaults to []
Show 6 propertiesHide 6 properties
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

SDIobjectSdiOutputStatus
namestringOptionalDefaults to
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to SDI
transportobjectOptional
Show 2 variantsHide 2 variants
SdiOutputTransportobject
urlstringRequired<=128 characterspattern: ^sdi://
linkModeobjectOptional
Show 2 variantsHide 2 variants
SDIUHDLinkModeenum

Variant 1: enum

nullnull

Variant 2: null

nullnull

Variant 2: null

processingobjectOptional
Show 2 variantsHide 2 variants
OutputProcessingobject
videoScalingobjectOptional
Show 2 variantsHide 2 variants
VideoScalingenum

Variant 1: enum

nullnull

Variant 2: null

dynamicRangeConversionenumDynamicRangeConversionOptionalDefaults to None
Allowed values:UnsyncedNoneBT709
nullnull

Variant 2: null

payloadobjectOptional
Show 2 variantsHide 2 variants
SdiOutputPayloadStatusobject
videoobjectOptional
Show 2 variantsHide 2 variants
OutputVideoFormatStatusobject
Live decoded video characteristics for a Reception Decoding SDI/ST2110 output. videoFormat combines resolution and scan type into a single broadcast-style string (e.g. "720x576i") rather than exposing width/ height/interlaced separately.
videoFormatobjectOptional
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

nullnull

Variant 2: null

audioslist of objectsSdiOutputAudioStatusOptionalDefaults to []
Show 4 propertiesHide 4 properties
inputNamestringRequired
audioInputNamestringRequired
embeddingenumSdiAudioEmbeddingRequired
Allowed values:UnsyncedG1P1G1P2G2P1G2P2G3P1G3P2G4P1G4P2G1P1ToG2P1G1P2ToG2P2G2P1ToG3P1G2P2ToG3P2G3P1ToG4P1G3P2ToG4P2G1P1ToG4P2
modeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum

Variant 1: enum

stringstring

Variant 2: string

nullnull

Variant 3: null

nullnull

Variant 2: null

Smpte2110objectSmpte2110OutputStatus
namestringOptionalDefaults to
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to Smpte2110
transportslist of objectsSmpte2110OutputTransportOptionalDefaults to []
Show 5 propertiesHide 5 properties
namestringRequired1-32 characters
interfacestringRequired<=32 characters
destinationAddressstringRequiredformat: ipv4
destinationPortintegerRequired1024 to 65535
Port number
sourcePortobjectOptional
Show 2 variantsHide 2 variants
integerinteger
Port number

Variant 1: integer

nullnull

Variant 2: null

processingobjectOptional
Show 2 variantsHide 2 variants
OutputProcessingobject
videoScalingobjectOptional
Show 2 variantsHide 2 variants
VideoScalingenum

Variant 1: enum

nullnull

Variant 2: null

dynamicRangeConversionenumDynamicRangeConversionOptionalDefaults to None
Allowed values:UnsyncedNoneBT709
nullnull

Variant 2: null

payloadobjectOptional
Show 2 variantsHide 2 variants
Smpte2110OutputPayloadStatusobject
essenceslist of objectsOptionalDefaults to []
Show 3 variantsHide 3 variants

Discriminated by essenceType. Select one variant:

VideoobjectSmpte2110VideoEssenceStatus
essenceTypestringOptionalDefaults to Video
transportNamestringRequired
typeobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

videoobjectOptional
Show 2 variantsHide 2 variants
OutputVideoFormatStatusobject
Live decoded video characteristics for a Reception Decoding SDI/ST2110 output. videoFormat combines resolution and scan type into a single broadcast-style string (e.g. "720x576i") rather than exposing width/ height/interlaced separately.
videoFormatobjectOptional
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

nullnull

Variant 2: null

sdpUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

AudioAES3objectSmpte2110AudioEssenceStatus
essenceTypeenumOptionalDefaults to AudioPCM
Allowed values:AudioPCMAudioAES3
transportNamestringRequired
typeobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

packetTimeenumPacketTimeOptionalDefaults to PT_1ms
Allowed values:PT_1msPT_125us
audioslist of objectsSmpte2110OutputAudioStatusOptionalDefaults to []
Show 3 propertiesHide 3 properties
inputNamestringRequired
audioInputNamestringRequired
modeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum

Variant 1: enum

stringstring

Variant 2: string

nullnull

Variant 3: null

sdpUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

AudioPCMobjectSmpte2110AudioEssenceStatus
essenceTypeenumOptionalDefaults to AudioPCM
Allowed values:AudioPCMAudioAES3
transportNamestringRequired
typeobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

packetTimeenumPacketTimeOptionalDefaults to PT_1ms
Allowed values:PT_1msPT_125us
audioslist of objectsSmpte2110OutputAudioStatusOptionalDefaults to []
Show 3 propertiesHide 3 properties
inputNamestringRequired
audioInputNamestringRequired
modeobjectOptional
Show 3 variantsHide 3 variants
AudioModeStatusenum

Variant 1: enum

stringstring

Variant 2: string

nullnull

Variant 3: null

sdpUrlobjectOptional
Show 2 variantsHide 2 variants
stringstring

Variant 1: string

nullnull

Variant 2: null

nullnull

Variant 2: null

HttpStreamingobjectHttpStreamingOutputStatus
namestringOptionalDefaults to
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to HttpStreaming
transportobjectOptional
Show 2 variantsHide 2 variants
HttpStreamingOutputTransportStatusobject
endpointslist of objectsHttpStreamingEndpointOptionalDefaults to []
Show 2 propertiesHide 2 properties
segmentationTypeenumSegmentationTypeRequired

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.
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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 objectsOutputAudioPayloadOptionalDefaults to []
Show 6 propertiesHide 6 properties
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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 objectsOutputRepresentationPayloadOptionalDefaults to []
Show 2 propertiesHide 2 properties
videoobjectOptional
Show 2 variantsHide 2 variants
OutputVideoPayloadobject
Video payload status from statistics-api.
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

interlacedobjectOptional
Show 2 variantsHide 2 variants
booleanboolean

Variant 1: boolean

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 objectsOutputAudioPayloadOptionalDefaults to []
Show 6 propertiesHide 6 properties
pidobjectOptional
Show 2 variantsHide 2 variants
integerinteger

Variant 1: integer

nullnull

Variant 2: null

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

UnsyncedobjectUnsyncedOutputStatus
namestringOptionalDefaults to
healthobjectHealthStatusRequired
Show 1 propertyHide 1 property
severityenumSeverityRequired
Allowed values:CriticalMajorMinorNoticeIgnoreClear
typestringOptionalDefaults to Unsynced
syncStateenumSyncStateOptionalDefaults to Ok

What kind of trouble a channel is in — see error-policy.md.

syncState says what kind of trouble; errors says what to do about it. Keep the split: a new state is only warranted by a new kind of trouble, not by a new cause of an existing one.

Allowed values:OkConfiguringConfigFailedSyncFailedFailed
syncErrorlist of stringsOptionalDefaults to []
errorslist of objectsErrorEntryOptionalDefaults to []
Show 6 propertiesHide 6 properties
codestringRequired
transientbooleanRequired
showCodebooleanRequired
userShortstringRequired<=40 characters
userMessagestringRequired<=512 characters
detailstringRequired<=512 characters
unsyncedFieldslist 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

422 Validation Error
detaillist of objectsValidationErrorOptional
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
503 Service unavailable

No response body.