play (Browser): Difference between revisions
From Engineering Client Portal
(Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Browser SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Browser SDK API Reference Call <code>pl...") |
(→Syntax) |
||
| Line 12: | Line 12: | ||
ggPM("play", metadataObject); | ggPM("play", metadataObject); | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''International (Germany) implementation''' | '''International (Germany) implementation''' | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
ggPM("play", playheadposition); | ggPM("play", playheadposition); | ||
</syntaxhighlight> | |||
<syntaxhighlight lang="javascript"> | |||
ggPM('5', playheadposition); // For VA users only | ggPM('5', playheadposition); // For VA users only | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''DCR based implementation''' | '''DCR based implementation''' | ||
<syntaxhighlight lang="javascript"> | <syntaxhighlight lang="javascript"> | ||
Latest revision as of 21:50, 21 May 2017
Engineering Portal 
Digital Browser SDK API Reference play (Browser)
Call play with the playheadPosition parameter to inform the SDK about the starting of a video.
- Normally, this API should be called when the user taps Play button on the player.
- Ability to pass the optional metadata information as a part of the metadata object.
- The channel name field is a 32-character free-form text field containing the name of the program or feed being sent, such as ESPN2, Food Network, etc.
Syntax
DTVR based implementation
ggPM("play", metadataObject);
International (Germany) implementation
ggPM("play", playheadposition);
ggPM('5', playheadposition); // For VA users only
DCR based implementation
ggPM("play", playheadposition);
Input Parameters
| Parameter | Description |
|---|---|
| event | play |
| metadataObject | CMS data to be sent as a JSON string in the format mentioned above.
"channelName": "mychannelname", “length: 3600"
This is optional. |
| playheadposition | This is the position of the playhead while calling play.
|
Notes
The client can pass the metadata parameter, as agreed between the client and Nielsen. Refer to Notes in loadMetadata for more details.