> For the complete documentation index, see [llms.txt](https://audalaxy.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://audalaxy.gitbook.io/docs/listener-id-and-meta-id/listener-id.md).

# Listener ID

## Introduction

A unique listener ID can and should be provided along with the stream URL to get best results from Adservers and other services. By now we support one listener ID per stream. If you work with adswizz this could be the adswizz listener ID.

There a multiple ways to provide a listener ID:

* As part of the virtual stream url: <https://domain/programkey/format/aggregator/listenerid/?parameters>
* As query parameter: <https://domain/programkey/format/aggregator?listenerid=xyz>

As the listener ID is especially important for ad insertion, we support a different ID that can be used along with listener specific metadata that we call “Meta ID”.

You should provide a unique meta id for each listener if you want to use listener specific metadata. This works by adding a query parameter metaid=xyz to the stream url.

<https://domain/programkey/format/aggregator/listenerid/?otherparameter=123&metaid=xyz>

You can than use the same meta id subscribe to metadata events and get the metadata for the listener. see: [Playerservices](/docs/platform-description/networking-and-content-delivery.md#playerservices)

## Listener IDs and listener IDs containers (WORKING DRAFT)

The following description is planned to be supported in the future and works as a working draft. Audalaxy supports listener IDs. It is possible to pass one or more listener IDs in order to be able to use dependent functions.

If listener IDs have been integrated and a function requires it, Audalaxy uses the listener IDs and forwards them to the associated provider.

### Build the listener IDs container

Use an JSON array of identifiers with value to build the listener IDs container.

```json
[
    { "identifierid": "value" },
    { "identifierid": "value" }
]
```

`identifierid`

Unique ID to identify the provider.

The identifierid should be as short as possible, and can contain lowercase alphanumeric characters.

Type: string

Example: `adswizz`

{% hint style="info" %}
Hint

Please note the Predefined identifier IDs.

The ID can also be used without an associated provider. In this case use the `identifierid` = `qc` or the simple listener ID transfer via stream URL: [Parts of audio stream request](/docs/platform-description/networking-and-content-delivery.md#parts-of-audio-stream-request)
{% endhint %}

`value`

The value is the listernerID and should be a UUID.

Type: string

Example: `ad82903a-7ba0-11ec-90d6-0242ac120003`

### Submit Listener IDs

Request a stream via [StreamRoute ](/docs/platform-description/networking-and-content-delivery.md#streamroute)and submit listener IDs container as a base64 encoded string.

`idsv1`

Parameter used to pass listener IDs container as a base64 encoded string through the stream uri

Example:

```
idsv1=W3sicWMiOiI0ZThkNmQwNTEyOWI4ZDFjNmU2MTZiY2ZlYWIyYjlmMiJ9LHsiYWRzd2l6eiI6ICJFNDUzNTk1Mi02QkVGLTQxMjItOUNGMS1DQzFBOTUwQ0VCQzMifSx7InF1YW50eW9vIjogInh1bDhPbmdCSXMwOS1nOUptZmIyIn0seyJwbGF0Zm9ybWtleSI6ICJhcHAtbGlmZXJhZGlvLWF0In1d
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://audalaxy.gitbook.io/docs/listener-id-and-meta-id/listener-id.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
