AudioConfiguration

Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfiguration object and used for monitoring stream health.

Live StreamingMediaVideoReal-Time

Properties

Name Type Description
channels object
codec object
sampleRate object
targetBitrate object
View JSON Schema on GitHub

JSON Schema

ivs-audio-configuration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-interactive-video-service/refs/heads/main/json-schema/ivs-audio-configuration-schema.json",
  "title": "AudioConfiguration",
  "description": "Object specifying a stream\u2019s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the <a>IngestConfiguration</a> object and used for monitoring stream health.",
  "type": "object",
  "properties": {
    "channels": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "Number of audio channels."
        }
      ]
    },
    "codec": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "Codec used for the audio encoding."
        }
      ]
    },
    "sampleRate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "Number of audio samples recorded per second."
        }
      ]
    },
    "targetBitrate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Integer"
        },
        {
          "description": "The expected ingest bitrate (bits per second). This is configured in the encoder."
        }
      ]
    }
  }
}