Listener ID and Meta ID¶
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
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. QuantumCast 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, QuantumCast 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.
[
{ "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
Please note the Predefined identifier IDs.
The ID can also be used without an associated provider. In this case use the
identifierid=qcor the simple listener ID transfer via stream URL: Parts of audio stream request
- 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 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
Predefined identifier IDs¶
ID |
Provider |
Homepage |
|---|---|---|
adswizz |
AdsWizz |
|
qc |
QuantumCast |
|
qy |
Quantyoo |