Supported Macros List

This article covers all our supported macros and is divided into three lists:

  • Enforcement macros - For use with Players (Portal/Player tag embed code).
    Go to the enforcement macros by clicking here.

  • Query string Macros - For use with Players via a Browser URL address bar.
    Go to the query string macros by clicking here.

  • Resolving Macros - For use with Ad Campaigns/Targeting Rules.
    Resolving macros are listen in the following article: Ad Campaign/Targeting Rule Resolving Macros (Placeholders).

 

Enforcement macros

Enforcement macros can be applied either to your Player in the Portal so anyone who takes the Player Tag will also have the macro included, or apply it directly to a specific player tag embed code using a text/HTML editor.

For further details, please see:

 

Parameter Description Supported Values Example
url

A parameter used to define a specific URL address that will allow Ad Campaigns and/or Targeting Rules to deliver ads if the detected embed page URL of the player matches the value of this macro.

This macro will only work if an Ad Campaign or Targeting Rule has the 'Strict Site Check' setting activated.

Note: For further details, please see How Strict Site Check works.

Enter the URL address of the page/domain where you would like to serve Strict Site Check Ad Campaigns / Targeting Rules.  url=aol.com
onLoad

A parameter used to invoke a custom JavaScript function in order to get hold of the Player object and allow you to tap into the exposed Player Events and Actions.

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

Any custom JavaScript function name. No need to add argument brackets.  onLoad=myFunction
htmlplayerforce

A parameter used to force the O2 Player to load as HTML5 Player and not Flash.

1; 0; true; false 

htmlplayerforce=true

htmlplayerforce=1

responsive

A parameter used to enforce responsive player sizing even if the player is set to a custom width and height.

 

1; 0; true; false 

responsive=true

responsive=1

360mobile A parameter used to enforce the player to render the video file as a 360 experience (orb stretching). 1; 0; true; false

360mobile=true

360mobile=1

 

disable360poster

A parameter used to enforce the player to render a 360 video poster as a regular click-to-play poster.

Note: This macro is relevant only for Click-to-Play players.

1; 0; true; false

disable360poster=true

disable360poster=1

hideskin A parameter used to hide the Player's controls skin (Play/Pause seek bar and social sharing buttons). 1; 0; true; false 

hideskin=true

hideskin=1

timelinepreview

A parameter used to force the Player to show/hide the timeline preview bubble.

Note: For further details, please see What is Time Line Preview.

1; 0; true; false

timelinepreview=true

timelinepreview=1

loadingplaceholder

A parameter used to force the Player into showing a static thumbnail placeholder instead of the Loading spinner. 

Important: It is not recommended to apply this macro without using the proper Static placeholder embed tag. For further details, please see What is the Player Placeholder Embed Tag

1; 0; true; false

loadingplaceholder=true

loadingplaceholder=1

posterstyle A parameter used to enforce the Player to display a button only poster that is more suitable for Mobile. button_only posterstyle=button_only
playback

A parameter used to enforce a selected playback option for the player playback option according to the following options: 

  • autoplay - The player will start playback of either Ads or content videos when the player loads.
  • autoplay_ad_only - The player will start the Ad playback when the player loads.
  • mouseover - The player will start playback when the viewer hovers over the player with the mouse cursor.
  • click - The player will start playback when the viewer clicks on the player.

autoplay

autoplay_ad_only

mouseover

click

playback=click
pauseIfOutOfTab A parameter used to force the player's video playback to pause if the viewer moves to another browser tab. 1; 0; true; false

pauseIfOutOfTab=true

pauseIfOutOfTab=1

pauseIfScrolledAway A parameter used to force the player's video playback to pause if the player is outside of the browser's viewport. 1; 0; true; false

pauseIfScrolledAway=true

pauseIfScrolledAway=1

sound

A parameter used to force the player's sound according to the following options:

  • normal - The sound of the player will use the volume settings defined in the player wizard.
  • muted - The player will be muted even if the player wizard is set to playback sound.
  • mouseover - The player will playback sound according to the defined volume settings of the player wizard only when the viewer hovers over the player with the mouse cursor.
  • mouseover/off - The player will playback sound according to the defined volume settings of the player wizard as usual, but when the viewer hovers over the player with the mouse cursor, the player will be muted.

normal

muted

mouseover

mouseover/off 

sound=normal

sound=muted

o2inline

A parameter used to force a muted ad autoplay experience on Android devices using Chrome browser versions prior to version 54.

Note: For further details, pelase see How to setup Preroll Mobie Ad Autoplay.

1; 0; true; false

o2inline=true

o2inline=1

o2inline_ios

A parameter used to force a muted ad autoplay experience on iOS devices with an OS prior to version 10. 

Note: For further details, pelase see How to setup Preroll Mobie Ad Autoplay.

1; 0; true; false 

o2inline_ios=true

o2inline_ios=1

forcereactions

A parameter used to force the advanced reactions set for the like button.

Note: For further details, please see What are Advanced Reactions.

1; 0; true; false

forcereactions=true

forcereactions=1

disableads A parameter used to force the Player to not serve any ads.  1; 0; true; false

disableads=true

disableads=1

adminibar A parameter used to force the folding minibar controls bar to be displayed when playing back ads. 1; 0; true; false 

adminibar=true

adminibar=1

enable_subscript

A parameter used to force the player to show subtitles if the video has a subtitles file attached to it.

Note: For further details, please see What are Closed Captions.

1; 0; true; false

enable_subscript=true

enable_subscript=1

subscript_language

A parameter used to force the player to show a specific language subtitle if the video has a relevant subtitles file attached to it.

Refer to ISO 639-1 column: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

Note: For further details, please see What are Closed Captions.

2 letter language code

en

ja

subscript_language=ja
upnext

A parameter used to force the player to show or hide the Up Next video popup.

Note: For further details, please see What is an Up Next Promotion.

1; 0; true; false 

upnext=true

upnext=1

timeline_preview_shape

Can be used the change the shape of the timeline preview

rectangle, square, circle (default)

timeline_preview_shape=square

timeline_preview_border Sets the weight of the border of the timeline preview 1 and above timeline_preview_border=4
loadingplaceholder Defined whether to use the loading placeholder or not 1; 0 loadingplaceholder=1
disable_3p Disable all third-party tracking and libraries (important for using Podcast Player on Yahoo O&O) 1; 0 disable_3p=1

 

 

 

Query string Macros

The following parameters and values can be passed in your browser's address bar URL query string.

Note: For further details, please see How to Pass a Query String Parameter Macro.

 

Parameter Description Supported Values Example
flashplayerforce

 A query string parameter used to force the O2 Player to load as Flash Player and not HTML5.

1; 0; true; false  

http://aol.com/video/new?flashplayerforce=true

http://aol.com/video/new?flashplayerforce=1

htmlplayerforce

A query string parameter used to force the O2 Player to load as HTML5 Player and not Flash.

1; 0; true; false 

http://aol.com/video/new?htmlplayerforce=true

http://aol.com/video/new?htmlplayerforce=1

forcereactions

A query string parameter used to force the Player to display the advanced like reactions. 

1; 0; true; false 

http://aol.com/video/new?forcereactions=true

http://aol.com/video/new?forcereactions=1

timelinepreview

A query string parameter used to force the Player to show/hide the timeline preview bubble.

Note: For further details, please see Time Line Preview.

1; 0; true; false  

 

http://aol.com/video/new?timelinepreview=true

http://aol.com/video/new?timelinepreview=1

hideskin A query string parameter used to hide the Player's controls skin (Play/Pause seek bar and social sharing buttons). 1; 0; true; false 

http://aol.com/video/new?hideskin=true

http://aol.com/video/new?hideskin=1

 
animatedposter A query string parameter used to force the player to show an Animated Poster instead of regular Click-to-Play static image. 1; 0; true; false  

http://aol.com/video/new?animatedposter=true

http://aol.com/video/new?animatedposter=1

 

 

Have more questions? Submit a request