Events, Modes and Phases
The player communicates its current state through various events and keeps track of assorted modes and phases. Events can be...
Developers
Player API
Methods
The Blue Billywig Player API has many functionalities. The list below shows all the methods that can be called on...Live Platform Documentation
Please find our Live Platform Documentation here.VAST Renderer
The VAST Renderer is a lightweight wrapper around the Blue Billywig player. The VAST renderer makes it possible to play...Command Queue
When using the player API it can be challenging to detect when it’s ready to be used. Use the command...
SAPI Reference Guide
Get started with SAPI
SAPI is the “Server API” that can be used to manage, publish and retrieve content from (web) applications. The SAPI Reference...API key management
Use an API key to create custom applications with Blue Billywig’s API. An API key contains a “shared secret” that.../sapi/audiotrack
The /sapi/audiotrack endpoint is used for managing Audiotracks. Audiotracks can be used to enrich a Media Clip with additional (mostly.../sapi/awsupload
The Blue Billywig Online Video Platform relies on AWS S3 for its file storage. AWS S3 is an extremely scalable.../sapi/language
The /sapi/language endpoint is a read-only endpoint that lists the configured set of languages for the current publication. 1.0 |.../sapi/cliplist (or /sapi/playlist)
/sapi/cliplist is the endpoint for managing static and smart playlists. 1.0 | Object structure “Cliplist” is the entity for storing.../sapi/embedcode
Use the /sapi/embedcode endpoint (read-only) to programmatically retrieve the embed code for a content object from the Online Video Platform.../sapi/mediaclip
/sapi/mediaclip is the endpoint for managing clip metadata. Media Clips are containers that combine: File/stream references Metadata References to other.../sapi/mediaasset
The /sapi/mediaasset endpoint is used for managing file/stream references, also referred to as “assets”. 1.0 | Object structure { id: "1635250054904314", status:.../sapi/playout
/sapi/playout is the endpoint for managing Playouts (player configurations). A Playout is stored as an object with a list of.../sapi/publication
A Blue Billywig Online Video Platform publication represents a set of video content and settings for one customer, website or.../sapi/subtitle
The /sapi/subtitle endpoint is used for managing subtitle tracks. Subtitle tracks can be used to enrich a mediaclip with additional.../sapi/transcoding
/sapi/transcoding is a read-only endpoint for the purpose of retrieving transcoding status and progress information. The status property of a...
Systems & Integrations
VMS RPC PHP client
1.0 | Introduction The VMS RPC client makes it possible to easily connect to the VMS by removing complexities, like...Google Analytics
In addition to using our Analytics dashboard to analyse video performance, it’s possible to connect a playout to your Google...AWS S3 upload credentials
Blue Billywig uses AWS S3 to store all files on your account. The Online Video Platform (OVP) provides an easy-to-use...
Native Player SDK
Web Based SDK
Data Security & Privacy
Content Security Policy (CSP)
Content Security Policy (CSP) refers to an extra layer of security to prevent attacks such as Cross Site Scripting (XSS)....Data Storage
All servers used for storing customer data are located in Ireland and wholly owned and operated by Amazon Web Services...
Advanced topics
Advanced Embedding
1.0 | Embed-Code Parameters Most playout settings can be overridden by embed-code parameters. Moreover, a selected subset of settings can...Advanced Playout Settings
1.0 Developer Options The Developer options can be found by selecting the Playout and navigating to the Miscellaneous tab. URL...JSON-LD Tagging
Our player supports JSON-LD tagging (“JavaScript Object Notation for Linked Data”). JSON-LD tagging is by default enabled in the playout...Direct AWS S3 Upload
The following example using fineuploader is mostly based on the documentation available at https://docs.fineuploader.com/. Example code can be found here...oEmbed Service
The oEmbed Service delivers a full media embed code from a URL. 1.1 | oEmbed JSON Output The default output...Implement Interactive Transcript
Interactive transcripts use .srt files to provide a written rendering of spoken phrases and a textual description of sounds. The...Fullbrowser Fallback
Viewers can watch video content in fullscreen mode by clicking the fullscreen button in the control bar (learn more about...
Need Support?Contact Support
Learn the basics
Our monthly Essentials training focuses on getting new users up to speed in the plaform. If you're ready to dive into interactive, be sure to check out our weekly interactive video workshop.
Sign up for a workshop