Advanced Player Options in Twitter Cards

Using a special page from Ooyala, you can create a Player URL to embed a video in Twitter's Player Card, including all available Ooyala player options.

As shown in Manually Getting Twitter <meta> Tags for Ooyala Player, in Twitter Player Cards, the basic HTML <meta> tag to define an Ooyala video player looks like the following. This is the most basic invocation of the Ooyala player:
.
.
.
<meta name="twitter:player" content="https://player.ooyala.com/tframe.html?embedCode=videoID&pbid=playerID"/>
.
.
.
To include more advanced player options, you can construct a URL and then replace the basic invocation highlighted above. After replacing the basic URL with your customized one, be sure to follow the remaining steps in getting your Twitter Player card into production.

Syntax for Advanced Player Options

Examine the following URL syntax. You can construct this URL to use as the value of the content attribute for Twitter's twitter:player <meta> tag shown above.

Note:The lines below have been broken for readability; in actual use, be sure to put this all on a single line.

https://player.ooyala.com/tframe.html?
ec=embedcode
&pbid=player_branding_id
&platform=platform
&options[optionname]=value&options[optionname]=value..." 
Parameter Description of Value
ec or embedCode The Ooyala embed code (asset or content ID) for the desired video.
pbid A "player branding ID" (or simply "player ID") for a player you have defined in Ooyala Backlot.
platform Any of the defined values for the platform parameter detailed at Player V3 Query String Parameters, such as flash or html5-fallback
options Standard Ooyala player runtime options, described in the next section. The optionames of nested passthrough parameters (for instance, ad manager parameters) are in dotted notation of the form parameter.subparameter, like ad-manager.url. Values must be URL-encoded.

Passing Embedded Parameters to the Player in a tframe

Standard Ooyala player syntax allows you to specify certain runtime arguments as the third argument on the player invocation (sometimes called the "options hash"), such as autoplay:true, initialTime:122, and other options detailed at Embedded Parameters and Ads Embedded Parameters.

With Ooyala's tframe.html you can pass the same embedded parameters with the options attribute. You can repeat the &options attribute and values as many times as you like. The only limit is the maximum length of a URL.

According to the syntax above, the options attributes look like the following.

https://player.ooyala.com/tframe.html?
ec=embedcode
&pbid=player_branding_id
&platform=platform
&options[autoplay]=true&options[initialTime]=122       
Nested options (that is, a hash key that is itself a hash, like ad tags), are expressed in dotted notation. See Example: Passing Multiple IMA Ad Tags for Pre-roll.

Possible "Ooyala Exception: Invalid query parameter" Errors

If your parameters for tframe.html are not correctly formatted or constructed, you will see the following error message, and the player will not load:
Ooyala Exception: Invalid query parameter  

Check your syntax carefully to eliminate this problem before you attempt to go into production with your Twitter Player Card.

Was this article helpful?