Player V3 Embedded Parameters (Deprecated)

Each ad set has a unique Ad Set Code identifier. Use the adSetCode key value pair to associate an ad set with a particular player and player asset (video).

Example:

<script>
    var videoPlayer = OO.Player.create('playerwrapper','embed_code',{
      height:'100%',
      width:'100%',
      adSetCode:'yourAdSetCode'
    });
<script>

Enables the use of custom analytics tags in Player V3.

Example:

...
var ca_tags = [];
ca_tags[0] = "toolbar";
OO.ready(
    function () {
        OO.Player.create('ooyalaplayer',
            'w3ZHc0Njr33Tdp-RRcwfZMjaOrmzOP82', {
                analytics: {
                    "tags": ca_tags
                }
            });
    });
...

Enables the automatic playing of an asset (video or audio) upon loading. This is useful for UIs that do not have play/pause controls or conditions where you want the content to play immediately.

Example:

var videoPlayer = OO.Player.create('playerwrapper',
         'embed_code', {
         height:100%,
         width:100%,
         autoplay:true,
         .... 
  });

For HTML:

• Set enableChannels : true to play the first video of the channel or the first video of the first channel of the channel set
• Set enableChannels : false to display an error screen.

For Flash:

• Set enableChannels : true to pass the channel embed to the player to run normally (this may impact performance).
• Set enableChannels : false to display an error screen.

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    enableChannels: true,
    ....
});

Type: integer

Valid Values: time in seconds

Example: initialTime: 10

OO.ready(function () {
    window.pp = OO.Player.create('playerV3Container',
        'embed_code', {
        width: 480,
        height: 360,
        initialTime: 10
    }); 

Example:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    'in-stream': {
        tagUrl: 'some url',
        ....
    },
});

Use this parameter to set or override the language and closed caption options. In the following example, the locale parameter is used to create a Hebrew localized player. Note that because of the way that closed captions are supported in iOS, we are not able to add closed caption data for IOS web for remote assets.

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    locale: 'he_IL',
    ....
});

Example:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    loop: true,
    ....
});

When called, onCreate: function(player):

• Checks for any additional modules (custom, 3rd party or other type).

• Enables these additional modules to connect to the message bus.

• Sends a message to the message bus signaling each module to start up.

You must call onCreate before anything can happen; otherwise, the existing and additional or third-party modules are not connected to the message bus and are not initialized.

Example

    OO.Player.create('playerwrapper',embedCode, {
      onCreate: function(player) {
        player.subscribe('*','myPage', function(eventName) {});
      }
    });

onCreate and the Player V2 Callback

To handle events in Player V2, you can define a callback function, and then pass its name to the embed tag using a callback parameter. However, to handle events in Player V3, you provide an onCreate function to the OO.Player.create() call, and then register for all the messages. For more information about Player V3 events, see Event Model for HTML5 Player V3 (Deprecated). For information about Player V2 callbacks and parameters, see the Player Query String Parameters (Player V2 Deprecated) topic. Keep in mind that Player V2 is deprecated.

• To decrease load time when loading multiple videos on the same page
• To avoid the cost of loading when you expect a video to be played infrequently

Example:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    preload: false,
    ....
});

Specifies whether to show or hide the ad marquee during ad playback. If showAdMarquee is missing or set to true, the ad marquee will appear while an ad is playing on your player. This global parameter works for all ad types supported by Ooyala.

Default: True

var player = OO.Player.create('playerwrapper', embedCode, {
    showAdMarquee: true
});

Specifies whether to show or hide the control bar during ad playback. If showInAdControlBar is missing or set to true, the control bar will appear while an ad is playing on your player. This global parameter works for all ad types supported by Ooyala.

Note: This parameter is available for Flash and HTML5 desktop.

Default: True

var player = OO.Player.create('playerwrapper', embedCode, {
    showInAdControlBar: false
});

Note: This parameter is for Flash desktop only.

This optional parameter specifies the position on the player where the TV rating watermark will appear.

Valid Values: top-left | top-right | bottom-left | bottom-right

Default: top-left

Note: To apply a TV Rating watermark to an asset, you need to include custom metadata in Backlot per asset you want given the TV Rating watermark. See Adding a TV Rating Watermark to a Flash Player for detailed information on applying a TV Rating watermark to an asset.

var player = OO.Player.create('playerwrapper', embedCode, {
    tvRatingsPosition: "top-left"
});

Note: This parameter is for Flash desktop only.

Specifies the duration of the TV Rating watermark on the player (in seconds) on initial play and every time the video resumes from Ad breaks. This parameter is required if you want to apply a TV Rating watermark to an asset.

Default: never

Note: To apply a TV Rating watermark to an asset, you need to include custom metadata in Backlot per asset you want given the TV Rating watermark. See Adding a TV Rating Watermark to a Flash Player for detailed information on applying a TV Rating watermark to an asset.

var player = OO.Player.create('playerwrapper', embedCode, {
    tvRatingsTimer: "15"
});

Type: Boolean

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    useFirstVideoFromPlaylist: true,
    ....
   };

    ooyalaPlayer = OO.Player.create('playerContainer', '', playerConfiguration);
}); 

Note:When a playlist is updated, after the caches expire, the first video in the first playlist that useFirstVideoFromPlaylist uses is updated.

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    useFirstVideoFromPlaylist: false,
    ....
   };

    ooyalaPlayer = OO.Player.create('playerContainer', 'embed_code', playerConfiguration);
});