ChannelCreate

object
Create channel - same as Channel but without status.

Properties

• kind: string (Optional)
  • Defaults to BeamChannel
• metadata: object ChannelMetadata (Required)

Show 2 properties

• name: string (Required)

• displayName: string (Required)

• spec: object ChannelSpec (Required)

Show 5 properties

• type: enum ChannelType (Required)
  • Allowed values: Encoding, Contribution, Distribution, Reception, Decoding, Reception, Gateway, Encoding, Streaming
• state: enum DesiredState (Optional)
  • Defaults to Stopped
  • Allowed values: Running, Stopped
• inputs: list of objects (Optional)
  • Defaults to []

Show 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

• url: string (Required)
  • pattern: ^srt://
• interface: object (Optional)
  • Show 2 variants
    • string
    • 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
    • string
    • null

Payload Configuration

• payload: object (Optional)
  • Show 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
    • DecryptConfig object
    • type: enum DecryptType (Optional)
      • Defaults to None
      • Allowed values: Unsynced, None, BISS, BISSC, ADVB, CI

SRTListener

...

Other input types

• UDP, ASI, SatDemod, Smpte2110, SDI, Unsynced
• Each of these types follow a similar structure with specific parameters.

Outputs

• SRTCaller, SRTListener, UDP, ASI, RF, SDI, Smpte2110
• Each of these output types has required transport properties and additional configurations.