| Media.open | s.Media.open(
mediaName,
mediaLength,
mediaPlayerName) | trackSessionStart | trackSessionStart(
mediaObject,
contextData) |
| mediaName | mediaName: (required) The name of the video as you want it to appear in video reports. | name | createMediaObject(
name,
mediaId,
length,
streamType) |
| mediaLength | mediaLength: (required) The length of the video in seconds. | length | createMediaObject(
name,
mediaId,
length,
streamType) |
| mediaPlayerName | mediaPlayerName: (required) The name of the media player used to view the video, as you want it to appear in video reports. | playerName | MediaHeartbeatConfig.
playerName |
| Media.openAd | s.Media.openAd(
name,
length,
playerName,
parentName,
parentPod,
parentPodPosition,
CPM) | trackEvent | mediaHeartbeat.trackEvent(
MediaHeartbeat.
Event.
AdBreakStart,
adBreakObject);
...
trackEvent(
MediaHeartbeat.
Event.
AdStart,
adObject,
adCustomMetadata); |
| name | name: (required) The name or ID of the ad. | name | createAdObject(
name,
adId,
position,
length) |
| length | length: (required) The length of the ad. | length | createAdObject(
name,
adId,
position,
length) |
| playerName | playerName: (required) The name of the media player used to view the ad. | playerName | MediaHeartbeatConfig.
playerName |
| parentName | parentName: The name or ID of the primary content where the ad is embedded. | N/A | Automatically inherited. |
| parentPod | parentPod: The position in the primary content the ad was played. | position | createAdBreakObject(
name,
position,
startTime) |
| parentPodPosition | parentPodPosition: The position within the pod where the ad is played. | position | createAdObject(
name,
adId,
position,
length) |
| CPM | CPM: The CPM or encrypted CPM (prefixed with a “~”) that applies to this playback. | N/A | Not available by default in Media Analytics. |
| Media.click | s.Media.click(name, offset) | N/A | Use a custom link analytics call to track clicks. |
| Media.close | s.Media.close(mediaName) | trackSessionEnd | trackSessionEnd() |
| Media.complete | s.Media.complete(name, offset) | trackComplete | trackComplete() |
| Media.play | s.Media.play(
name,
offset,
segmentNum,
segment,
segmentLength) | trackPlay | trackPlay() |
| Media.stop | s.Media.stop(mediaName, mediaOffset) | trackPause
or
trackEvent | trackPause()
or trackEvent(
MediaHeartbeat.
Event.
SeekStart)
or
trackEvent(
MediaHeartbeat.
Event.
BufferStart); |
| Media.monitor | s.Media.monitor(s, media) | Use custom or standard metadata to set additional variables. | var customVideoMetadata =
{
isUserLoggedIn:
"false",
tvStation:
"Sample TV station",
programmer:
"Sample programmer"
};
...
var standardVideoMetadata
= {};
standardVideoMetadata
[MediaHeartbeat.
VideoMetadataKeys.
EPISODE] =
"Sample Episode";
standardVideoMetadata
[MediaHeartbeat.
VideoMetadataKeys.
SHOW] = "Sample Show";
...
mediaObject.setValue(
MediaHeartbeat.
MediaObjectKey.
StandardVideoMetadata,
standardVideoMetadata); |
| Media.track | s.Media.track(mediaName) | N/A | Tracking call frequency is automatically set. |