Getting Started with the OneScreen Toolkit for WordPress Plugin

Our plugin is available in WordPress's plugin repository (http://wordpress.org/plugins/onescreen-video/). You can search for and install our plugin OneScreen Toolkit for WordPress. If you are running an older version of our plugin (anything below v1.3.1), please uninstall the plugin and re-install it through WordPress's Plugin repository (Please be sure to configure the plugin account settings once you update). This will allow you to receive automatic updates when new features are added to our plugin. This documentation applies to version 1.3.1 and up.

Note: This document applies to the most recent version of the OneScreen Toolkit for WordPress that is using our 1.9 Apps JavaScript (v1.2+).

Installing and Activating the Video Plugin

  1. Use WordPress's plugin installer to install the OneScreen Toolkit for WordPress (search for onescreen video).
  2. Once installed go into the Plugin section, find OneScreen Toolkit for WordPress and click Activate. See image below.

After you have activated the plugin, you will need to authenticate your OneScreen account and set the default widget ID. Please follow these steps:

  1. Click "Settings"
  2. Click "OneScreen Account"
  3. You will be prompted to enter your OneScreen account token and default widget ID as seen in the image below

To generate an account token follow these steps:

  1. Log into your OneScreen account
  2. Click "Settings"
  3. Click "Security" located in the left navigation bar
  4. Generate a token with read access

To find the widget/application ID follow these steps when logged into the OneScreen

  1. Click the "Publishing Tab"
  2. Click "Applications"
  3. Select the application that you want to set as the default. This application will be used if you do not provide one in the shortcode. (Use of the shortcode is explained below)
  4. Click the "Get Code" button. (A window will pop-up) The highlighted portion in the image below is the widget ID you should copy and paste into your WordPress settings.
The first 4 digits of this ID is the application ID and the remaining text string after the dash is the obfuscated ID.

Embedding a Player Application on Your Site

Now that you have installed and set up the OneScreen Toolkit for WordPress, you are now ready to post a player application on your site. This is simply done through the use of shortcodes. From your WordPress dashboard, go to make a page/post and enter in one of the shortcodes below depending on your use case in either the "Visual" or "HTML" tab of the text editor.

Note: The shortcode must be entered in all lowercase.

Shortcode to Embed a Player Application
  • [onescreen widget_id="13759-98b00f92afb5fe720d8c2523ac40eba0"]
  • [onescreen] (This shortcode will render the default widget ID specified in the settings)

Available shortcodes for player application overrides

Starting in version 1.4, all player application overrides are available. For previous versions, please refer to the information below.

In certain instances, you might want to override certain player application properties. Overriding properties are useful when you are placing the same player application on multiples pages, but want to change only one or a few properties of the player on each page. For example, you may want to change one instance of the player from click to play to autoplay or change the video that is playing in that player application. These changes can easily be done by apply overrides in the shortcode.

Shortcode Overrides Examples

All examples below will render the default application/widget specified in the settings. To target a specific widget/player application, simply add the widget_id in the shortcode.

  • For example [onescreen widget_id="13759-98b00f92afb5fe720d8c2523ac40eba0" item="1234567"]

In addition, you can use multiple overrides at the same time. Simply separate each override with a space.

  • For example [onescreen widget_id="13759-98b00f92afb5fe720d8c2523ac40eba0" item="1234567" auto_play="true"]

For more information regarding player application properties, please refer to the following page: Properties

  • item
    • Overrides the video that is set in the player application
    • [onescreen item="1234567"]
  • playlist_id
    • Overrides the playlist that is set in the player application
    • [onescreen playlist_id="2312233"]
  • auto_play
    • Override autoplay on or off
    • [onescreen auto_play="false"]
  • start_index
    • Overrides the default video start index of 0
    • [onescreen start_index="1"]
  • height
    • Override the height of the player application
    • [onescreen height="250"]
  • width
    • Override the width of the player application
    • [onescreen width="300"]
  • dock
    • Override dock to be true or false
    • [onescreen dock="true"]
  • player_fill
    • If enabled, the player will ignore width and height properties and will fill the target div instead to a 16:9 ratio (note: height and width must be specified in the parent div or an error in the player will be thrown)
    • [onescreen player_fill="both"]
  • ads
    • Overrides any ad set and will run the ad xml provided in the shortcode
    • [onescreen ads="http://d.1sadx.net/impressions/uint/asc=3283/f=29/chip=23c08ff0e99e012ffae30024e87a30c2.xml?AG_P0=nocompanion"]
  • force_companions
    • Creates a div to display a companion banner
    • [onescreen force_companions="true"]
  • companion_target
    • Overrides the default companion banner div set by the player
    • [onescreen companion_target="sample_div_id"]
  • target_div
    • Overrides the target div of where the player is to be loaded
    • [onescreen target_div="os_dmp_embed"]
  • playback_priority
    • Overrides playback adapter priority between Flash and HTML 5 with failback support
    • [onescreen playback_priority="html5,flash"]
    • Added in version 1.3.6
  • force_html5
    • Forces our HTML5 player to load on all instances
    • [onescreen force_html5="true"]
  • show_thumbs
    • Overrides whether to show or not show thumbnails the player application
    • [onescreen show_thumbs="true"]
    • Added in version 1.3.8

After you enter in your applicable shortcode all you have to do is save the page/post and the OneScreen player application will render on your page.

If you have any additional questions, please contact your account manager.