logo

Freewheel

This guide explains how to set up THEOplayer in combination with FreeWheel, an advertisement vendor.

Table of Contents

SDKs

Web SDK Android SDK iOS SDK tvOS SDK Android TV SDK Chromecast SDK
Yes No No No No N/A

Prerequirements

There are two prerequirements in order to continue with this guide:

  1. This guide expects that you have a THEOplayer license. If you aren't using THEOplayer yet, you can start your free trial here. Be sure to have THEOplayer version 2.X or higher with the FreeWheel module enabled.
  2. This guide expects that you are a FreeWheel client and that you have ad campaigns ready for use. Information on FreeWheel can be found at https://freewheel.com.

If you can place a checkmark next to these fields, you are good to go.

How to integrate FreeWheel

Code Examples

This example explains how you do a basic implementation of FreeWheel in THEOplayer.

Web SDK

The FreeWheel integration is currently only available on the Web SDK.

After setting up your basic page containing THEOplayer, you need to add the FreeWheel MRM client SDK to the page:

<script type='text/javascript' src='https://mssl.fwmrm.net/libs/adm/6.xx.x/AdManager.js'></script>

Next, you add a FreeWheelAdDescription to your source that specifies the FreeWheel tokens. An example sourceDescription could look like this:

...
<!-- make sure to link to a valid version number -->
<script type='text/javascript' src='https://mssl.fwmrm.net/libs/adm/6.xx.x/AdManager.js'></script>
...

player.source = {
    sources : [{
        src : 'your.m3u8',
        type : 'application/x-mpegurl'
    }], 
    ads: [{
        integration: 'freewheel',
        networkId: 96749,
        assetId: 'DemoVideoGroup.01',
        profile: 'global-js',
        assetDuration: 22,
        adServerUrl: 'https://demo.v.fwmrm.net/ad/g/1',
        siteSectionId: 'DemoSiteGroup.01',
        cuePoints: [{ adUnit: 'preroll' }]
    }]
};

We configure cuePoints in this example. This is needed for some set-ups or completely optional for others. THEOplayer will create a FreeWheel temporalSlot behind the screens, which is a request to schedule an advertisement at said point. It is up to FreeWheel (and the campaign settings) to decide whether or not it will insert an advertisement at this requested time. Not all campaigns need it and for some campaigns the requested cuePoints might even be ignored by FreeWheel.

Android SDK

This API is currently not available on the Android (TV) SDK.

iOS SDK

This API is currently not available on the iOS (/tvOS) SDK.

Resources

The following resources provide more information:

  1. THEOplayer Getting Started Guide
  2. FreeWheelAdDescription
  3. FreeWheel website
github
Make sure to follow us on GitHub!
THEO-logo-white
twitter
facebook
linkedin
Copyright © 2020. All Rights Reserved.
Leuven
New York
Singapore
Barcelona