How Can I Apply a Previously Supported Customization Options in the New Player

Our previous Player Embed Code used to include a selection of parameters and values to apply different customization options, directly from your Grab Code. 

As our New Player is much more versatile and robust, setting up different customization options requires to do so either by: 

  • Applying via the Player Wizard in the Portal.
  • Applying a Macro directly to the Player Tag.
  • Modifying the Player Tag in select cases only.


 

5Min Player Vs. ONE Player Customization

The following tables outline the previously available customization options including references on how to apply each one using our New Player.

Please see any of the following tables, or search for the relevant Grab Code parameter:

Note: Customization options highlighted in red do not have an implementation in the New Player for the following reasons:

  • Either they are implemented using another object/entity
  • Either they are no longer in use.

Note: Parameters highlighted in red have been deprecated either entirely or partially.

 

 

General Options

Customization Option Name Description

Where to Apply in the New Player & Portal

sid

Previously used to identify your account in the system and apply the required restrictions in the player.

This parameter has been partially deprecated and is no longer needed to identify your player as each company has unique Player IDs.

Regarding the restrictions, the New Player Tag requires you pass a different parameter known as 'bcid' (Buyer Company ID). This represents the Publisher Company and applies the appropriate Content Owner restrictions in accordance to it.

Apply via Portal:
Not required, auto-detected by user login that is assigned to a Company.

Player Tag Modification:
To verify that restriction are applying to your player verify that the correct 'bcid' is defined in your Player Tag.

For further details, please see How to create a static player tag.

 

playList

Previously used to pass single/multiple video IDs to be played back by the Player.

The New Player supports this method as an additional way to assign videos, in addition to any Playlist (a group of videos) assigned to the player via the Portal.

This option is applied by adding the 'vid' parameter and passing our new video IDs directly in the Player Tag.

Note: If a player has an assigned Playlist (group of videos) the injected video IDs in the Player Tag will be played back first, and after that the assigned playlist will continue.

Note: To assign a Playlist (group of videos) to a player, please see the following row 'videoGroupID'.

Apply via Portal:

Create Playlist:
Portal->MANAGE->Playlists tab->Create New Playlist.

For further details, please see How to create a playlist.

Assign Playlist to Player:
Portal->MANAGE->Players tab->Your Player Wizard->Metadata tab ->'Playlist' field.

For further details, please see How to assign a playlist to a player.

Player Tag Modification:
Add one or more video IDs using the Player Tag that will be played back before any Playlist assigned to the player.

For further details, please see How to create a static player tag.

videoGroupID

Previously used to assign a group of videos that were bundled under a single group ID to the player.

This parameter has been deprecated as the following methods are available.

In the Portal you can create a Playlist object and select multiple videos to be played back. This Playlist can then be assigned to the Player via the Portal without the need to edit the Player Tag.

Additionally, you can assigned multiple video IDs using the 'vid' parameter directly in the Player Tag.

Note: Video IDs added to the Player Tag will always be in addition to any existing Playlist assigned to the Player using the Portal and will not override it.

Apply via Portal:
Create Playlist:
Portal->MANAGE->Playlists tab->Create New Playlist.

For further details, please see How to create a playlist.

Assign Playlist to Player:
Portal->MANAGE->Players tab->Your Player Wizard->Metadata tab ->'Playlist' field.

For further details, please see How to assign a playlist to a player.

Player Tag Modification:
Add one or more video IDs using the Player Tag that will be played back before any Playlist assigned to the player.

For further details, please see How to create a static player tag.

width

Previously used to define the width of a specific player. 

The New Player's size is defined using the Player Wizard (the player setup interface in the Portal). 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Player size tab->Select 'Custom'->'Width' field.

For further details, please see Defining Player Size Using the Player Size Tab.

Player Tag Modification:
Deprecated in the New Player.

 

height

Previously used to used to define the height of a specific player. 

The New Player's size is defined using the Player Wizard (the player setup interface in the Portal). 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Player size tab->Select 'Custom'->'Height' field.

For further details, please see Defining Player Size Using the Player Size Tab.

Player Tag Modification:
Deprecated in the New Player.

ratio

Previously used to used to define the aspect ratio of the video in a specific player. 

The New Player's aspect ratio is defined using the Player Wizard (the player setup interface in the Portal). 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Video Location tab->Select either 'Force 4x3' or 'Force '16x9'.

For further details, please see Applying Video Location Options Using the Video Location Tab.

Player Tag Modification:
Deprecated in the New Player.

responsive

Previously used to define the player's size responsively to the parent <div> element on the web page.

The New Player can be defined as responsive using two methods:

  • Via the Player Wizard (the player setup interface in the Portal) - This will apply the setting across all players using the same Player Tag.
  • By applying a Player Macro - Passing a specific 'responsive' macro parameter directly to the Player Tag. This will override any other player size settings defined via the Portal.

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Player size tab.

For further details, please see Defining Player Size Using the Player Size Tab.

Player Tag Modification:
Specific override on Player Tag via Macro. 

For further details, please see How to Add 'responsive' Player Size Macro to your Player Tag.

align

Previously used to define the player's location within a larger parent element in the web page.

This parameter has been deprecated as you can define your player's location using custom CSS by targeting the Player Tag <div> 'id' or 'class' attributes.

Deprecated in the New Player.

Use custom CSS to position the Player Tag <div>. Target the <div> using the provided <div> 'id' or 'class'.

Note: This method can change between different player tags as each player ID is unique.

topHeader

Previously used to apply a custom top text header to your player.

The New Player includes an Extra module named 'Flat Top Current video info' That displays the title of the currently playing video in the player.

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Extras tab->Select 'Flat Top Current video info' Extra.

For further details, please see Applying player extras using the Extras tab and select the:'Flat Top Current video info' Extra.

Player Tag Modification:
Deprecated in the New Player.

 

 

 

 

 

Player Behavior

Customization Option Name Description

Where to Apply in the ONE Player

autostart

Previously used to define the player's playback method.

The New Player's playback can be defined using two methods:

  • Via the Player Wizard (the player setup interface in the Portal) - This will apply the setting across all players using the same Player Tag.
  • By applying a Player Macro - Passing a specific 'playback' macro parameter directly to the Player Tag. This will override any other playback settings defined via the Portal.

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Playback tab->'Start' field.

For further details, please see Applying Player Playback Options Using the Playback Tab.

Player Tag Modification:
Specific override on Player Tag via Macro.

For further details, please see How to Add a 'playback' Macro to your Player Tag. 

shuffle

Previously used to randomize the playback order of videos assigned to player either by video IDs or a Playlist.

The New Player's shuffle setting is defined using the Player Wizard (the player setup interface in the Portal).

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Playback tab->'Randomize videos' check box.

For further details, please see Applying Player Playback Options Using the Playback Tab.

Player Tag Modification:
Deprecated in the New Player.

volume

Previously used to set the initial volume of the player upon loading.

 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Playback tab->'Sound' and 'Initial volume' fields.

For further details, please see Applying Player Playback Options Using the Playback Tab.

Player Tag Modification:
Deprecated in the New Player.

mute

Previously used to mute the player's volume upon loading.

 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Playback tab->'Sound' field.

For further details, please see Applying Player Playback Options Using the Playback Tab.

Player Tag Modification:
Deprecated in the New Player.

loop

Previously used to loop through videos or a playlist assigned to the player.

 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Playback tab->'Videos to play before stopping' field.

Enter a number that is bigger than the number of videos in your playlist.

For further details, please see Applying Player Playback Options Using the Playback Tab.

Player Tag Modification:

Deprecated in the New Player.

sequential

Previously used to progress through a defined number of videos automatically before stopping.

Deprecated in the New Player.
isFL

Previously used to define the content of the videos displayed in the related videos pane.

Deprecated in the New Player. 
videoClickUrl

Previously used to define a URL to redirect users when clicking on the player.

In the New Player this can be applied using the following methods:

  • Apply the 'Click Throughs Module' Extra that will apply to your player.
  • Content Owners can define a click through URL on the video level that will override your player level extra. 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Extras tab->Select 'Click Throughs Module' Extra.

For further details, please see Applying player extras using the Extras tab and select the:'Click Throughs Module' Extra.

Player Tag Modification:

Deprecated in the New Player.

 

 

 

 

 

Semantic

Customization Option Name Description

Where to Apply in the ONE Player

Remove playlist and videoGroupID parameters

Previously used to apply the semantic video results.

In the New Player, to apply semantic search feature you are required to assign a semantic playlist to the player.

Important! This player must not have any other video IDs in the Player Tag.

 

Apply via Portal:
Create Playlist:
Portal->MANAGE->Playlists tab->Create New Playlist.

For further details, please see How to create a playlist.

Assign Playlist to Player:
Portal->MANAGE->Players tab->Your Player Wizard->Metadata tab ->'Playlist' field.

For further details, please see How to assign a playlist to a player.

Player Tag Modification:
Deprecated in the New Player.

fallbackType

Previously used to define a fallback video or playlist type when no video matches are returned from our semantic search engine.

Deprecated in the New Player.
fallback

Previously used to define a specific video or playlist ID (in relation to the selected fallbackType) to return a video or playlist when no video matches are returned from our semantic search engine.

Deprecated in the New Player.
categories

Previously used to define the scope of the semantic search results to a one or more specified video category verticals in our platform.

Deprecated in the New Player.

 

 

 

 

 

 

Color Options & Design

Customization Option Name Description

Where to Apply in the ONE Player

colorPallet

Previously used to define the color of the play and playback navigation bar in the player.

In the New Player, the controls color is defined using the Controls tab in the Player Wizard.

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Controls tab->'Background color' and 'Background alpha' fields.

For further details, please see Applying Player Controls Using the Controls Tab.

Player Tag Modification:
Deprecated in the New Player.

videoControlDisplayColor

Previously used to define the color of the controls bar in the player.

Deprecated in the New Player.
playerSkinType

Previously used to to define the player controls theme as wither Classic and Modern.

In the New Player, the controls skin is defined using the Controls tab in the Player Wizard.

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Controls tab->Select the required controls as either:

  • Controls_AOL_3 - for Classic skin
  • Controls_AOL_5 - for Modern skin

For further details, please see Applying Player Controls Using the Controls Tab.

Player Tag Modification:
Deprecated in the New Player.

templateId

Previously used to inherit a theme for the player using a predefined player template.

 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Metadata tab->'Template' field.

For further details, please see Applying General Options Using the Metadata Tab.

Player Tag Modification:
Deprecated in the New Player.

 

 

 

 

 

Related Videos Pane

Customization Option Name Description

Where to Apply in the ONE Player

relatedMode

Previously used to define the location of the related videos pane.

Applying the related videos pane in the New Player is done by applying a selected related Extra.

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Extras tab->Select required related videos pane Extra according to the following options:

  • Aol_Modern Bottom Related
  • Aol_Classic Right Related
  • Aol_Modern Right Related
  • Aol_Classic Right Auto Hide Related
  • Aol_Modern Right Auto Hide Related

For further details, please see Applying player extras using the Extras tab and search for the required extra described above.

Player Tag Modification:
Deprecated in the New Player.

relatedBottomHeight

Previously used to define the height of the related videos pane when selecting the related bottom option.

I the New Player, the bottom related height is defined using the 'Gap' field in the Config area of the 'Aol_Modern Bottom Related' extra.

 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Extras tab->Selected Related Extra->'Gap' field.

For further details, please see Applying player extras using the Extras tab. The locate the 'Gap' field in the Extra Config area.

Player Tag Modification:
Deprecated in the New Player.

relatedNumOfResults

Previously used to define how many videos will be displayed in the related videos pane.

Deprecated in the New Player.

 

 

 

 

 

Companion Banners

Customization Option Name Description

Where to Apply in the ONE Player

companionPos

Previously used to define the position of a companion banner in relation to the player.

Note: You can only inject a Companion banner into a custom <div> element specified on the web page.

Deprecated in the New Player.

hasCompanion

Previously used to define if the current player will display a companion banner.

In the New Player you can define Companion banners by adding them under the 'COMPANIONS' area in the Player Wizard's Ads tab.

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Ads tab->Add Companion.

For further details, please see Applying Ad Settings to the Player Using the Ads Tab. Then locate the 'COMPANIONS' area and click on 'Add Companion'.

Player Tag Modification:
Deprecated in the New Player.

innerMargin

Previously used to define the spacing margin between the player and the companion banner that is injected around the player.

Deprecated in the New Player.
cbCustomId

Previously used to target a companion banner to be displayed in an element defined on the web page.

In the New Player you can target a Companion banner to display in a selected web page element by going to the 'COMPANIONS' are in the Ads tab and entering the element ID in the Companion 'Element name' field.

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Ads tab->Add Companion->'Element name' field.

For further details, please see Applying Ad Settings to the Player Using the Ads Tab. Then locate the 'COMPANIONS' area and click on 'Add Companion'. After Clicking this field, the Companion configuration fields will appear. Locate the 'Element name' field and enter the element ID.

Player Tag Modification:
Deprecated in the New Player.

cbFailOverUrl

Previously used to define a custom image or banner that will be displayed if the player does not receive a fitting banner with the ad request.

In the New Player you can target a Companion banner to display in a selected web page element by going to the 'COMPANIONS' are in the Ads tab and entering the element ID in the Companion 'Failover' field. 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Ads tab->Add Companion-->'Failover' field.

For further details, please see Applying Ad Settings to the Player Using the Ads Tab. Then locate the 'COMPANIONS' area and click on 'Add Companion'. After Clicking this field, the Companion configuration fields will appear. Locate the 'Failover' field and enter the failover URL.

Player Tag Modification:
Deprecated in the New Player.

cbFailOverOnStart

Previously used to define if the custom image or banner will be displayed regardless if the ad request receives a fitting banner.

In the New Player you can target a Companion banner to display in a selected web page element by going to the 'COMPANIONS' are in the Ads tab and entering the element ID in the Companion 'Failover on start' check box. 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Ads tab->Add Companion->'Failover on start' check box.

For further details, please see Applying Ad Settings to the Player Using the Ads Tab. Then locate the 'COMPANIONS' area and click on 'Add Companion'. After Clicking this field, the Companion configuration fields will appear. Locate the 'Failover on start' check box and select it to apply the failover URL always.

Player Tag Modification:
Deprecated in the New Player.

 

 

 

 

 

Logo & Branding

Customization Option Name Description

Where to Apply in the ONE Player

logoUrl

Previously used to define a custom watermark logo that will be placed on the player.

In the New Player you can apply a custom logo watermark by applying the 'Now playing custom logo' Extra.

 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Extras tab->Select 'Now playing custom logo' extra.

For further details, please see Applying player extras using the Extras tab. The apply the 'Now playing custom logo' Extra.

Player Tag Modification:
Deprecated in the New Player.

vcdLogoUrl

Previously used to define a custom logo to be displayed in the player controls bar.

In the New Player you can apply a custom logo that will be displayed in the player controls bar by entering a URL to a custom logo in the 'Logo url' field that is displayed under the Player Wizard's Controls tab.

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Controls tab->'Logo url' field.

For further details, please see Applying Player Controls Using the Controls Tab. Then go to the 'Logo url' field.

Player Tag Modification:
Deprecated in the New Player.

vcdLogoClickUrl

Previously used to define a URL to redirect viewers when clicking on the custom logo in the video controls bar.

In the New Player you can apply a custom logo click URL that will redirect users when clicking on the controls bar logo by entering the redirection URL in the 'Logo click url' field that is displayed under the Player Wizard's Controls tab.

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Controls tab->'Logo click url' field.

For further details, please see Applying Player Controls Using the Controls Tab. Then go to the 'Logo click url' field.

Player Tag Modification:
Deprecated in the New Player.

 

 

 

 

 

Flash & HTML5 Actions

Customization Option Name Description

Where to Apply in the ONE Player

wmode

Previously used to define the layering mode of the player in relation to other HTML elements & layers in the web page. 

Deprecated in the New Player.
htmlPlayerForce

Previously used to force the player to load the HTML5 player instead of the Flash player.

The New Player can force the HTML5 player to load using two methods:

  • Via the Portal by defining the 'Player Widget type' as 'HTML5' using the Player Wizard's Metadata tab.
  • By applying a Player Macro - Passing a specific 'htmlplayerforce' macro parameter directly to the Player Tag. This will override the player's setting if the player is either set to 'SMART' or 'FLASH'. 

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Metadata tab->'Player Widget Type' field.

Select the required type according to the following options:

  • SMART - Auto detect device and inject the appropriate player. Either HTML5 or Flash.
  • HTML5 - Deliver only HTML5 player.
  • FLASH - Deliver only Flash player.

For further details, please see Applying General Options Using the Metadata Tab. Then go to the 'Player Widget Type' field.

Player Tag Modification:

Specific override on Player Tag via Macro. 

For further details, please see How to Add the 'htmlplayerforce' Macro to your Player Tag.

playerActions

Previously used to apply several customization  options such as: 

  • Ad pause button.
  • Social sharing buttons.
  • Embed link.

In the New Player social sharing options are applied using a Player Extra.

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Wizard->Extras tab->Select 'Share tuner' extra.

For further details, please see Applying player extras using the Extras tab. The apply the 'Share tuner' Extra.

Player Tag Modification:
Deprecated in the New Player.

 

 

 

 

 

Player Events & Actions

 

Customization
Option Name
Description

Where to Apply in the ONE Player

onLoad

Previously used to map a custom JavaScript function to the selected player event.

In the New Player this is a Macro that can be applied to your player to gain access to all of our new and improved player events including player actions.

Apply via Portal:
Portal->MANAGE->Players tab->Your Player Details Page->Add Macros->'onLoad' macro.

For further details, please see How to Apply a Supported Macro to Your Player using the Portal.

 

Player Tag Modification:
Specific override on Player Tag via Macro. 

For further details, please see How to Get Hold of Player Events using the 'onLoad' Macro.

onReady
onVideoDataLoaded
onPlay
onPause
onTimeUpdate
onVideoStartPlay
onPrerollStarted
onPrerollEnded
onVideoEnded
onContextStarted
Previously used to map a custom JavaScript function to the selected player event.

Player Tag Modification:
Deprecated in the New Player.

 

 

 

 

 

 

Have more questions? Submit a request