updateOTT (Browser)

From Engineering Client Portal

Revision as of 21:53, 21 May 2017 by Admin (talk | contribs) (Created page with "{{Breadcrumb|}} {{Breadcrumb|Digital}} {{Breadcrumb|Browser SDK API Reference}} {{CurrentBreadcrumb}} Category:Digital Category:Browser SDK API Reference Use the ggPM...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Engineering Portal / Digital / Browser SDK API Reference / updateOTT (Browser)
Use the ggPM function to pass updateOTT as event parameter in order to notify Browser SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status).

  • When OTT device is connected, call ggPM("updateOTT", {"ottStatus": "1",…}) and a set of OTT device related parameters in the same JSON object.
  • When OTT device is disconnected, call ggPM("updateOTT",{"ottStatus": "0"}).

Syntax

NA // For VA users only


International (Germany) implementation

ggPM("updateOTT", {"ottStatus": "1',}); // Except VA users

Input Parameters

Parameter Description
ottInfo A JSON string with the following parameters:

OTT device is connected:

{
   "ottStatus": "1",
   "ottType": "ottTypeStatus",
   "ottDevice": "ottchromecast",
   "ottDeviceName": ottDeviceNChromeCast",
   "ottDeviceID": "xxxx-xxxx-xxxx",
   "ottDeviceManufacturer": "ottDeviceMan",
   "ottDeviceModel": "ottChromeCast",
   "ottDeviceVersion": "1.0.0"
}


OTT device is disconnected:

{
    "ottStatus": "0"
}

Output Parameters

Parameter Description
event stop
playheadposition The exact position of playhead when streaming was paused.

Output Parameters

Output Parameters (Return value) Description
void

Notes

The player needs to report all the possible OTT types (casting, screen mirroring, etc.) to the Browser SDK.

Communicating with the Chromecast Receiver App

Browser SDK cannot communicate directly with the Receiver App running on the Chromecast as it needs access to the Google Casting framework. Alternatively, Browser SDK requires the application to pass the data to the Receiver App.