Browser SDK API Table: Difference between revisions
From Engineering Client Portal
NickParrucci (talk | contribs) (Created page with "== Browser SDK API Methods & Properties Table == {| class="wikitable sortable" |- ! Method / Property !! Event # !! DTVR !! DAR !! DCR !! Description |- | loadMetadata (Brow...") |
NickParrucci (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Breadcrumb|}} {{Breadcrumb|Digital}} {{CurrentBreadcrumb}} | |||
[[Category:Digital]] | |||
__NOTOC__ | |||
== Browser SDK API Methods & Properties Table == | == Browser SDK API Methods & Properties Table == | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
| Line 4: | Line 8: | ||
! Method / Property !! Event # !! DTVR !! DAR !! DCR !! Description | ! Method / Property !! Event # !! DTVR !! DAR !! DCR !! Description | ||
|- | |- | ||
| [[loadMetadata (Browser)]] || 15 || ✔ || ✔ || ✔ || Used when there is a preroll ad that needs to be associated with content metadata. The loadMetadata will first be called to populate the content metadata values and then the loadMetadata for ad metadata will be called. This allows sending a content ping with the ad info, even if the user bails out during the preroll ad. | | [[loadMetadata (Browser)|loadMetadata]] || 15 || ✔ || ✔ || ✔ || Used when there is a preroll ad that needs to be associated with content metadata. The loadMetadata will first be called to populate the content metadata values and then the loadMetadata for ad metadata will be called. This allows sending a content ping with the ad info, even if the user bails out during the preroll ad. | ||
|- | |- | ||
| [[play (Browser)]] || 5 || ✔ || ✘ || ✔ || Used when there is an ID3 fed product such as DTVR and the client does not want to send in all the CMS metadata that is sent in loadMetadata. This allows the client to send in at least the required “channel name” value associated to the ID3 feed. When the client passes in the channelName, they can change the CMS data stored by passing new values. If this event is not called then the “channel name” value populated will be the default value of “defaultChannelName”. | | [[play (Browser)|play]] || 5 || ✔ || ✘ || ✔ || Used when there is an ID3 fed product such as DTVR and the client does not want to send in all the CMS metadata that is sent in loadMetadata. This allows the client to send in at least the required “channel name” value associated to the ID3 feed. When the client passes in the channelName, they can change the CMS data stored by passing new values. If this event is not called then the “channel name” value populated will be the default value of “defaultChannelName”. | ||
|- | |- | ||
| [[sendID3 (Browser)]] || 55 || ✔ || ✘ || ✘ || Used to send the ID3 metadata. | | [[sendID3 (Browser)|sendID3]] || 55 || ✔ || ✘ || ✘ || Used to send the ID3 metadata. | ||
|- | |- | ||
| [[setPlayheadPosition (Browser)]] || 49 || ✘ || ✘ || ✔ || Used to send the playhead position. | | [[setPlayheadPosition (Browser)|setPlayheadPosition]] || 49 || ✘ || ✘ || ✔ || Used to send the playhead position. | ||
|- | |- | ||
| [[stop (Browser)]] || 7 || ✘ || ✘ || ✔ || Used when switching between ad and content or content and ad. | | [[stop (Browser)|stop]] || 7 || ✘ || ✘ || ✔ || Used when switching between ad and content or content and ad. | ||
|- | |- | ||
| [[end (Browser)]] || 57 || ✔ || ✘ || ✔ || This is triggered 1) at the end of the content stream, 2) if the user switches to another piece of content 3) when the browser is refreshed or closed | | [[end (Browser)|end]] || 57 || ✔ || ✘ || ✔ || This is triggered 1) at the end of the content stream, 2) if the user switches to another piece of content 3) when the browser is refreshed or closed | ||
|- | |- | ||
| [[staticstart (Browser)]] || 14 || ✘ || ✘ || ✔ || Used to send the metadata for the static page. | | [[staticstart (Browser)|staticstart]] || 14 || ✘ || ✘ || ✔ || Used to send the metadata for the static page. | ||
|- | |- | ||
| [[ | | [[StaticEnd (Browser)|staticend]] || 56 || ✘ || ✘ || ✔ || The API call for staticend is not a requirement for all DCR Static integrations, however if client integration is a Single Page Application (SPA) it is imperative that staticend is called prior to the loading of new metadata. This allows the Browser SDK to properly credit the previous section/content being viewed before measuring the new one. | ||
|- | |- | ||
| [[ | | [[updateOTT (Browser)|updateOTT]] || - || ✘ || ✘ || ✔ || Used to notify Browser SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status). | ||
|- | |- | ||
| [[ | | [[ onPaginate (Browser)|onPaginate]] || 30 || ✘ || ✘ || ✔ || Used to create a new instance of the SDK object | ||
|- | |- | ||
| [[setVolume (Browser)]] || 61 || ✔ || ✘ || ✔ || Used to pass in the player volume levels in % | | [[updateMetadata (Browser)|updateMetadata]] || 35 || ✔ || ✔ || ✔ || This event is used for updating metadata parameters for the content or ad that is being played. | ||
|- | |||
| [[setVolume (Browser)|setVolume]] || 61 || ✔ || ✘ || ✔ || Used to pass in the player volume levels in %. Default value is -1. | |||
|} | |} | ||
Latest revision as of 19:24, 7 June 2023
Browser SDK API Methods & Properties Table
| Method / Property | Event # | DTVR | DAR | DCR | Description |
|---|---|---|---|---|---|
| loadMetadata | 15 | ✔ | ✔ | ✔ | Used when there is a preroll ad that needs to be associated with content metadata. The loadMetadata will first be called to populate the content metadata values and then the loadMetadata for ad metadata will be called. This allows sending a content ping with the ad info, even if the user bails out during the preroll ad. |
| play | 5 | ✔ | ✘ | ✔ | Used when there is an ID3 fed product such as DTVR and the client does not want to send in all the CMS metadata that is sent in loadMetadata. This allows the client to send in at least the required “channel name” value associated to the ID3 feed. When the client passes in the channelName, they can change the CMS data stored by passing new values. If this event is not called then the “channel name” value populated will be the default value of “defaultChannelName”. |
| sendID3 | 55 | ✔ | ✘ | ✘ | Used to send the ID3 metadata. |
| setPlayheadPosition | 49 | ✘ | ✘ | ✔ | Used to send the playhead position. |
| stop | 7 | ✘ | ✘ | ✔ | Used when switching between ad and content or content and ad. |
| end | 57 | ✔ | ✘ | ✔ | This is triggered 1) at the end of the content stream, 2) if the user switches to another piece of content 3) when the browser is refreshed or closed |
| staticstart | 14 | ✘ | ✘ | ✔ | Used to send the metadata for the static page. |
| staticend | 56 | ✘ | ✘ | ✔ | The API call for staticend is not a requirement for all DCR Static integrations, however if client integration is a Single Page Application (SPA) it is imperative that staticend is called prior to the loading of new metadata. This allows the Browser SDK to properly credit the previous section/content being viewed before measuring the new one. |
| updateOTT | - | ✘ | ✘ | ✔ | Used to notify Browser SDK that the remote OTT device (like Google ChromeCast, Roku, Amazon FireTV, etc.) is connected / disconnected (change of OTT status). |
| onPaginate | 30 | ✘ | ✘ | ✔ | Used to create a new instance of the SDK object |
| updateMetadata | 35 | ✔ | ✔ | ✔ | This event is used for updating metadata parameters for the content or ad that is being played. |
| setVolume | 61 | ✔ | ✘ | ✔ | Used to pass in the player volume levels in %. Default value is -1. |