---
updatedAt: 2026-07-30T09:18:27.000Z
agentTools:
  siteIndex: https://developer.bitmovin.com/llms.txt
  projectIndex: https://developer.bitmovin.com/encoding/llms.txt
---

# Get Dolby Atmos Codec Configuration details

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "VOD Encoding API",
    "description": "Bitmovins API Reference Description",
    "version": "3.0",
    "termsOfService": "https://bitmovin.com",
    "contact": {
      "name": "Bitmovin Inc",
      "url": "https://bitmovin.com",
      "email": "support@bitmovin.com"
    }
  },
  "servers": [
    {
      "url": "https://api.bitmovin.com/v1",
      "description": "Bitmovin Server",
      "variables": {}
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    },
    {
      "ApiKeyAuth": [],
      "TenantOrgId": []
    }
  ],
  "paths": {
    "/encoding/configurations/audio/dolby-atmos/{configuration_id}": {
      "get": {
        "tags": [
          "Dolby Atmos Configuration"
        ],
        "summary": "Get Dolby Atmos Codec Configuration details",
        "operationId": "GetEncodingConfigurationsAudioDolbyAtmosByConfigurationId",
        "x-bitmovin": {
          "product": "vod"
        },
        "parameters": [
          {
            "name": "configuration_id",
            "in": "path",
            "description": "Id of the codec configuration",
            "style": "simple",
            "required": true,
            "schema": {
              "type": "string",
              "example": "cb90b80c-8867-4e3b-8479-174aa2843f62"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ResponseEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "properties": {
                            "result": {
                              "allOf": [
                                {
                                  "$ref": "#/components/schemas/DolbyAtmosAudioConfiguration"
                                },
                                {
                                  "description": "Dolby Atmos Audio Configuration"
                                }
                              ]
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseError"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "description": "Your Bitmovin API key",
        "name": "X-Api-Key",
        "in": "header"
      },
      "TenantOrgId": {
        "type": "apiKey",
        "description": "Your Bitmovin account organization",
        "name": "X-Tenant-Org-Id",
        "in": "header"
      }
    },
    "schemas": {
      "BitmovinResource": {
        "title": "BitmovinResource",
        "allOf": [
          {
            "$ref": "#/components/schemas/BitmovinResponse"
          },
          {
            "properties": {
              "name": {
                "type": "string",
                "description": "Name of the resource. Can be freely chosen by the user.",
                "example": "Name of the resource"
              },
              "description": {
                "type": "string",
                "description": "Description of the resource. Can be freely chosen by the user.",
                "example": "Description of the resource"
              },
              "createdAt": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "description": "Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ",
                "example": "2016-06-25T20:09:23.69Z"
              },
              "modifiedAt": {
                "type": "string",
                "format": "date-time",
                "readOnly": true,
                "description": "Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ",
                "example": "2016-06-25T20:09:23.69Z"
              },
              "customData": {
                "type": "string",
                "writeOnly": true,
                "description": "User-specific meta data. This can hold anything.",
                "additionalProperties": {
                  "type": "object"
                }
              }
            }
          }
        ]
      },
      "BitmovinResponse": {
        "title": "BitmovinResponse",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string",
            "readOnly": true,
            "description": "Id of the resource",
            "example": "cb90b80c-8867-4e3b-8479-174aa2843f62"
          }
        }
      },
      "AudioConfiguration": {
        "title": "AudioConfiguration",
        "required": [
          "bitrate"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/CodecConfiguration"
          },
          {
            "properties": {
              "bitrate": {
                "type": "integer",
                "format": "int64",
                "description": "Target bitrate for the encoded audio in bps",
                "example": 128000
              },
              "rate": {
                "type": "number",
                "format": "double",
                "description": "Audio sampling rate in Hz",
                "example": 48000
              }
            }
          }
        ]
      },
      "CodecConfiguration": {
        "title": "CodecConfiguration",
        "required": [
          "name"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/BitmovinResource"
          }
        ]
      },
      "DolbyAtmosLoudnessControl": {
        "title": "DolbyAtmosLoudnessControl",
        "required": [
          "meteringMode",
          "dialogueIntelligence",
          "speechThreshold"
        ],
        "allOf": [
          {
            "properties": {
              "meteringMode": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/DolbyAtmosMeteringMode"
                  }
                ],
                "description": "Algorithm to be used for measuring loudness. Recommended value is \"ITU_R_BS_1770_4\""
              },
              "dialogueIntelligence": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/DolbyAtmosDialogueIntelligence"
                  }
                ],
                "description": "Whether to use the Dialogue Intelligence feature, which identifies and analyzes dialogue segments within audio as a basis for speech gating. Must not be \"DISABLED\" for meteringMode \"ITU-R BS.1770-1\" or \"Leq (A)\", otherwise recommended value is \"ENABLED\""
              },
              "speechThreshold": {
                "type": "integer",
                "format": "int32",
                "minimum": 0,
                "maximum": 100,
                "description": "Specifies the percentage of speech that must be detected in the metered content before using the measured speech loudness as the overall program loudness. Given as an integer percentage between 0 and 100 (0% to 100%). Recommended value is 15"
              }
            }
          }
        ]
      },
      "DolbyAtmosPreprocessing": {
        "title": "DolbyAtmosPreprocessing",
        "properties": {
          "dynamicRangeCompression": {
            "description": "It indicates a gain change to be applied in the Dolby Atmos decoder in order to implement dynamic range compression.\n\nThe values typically indicate gain reductions (cut) during loud passages and gain increases (boost) during quiet passages based on desired compression characteristics.\n",
            "allOf": [
              {
                "$ref": "#/components/schemas/DolbyAtmosDynamicRangeCompression"
              }
            ]
          }
        }
      },
      "DolbyAtmosDynamicRangeCompression": {
        "title": "DolbyAtmosDynamicRangeCompression",
        "properties": {
          "lineMode": {
            "description": "Line mode is intended for use in products providing line‐level or speaker‐level outputs, and is applicable to the widest range of products.\nProducts such as set‐top boxes, DVD players, DTVs, A/V surround decoders, and outboard Dolby Atmos decoders typically use this mode.",
            "allOf": [
              {
                "$ref": "#/components/schemas/DolbyAtmosDynamicRangeCompressionMode"
              }
            ]
          },
          "rfMode": {
            "description": "RF mode is intended for products such as a low‐cost television receivers.",
            "allOf": [
              {
                "$ref": "#/components/schemas/DolbyAtmosDynamicRangeCompressionMode"
              }
            ]
          }
        }
      },
      "DolbyAtmosDynamicRangeCompressionMode": {
        "title": "DolbyAtmosDynamicRangeCompressionMode",
        "type": "string",
        "description": "Dynamic range compression processing mode",
        "default": "AUTO",
        "enum": [
          "AUTO",
          "NONE",
          "FILM_STANDARD",
          "FILM_LIGHT",
          "MUSIC_STANDARD",
          "MUSIC_LIGHT",
          "SPEECH"
        ],
        "x-enum-elements": [
          {
            "name": "AUTO",
            "description": "Film light dynamic range preset except DRC modes are provided as part of Dolby Atmos metadata inside ADM inputs"
          },
          {
            "name": "NONE",
            "description": "No dynamic range processing preset"
          },
          {
            "name": "FILM_STANDARD",
            "description": "Film standard dynamic range processing preset"
          },
          {
            "name": "FILM_LIGHT",
            "description": "Film light dynamic range processing preset"
          },
          {
            "name": "MUSIC_STANDARD",
            "description": "Music standard dynamic range processing preset"
          },
          {
            "name": "MUSIC_LIGHT",
            "description": "Music light dynamic range processing preset"
          },
          {
            "name": "SPEECH",
            "description": "Speech dynamic range processing preset"
          }
        ]
      },
      "DolbyAtmosDialogueIntelligence": {
        "title": "DolbyAtmosDialogueIntelligence",
        "type": "string",
        "description": "Whether to use the Dialogue Intelligence feature, which identifies and analyzes dialogue segments within audio as a basis for speech gating",
        "enum": [
          "ENABLED",
          "DISABLED"
        ],
        "x-enum-elements": [
          {
            "name": "ENABLED",
            "description": "Enable Dialogue Intelligence feature"
          },
          {
            "name": "DISABLED",
            "description": "Disable Dialogue Intelligence feature"
          }
        ]
      },
      "DolbyAtmosMeteringMode": {
        "title": "DolbyAtmosMeteringMode",
        "type": "string",
        "description": "Algorithm to be used for measuring loudness",
        "enum": [
          "ITU-R BS.1770-1",
          "ITU-R BS.1770-2",
          "ITU-R BS.1770-3",
          "ITU-R BS.1770-4",
          "Leq (A)"
        ],
        "x-enum-elements": [
          {
            "name": "ITU_R_BS_1770_1",
            "description": "ITU-R BS.1770-1"
          },
          {
            "name": "ITU_R_BS_1770_2",
            "description": "ITU-R BS.1770-2"
          },
          {
            "name": "ITU_R_BS_1770_3",
            "description": "ITU-R BS.1770-3"
          },
          {
            "name": "ITU_R_BS_1770_4",
            "description": "ITU-R BS.1770-4"
          },
          {
            "name": "LEQ_A",
            "description": "Leq (A)"
          }
        ]
      },
      "DolbyAtmosAudioConfiguration": {
        "title": "DolbyAtmosAudioConfiguration",
        "required": [
          "loudnessControl"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/AudioConfiguration"
          },
          {
            "properties": {
              "loudnessControl": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/DolbyAtmosLoudnessControl"
                  }
                ],
                "description": "Settings for loudness control"
              },
              "bitrate": {
                "type": "integer",
                "format": "int64",
                "description": "Target bitrate for the encoded audio in bps. Allowed values are: 384000, 448000, 576000, 640000, 768000, 1024000",
                "example": 448000
              },
              "rate": {
                "type": "number",
                "format": "double",
                "description": "Audio sampling rate in Hz. Only 48000 is allowed.",
                "default": 48000,
                "example": 48000
              },
              "preprocessing": {
                "allOf": [
                  {
                    "$ref": "#/components/schemas/DolbyAtmosPreprocessing"
                  }
                ]
              }
            }
          }
        ]
      },
      "Link": {
        "title": "Link",
        "required": [
          "href"
        ],
        "properties": {
          "href": {
            "type": "string",
            "description": "webpage target URL",
            "example": "https://bitmovin.com/encoding-documentation/bitmovin-api/#/reference/encoding/manifests/add-period"
          },
          "title": {
            "type": "string",
            "description": "Short description of the linked page",
            "example": "how to add a period to a manifest"
          }
        }
      },
      "Message": {
        "title": "Message",
        "required": [
          "type",
          "text"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/BitmovinResponse"
          },
          {
            "properties": {
              "type": {
                "description": "Message type giving a hint on the importance of the message (log level)",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessageType"
                  }
                ]
              },
              "text": {
                "type": "string",
                "description": "Message text",
                "example": "field must not be empty"
              },
              "field": {
                "type": "string",
                "description": "Name of the field to which the message is referring to",
                "example": "manifestId"
              },
              "links": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Link"
                },
                "description": "collection of links to webpages containing further information on the topic"
              },
              "more": {
                "type": "object",
                "description": "Service-specific information"
              },
              "date": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp when the message occurred",
                "example": "2016-06-25T20:09:23.69Z"
              }
            }
          }
        ]
      },
      "MessageType": {
        "title": "MessageType",
        "type": "string",
        "enum": [
          "ERROR",
          "WARNING",
          "INFO",
          "DEBUG",
          "TRACE"
        ]
      },
      "ResponseEnvelope": {
        "title": "ResponseEnvelope",
        "required": [
          "requestId",
          "status",
          "data"
        ],
        "properties": {
          "requestId": {
            "type": "string",
            "readOnly": true,
            "description": "Unique correlation id",
            "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333"
          },
          "status": {
            "description": "Response status information",
            "readOnly": true,
            "example": "SUCCESS",
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ]
          },
          "data": {
            "description": "Response information",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/ResultWrapper"
              }
            ]
          },
          "more": {
            "type": "object",
            "description": "Additional endpoint specific information"
          }
        }
      },
      "ResponseError": {
        "title": "ResponseError",
        "required": [
          "requestId",
          "status",
          "data"
        ],
        "properties": {
          "requestId": {
            "type": "string",
            "readOnly": true,
            "description": "Unique correlation id",
            "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333"
          },
          "status": {
            "description": "Response status information",
            "readOnly": true,
            "example": "ERROR",
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ]
          },
          "data": {
            "description": "Response information",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseErrorData"
              }
            ]
          }
        }
      },
      "ResponseErrorData": {
        "title": "ResponseErrorData",
        "required": [
          "code",
          "message",
          "developerMessage"
        ],
        "properties": {
          "code": {
            "type": "integer",
            "format": "int32",
            "readOnly": true,
            "description": "Contains an error code as defined in https://bitmovin.com/encoding-documentation/bitmovin-api/#/introduction/api-error-codes\n",
            "example": 1005
          },
          "message": {
            "type": "string",
            "readOnly": true,
            "description": "General error message"
          },
          "developerMessage": {
            "type": "string",
            "readOnly": true,
            "description": "More detailed message meant for developers"
          },
          "links": {
            "type": "array",
            "readOnly": true,
            "items": {
              "$ref": "#/components/schemas/Link"
            },
            "description": "collection of links to webpages containing further information on the topic"
          },
          "details": {
            "type": "array",
            "readOnly": true,
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "description": "collection of messages containing more detailed information on the cause of the error"
          }
        }
      },
      "ResponseStatus": {
        "title": "ResponseStatus",
        "type": "string",
        "enum": [
          "SUCCESS",
          "ERROR"
        ]
      },
      "ResultWrapper": {
        "title": "ResultWrapper",
        "properties": {
          "result": {
            "type": "object",
            "readOnly": true
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Dolby Atmos Configuration"
    }
  ]
}
```