Introducing OTT endpoints
OTT endpoints are available in Quortex Play since June 26th 2024. This article describes this new configuration object and its benefits.
OTT endpoints are an evolution of publishing points. They are used for the same purpose, which is configuring URLs that players can use to stream content. OTT endpoints have the same structure as publishing points, as described further in this article.
However, OTT endpoints differ from publishing points in the way they are created.
Publishing points are automatically created as a combination of all inputs, processing, and targets for a pool.
In contrast, OTT endpoints need to be explicitly created by selecting an input, processing, and packaging.
OTT endpoints replace former publishing points.
Former publishing points are automatically converted into OTT endpoints, making this change seamless for you.
New OTT endpoints need to be explicitly created."
With OTT endpoints, the configuration philosophy changes and becomes an explicit action: you simply select the processing and packaging combinations you need for each input. With explicit creation, the list of generated URLs is reduced to what you actually need. The display of the list is limited to only the necessary URLs.
An OTT endpoint on Quortex I/O is the HTTPS endpoint a player will use to access a stream.
The general structure of a publishing point is as follows:
https :// <pool_id> .live.quortex.io / <input> / <processing> / <target> / index.<extension>
Let's break it down:
<pool_id> is an unique identifier for your pool, it cannot be changed.
<input> is the identifier of your choice for each input. Its default value is generated using the input name.
<processing> is the identifier of your choice for each processing configuration. Its default value is generated using the processing configuration name.
<target> is the identifier of your choice for each target. Its default value is generated using the target name.
<extension> depends on the target type, it cannot be changed.
Open the "OTT endpoints" tab as shown below.
Select your input, and select the required processing and packaging configurations that compose the endpoint.
Once the creation is complete, the endpoint appears active as shown:
Endpoints are listed and you can expand or collapse the list of endpoints per input:
One click filters are proposed to filter endpoints on the following states:
Warning: endpoints that currently have errors
Active: endpoints running fine
Configuring: endpoints being configured
Disabled: endpoints configured but currently not active
For instance, clicking on "Configuring" only displays the list of all endpoints being configured in the pool:
OTT Endpoints have replaced former publishing points, which were automatically created whenever a new processing/packaging combination was added for a given input.
To ensure upward compatibility of the API, the default behavior remains unchanged: OTT endpoints are automatically created if a new processing and/or packaging configuration is added via the API.
However, if you want to control the creation of OTT endpoints from the API, you need to include the "Publishing-Mode" header field in the API calls when adding new processing/packaging configurations. This prevents the automatic creation of the corresponding OTT endpoint. The "Publishing-Mode" must be set to "explicit" to get an explicit creation of OTT endpoints.
The "Publishing-Mode" header field is described in the API documentation. Below is an illustration from the API documentation:
What are OTT endpoints?
OTT endpoints are an evolution of publishing points. They are used for the same purpose, which is configuring URLs that players can use to stream content. OTT endpoints have the same structure as publishing points, as described further in this article.
However, OTT endpoints differ from publishing points in the way they are created.
Publishing points are automatically created as a combination of all inputs, processing, and targets for a pool.
In contrast, OTT endpoints need to be explicitly created by selecting an input, processing, and packaging.
OTT endpoints replace former publishing points.
Former publishing points are automatically converted into OTT endpoints, making this change seamless for you.
New OTT endpoints need to be explicitly created."
Benefits of OTT endpoints
With OTT endpoints, the configuration philosophy changes and becomes an explicit action: you simply select the processing and packaging combinations you need for each input. With explicit creation, the list of generated URLs is reduced to what you actually need. The display of the list is limited to only the necessary URLs.
General structure
An OTT endpoint on Quortex I/O is the HTTPS endpoint a player will use to access a stream.
The general structure of a publishing point is as follows:
https :// <pool_id> .live.quortex.io / <input> / <processing> / <target> / index.<extension>
Let's break it down:
<pool_id> is an unique identifier for your pool, it cannot be changed.
<input> is the identifier of your choice for each input. Its default value is generated using the input name.
<processing> is the identifier of your choice for each processing configuration. Its default value is generated using the processing configuration name.
<target> is the identifier of your choice for each target. Its default value is generated using the target name.
<extension> depends on the target type, it cannot be changed.
Creating an OTT endpoint
Open the "OTT endpoints" tab as shown below.
Select your input, and select the required processing and packaging configurations that compose the endpoint.
Once the creation is complete, the endpoint appears active as shown:
Monitoring OTT endpoints
Endpoints are listed and you can expand or collapse the list of endpoints per input:
One click filters are proposed to filter endpoints on the following states:
Warning: endpoints that currently have errors
Active: endpoints running fine
Configuring: endpoints being configured
Disabled: endpoints configured but currently not active
For instance, clicking on "Configuring" only displays the list of all endpoints being configured in the pool:
API considerations
OTT Endpoints have replaced former publishing points, which were automatically created whenever a new processing/packaging combination was added for a given input.
To ensure upward compatibility of the API, the default behavior remains unchanged: OTT endpoints are automatically created if a new processing and/or packaging configuration is added via the API.
However, if you want to control the creation of OTT endpoints from the API, you need to include the "Publishing-Mode" header field in the API calls when adding new processing/packaging configurations. This prevents the automatic creation of the corresponding OTT endpoint. The "Publishing-Mode" must be set to "explicit" to get an explicit creation of OTT endpoints.
The "Publishing-Mode" header field is described in the API documentation. Below is an illustration from the API documentation:
Updated on: 17/07/2024
Thank you!