OBJECT

Encoder

The hardware encoder.”

link GraphQL Schema definition

  • type Encoder implements IExtraProperties {
  • # The encoder ID.
  • id: ID!
  • # The encoder name.
  • name: String!
  • # The encoder unique device ID.
  • deviceId: String!
  • # The encoder hardware serial number.
  • serial: String
  • # The parent namespace to which this encoder belongs.
  • namespace: Namespace!
  • # The date and time at which the encoder was created.
  • createdAt: DateTime
  • # The date and time at which the encoder was last updated.
  • updatedAt: DateTime
  • # The current status of the encoder.
  • encoderStatus: EncoderStatus
  • # The audio and video capture session information that is collected every 4
  • # seconds.
  • captureSessionInfo: EncoderCaptureSessionInfo
  • # The broadcast with which the encoder is currently associated.
  • activeBroadcast: Broadcast
  • # A collection of user-defined name-value pairs.
  • extraProperties: [ExtraPropertyEncoder]
  • # A collection of security secrets.
  • accessKeys: [AccessKey]
  • # A collection of near-realtime metrics related to the encoder and its associated
  • # broadcast. Data is collected every 10 seconds while a broadcast is active.
  • nearRealTimeData: NearRealTimeData
  • # The URL to a TGZ file that contains custom encoder assets.
  • encoderAssetsUrl: String
  • # The custom encoder asset package name.
  • encoderAssetsName: String
  • # The custom encoder asset package vendor.
  • encoderAssetsVendor: String
  • # The custom encoder asset package version.
  • encoderAssetsVersion: String
  • # The authorization header added to the HTTPS request when downloading a custom
  • # encoder asset package.
  • encoderAssetsAuthorization: String
  • # The AES-256 decryption key used to decrypt a custom encoder asset package.
  • encoderAssetsDecryptKey: String
  • # A collection of recent log files for the encoder.
  • logFiles: [LogFile]
  • # Registration Data For The Encoder. Internal Use Only
  • registrationData: JSON
  • }