Concept of Sources

Sources are objects which point to content or, more generally resources, used in Services definition.

If you want to create a Service, you first need to create a Source.

Note that certain Services (such as DAI for instance, require you to create at least two Sources e.g. Live + Ad Server, or, Asset Catalog + Ad Server)

As shown below, there are 5 types of Sources which can be created, updated or deleted through the WebApp or the API.

Source type

Description

Parameters

Ad Server

A link to an ad server compliant with the VAST or VMAP protocols, which will tell broadpeak.io which ads should be played within an ad placement opportunity, depending on the context

Name: must be unique among all sources.
URL: must point to a valid ad server that broadpeak.io can connect to.
Query parameters: static or dynamic variables forwarded from the client request or inserted by broadpeak.io to communicate the context to the Ad Server.
Description: informational only.

Asset Catalog

A link to a directory containing DASH and/or HLS VOD assets

Name: must be unique among all sources.
URL: the common part of the path of all assets in the catalog. It must end with a /.
Sample: one of the VOD assets contained in the catalog. Combined with the above URL, it must link to a valid DASH or HLS VOD asset for validation purposes.
Backup origin IP: IP address of a backup server used when the primary address is unreachable.
Description: informational only.

Asset

A link to a DASH or HLS VOD asset that can be used as content in a Virtual Channel slot or a gap filler in an Ad Insertion service

Name: must be unique among all sources.
URL: must link to a valid DASH or HLS VOD asset.
Backup origin IP: IP address of a backup server used when the primary address is unreachable.
Description: informational only.

Live

A link to a DASH or HLS live channel that can be used as original source in a service or replacement content in a Content Replacement or Virtual Channel service

Name: must be unique among all sources.
URL: must link to a valid DASH or HLS live channel.
Backup origin IP: IP address of a backup server used when the primary address is unreachable.
Description: informational only.

Slate

A VOD asset produced from a still picture, that can be used as gap filler in a service

Currently requires you to contact our Customer Success team.


Did this page help you?