Summary

Frequency's Javascript video player is built as an end all solution for short form video to support a myriad of third party players, media formats, advertising requirements, financial settlements, and reporting. This document describes the technical capabilities of the player. 

 Player can be loaded as html from https://static.frequency.com/player/<version>/index.html or as standalone js file http://static.frequency.com/player/<version>/_assets/interface.js

PlayerLite can be downloaded as javaScript file from https://static.frequency.com/player/<version>/playerLite.js

Version History

Version #Description
2.0.3

Bugfixes:

  • "autoplay" is ignored
  • playerLite memory leaks
  • VAST impression support
2.0.2

Bugfixes:

  • Player does not emit onVolumeChange event during playing ads 
  • Current time is not equal to Duration on video End 
  • Video doesn't pause at starting playback
  • Infinite SEEKING state after advertisement 
  • "autoplay" is ignored

Breaking changes:

  •  please provide source instead of source_id in video object for ads 
2.0.1
  • ad_tag no longer required - configuration kept in ad server
2.0.0
  • Ad handled via decisioning server
  • Unified constructors for Player and PlayerLite version
  • Accept resolution and bitrate parameters within player for ad request
  • [Player] Player can't use ad_tag provided by frequency services if player is loaded over HTTPS

  • [Player] Impossible to change AdsConfiguration for loadVideo method.

  • [Player] Event onProgress is received after state PAUSED

  • [Player] Subtitles are enabled by default on YouTube

Breaking changes:

  • Unified constructor for both versions
  • setSesion method is now asynchronous
  • adConfig object no longer accepts adCuePoints and adTag
  • video object is now compatible with API video object
1.3.7

Fixes:

  • AC-227 Youtube videos are not filling the entire player field of view
  • LG-154 [Player] versioning support when loading from CDN - Base path param
  • AC-212 All videos cease to play
  • LG-157 [Player] youtube video breaks play

 

1.3.6

Fixes:

  • LG-154 - [Player] versioning support when loading from CDN
  • LG-146 - [Player][Android 4.1.2] There is playback in the corner in small size
1.3.5Fixes:
  • Player doesn't save mute state for videos.
  • Edge Incorrect handling for Ended and Seek statuses for some videos. 
  • Player throws incorrect state ENDED (Nexus 7)
  • Duplicated events listeners

Player light build (with mp4 player only)

1.3.4Internal testing
1.3.3Support for different video urls (direct, embed)
1.3.2Offline events, bugfixes.
1.3.0

Fullscreen API, Activity events errors and change session support

1.2.1Possibility to change API url for activities
1.2.0Video activities, poster, bugfixes

1.1.0

 

Volume control functions and bugfixes.
1.0.0This is the first version of the Frequency player that supports VMAP, VPAID, VAST 2.0, VAST 3.0 advertising standards and MP4 and HLS video formats.
  


Browsers & Device Support

Frequency's player is supported on the following browsers and devices. 


Desktop BrowserVersionMp4HLSYouTubeVimeoDailyMotion
IE10+YesNoYesYesNo
Edge13+YesYesYesYesYes
FF30+Yes41+YesYesYes
Chrome35+YesYesYesYesYes
Opera30+YesYesYesYesYes
Safari6.2+YesYesFlashYesFlash
Mobile OSVersionMp4HLSYouTubeVimeoDailyMotion
Android4.4+YesYesYesYesNo
iOS6.0+YesYesYesYesNo
Windows Phone8.1+YesNoYesYesYes

Players & Formats

The Frequency Javascript video player provides a Javascript class and a set of constructs that makes short form video playback with advertisement a simple task. The supported video formats are:

Player / FormatExample
DailyMotion (in dev)http://www.frequency.com/video/funny-animals-vines-february-2016-part-5/251068904?cid=4-2014064
Vimeohttp://www.frequency.com/video/while-you-were-away/253184882?cid=4-2070
Youtube

http://www.frequency.com/video/game-of-thrones-season-6-trailer-2-hbo/253199983?cid=4-8621

H264http://once.unicornmedia.com/now/stitched/mp4/8e6db0ba-80b7-4c02-b328-07d1af9ee5d3/7aab0ba9-921d-4d44-8ee9-938049fb3572/a07db314-1579-44ce-93cd-ee9c63cfc294/3eccdfc7-4e10-4f4e-b07f-17ab769ba565/content.mp4
HLShttp://once.unicornmedia.com/now/adaptive/m3u8/95286106-b310-4123-abd8-76e9b8fa5ccb/2d45f3f5-1836-46b2-9b48-125be611c8eb/be919c0f-034f-4008-b288-3e7ff1523002/content.m3u8?UMLITERAL%3Dfkey%2C14%26guid 

Fullscreen API support

 The Frequency Javascript video player provides wrapper around Fullscreen API. Supported browsers:

Desktop BrowserVersion
IE11+
Edge12+
FF10+
Chrome15+
Opera15+
Safari5.1+
Mobile OSVersion
Android-
iOS-
Windows PhoneIE Mobile 11+

Class Documentation

Player Class

The Player class plays videos from HTML5 web apps. The Player supports advertisement playback and beaconing along with standalone video playback transparently. 

Param
Type
Description
elementString or DOMNodeNode selector or DOMNode the player will be inserted into.
optionsObjectFrequency.Player.Options object 

Player Constructor

new Frequency.Player({
    config: {// optional
        basePath: '.'
    },
    session: {// mandatory
        'x-frequency-auth': '013ffaa2-a64e-4974-a9ee',
        'x-frequency-deviceid': '5680c4f2-e3fd'
    },
    adConfig: {// optional
        minBitrate: 100,
        maxBitrate: 5000,
        maxResolution: '720p',
        deliveryFormat: 'progressive'
    },
    video: {// mandatory
        "video_id": "12345",// mandatory
        "title": "Gangnam Style",
        "description": "Good Dance Video",
        "image_url": "http://image1.frequency.com/uri/w{width}_h{height}_ctrim_tt1406242656000/_/item/1/8/3/2/Kelsey_Grammer_Welcomes_6th_Child_183236961_thumbnail.jpg",
        "deep_link": "frequency://video/12345/-/4-895",
        "media_url": "http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4",// mandatory
        "media_type": "h264",
        "media_types": ["h264", "hls"],
        "resolution": "1080p",
        "resolutions": ["1080p", "720"],
        "duration": 3600,
        "source": "Online",// mandatory
        "source_id": "X8yZ4f",
        "source_url": "http://www.eonline.com/videos/223996/kelsey-grammer-welcomes-6th-child",
        "score": 126,
        "meta_tags": [
            {"network": "Machinima"},
            {"genre": "Gaming"},
            {"subgenre": "Action"},
            {"series": "Random LOL Moments"},
            {"season": "1"},
            {"episode": "489"}
        ],
        "channel": {
            "channel_id": "4-1234",
            "title": "News",
            "image_url": "http://image1.frequency.com/uri/w{width}_h{height}/_/user/1/8/5/0/1385085551000_abc_nightly_news_1850953_avatar.jpg",
        },
        "referrer_link": "https://twitter.com/zgutierrez90/status/446459061161451520",
        "ad_tag": "https://pubads.g.doubleclick.net/gampad/ads?sz=640x480&iu=%2F105934051%2FtestAdUnit&impl=s&gdfp_req=1&env=vp&output=vast&unviewed_position_start=1&url=[referrer_url]&description_url=[description_url]&correlator=1485732061110",// optional
        "ad_cue_points": [0],// mandatory for ads
        "date_publish": "2014-07-29T14:18:10Z",
        "date_available": "2014-07-29T14:18:10Z",
        "date_expired": "2014-07-29T14:18:10Z",
        "last_updated": "2014-07-29T14:18:10Z",
        "autoplay": true
    },
    events: {// optional
    	onStateChange(state) {
			...
		}  
    }
})

           

Constructs a Player object for video playback.

Constructor also accept element, which will be replaced by video player (* PlayerLite can only accept existing video element)

// element provided as string
new Frequency.Player('#player', {...});
 
// element provided directly as DOM node
new Frequency.Player(document.getElementById('player'), {...});
new Frequency.PlayerLite(document.getElementsByTagName('video')[0], {...});


Parameters:

video - The Frequency.Player.Video object containing the video url, playback start position along with whether to auto play the video once loaded.

events - The Frequency.Player.Events object to bind playback event listeners.

session - User session tokens required for activities.

api - Api configuration for activities.

config - player configuration.

Returns:

An initialized Player object.


Player Methods

play

play()

Plays the currently loaded video.

Parameters:

None

Returns:

void


pause

pause()

Pauses the currently playing video.

Parameters:

None

Returns:

void


seekTo

seekTo(time:Number)

Seeks to a specified time in the video.

Parameters:

time - The time position (in seconds) in the video to jump to. 

Returns:

void

  

getDuration

getDuration()

Returns the duration of the currently playing video in seconds.

Parameters:

None

Returns:

Number - The video duration in seconds.


getState

getState()

Returns the video player's current play state.

Parameters:

None

Returns:

Number - The number representing the video playback state. (see video states).


getCurrentTime

getCurrentTime()

Returns the lapsed time since the video start in seconds.

Parameters:

None

Returns:

Number - The lapsed video playback time in seconds.


loadVideo

loadVideo(video)

Loads the video specified by the video object. This does not auto play the video. The onMediaReady event would need to be monitored along with a subsequent video play() method call to cause the loaded video to play.

Parameters:

video - video object described in Player Fields section.

Returns:

void

 

setVolume

setVolume(volume:Number)

Sets player volume.

 Parameters:

 volume - New volume value for player. Value must be in range 0-100 

Returns:

void 

getVolume

getVolume()

Returns current volume for the player.

Parameters:

 none

Returns:

 Number

 

isFullscreen 

isFullscreen()

Returns true if player is in fullscreen mode.

Parameters:

 none

Returns:

 Boolean

requestFullScreen

requestFullScreen()

Tries to put player in fullscreen mode.

Parameters:

 none

Returns:

 none


exitFullScreen

exitFullScreen()

Tries to disable fullscreen mode for player.

Parameters:

 none

Returns:

 none

setSession

setSession(session:Object)

Updates player session for activities.

Parameters:

session - Session object ({'X-Frequency-Auth': '...', 'X-Frequency-DeviceId': '...'})

Returns:

void

addEventListener

addEventListener(event:String, callback:String)

Adds a listener function for the specified event. 

Parameters:

event - The event to register for listening. (See Player events)

callback - The event handler method of code block.

Returns:

void 


removeEventListener

removeEventListener(event:String, callback:String)

Removes a listener function for the specified event.

Parameters:

event - The listening event. (See Player events)

callback - The event handler method or code block.

Returns:

void


Player Video Class

Frequency.Player.Options.Video

The Player Video class is a video data structure used for video player initialization along with video playback.


Player properties

version - current player version

Player Ads Configuration

Frequency.Player.AdsConfig

Ad Fields

Param

Type

Description

adTagUrl

String

VAST document URL

adCuePoints

Number[]

array of cue points (seconds or "preroll", "postroll")

Player Events Class

Frequency.Player.Events

The Player Events class defines all the events that listeners can register on.

Event

Type

Description

onError

Function

An error occurred.

onReady

Function

JS player ready for actions.

onMediaReady

Function

Media player ready.

onStateChange

Function

Player state has changed.

onProgress

Function

Players progress changed.

onVastEventFunctionVast Ad Event occurred.
onVolumeChangeFunctionPlayer volume has changed.
onActivityErrorFunctionActivity call failed.

Video Playback States

State

Value

Description

UNKNOWN

undefined

Player state is unknown, player setup process did not finished.

UNSTARTED

-1

Player media ready but pending play action.

ENDED

0

Player finished playback.

PLAYING

1

Player is currently playing a video.

PAUSED

2

Player paused.

BUFFERING

3

Player is buffering.

LOCKED

4

Player locked by internal action.

 

SEEKING5Played seeking.
ERROR6Player interface returned error.

 

Code Examples

Demo

Frequency Player Demo