Enabling Third Parties to Pass Parameters to YOUBORA

Certain third parties can pass data (parameters) through to the YOUBORA dashboard. Please talk to your Ooyala point of contact to see if a specific third party is able to pass parameters to the YOUBORA dashboard.

The Ooyala-NPAW plugin passes over the entire player message bus to NPAW. Other third parties need to work with NPAW to identify what variables they need to assign on their end (e.g. a "Client Id" for a user login) and then listen for on the other end to receive that data (e.g. NPAW receiving the third party's "Client ID" in their "username" parameter).

In order for NPAW to get extra data from a third party integration, the third party will need to leverage the following code that creates the Ooyala player.
window.pp = OO.Player.create('player', 'yourEmbedCode',
{ autoplay: false, enableDiagnostics:true, preload: false, }

The last parameter, { autoplay: false, enableDiagnostics:true, preload: false }

is an object that can contain extra data for optional player functionality, such as autoplay, enableDiagnostics, etc. A third party can use this object to programmatically send new parameters for NPAW. The params will need to be contained in a new object called npaw_extra_params. The parameters are named extraParam1and extraParam2, etc.. You can also include Youbora parameters in this object. Below is an example of what the last parameter will look like if you want to send two third party parameters and a user ID value that lets you get statistics for a specific user:
    autoplay: false,
    preload: false,
            extraParam1: "myEmbedCode",
            extraParam2: "myPlayerId",
            username: "example@ooyalA.com"

In the example above, the code is always sending the embed code as parameter 1 and the player id as parameter 2. The data must be consistent. If the embed code is sent as parameter 2, NPAW will assume it's actually the player id (in this case). If you need to assign a label for what extraParam1 and extraParam2 signify, then you must take care of that on the YOUBORA dashboard.

See the YOUBORA product documentation for the full list of YOUBORA parameters you can use.

Was this article helpful?