How to use broadpeak.io ?
Services
A broadpeak.io service defines the URL that your end-user OTT clients must use to access your contextualized streaming services.
There is no global definition of services as they are defined differently for each application (see the application sections for more details on the corresponding service definitions).
The API to create, read, update or delete Services can be found here (link).
Service Format
You can define only one combination of streaming format per service (e.g. DASH or HLS).
This level of granularity is intended to provide the maximum level of flexibility and to allow you to apply different policies, rules or contextualization based upon individual combinations. Therefore, you need to define multiple Service variants if you have multiple combinations (e.g. packaging formats, packaging formats versions, DRM versions, etc.).
For the Content Replacement application, a suffix-based naming convention allows linking of multiple service variants with a common "Media ID" defined through the SCTE 224 API to simplify batch processing.
More details can be found in the Handling Content Replacement slots section.
Service Tags
There are three types of tags defined in the platform for your services.
They refer to your environment and can be used to help you sort services by usage or readiness.
Tags are optional, informative only and have no impact on how services are processed or charged.
Tag | Typical use case |
---|---|
Lab | Quick test and evaluation |
Staging | Staging/pre-production stage |
Prod | Production |
Sources
A broadpeak.io source is typically defining where your streaming content can be retrieved from, and what type of content media is being used. For some applications, other objects are also defined as sources (e.g. Ad Server for Targeted Ad).
A source is uniquely defined (independently of applications).
The API to create, read, update or delete Sources can be found here: link.
Source Type
Not all types of sources can be used in each application.
The different types of sources are listed below:
Type | Description |
---|---|
Live | Linear content |
Asset | Fixed duration media file |
Asset Catalog | Library of assets |
Slate | Still picture |
Ad Server | Ad Decision Service |
Source Format
You can define only one combination of streaming format per source (e.g. DASH or HLS). This level of granularity is intended to provide the maximum level of flexibility and to allow you to select specific source variants in your services. Therefore, you need to define multiple source variants if you have multiple combinations (e.g. packaging formats, packaging formats versions, DRM versions, etc.).
For the Content replacement application, the following source types are supported.
Application | Original content | Replacement content (default or slot based) |
---|---|---|
Content replacement service | Live | Live Asset Slate |
Live and Asset sources attributes
Live and asset source have the same attributes.
Live sources must provide open manifests while asset sources must provide closed manifests.
The type of manifests delivered by a source is not checked by broadpeak.io but this may change in the near future.
Parameter | Description |
---|---|
Name | String (must be unique accross all applications) |
URL | Streaming URL on your origin/CDN |
Backup origin IP* | Backup IP address of origin to use in case the manifest cannot be read from the URL |
- Will soon be replaced by FQDN (Fully Qualified Domain Name)
Limitation of the free trial plan
You are welcome to test the platform and your services for free but there are a few limitations you should be aware of when using an account on a Free Trial commercial plan.
The commercial plan of your account is displayed in a label at the top of your web app, when you are logged in.
Once you reach those limits, you are welcome to upgrade to a pay-as-you-go plan by clicking the Upgrade icon in the web app. If you still need a few days or a few GB, we should be able to do something for you ;-) Feel free to reach out to our Customer Success team: you can send an email to [email protected] or use the online chat at the bottom right of this page.
Resource | Maximum limit |
---|---|
Trial period | 30 days |
Sources | 20 |
Services | 5 |
Egress data | 50 GB |
Content Replacement slots | 100 (based upon 1 Viewing Policy per slot) |
Depending on what interface you use (web app, API, end-user client requests to your broadpeak.io Content Replacement services), you will either get a notification or an error code and message when you reach any of those limits.
Updated 5 months ago