> This page is for Harmonic.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://mediakind.ferndocs.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://mediakind.ferndocs.com/_mcp/server.

# Check audio meta data

POST https://device.example.com:443/cluster1/vos-api/configure/v1/validate_audio_metadata
Content-Type: application/json

Check if missing audio meta data in source.

Reference: https://mediakind.ferndocs.com/harmonic/api/vos/configure-source/check-audio-meta-data

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Body (application/json)

This endpoint expects a com.harmonicinc.vos.app.configure.model.source.AudioGrooming.

- `tracks` (list of com.harmonicinc.vos.app.configure.model.source.AudioTrack, optional) — Essential metadata of audio tracks

## Response

### 200

Success

### 201

Created

## Errors

### 400 Bad Request Error

Missing grooming info

- `any`

### 401 Unauthorized Error

Unauthorized

- `any`

### 403 Forbidden Error

Forbidden

- `any`

### 404 Not Found Error

Not Found

- `any`

## Types

### com.harmonicinc.vos.app.configure.model.source.AudioTrack

- `locator` (com.harmonicinc.vos.app.configure.model.source.AudioTrackLocator, required)
- `audioPreferredProperties` (list of com.harmonicinc.vos.app.configure.model.source.AudioPreferredProperty, optional) — Preferred audio properties of audio track for mapping
- `audioStreamType` (enum, optional) — Input audio stream type
  - Allowed values: `MPEG`, `AAC`, `DOLBY_E`, `DOLBY_DIGITAL`, `DOLBY_DIGITAL_PLUS`, `DOLBY_AC4`, `AES3`, `PCM`
- `audioTrackIndex` (integer, optional) — Index of the audio track
- `audioTrackStreamType` (integer, optional) — Type of the audio stream; Stream Type defined at http://en.wikipedia.org/wiki/Program-specific_information#Elementary_stream_types
- `backUpAudioTrackIndex` (integer, optional) — Index of the backup audio track
- `countryCode` (string, optional) — Optional Country Code to append to the Language Code
- `delayAdjustment` (integer, optional) — Specifies the audio delay in millisecond in order to synchronize the video stream, valid range from -500 to 500 ms
- `dolbyEProgramNumber` (integer, optional) — Source DolbyE program number for the audio (range 1 to 8)
- `forceAtmos` (boolean, optional) — Force Dolby Atmos detection for E-AC-3
- `hasNielsenWatermark` (boolean, optional) — Indicate this audio stream has Nielsen watermark
- `hlsCustomCharacteristicsValue` (string, optional) — Custom characteristics for HLS
- `inputLevel` (integer, optional) — Audio input level
- `insertNullPidOnSignalLoss` (boolean, optional) — Indicate insertion of nulls when there is audio signal loss
- `isDefault` (boolean, optional) — Indicate this audio is default
- `labels` (list of string, optional) — Labels identifier of the audio track
- `silenceDetectionThreshold` (integer, optional) — Silence detection threshold (-65dB)
- `skipProcessing` (boolean, optional) — Indicate this audio stream will not be processed and will not be mux.
- `streamName` (string, optional) — Custom stream name
- `useDiscovery` (boolean, optional) — Indicate the usage of the discovery to know the audio input level

### com.harmonicinc.vos.app.configure.model.source.AudioTrackLocator

- `channelId` (string, optional) — Specify how to locate an audio track
- `channelList` (list of com.harmonicinc.vos.app.configure.model.source.Smpte302mChannelList, optional) — For SMPTE302M Audio channel selection on audio stream and audio channels
- `pid` (integer, optional) — Pid of the audio stream

### com.harmonicinc.vos.app.configure.model.source.AudioPreferredProperty

- `iso639AudioType` (enum, optional) — Preferred audio ISO639 type. Set to null to match any type
  - Allowed values: `UNDEFINED`, `CLEAN_EFFECTS`, `HEARING_IMPAIRED`, `VISUAL_IMPAIRED_COMMENTARY`, `PRIMARY`, `NATIVE`
- `language` (string, optional) — Preferred audio track language. Expects 3 letter abbreviation based on ISO639 (e.g. ENG, FRA) and set to null to match any language

### com.harmonicinc.vos.app.configure.model.source.Smpte302mChannelList

- `indices` (list of integer, optional) — Specify how to locate all audio tracks of the audio pid. The index order matters for mapping the channel position
- `pid` (integer, optional) — Pid of the audio stream that is used for selection

## Examples

### Example 1

**Request**

```json
{}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Example 2

**Request**

```json
{}
```

**Response**

```json
{}
```

**SDK Code**

```python
import requests

url = "https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://device.example.com/cluster1/vos-api/configure/v1/validate_audio_metadata")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```