Player V3 Embedded Parameters for Custom Modules (Deprecated)

Note: Ooyala Player V3 has been deprecated and is scheduled to be disabled. For details and alternatives, see the OVP Release Notes.

You can add custom module embedded parameters (key value pairs) to the OO.Player.create() method. The following table describes these custom module parameters.

Parameter Description Player Type
devModuleCategory Used for the development of third party custom modules, you specify this parameter in the "flashParams" subhash of the Player.create options hash. Use this parameter to specify the custom module category such as 'universal' or 'ads-manager.'

Type: string

Valid Values: category name such as 'universal' or 'ads-manager'

Example:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    'flashParams': {
        devModuleCategory: 'universal',
        ....
    },
});
Flash only
devModuleURL Used for the development of third party custom modules, you specify this parameter in the "flashParams" subhash of the Player.create options hash. You use this parameter to specify the URL of the location where the third party module swf can be downloaded.

Type: string

Valid Values: download URL where the third party module swf is located

Example:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    'flashParams': {
        devModuleURL: 'someURL',
        ....
    },
});
Flash only
hide

Use this parameter to disable specific player functionality. The V3 HTML5 player does not display the controls by default and thus the hide parameter does not work with the V3 player. However, if you have Flash fall-back on your device, you can us use the hide parameter (see the platform parameter listed earlier). In the case where you do have Flash fall-back, you need to specify hide with flashParams in the hash.

Type: string

Valid Values: all | comma-separated list of options

where the values are:
  • all - to disable all controls
  • channels, fullscreen, embed, endscreen, info, loadingindicator, sharing, or volume,
Example:

In the following example we specify 'flashParams' in the hash and add the hide key value pair.

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

If the player is in a chromeless layout, it is possible to disable the loadingIndicator. The following example shows how to use this value with the hide parameter.

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    'flashParams': {
        hide: 'loadingindicator',
        ....
    },
});
HTML5 and Flash
layout

Use this platform parameter to control the UI layout. The parameter format is:

layout=(chromeless)

For Player V3, the parameter has the following option:

  • chromeless - Toggles the default player controls on or off. If set to chromeless, the parameter removes the chrome and the start screen. If not specified, the player reverts to its default layout.

The chromeless parameter disables the controls in the player UI and plays the video just through autoplay. To implement a chromeless layout on the Ooyala V3 Player, you can add the layout='chromeless' parameter to the <script ..../v3> tag. This disables the player controls so that the viewer can playback a video without the controls being shown. By removing the player's control bar, viewers will not be able to play the video as the playback button is removed. You need to enable a video playback so that the video will start automatically. Set the autoplay parameter to 1 to make the video to start as soon as the player finishes loading the stream.

Example:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    layout: 'chromeless'
    });
HTML5 and Flash
thruParam_dev-other Used for the development of third-party custom modules. You specify this parameter in the "flashParams" subhash of the Player.create options hash. This parameter allows you to pass basic customizations to the Ooyala player.

Type: string

Valid Values: customization code

Example:

var videoPlayer = OO.Player.create('playerwrapper',
    'embed_code', {
    height: 100%,
    width: 100%,
    'flashParams': {
        thruParam_dev-other: 'customization',
        ....
    },
});
Flash only

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