Player Definition Plugins

These plugins enable you to publish and un-publish players.

Ooyala Flex HTML 5

Description:

This plugin is the default player plugin for creating players in Mio. This plugin is designed to be highly configurable so that player behaviours and look and feel can be customised to meet the users exact preferences. This player plugin supports the latest HTML5 video technologies.

Options worth of note are as follows:

  • Plugins: A comma separated list of JavaScript plugins can be specified to add additional functionality to the player.
  • Call to Action Plugin Options: It is possible to specify a "call to action" that overlays the player, with a URL link.
  • Player Option: Specifiying optional key-value pairs to make available to the player .

JavaScript Plugins

The following JavaScript plugins can be utilised:

  • calltoaction: Allows for the overlaying of a "call to action" URL
  • chapters: Enabled chaptering markers on the time line
  • timelinepreview: Supports a frame preview when rolling over the timeline
  • resolutions:  Allows for setting resolutions (SD, HD, etc.)
  • sharing:  Enables sharing the player with others and with social media platforms like Twitter and Facebook.
  • relatedcontent:  Shows a related content panel

Note: These options must be specified as a comma-separated list.

Media

Media options are used to specify the location of the media content to use.

  • Asset Context: Asset context syntax used to identify the asset to use. For examples "./TRANSCODE[1280x720@25-2564k-main31]".
  • Mime Type: Optional mime type specification. For example "video/mp4; codecs=avc1.4d001f,mp4a.40.2".
  • Validation Profile: Optional validation profile to specify supported media file formats.

Player Files

Player File options are used to specify template and supporting files.

  • Embed Template File: A Velocity template  used to define the embed code which is generated for the player. This will result in the embed code that ends up in a  Mio Publish  response.
  • Player Template File: A Velocity Template  used to define the  player html that will be generated. This will be generated when a player is returned as a  Mio Publish  response.
  • Supporting File: Additional files published which are referenced by the generated html allows for skin and functionality overridding. This allows for skin and functionality overridding.

Example Embed Template File:

<script type="text/javascript" src="$contentGetURL/mioplayer/scripts/mioplayer-embed.js"></script> #if ( $embedURL.startsWith("http://") ) #set( $embedURL = $embedURL.replace("http://", "https://") ) #set( $embedURL = $embedURL.replaceAll("[:][1-9][0-9]*", "") ) #end <div> <img onLoad='embedMioPlayer(this, { src: "$embedURL", width: "$width", height: "$height", center: true });' src="$contentGetURL/mioplayer/images/pixel.png"/> </div>

Properties:

Table 1.
Field Value Explanation
Icon plugin icon
Sub-type Player Sub-type of this plugin
Classification Player Classification of this plugin
Deployment Internal Whether the plugin is deployed inside Mio or within another product
Supports Configuration Whether this plugin supports configuration
Supports Scripting Whether configuration supports scripting
Scripting Context   What Mio objects can be referenced from within the scripting context
Undo Action   The action required to undo this action
Redo Action   The action required to redo this action
Compatability 5.x What versions of Mio this plugin works for
Lifecycle Stable Maturity of this plugin (Experimental, Unstable or Stable)

Configuration:

Table 2.
Field Field Type Mandatory Multiplicity Description
Player Instance Configuration complex   Configuration options for each player instance.
Auto Play boolean   Should the player start playing by itself?
Controls boolean   Should user controls be enabled?
Display Time boolean   Should current time and duration be displayed?
Poster Image boolean   Should an initial poster image be displayed?
Central Play Button boolean   Should an initial large central play button be displayed?
Loop boolean   Should playback continue in a loop?
Allow Fullscreen boolean   Should a button for fullscreen be provided?
Background Colour string   Background colour of player footprint - either a hex code e.g. '#000000' or 'transparent'
Plugins string   Comma separated list of plugins to include.
Call To Action Plugin Options complex   Configuration options for the Call To Action plugin.
Link Text string   The text display for the link.
Relative Path string   The relative path to link to.
Player Option complex 0..* An option that will be passed into the player template.
Name string    
Value string    
Preferred Size complex   The preferred rendering size for the player.
Width integer   Preferred width of the player in pixels.
Height integer   Preferred height of the player in pixels.
Media complex    
Media Source complex 1..*  
Asset Context string    
Mime Type string 0..1  
Validation Profile Validation Profile (All) 0..1  
Player Files complex    
Embed Template File file    
Player Template File file    
Supporting File file    

Ooyala Player V4

This Plugin is the Player Plugin for creating Player V4 players in Ooyala Flex. This Plugin determines how the Player V4 player behaviours, looks, and feels.

To learn more about Player V4 please consult the Player V4 documentation.

Media

Media options are used to specify the location of the media content to use.

  • Asset Context: Asset context syntax used to identify the asset to use. For examples "./TRANSCODE[1280x720@25-2564k-main31]".
  • Mime Type: Optional mime type specification. For example`: "video/mp4; codecs=avc1.4d001f,mp4a.40.2".
  • Validation Profile: Optional validation profile to specify supported media file formats.

Player Files

Player file options are used to specify template and supporting files.

  • Embed Template File: A Velocity Template  used to define the embed code which is generated for the player. This will result in the embed code that ends up in a  Mio Publish  response.
  • Player Template File: A Velocity Template   used to define the  player html that will be generated. This will be generated when a player is returned as a  Mio Publish  response.
  • Supporting File: Additional files published which are referenced by the generated html allows for skin and functionality overridding. This  allows for skin and functionality overridding.

Properties:

Table 3.
Field Value Explanation
Icon Plugin icon
Sub-type Player Sub-type of this plugin
Classification Player Classification of this plugin
Deployment Internal Whether the plugin is deployed inside Mio or within another product
Supports Configuration Whether this plugin supports configuration
Supports Scripting Whether configuration supports scripting
Scripting Context   What Mio objects can be referenced from within the scripting context
Undo Action   The action required to undo this action
Redo Action   The action required to redo this action
Compatability 5.4.0 What versions of Mio this plugin works for
Lifecycle Stable Maturity of this plugin (Experimental, Unstable or Stable)

Configuration:

Table 4.
Field Field Type Mandatory Multiplicity Description
Player Instance Configuration complex   Configuration options for each player instance.
Player Version string   Player version
Code string   Backlot account identifier
Player Branding ID string   Player Branding ID
Auto Play boolean   Should the player start playing by itself?
Loop boolean   Should playback continue in a loop?
Poster Image boolean   Should an initial poster image be displayed?
Pre-Load boolean 0..1 Should the Video be pre-loaded?
Encoding Priority string 0..1 Should the player start playing by itself?
Initial Time string 0..1 Initial to video be played.
Initial Volume string 0..1 Initial Video volume
Initial bitrate complex 0..1 Initial minimum bitrate level for a specific period of time
Bitrate Level string   Initial bitrate level (#,##0.###)
Duration string   Duration in seconds to sustain the bitrate level (#)
Player Plugins complex   List of plugins to include.
HLS and MP4 Main video plugin boolean   Use HLS and MP4 Main video plugin?
OSMF Flash plugin for HDS boolean   Use OSMF Flash plugin for HDS?
Bitmovin plugin for DASH and HLS boolean   Use Bitmovin plugin for DASH and HLS?
Akamai HD video plugin for Akamai packaged HDS boolean   Use Akamai HD video plugin for Akamai packaged HDS?
HTML5 skin plugin boolean   HTML5 skin plugin?
Discovery Content plugin boolean   Discovery Content plugin?
Pulse complex 0..1 Ooyala Pulse ad plugin and parameters.
Pulse Host string   Identify which Pulse account to request ads from
Pulse Device Container string   Device Container
Pulse Persistent ID string   End User Identifier
Pulse Width string 0..1 The width of the video player. (#)
Pulse Height string   The height of the video player. (#)
Pulse Max bitrate string   The maximum bandwith in Kpbs that your device was access to. (#)
Pulse non linear cuepoints string   For non-linear ads.
Pulse insertion point filter string   For non-linear ads.
Pulse Referrer URL string   Referrer URL.
Pulse Linear Slot size string   Number of linear ads per slot. (#)
Pulse Category string   Pulse Category.
Pulse Content Form single option   Pulse Content Form.
Pulse Content ID string   Content ID .
Pulse Content Partner string   Content Partner.
Pulse Duration boolean   Include main content duration?
Pulse Flags string   Pulse Flags.
Pulse Tags string   Pulse Tags.
Pulse Custom Parameter string 0..* Configuration option for plugin
Pulse Override Metadata boolean   Override Metadata?
Pulse Callbacks complex   Plugin and options to be included.
On Session Created Callback string   Callback on Session Created.
On Ad Player Created Callback string   Callback on Ad Player Created.
Plugin complex   Plugin and options to be included.
Plugin name string   Name of the plugin
Plugin Option string 0..* Configuration option for plugin
Preferred Size complex   The preferred rendering size for the player.
Width string   Preferred width of the player in pixels. (#)
Height string   Preferred height of the player in pixels. (#)
Media complex    
Media Source complex 0..*  
Asset Context string    
Player Files complex    
Embed Template File file    
Player Template File file    
Supporting File file 0..*  
Player Option       An option that will be passed into the player template.
Plugin Option     0..* Configuration option for plugin

Was this article helpful?