Override a Plugin Template

Overview

Instead of creating a new template, simply generate the plugin embed code for a transcript that you want to embed on a webpage along with a media player and use the tips below to override the settings associated with the plugin template.

One or multiple parameters from a plugin template can be overridden by amending the plugin embed code generated from a 3Play Media file.

IMPORTANT NOTE: To override the plugin template's core configurations AND template settings, first add the overrides for either or both template configurations  (PLAYER ID and/or PLAYER TYPE) to the plugin embed code followed by one or more of the template's settings (SKIN, HEIGHT, WIDTH, etc).

Configurations

Both PLAYER TYPE and PLAYER ID are the core configurations for a plugin template.
To override either configurations add either

?player_type=

or

?player_id=

after .js from the plugin embed code followed by the one of the available values listed in the corresponding section below.


PLAYER TYPE 

If you are working with a media player different from the one used in your template you can override the plugin to match the type of player you intend to embed.

PLAYER             SETTING              VALUE (use only one)

Brightcove         player_type          brightcove
Delve/Limelight    player_type          delve
Flowplayer         player_type
HTML5              player_type
JW Player          player_type
Kaltura            player_type          kaltura
Ooyala             player_type          ooyala
SoundCloud         player_type          soundcloud
SoundManager2      player_type
Sublime            player_type
Video.js           player_type
Vimeo              player_type          vimeo
Vimeo iFrame       player_type          vimeo_iframe
Wistia             player_type          wistia
Wistia iFrame      player_type          wistia_iframe
YouTube            player_type          youtube

 

EXAMPLE of Plugin Embed Code with Player Type Override

http://static.3playmedia.com/p/projects/00/files/00/plugins/00.js?player_type=kaltura

 

PLAYER ID

Modify the plugin embed code to reference a different player ID. This override is helpful when embedding multiple videos and plugins on one web page where the design stays the same but where each plugin needs to point to different media.

EXAMPLE of Plugin Embed Code with Player ID Override

http://static.3playmedia.com/p/projects/00/files/00/plugins/00.js?player_id=moog2

NOTE: The new player ID (moog2) shown is the example above is for demonstrative purposes. The player ID you add after ?player_id= will need to match the object/player ID of the current media file you are embedding along with a plugin.


PLAYER TYPE and PLAYER ID
 

Both of these plugin configurations can be amended at the same time. 

EXAMPLE of PLUGIN EMBED CODE with PLAYER TYPE and PLAYER ID OVERRIDES.

...dia.com/p/projects/00/files/00/plugins/00.js?player_type=vimeo&player_id=container2 

Note that the first configuration in the example above requires a question mark to follow .js while the second configuration requires an ampersand as opposed to a question mark.

SETTINGS

Change the dimensions and functionality of a plugin by overriding the plugin template's settings. 
The following settings can be changed for the plugin template:

SETTING                  VALUE

skin                     see available values below
width                    numeric          
height                   numeric
can_print                boolean
can_download             boolean
can_collapse             boolean
progressive_tracking     boolean
include_translations     boolean
can_clip                 boolean
html5_container_id       string      

To override these settings add:

 ?settings= 

...after the .js in the plugin embed code followed by the settings and the value.

 

OVERRIDE MULTIPLE SETTINGS
To override more than one of these settings add them to amended embed code but be sure separate each setting and the corresponding value with a comma similary to this example:

..jects/00/files/00/plugins/00.js?settings=width:555,height:120,can_print:false

 

SKIN

Override the look of the plugin by overriding the skin.
Note that different skins are available for the captions plugin and interactive transcript.

PLUGIN TYPE               SETTING   AVAILABLE VALUES (use only one)              

Interactive Transcript    skin      frost
                                    ice 
                                    gecko3 
                                    darth_gecko 
                                    minimalist 
                                    metallic
                                    wood
                                    sunburst
                                    blue_pro
                                    hot_pink
                                    zesty_orange
                                    cardinal_red

 

CAPTIONS PLUGIN           skin      dark
                                    light                

 

EXAMPLE of Plugin Embed Code with a Skin Override

http://static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=skin:gecko

 

WIDTH

Override the width (in pixels!) of the captions plugin or interactive transcript template by adding:

?settings=width:440

after .js in the plugin embed code generated from a 3Play Media transcript.
Note: Any number can be added to override the width.

EXAMPLE of Plugin Embed Code with a Width Override

http://static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=width:440

 

HEIGHT 

Override the height (in pixels!) of the interactive transcript template by adding:

?settings=height:220

after .js in the plugin embed code. 

Note: Any number can be added to override the height but can only be added to an interactive transcript embed code.

EXAMPLE of Plugin Embed Code with a Height Override 

http://static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=height:220

 

Gives the viewer ability to minimize the plugin

EXAMPLE of Plugin Embed Code with a Collapse Override
static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=can_collapse:true
The plugin is minimized by default when the page loads.
EXAMPLE of Plugin Embed Code with a Collapse On Load Override
....media.com/p/projects/00/files/00/plugins/00.js?settings=collapse_onload:false
EXAMPLE of Plugin Embed Code with a Progressive Tracking Override
static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=progressive_tracking:true
PRINTABLE TRANSCRIPT
Gives the viewer the ability to print the transcript

EXAMPLE of Plugin Embed Code with a Printable Override
static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=can_print:true
Gives the viewer the ability to download the transcript

EXAMPLE of Plugin Embed Code with a Downloadable Override
static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=can_download:false
ENABLE SCAN VIEW
Gives the viewer the ability to enable a word cloud view of your transcript making words that occur frequently display larger than the less frequently occurring words.
EXAMPLE of Plugin Embed Code with a Enable Scan View Override
static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=scan_view:true
static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=include_translations:true
LESS SCROLLING
Interactive Transcript scrolls slower than it does by default
EXAMPLE of Plugin Embed Code with a Less Scrolling Override
static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=light_scroll:false

OVERLAY (captions plugin)
Displays your closed captions over the the lower part of the video and is similar to broadcast closed captions. If you don't select Overlay, by default your captions will be displayed below the video player.

EXAMPLE of Plugin Embed Code with a Overlay Override

static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=overlay:false

 

OVERLAY DRAGGABLE (captions plugin) 
Enables your audience to use their cursor to drag the closed captions overlay anywhere over the video image. 

EXAMPLE of Plugin Embed Code with a Overlay Draggable Override

static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=overlay_draggable:false

 

HTML5  CONTAINER ID

Add or change an html5 container ID for HTML5 playback. This will need to be a string value.

static.3playmedia.com/p/projects/00/files/00/plugins/00.js?html5_container_id:string

 

SOCIAL CLIPPING


For  YouTube, Kaltura, and Brightcove video players, enable your viewers to select excerpts from the interactive transcript and share it on social media applications like Facebook and Twitter.

static.3playmedia.com/p/projects/00/files/00/plugins/00.js?settings=can_clip:true

 


Other EXAMPLES

Width and Height

Override the width and height (in pixels!) of the template by adding the settings and values separated by a comma.

Excerpt of an EXAMPLE of Plugin Embed Code with Height AND Width Override

....ymedia.com/p/projects/0/files/0/plugins/0.js?settings=width:620,height:140

 

 

Here is an example of a a plugin embed code that first includes the overrides for PLAYER TYPE and PLAYER ID followed by the overrides for the template settings.

http://static.3playmedia.com/p/projects/000/files/000/plugins/000000000000000000000000.js?player_type=kaltura&player_id=container2&settings=width:440,height:120,skin:pro_blue

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk