Using the Vidyard Player API (Legacy)

DEPRECATED CONTENT

We've updated our Player API
With the introduction of the Vidyard responsive embed code, we've made additions to our Player javascript API to make it even more powerful.

To use the API on players with the responsive embed code, see our updated Player API documentation.

The Vidyard Player API allows developers to control the behavior of an embedded player via Javascript. This document pertains to players that have been embedded using Vidyard's Legacy Inline and Legacy Lightbox Embed codes.

The Player API Script

Use the Vidyard player API script with either the Use either the Legacy Inline or Legacy Lightbox Embed codes.

You can obtain these embed codes from these locations:

1. From a player(s) inside the Vidyard platform
2. Through a GET request to the Vidyard dashboard API 

Add the API script to the webpage where your player(s) is embedded. The last line of the script, <script src="//play.vidyard.com/v0/api.js"></script>, must follow the player embed code.

<script type="text/javascript" id="vidyard_embed_code_[playerUUID] src="//play.vidyard.com/[playerUUID].js?v=3.1.1&type=inline"></script>
<script src="//play.vidyard.com/v0/api.js"></script>

Players are referenced via their UUID. The UUID can be extracted from the player embed code or sharing page URL.

For example: http://embed.vidyard.com/share/oTDMPlUv--51Th455G5u7Q. The player UUID is oTDMPlUv--51Th455G5u7Q.

Example for querying a player

// Returns a specified player
// Replace playerUUID with the UUID of the player you would like to control with the API
var player = new Vidyard.player("playerUUID"); 
player.play();

OR

// Returns all players with reference to one particular instance of a player
// Replace playerUUID with the UUID of the player you would like to control with the API
var players = new Vidyard.players(); 
players["playerUUID"].play();

 Methods

GDPR-specific methods

These methods were implemented in order to enable customers to achieve GDPR compliance on webpages where Vidyard players exist.

The methods are used to communicate to players whether a visitor has consented to having identified view data passed to Vidyard. Note that Vidyard.GDPR.consent calls set to true persist in localStorage, so visitors to your webpage do not need to accept tracking on every page load.

When players do not receive consent, only completely anonymized viewing data will be passed to Vidyard.

Example:

Vidyard.GDPR.hasConsentOnReady(function(consent) {
// Your callback logic goes here
});

Return player properties

Use player.metadata to return information about the player (title, length, description, public custom attributes, etc). This data is available after the ready event has fired. null is returned otherwise.

Example Response

{
  "chapters_attributes": [
    {
      "video_attributes": {
        "description": null,
        "name": "nature",
        "tags": [],
        "thumbnail_urls": {},
        "captions": [
          {
            "name": "English",
            "language": "en",
            "is_default": true,
            "vtt_url": "//example.com/example_en.vtt"
          },
          {
            "name": "dansk",
            "language": "da",
            "is_default": false,
            "vtt_url": "//example.com/example_da.vtt"
          }
        ]
      }
    }
  ],
  "custom_attributes": [
    {
      "attribute_type": "String",
      "is_public": true,
      "list_options": null,
      "name": "test_public",
      "value": "Test public"
    },
    {
      "attribute_type": "Number",
      "is_public": true,
      "list_options": null,
      "name": "test_public",
      "value": 10678
    }
  ],
  "description": "",
  "height": 360,
  "length_in_seconds": 123,
  "name": "player name",
  "tags": [],
  "visitorID": "string",
  "width": 640
}

Events

Use events to craft responses in reaction to a player's behavior.

See our documentation for additional player API examples.