Player Query String Parameters (Player V2 Deprecated)

Lists and describes all Player Query String Parameters

General Query String Parameters

Important: Ooyala Player V2 is deprecated and is scheduled to be disabled on 2018-01-31. After that date, Player V2 will no longer play your video or audio content. Customers still using Player V2 need to migrate to Player V4 (see Player V4.

The following table describes parameters that can be expressed through the query string.

Parameter Description
alwaysShowScrubber

Specify true to enable always showing the main control bar and scrubber feature. Default is false and will only show the controls on hover.

autoplay

If set to 1, play the video upon display.

browserPlacement

For a channel, specify where external controls are placed, either left or right. This can include a percentage or a width in pixels that will be occupied by the controls as in left40 for left and 40% of the width, or left200px to specify left and 200 pixels. The default left or right value is 50%.

callback Specify the name of a function to call. When the player sees the query string callback, it looks for the specified function on the page and calls it. For example,
<script src="http://player.ooyala.com/player.js? ... callback=foofunction"></script>
embedCode

Specify the embed code for a video or channel.

hasModuleParams

hasModuleParams should be set to 1 The hasModuleParams=1 parameter signals to the player that it should wait for custom data to be sent via the setModuleParams function (available to the player object). You use this parameter with the corresponding setModuleParams function to pass custom data to the player. To use hasModuleParams, you need to provide two additional parameters in the script embed (hasModuleParams and a callback). callback can be set to any function It is necessary to add the callback=playerAPICallback to the embed script because you will need to call the setModuleParams function at a specific time, namely after the playerEmbedded event is fired. You can add Javascript to listen to these events inside the callback function. The playerAPICallback can be replaced by whatever function you want. Example: If you want to add parameters to your script embed, you would use hasModuleParams, a callback, and the callback function in the embed string, as shown in the following example:

<script src="http://player.ooyala.com/player.js?
 ... hasModuleParams=1&callback=playerAPICallback"></script>

In this example, you set hasModuleParams to 1, while the callback can be any function. You also need to add the callback function in JavaScript elsewhere on your page. For more information, see setModuleParams function.

height

Specify the height, in pixels, of the player.

hide Disables specific player functionality. This parameter accepts all to disable all controls or a comma-separated list that can contain any combination of volume, fullscreen, channels, sharing, info, embed or endscreen. If in a chromeless layout, disabling the loadingIndicator is also possible.
layout If set to chromeless, removes chrome and start screen. If not specified, the player will revert to its default layout.
loop If set to 1, automatically replay the video when it finishes.
thruParam_<adplatform> The values of these parameters are tags from your respective ad server or ad network.

Query String Parameters for Adjusting Player Location

When embedded on a web page, the player is bounded by its own outer DIV. This enables you to have better control of the location and positioning of the player. In addition, we provide additional query string parameters that you can add as options to the embed code to make other adjustments to the player container, DIV, class name, ID and target location. In a DOM tree, an inserted player is not loaded upfront but rather loaded via a lazy load design (the object is not loaded until the first time it is accessed).

The following table describes parameters used to change embedding behavior to adjust the player placement.
Parameter Description
playerContainerId The playerContainerId is an optional parameter that you can add to the player.js query string parameters of your embed code snippet. This parameter places the Player in a DIV based on the Id. If specified, we perform an innerHTML swap into the specified DIV instead of using document.write. Use this parameter when you want to place multiple players on a web page or just wish to fine tune the player location on your web page. The default behavior of placing embed code snippets on a web page can have an unintended impact on the web page appearance, layout, and to a lesser extent the page loading. You can use the playerContainerId to control the positioning of the player in your web page. To use this parameter, you just need to add ?playerContainerId=... to your embeds.

For an example showing the use of this parameter, see the section "playerContainerId Query String Parameter Example" in the topic Query String Parameter Examples of this document.

playerClassName Class name assigned to the outer DIV of the Flash Object class. You can use this parameter to modify the default Class name of the outer DIV of the player. For example, if the default outer DIV is named "alpha" and you want to specify it by a different name, you can set it to class = "alpha delta." Once renamed, you can get element by class using either the default alpha or added delta class name. This returns a reference to the player using either specified name.

For an example showing the use of this parameter, see the section "playerClassName Query String Parameter Example" in the topic Query String Parameter Examples of this document.

playerId

DOM ID for the Player Flash object.

Type: String, must conform to the HTML DOM specification

Example: b4f1a93b779145b4a9c8ef15f8502345

You use this parameter to perform player id manipulation. When generated in Backlot, by default this player ID is a random string. You can use the default random string or use playerId and manually specify your player ID. If you do this you should specify an ID and Class combination to keep it unique.

When specifying the playerId, use an Id that conforms to the HTML DOM specification. Make sure you don't include spaces or other random special characters in your playerId as it can generate errors.

Note: If you specify the player Id, it must be unique on the page. If the player ID is not unique, the behavior is undefined. A browser may or may not throw an Unknown Error: exception depending upon the individual browser implementation as some browsers are more tolerant of a duplicate DOM Id.

For an example showing the use of this parameter, see the section "playerId Query String Parameter Example" in the topic Query String Parameter Examples of this document.

targetReplaceId Replace the DOM object on the web page with that object specified by the ID. If you specify a DOM object id on the web page, if the DOM ID is available, we replace that DOM object with our Player. You use this API to completely remove a defined DIV and replace it with a specified Ooyala player that is inserted in the same location as the DIV that you are replacing.

For an example showing the use of this parameter, see the section "targetReplaceId Query String Parameter Example" in the topic Query String Parameter Examples of this document.

Related Information

The following list provides links to Backlot documentation that provides some general information about players.

해당 내용이 도움 되었습니까?