Templates

Owned by Lior W. (Unlicensed)
Last updated: Feb 08, 2023 by Lior Weissbrod
19 min read

List of Template

Templates define how the players should look and act.

Next to each name is some basic info and the (far right side) option to edit/duplicate/archive this template.

Add/Edit Template

When you click to add a new template or click to edit an existing one, you are presented with many useful options, most of which optional!

Please remember to click Save / Deploy after you’re done.

Clicking only Save (which is possible only when editing existing templates) saves the changes as draft. The changes won’t be reflected live until you then click Deploy.

Be aware if you only click Save, a red dot will appear next to the relevant template to indicate it’s not deployed live. This will also happen if you choose Preview!

OutStream

Main

  1. Name (required) - the name of the template. Tip: use main keywords to know which template to choose when using .

  2. Description - any note you like to add about this template.

Performance

Left side

If clashed, the following options will give priority to the more strict ones.

For example, an Error Limit of 5 won’t matter if Maximum Waterfall Runs is 4, since the session will stop before having the possibility to reach Error Limit.

  1. Vast Retry - number of consecutive waterfall retries.

  2. Error Limit - the maximal number of full waterfall runs in a row that do not generate an impression. Once an impression is generated, the counter is reset to 0.

  3. Maximum Impressions - limit the amount of impressions per player session.

  4. Maximum Waterfall Runs - number of seconds to wait between each waterfall run.

  5. Midroll Time - number of seconds to wait between each waterfall run.

Right side

If clashed, the following options will give priority to the less strict ones.

For example, if you choose both Autoplay and Play On View, then Autoplay will override Play On View since Autoplay is more general.

  1. Autoplay - enable to make the player play video ads regardless if the player is visible or not.
    We suggest to disable it in order to avoid policy violations in premium such as Google.
    * Technically, defines whether startAd is called automatically. If FALSE, startAd should be called after getting the onLoad callback event.

  2. Loop - defines whether to continue looking for more ads at the end of the first impression.
    Disabling it is equal to setting a Maximum Impressions of 1.

    • Technically, if loop is FALSE, it will only play one ad. When using Video Content (as a preloader), it will also define whether or not to loop it.

  3. Pause On Unseen - if set to TRUE, the player will pause when it is out of view.

  4. Pause On Blur - if set to TRUE, the player will pause when the browser window loses focus.

  5. Requests On View - send requests to only when the player is in view.

  6. Check Tab Is In View - consider “in view” only if the relevant browser tab is actually in focus.

  7. Player Load On View - Send Inventory only if the player is in view. Without Inventory, the player will be loaded but not open video ads.

  8. Play On View - enable to make the player play video ads only if the player is in view.
    * Technically, if set to TRUE, the player will automatically check the viewability and will call startAd only when it is in view.
    We suggest to enable it in order to avoid policy violations in premium such as Google.

In general:

Appearance

Player Caption

Enable Advertising Label - if set to TRUE, show an advertising label in the caption above the player view.
We suggest to enable it in order to avoid policy violations in premium such as Google.

Player Mode

Can be set to:

  1. In Read - never float the player, only show it regularly (e.g. in the middle of the page).

  2. Floating (default) - make the player become Sticky only after it’s seen in a regular way (e.g. in the middle of the page) and the user scrolls away from it.

  3. Sticky - always float the player and never show it regularly (e.g. in the middle of the page).
    We suggest to never enable Sticky in order to avoid policy violations in premium such as Google.

Player Mode Settings

These settings only show up for Floating and Sticky whereas Sticky’s options are a subset for Floating’s:

  1. Close Floating Button - if set to TRUE, show a close button only when the player is Floating that will disable the floating option.

  2. Float On Bottom - the player will float both when scrolled down past it and above it, and not just down past it.
    If you enabled Autoplay, we suggest to also enable Float on Bottom to make sure the player is only autoplayed when visible (meaning even if it starts floating to begin with, it will at least be visible).

  3. Float On Impression - the player will start floating only after an impression.

  4. Resizing Method - define the size of the player when it is Floating, by scale to the original size
    or by fixed width and height sizes in pixels.

  5. Size When Floating or Width/Height - based on Resizing Method.

  6. Position (also for Sticky) - choose the corner of the screen where the player will appear and "float" to.
    Note Top and Bottom mean 100% of the page’s width.

  7. Margins - based on Position.
    Note only Top and Bottom also offer Background Color - change/type the background color of the caption above the player view from the default.

Player Sizing

  1. Player Size - Choose Responsive so the player's size will adapt to the frame in which it is wrapped, maintaining an aspect ratio of 16:9. Choose Fixed (size) to manually define both the Width and Height of the player.

  2. Maximum Width - defines the maximum width of the player, as completion of Player Size.

  3. Minimum Height - defines the minimum height, as completion to Player Size.

  4. Z-Index (Overlapping) - specifies the stack order of the player. Overlapping elements with a larger z-index cover those with a smaller one.
    Tip: if the publisher asks you not to cover their elements, choose a lower z-index, and vice versa.

  5. Opening Animation - If set to TRUE, the player will open with an animation.

  6. Custom CSS - use your own CSS to change the appearance of the player.

Extensions

Preloader

An element that can be shown between video ads.

Preloader Type None

Don’t present anything between video ads.

Note: this might mean the player will shrink when there are no ads, and expand when there are ads. This is considered a violation of (that requires elements to never shrink/expand)!
Alternatively, if settings such as Show Player and/or Show Position are Enabled, this means there’ll be an empty square whenever there are no video ads, which might draw complaints and confusion from your .

It’s therefore recommended to choose one of the other Preloader Types.

Preloader Type Content

Content means Video Content, meaning to show video content between video ads.

  1. Add as many links as you want to create playlists.
    Each video requires a URL, however the Click Through URL is optional
    URL: Link to video content (usually mp4 file) you would like to use.
    Click Through URL: The link where users will be redirected to when clicking on the Video

  2. Autoplay Content - if set to TRUE, the video content will start playing automatically.
    If not, it will be Click-to-play.

  3. Random Contents - if set to TRUE, the order in which the different videos are reproduced is random.

  4. Poster - the link to an image that will be shown while the content is loading.

  5. Preroll - defines the number of preroll ads that will try to generate.
    Can't be more then 4 prerolls.

  6. Preroll Time Out (only if Preroll was chosen) - the time for the player to generate preroll ads.
    Must be larger then 3 seconds.

Preloader Type Image

Show images between video ads.

  1. URL - Link to an image file you would like to use.

  2. Click Through URL - The link where users will be redirected to when clicking on the image.

Preloader Type JS

Use HTML code between video ads. This HTML code will be put inside an iframe.

  1. Full Html - if the code uses <head> and <body>, respect it. If it’s disabled, <head> and <body> tags will be stripped and the entire HTML will be put into <body>.

  2. Close Button - if set to TRUE, show a close button when the preloader appears.
    We suggest to enable it. Since the preloader might appear floating, enabling it should avoid policy violations in premium such as Google.

  3. Width and Height - size of the iframe in pixels.

  4. URL - link to the HTML file that you would like to use.
    Note it must have a TXT extension, not HTM or HTML!

  5. Background Color - choose or type the color you would like to use for the iframe's background.

Preloader Type Holder

Used in special cases as a placeholder.

Passback

An HTML code (that will also remain) after the player finishes up its session. This HTML code will be put inside an iframe.

  1. Passback URL - a link to a HTML file that will be called once the player has finished all its retries.
    Note it must have a TXT extension, not HTM or HTML!

  2. Width and Height - size of the iframe in pixels.

  3. Passback Priority - if set to TRUE, show the passback, even if there is a preloader.
    It is only relevant in cases where both a preloader and a passback are defined.

  4. No Float - if set to TRUE, prevent the iFrame with the passback from Floating (only if the player itself uses floating).

  5. No Passback After Impression - don't show passback after there was a video impression.

  6. No Close Button - if set to TRUE, remove the close button from the iframe.

  7. Background Color - choose or type the color you would like to use for the iframe's background.

  8. Full Html - if the code uses <head> and <body>, respect it. If it’s disabled, <head> and <body> tags will be stripped and the entire HTML will be put into <body>.

Controls

Left side

  1. Timeline Mode - choose where (if at all) to put player’s timeline - Overlay (inside the player), Bottom (of the player) or None.

  2. Skip Button

    If set to TRUE, show a Skip button within the player.

    1. Skip Timer - the amount of seconds to wait before showing the Skip Button.
      It must be > 0.

    2. Skip Text - change the text shown in the Skip button from the default.

Right side

  1. Play/Pause button - if set to TRUE, the player will have a Play/Pause button.

  2. Close button - if set to TRUE, the close button will appear in the top left corner of the player.

  3. Close Outside - If set to TRUE, the close button will appear in outside/above the player.
    Note this controls every other Close button element as well (in Floating, in Extensions, etc.).

  4. Position and Margin - choose the corner of the screen where the close button will appear and stick to.
    The Default option depends on Close Outside - if Close Outside is not checked then the close button will appear at the top left corner of the player view. Otherwise the button will appear at the top right corner of the caption above the player.

  5. Overlay Margin - define the size of the non clickable area around the close button

  6. Sound Button - if set to TRUE, the player will have a button users can click on to turn on sound.
    Note this concerns just the existence of a button! Ads that are autoplay start off muted.

Logo

  1. Enable Logo - if set to TRUE, show a logo on the top right corner of the player.

  2. Custom Logo - customize the logo so that yours will appear instead of the system’s logo.

    1. Link - the link to the logo you would like to use instead of the system’s one.
      We recommend using a png, with a transparent background

    2. Clickthrough - the link that will open when clicking on the logo instead of the system’s one.

    3. Width and Height - size in pixels of the custom logo.

    4. Top - the distance of the custom logo from the top frame in pixels.

  3. Hide Logo On Ad - if set to TRUE, logo is hidden when showing ads.
    If you Enable Logo, we suggest enabling Hide Logo On Ad too in order to avoid policy violations in premium such as Google, as external logos aren’t supposed to interfere with ads.

  4. Text - change the text that appears right next to the logo from the default.

Advanced

Left side

  1. In View Ratio - must be > 0 < 1 and is the required viewability of the player for floating

  2. Start Midroll - defines the amount of seconds to wait after one impression finishes and calls startAd for the next one.

  3. Midroll Delay - defines the amount of seconds to wait before the player starts searching for the first ad.

  4. Start Ad Delay - defines the amount of seconds to wait before calling startAd, giving extra time for a higher priority ad source to respond with Ad Loaded.

  5. Start Delay - defines the amount of seconds to wait before calling startAd for the first time. The player will still load and search for ads, but will delay the call to startAd.

  6. Player Delay - set Player Delay in seconds.

Right side

  1. Close Event - if set to TRUE, the player will not be closed, but will send the event and an event listener will be responsible for closing the player.

  2. Show Preloader - if set to TRUE, show the loading icon while the player searches for an ad.

  3. Auto Play Content - autoplay the content preloader when in view.

  4. Show Position - if set to TRUE, the player will consume its space in the page immediately so the page will not move when the player opens.

  5. Hide Preloader - if set to TRUE, hide the preloader (and the player) until there is an ad (impression).

  6. Last Frame - if set to TRUE, the video "freezes" when it reaches the end.
    Only works with direct mp4 campaigns
    By activating this flag the skip functionality will not work.

  7. Don't Hide I-Frame - if set to TRUE, the iframe will not be hidden.

  8. Wait For Consent - in the EU and UK wait for an answer about consent (which could be both yes and no) before starting requesting ads.
    If a CMP is not available in the webpage (i.e. no question is asked), the player will try again for a while but will not call ads until an answer (aka consent string) is given.

InStream

Main

  1. Player version - choose the new version to get a more modern player style.

  2. Name (required) - the name of the template. Tip: use main keywords to know which template to choose when using Player Tags.

  3. Description - any note you like to add about this template.

Content

Choose playlists/videos from the (preferred) or externally (preferably at least through ).

CMS

Just search for the needed playlist/video and choose it.

Custom

You can choose (CDN) Entry or a custom (preferably MP4) link.

Ad Config

Left side

  1. Vast Retry - number of consecutive waterfall retries.

  2. Error Limit - the maximum number of full waterfall runs in a row that do not generate an impression. Once an impression is generated, the counter is reset to 0.

Right side

  1. Control Button Positioning - choose between Aligned to Left (All the controls will be located in the bottom left corner of the player) and Distributed (Play/Pause button will be located in the bottom left corner but Sound and Full Screen buttons will be in the bottom right corner).

  2. Timeline Mode - choose the formation of the player timeline - Overlay (inside the player), Bottom (of the player) or None.

  3. Sound Button - if set to TRUE, the player will have a button users can click on to turn on sound.
    Note this concerns just the existence of a button! Ads that are autoplay start off muted.

  4. Play/Pause Button - if set to TRUE, the player will have a Play/Pause button while showing an ad.

  5. Logo - If set to TRUE, the player will show the logo while showing an ad.
    We recommend to disable it to avoid policy violations in premium such as Google, as external logos aren’t supposed to interfere with ads.

  6. Request on View - the player will calls the ad sources only when in view.

  7. Check Tab Is In View - the player will calls the ad sources only when in view.

  8. Play Ad when in View - automatically check the viewability and call startAd only when it is in view.
    Note: according to if Autoplay is unchecked and Play On View is unchecked, the user must click play first. Else, if Play On View is checked then Play Ad when in View is always true.

  9. Skip Button

    if set to TRUE, show a Skip button within the player.
    You can add a timer for it as well as define the actual text:

    1. Skip Timer - the amount of seconds to wait before showing the Skip Button.
      It must be > 0.

    2. Skip Text - change the text shown in the Skip button from the default.

Performance

General

Note if you choose both Autoplay and Play On View, then Play On View will override Auto Play since Play On view is more specific.

  1. Autoplay - defines whether startAd is called automatically. If FALSE, startAd should be called after getting the onLoad callback event.

  2. Auto Continue - at the end of each video, automatically play the next one.

  3. Loop - defines whether to continue looking for more ads at the end of the first impression. If loop is FALSE, it will only play one ad. When using Video Content (as a preloader), it will also define whether or not to loop it.

  4. Play On View

    if set to TRUE, the player will automatically check the viewability and will call startAd only when it is in view.
    Play on View Percent - from which percent of viewable player, the player will be consider as "On View" and will automatically play.

    if Autoplay is unchecked and Play On View is unchecked, the user must click play first (i.e. “click-to-play”).

Auto Skip

Enable Auto Skip

If set to TRUE, the player will skip the video after the number of seconds set in the Time To Skip filed.
Any gesture on the player or pressing the stay button will continue the current video.

Note: since browsers such as Google Chrome are supposed to automatically block midroll ads (i.e. ads that appear in the middle of a video content) in video content that is less than 8 minutes (following ), and given that most users stay in a given webpage for only a minute or two, this important feature should allow to use longer videos and yet auto skip them and thus allow using playlists.

  1. Time To Skip - the amount of seconds after which the player will skip to the next content.

  2. Show Auto Skip Buttons - the amount of seconds before the skip to show the next and stay buttons.

Start Mode

Wait For Ad Before Content - control the functionality of the player regards its beginning appearance based on its success to get an impression.
If set to TRUE, the player will display the poster from the first content until it will fetch an ad.

If enabled, the following settings will also appear:

  1. Start content when in view - if set to TRUE, the player will only play the content when in view.

  2. Hide While Waiting - if set to TRUE, the player will not appear until it will fetch an ad.

  3. Opening Animation - if set to TRUE, the player will open with an animation.

  4. Show Player - if set to TRUE, the player space is always shown.

    Note: this is required for .

  5. Float Only After Impression - if set to TRUE, the player will start floating only after an impression.

  6. Show Play Button After - the amount of seconds after which the play button for the content will appear.
    This is only relevant if there was no impression and the player is not hidden.

Appearance

Player Caption

Background Color - change/type the background color of the caption above the player view from the default.

Example: #000.

Player Mode

Can be set to:

  1. In Read - never float the player, only show it regularly (e.g. in the middle of the page).

  2. Floating (default) - make the player become Sticky only after it’s seen in a regular way (e.g. in the middle of the page) and the user scrolls away from it.

  3. Sticky - always float the player and never show it regularly (e.g. in the middle of the page).
    We suggest to never enable Sticky in order to avoid policy violations in premium Advertisers such as Google.

These settings only show up for Floating and Sticky whereas Sticky’s options are a subset for Floating’s:

  1. Close Floating Button - if set to TRUE, show a close button only when the player is Floating that will disable the floating option.

  2. Float On Bottom - the player will float both when scrolled down past it and above it, and not just down past it.
    If you enabled Autoplay, we suggest to also enable Float on Bottom to make sure the player is only autoplayed when visible (meaning even if it starts floating to begin with, it will at least be visible).

  3. Resizing Method - define the size of the player when it is Floating, by scale to the original size
    or by fixed width and height sizes in pixels.

  4. Size When Floating or Width/Height - based on Resizing Method.

  5. Position (also for Sticky) - choose the corner of the screen where the player will appear and "float" to.
    Note Top and Bottom mean 100% of the page’s width.

  6. Margins and/various other settings - based on Position.
    Note only Top and Bottom offer:

    1. Text Size - set the title size.

    2. Text Font - set the font.
      The default is "Roboto, Arial, sans-serif".

    3. Text Color - set the text color.

    4. Background Color - change/type the background color of the caption above the player view from the default.

Player Sizing

  1. Player Size - Choose Responsive so the player's size will adapt to the frame in which it is wrapped, maintaining an aspect ratio of 16:9. Choose Fixed (size) to manually define both the Width and Height of the player.

  2. Maximum Width - defines the maximum width of the player, as completion of Player Size.

  3. Minimum Height - defines the minimum height, as completion to Player Size.

  4. Custom CSS - use your own CSS to change the appearance of the player.

  5. Show Playlist Gallery

    Show thumbnails of the videos of the playlist.

    1. Infinite Playlist - allows you to move from the first index to the last and from the last to the first.

    2. Playlist Position - select position of playlist gallery - Overlay (inside the player) or Below Player.

    3. Show Entry Titles - show the titles of the videos in the playlist.

Mobile

Make buttons appear differently over Mobile.

Left side

  1. Big Play/Pause - show big play/pause buttons.

  2. Big Play On Pause - show big play on pause.

  3. Big Preview and Next - show big Preview and Next buttons.

  4. Pause Button - show the pause button in the timeline.

Right side

  1. Previous Button - show the previous button in the timeline.

  2. Next Button - show the next button in the timeline.

  3. Fullscreen - show the fullscreen button in the timeline.

  4. UI Time Limit - the user interface will be displayed for this specific time in seconds after a click, meaning:

    1. Player starts without a UI (logo, play/pause, mute/unmute, timeline, etc.)

    2. User clicks somewhere on the player

    3. The UI shows up

    4. After X seconds the UI disappears again

Controls

Left side

  1. Timeline Mode - choose where (if at all) to put player’s timeline - Overlay (inside the player), Bottom (of the player) or None.

  2. Previous Button - show the button in the timeline.

  3. Next Button - show the button in the timeline.

  4. Big Previous And Next Buttons - show the big Previous And Next Buttons in the center of the player.

  5. Previous And Next Buttons On pause - show the big Previous And Next Buttons on pause.

  6. Big Play Button - make the play button big.

  7. Big Play Button On Pause - show a big play button when pausing.

  8. Fullscreen Button - show the fullscreen button in the timeline.

  9. Duration - show the duration on the timeline.

  10. Duration Position - select the location for the duration.

  11. Time Jumps

    Enable forward and backward time jumps in seconds.
    Seconds Of Time Jump - number of seconds per each jump.

Right side

  1. Close Button - if set to TRUE, the close button will appear in the top left corner of the player.

  2. Close Outside - if set to TRUE, the close button will appear in the top caption above the player.

  3. Sound Button - if set to TRUE, the player will have a button users can click on to turn on sound.
    Note this concerns just the existence of a button! Ads that are autoplay start off muted.

  4. Volume Button Position - select the location for the position of the volume button in the timeline.

  5. Volume Bar - if set to TRUE, hovering over the sound button will display a volume bar.

  6. Vertical Volume Bar - replace the default volume bar with an vertical one.

  7. Replay button - if set to TRUE, show replay button on the timeline.

  8. Show Video Title

    Show the title of the video
    If Enabled, select the side of the video title.

Logo

  1. Enable Logo - if set to TRUE, show a logo on the top right corner of the player.

  2. Custom Logo - customize the logo so that yours will appear instead of the system’s logo.

    1. Link - the link to the logo you would like to use instead of the system’s one.
      We recommend using a png, with a transparent background

    2. Clickthrough - the link that will open when clicking on the logo instead of the system’s one.

    3. Width and Height - size in pixels of the custom logo.

    4. Top - the distance of the custom logo from the top frame in pixels.

  3. Text - change the text that appears right next to the logo from the default.

  4. Position - select the side for the logo position.

Advanced

  1. Sync Volume - if set to TRUE, the volume of the content and the ads will be in sync.

  2. Content continue when Clickthrough - if set to TRUE, the content will continue to play on a clickthrough.

  3. Hide GUI Time Limit - the user interface will be displayed for this specific time in seconds after a click.

  4. Spinner - change the default spinner to Dots or None.

  5. Theme Color - choose or type the theme color.

  6. Wait For Consent - in the EU and UK wait for an answer about consent (which could be both yes and no) before starting requesting ads.
    If a CMP is not available in the webpage (i.e. no question is asked), the player will try again for a while but will not call ads until an answer (aka consent string) is given.

  7. Player Delay - add a player delay.