ExportedChannel – Channels API – MediaKind

ExportedChannel

object

kind string Optional Defaults to BeamChannel

metadata object ChannelMetadata Required

Show 2 properties Hide 2 properties

name string Required

displayName string Required

spec object ChannelSpec Required

Show 5 properties Hide 5 properties

type enum ChannelType Required

Allowed values: EncodingContribution EncodingDistribution ReceptionDecoding ReceptionGateway EncodingStreaming

state enum DesiredState Optional Defaults to Stopped

Allowed values: Running Stopped

inputs list of objects Optional Defaults to []

Show 8 variants Hide 8 variants

Discriminated by type. Select one variant:

SRTCaller object SrtCallerInput

type string Optional Defaults to SRTCaller

name string Required

transport object SrtCallerTransport Required

Show 5 properties Hide 5 properties

url string Required pattern: ^srt://

interface object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

latency double Optional 0.06 to 8 Defaults to 0.125

encryptionStandard enum SrtEncryptionStandard Optional Defaults to None

Allowed values: Unsynced None AES128 AES192 AES256

passPhrase object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

payload object Optional

Show 2 variants Hide 2 variants

MptsPayload object

programNumber string Optional Defaults to 1

delayMode enum DelayMode Optional Defaults to Standard

Allowed values: Unsynced Standard Low SuperLow

decrypt object Optional

Show 2 variants Hide 2 variants

DecryptConfig object

type enum DecryptType Optional Defaults to None

Allowed values: Unsynced None BISS BISSC ADVBCI

bissMode object Optional

Show 2 variants Hide 2 variants

BissMode enum

Variant 1: enum

null null

Variant 2: null

bissKey object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

bissInjectedKeyId object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

bissCAKeyId object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

camSlot object Optional

Show 2 variants Hide 2 variants

integer integer

Variant 1: integer

null null

Variant 2: null

camPort object Optional

Show 2 variants Hide 2 variants

integer integer

Variant 1: integer

null null

Variant 2: null

null null

Variant 2: null

SRTListener object SrtListenerInput

type string Optional Defaults to SRTListener

name string Required

transport object SrtListenerTransport Required

Show 6 properties Hide 6 properties

interface string Required

port integer Required 256 to 65535

Port number

maxConnections integer Optional >=1 Defaults to 10

latency double Optional 0.06 to 8 Defaults to 0.125

encryptionStandard enum SrtEncryptionStandard Optional Defaults to None

Allowed values: Unsynced None AES128 AES192 AES256

passPhrase object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

payload object Optional

Show 2 variants Hide 2 variants

MptsPayload object

programNumber string Optional Defaults to 1

delayMode enum DelayMode Optional Defaults to Standard

Allowed values: Unsynced Standard Low SuperLow

decrypt object Optional

Show 2 variants Hide 2 variants

DecryptConfig object

type enum DecryptType Optional Defaults to None

Allowed values: Unsynced None BISS BISSC ADVBCI

bissMode object Optional

Show 2 variants Hide 2 variants

BissMode enum

Variant 1: enum

null null

Variant 2: null

bissKey object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

bissInjectedKeyId object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

bissCAKeyId object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

camSlot object Optional

Show 2 variants Hide 2 variants

integer integer

Variant 1: integer

null null

Variant 2: null

camPort object Optional

Show 2 variants Hide 2 variants

integer integer

Variant 1: integer

null null

Variant 2: null

null null

Variant 2: null

null null

Variant 2: null

UDP object UdpInput

type string Optional Defaults to UDP

name string Required

transport object UdpTransport Required

Show 3 properties Hide 3 properties

url string Required

interface string Required

unicast boolean Optional Defaults to false

payload object Optional

Show 2 variants Hide 2 variants

MptsPayload object

programNumber string Optional Defaults to 1

delayMode enum DelayMode Optional Defaults to Standard

Allowed values: Unsynced Standard Low SuperLow

decrypt object Optional

Show 2 variants Hide 2 variants

DecryptConfig object

type enum DecryptType Optional Defaults to None

Allowed values: Unsynced None BISS BISSC ADVBCI

bissMode object Optional

Show 2 variants Hide 2 variants

BissMode enum

Variant 1: enum

null null

Variant 2: null

bissKey object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

bissInjectedKeyId object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

bissCAKeyId object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

camSlot object Optional

Show 2 variants Hide 2 variants

integer integer

Variant 1: integer

null null

Variant 2: null

camPort object Optional

Show 2 variants Hide 2 variants

integer integer

Variant 1: integer

null null

Variant 2: null

null null

Variant 2: null

null null

Variant 2: null

ASI object AsiInput

type string Optional Defaults to ASI

name string Required

transport object AsiInputTransport Required

Show 2 properties Hide 2 properties

url string Required pattern: ^asi://

tsPacketSize object Optional

Show 2 variants Hide 2 variants

TsPacketSize enum

Variant 1: enum

null null

Variant 2: null

payload object Optional

Show 2 variants Hide 2 variants

MptsPayload object

programNumber string Optional Defaults to 1

delayMode enum DelayMode Optional Defaults to Standard

Allowed values: Unsynced Standard Low SuperLow

decrypt object Optional

Show 2 variants Hide 2 variants

DecryptConfig object

type enum DecryptType Optional Defaults to None

Allowed values: Unsynced None BISS BISSC ADVBCI

bissMode object Optional

Show 2 variants Hide 2 variants

BissMode enum

Variant 1: enum

null null

Variant 2: null

bissKey object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

bissInjectedKeyId object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

bissCAKeyId object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

camSlot object Optional

Show 2 variants Hide 2 variants

integer integer

Variant 1: integer

null null

Variant 2: null

camPort object Optional

Show 2 variants Hide 2 variants

integer integer

Variant 1: integer

null null

Variant 2: null

null null

Variant 2: null

null null

Variant 2: null

SatDemod object SatDemodInput

type string Optional Defaults to SatDemod

name string Required

transport object SatDemodTransport Required

Show 10 properties Hide 10 properties

url string Required pattern: ^rfdemod://

lnbFrequencyMHz integer Required

lnbVoltage enum LnbVoltage Optional Defaults to Off

Allowed values: Unsynced Off 13V 18V

lnbToneEnabled boolean Optional Defaults to false

tunerFrequencyHz integer Required

tunerSymbolRate integer Required

tunerSearchRangeHz integer Optional Defaults to 2000000

tunerMISEnabled boolean Optional Defaults to false

tunerGoldCode integer Optional Defaults to 0

tunerMISStreamId object Optional

Show 2 variants Hide 2 variants

integer integer

Variant 1: integer

null null

Variant 2: null

payload object Optional

Show 2 variants Hide 2 variants

MptsPayload object

programNumber string Optional Defaults to 1

delayMode enum DelayMode Optional Defaults to Standard

Allowed values: Unsynced Standard Low SuperLow

decrypt object Optional

Show 2 variants Hide 2 variants

DecryptConfig object

type enum DecryptType Optional Defaults to None

Allowed values: Unsynced None BISS BISSC ADVBCI

bissMode object Optional

Show 2 variants Hide 2 variants

BissMode enum

Variant 1: enum

null null

Variant 2: null

bissKey object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

bissInjectedKeyId object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

bissCAKeyId object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

camSlot object Optional

Show 2 variants Hide 2 variants

integer integer

Variant 1: integer

null null

Variant 2: null

camPort object Optional

Show 2 variants Hide 2 variants

integer integer

Variant 1: integer

null null

Variant 2: null

null null

Variant 2: null

null null

Variant 2: null

Smpte2110 object Smpte2110Input

type string Optional Defaults to Smpte2110

name string Required

transport object Smpte2110InputTransport Required

Show 2 properties Hide 2 properties

interface object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

nmosEnabled boolean Optional Defaults to false

payload object Optional

Show 2 variants Hide 2 variants

Smpte2110Payload object

video object Optional

Show 2 variants Hide 2 variants

Smpte2110VideoInputEssence object

type string Optional Defaults to video

transportFile object Optional

Show 2 variants Hide 2 variants

TransportFile object

SDP transport file for an ST 2110 stream.

datastring Required;

Raw file contents; expects SDP format by default.

null null

Variant 2: null

sdpUrl object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

streamIndex integer Optional >=0 Defaults to 0

null null

Variant 2: null

audios list of objects Smpte2110AudioInputEssence Optional Defaults to []

Show 6 properties Hide 6 properties

type string Optional Defaults to audio

transportFile object Optional

Show 2 variants Hide 2 variants

TransportFile object

SDP transport file for an ST 2110 stream.

datastring Required;

Raw file contents; expects SDP format by default.

null null

Variant 2: null

sdpUrl object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

streamIndex integer Optional >=0 Defaults to 0

channelGroupIndex integer Optional >=0 Defaults to 0

name object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

null null

Variant 2: null

SDI object SdiInput

type string Optional Defaults to SDI

name string Required

transport object SdiInputTransport Required

Show 1 property Hide 1 property

url string Required pattern: ^sdi://

payload object Optional

Show 2 variants Hide 2 variants

SdiPayload object

audios list of objects SdiAudioInput Optional Defaults to []

Show 2 properties Hide 2 properties

name string Required

aggregation object Optional Defaults to {"type":"None","pair":"G1P1"}

Show 1 variant Hide 1 variant

Discriminated by type. Select one variant:

None object SdiNoAggregation

type string Optional Defaults to None

pair enum SdiAudioPair Required Defaults to G1P1

Allowed values: Unsynced G1P1 G1P2 G2P1 G2P2 G3P1 G3P2 G4P1 G4P2

null null

Variant 2: null

Unsynced object 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.

type string Optional Defaults to Unsynced

name string Required

unsupportedValue string Optional Defaults to

transform object Optional

Show 2 variants Hide 2 variants

TransformConfig object

encoding object Optional

Show 2 variants Hide 2 variants

EncodingConfig object

video object VideoEncoding Required

Show 4 properties Hide 4 properties

codec enum VideoCodec Required Defaults to H264High

Allowed values: Unsynced HEVCMain HEVCMain10bit HEVCMain422 HEVCMain10bit422 H264Main H264High H264High422 H264High10bit H264High10bit422 H264Baseline MPEG2 MPEG2422 JPEGXS JPEGXS10bit

videoFormat enum VideoFormat Required Defaults to 1920x1080p

Allowed values: Unsynced 3840x2160p 1920x1080p 1920x1080i 1440x1080p 1440x1080i 1280x1080p 1280x1080i 960x1080p 960x1080i 1280x720p 960x720p 854x720p 848x720p 640x720p 720x576p 720x576i 704x576p 704x576i 544x576p 544x576i 528x576p 528x576i 480x576p 480x576i 352x576p 352x576i 720x480p 720x480i 704x480p 704x480i 640x480p 640x480i 544x480p 544x480i 528x480p 528x480i 480x480p 480x480i 352x480p 352x480i 352x288p 320x240p 192x192p 176x144p 176x120p 128x96p 96x96p

bitrate integer Required 100000 to 60000000 Defaults to 6000000

frameRate object Optional Defaults to TrueMotion

Show 2 variants Hide 2 variants

FrameRate enum

Variant 1: enum

null null

Variant 2: null

audios list of objects AudioEncoding Optional Defaults to []

Show 7 properties Hide 7 properties

name object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

inputName object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

audioName object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

codec enum AudioCodec Required Defaults to AC3

Allowed values: Unsynced PassThrough SMPTE302 PassThrough MPEG1Layer2 AAC EAC3 EAC3AC4

mode object Optional Defaults to Stereo

Show 2 variants Hide 2 variants

AudioMode enum

Variant 1: enum

null null

Variant 2: null

bitrate object Optional Defaults to 192000

Show 2 variants Hide 2 variants

AudioBitrate enum

Variant 1: enum

null null

Variant 2: null

ac4Config object Optional

Show 2 variants Hide 2 variants

Ac4Config object

frameRate string Optional Defaults to 25

language string Optional Defaults to auto

contentClassifier enum Ac4ContentClassifier Optional Defaults to classCompleteMain

Allowed values: Unsynced classCompleteMain classEmergency classMusicEffect classMainAssociatedMix

null null

Variant 2: null

null null

Variant 2: null

abrEncoding object Optional

Show 2 variants Hide 2 variants

AbrEncodingConfig object

representations list of objects Representation Optional Defaults to []

Show 2 properties Hide 2 properties

video object VideoEncoding Required

Show 4 properties Hide 4 properties

codec enum VideoCodec Required Defaults to H264High

videoFormat enum VideoFormat Required Defaults to 1920x1080p

bitrate integer Required 100000 to 60000000 Defaults to 6000000

frameRate object Optional Defaults to TrueMotion

Show 2 variants Hide 2 variants

FrameRate enum

Variant 1: enum

null null

Variant 2: null

audios list of objects AudioEncoding Optional Defaults to []

Show 7 properties Hide 7 properties

name object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

inputName object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

audioName object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

codec enum AudioCodec Required Defaults to AC3

Allowed values: Unsynced PassThrough SMPTE302 PassThrough MPEG1Layer2 AAC EAC3 EAC3AC4

mode object Optional Defaults to Stereo

Show 2 variants Hide 2 variants

AudioMode enum

Variant 1: enum

null null

Variant 2: null

bitrate object Optional Defaults to 192000

Show 2 variants Hide 2 variants

AudioBitrate enum

Variant 1: enum

null null

Variant 2: null

ac4Config object Optional

Show 2 variants Hide 2 variants

Ac4Config object

frameRate string Optional Defaults to 25

language string Optional Defaults to auto

Allowed values: Unsynced classCompleteMain classEmergency classMusicEffect classMainAssociatedMix

null null

Variant 2: null

sharedAudios list of objects AudioEncoding Optional Defaults to []

Show 7 properties Hide 7 properties

name object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

inputName object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

audioName object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

codec enum AudioCodec Required Defaults to AC3

Allowed values: Unsynced PassThrough SMPTE302 PassThrough MPEG1Layer2 AAC EAC3 EAC3AC4

mode object Optional Defaults to Stereo

Show 2 variants Hide 2 variants

AudioMode enum

Variant 1: enum

null null

Variant 2: null

bitrate object Optional Defaults to 192000

Show 2 variants Hide 2 variants

AudioBitrate enum

Variant 1: enum

null null

Variant 2: null

ac4Config object Optional

Show 2 variants Hide 2 variants

Ac4Config object

frameRate string Optional Defaults to 25

language string Optional Defaults to auto

Allowed values: Unsynced classCompleteMain classEmergency classMusicEffect classMainAssociatedMix

null null

Variant 2: null

multiplexing object Optional

Show 2 variants Hide 2 variants

MultiplexingConfig object

enabled boolean Optional Defaults to false

null null

Variant 2: null

null null

Variant 2: null

outputs list of objects Optional Defaults to []

Show 9 variants Hide 9 variants

Discriminated by type. Select one variant:

SRTCaller object SrtCallerOutput

type string Optional Defaults to SRTCaller

transport object SrtCallerOutputTransport Required

Show 5 properties Hide 5 properties

url string Required pattern: ^srt://

interface object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

latency double Optional 0.06 to 8 Defaults to 0.125

encryptionStandard enum SrtEncryptionStandard Optional Defaults to None

Allowed values: Unsynced None AES128 AES192 AES256

passPhrase object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

SRTListener object SrtListenerOutput

type string Optional Defaults to SRTListener

transport object SrtListenerOutputTransport Required

Show 6 properties Hide 6 properties

interface string Required

port integer Required 256 to 65535

Port number

maxConnections integer Optional >=1 Defaults to 10

latency double Optional 0.06 to 8 Defaults to 0.125

encryptionStandard enum SrtEncryptionStandard Optional Defaults to None

Allowed values: Unsynced None AES128 AES192 AES256

passPhrase object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

UDP object UdpOutput

type string Optional Defaults to UDP

transport object UdpOutputTransport Required

Show 4 properties Hide 4 properties

url string Required

interface string Required

sourceAddress object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

sourcePort object Optional

Show 2 variants Hide 2 variants

integer integer

Port number

Variant 1: integer

null null

Variant 2: null

ASI object AsiOutput

type string Optional Defaults to ASI

name object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

transport object AsiOutputTransport Required

Show 1 property Hide 1 property

url string Required pattern: ^asi://

RF object RfOutput

type string Optional Defaults to RF

transport object RfOutputTransport Required

Show 1 property Hide 1 property

url string Required pattern: ^satmod://

SDI object SdiOutput

type string Optional Defaults to SDI

transport object SdiOutputTransport Required

Show 1 property Hide 1 property

url string Required pattern: ^sdi://

processing object Optional

Show 2 variants Hide 2 variants

OutputProcessing object

videoScaling enum VideoScaling Optional Defaults to None

Allowed values: Unsynced None 1080i

dynamicRangeConversion enum DynamicRangeConversion Optional Defaults to None

Allowed values: Unsynced None BT709

null null

Variant 2: null

HttpStreaming object HttpStreamingOutput

type string Optional Defaults to HttpStreaming

Smpte2110 object Smpte2110Output

type string Optional Defaults to Smpte2110

transport object Smpte2110OutputTransport Required

Show 2 properties Hide 2 properties

interface object Optional

Show 2 variants Hide 2 variants

string string

Variant 1: string

null null

Variant 2: null

nmosEnabled boolean Optional Defaults to false

processing object Optional

Show 2 variants Hide 2 variants

OutputProcessing object

videoScaling enum VideoScaling Optional Defaults to None

Allowed values: Unsynced None 1080i

Allowed values: Unsynced None BT709

null null

Variant 2: null

payload object Optional

Show 2 variants Hide 2 variants

Smpte2110OutputEssences object

video object Smpte2110VideoOutputEssence Required

Show 4 properties Hide 4 properties

interface string Required

destinationAddress string Required format: ipv4

destinationPort integer Required 1024 to 65535

Port number

sourcePort integer Required 1 to 65535

Port number

audios list of objects Smpte2110AudioOutputEssence Optional Defaults to []

Show 3 properties Hide 3 properties

interface string Required

destinationPort integer Required 1024 to 65535

Port number

sourcePort integer Required 1 to 65535

Port number

null null

Variant 2: null

Unsynced object UnsyncedOutput

Output counterpart of UnsyncedInput. See UnsyncedInput.

type string Optional Defaults to Unsynced

unsupportedValue string Optional Defaults to

services list of objects ExportedService Optional

Show 5 properties Hide 5 properties

name string Required

type string Required

id string Required

config object Required

configVersion string Required