trackMediaPauseEvent

Triggers a MediaPauseEvent for the given TrackedElement.

trackMediaPauseEvent = (parameters: {
element: TrackedElement;
locationStack?: LocationStack;
globalContexts?: GlobalContexts;
tracker?: BrowserTracker;
onError?: TrackerErrorHandlerCallback;
}) => void

Parameters

typedefault value
requiredelementTrackedElement
optionallocationStackLocationStack
optionalglobalContextsGlobalContexts
optionaltrackerBrowserTracker
optionalonErrorTrackerErrorHandlerCallbackTrackerConsole.error

Returns

trackMediaPauseEvent is a void function.

Usage example

import { trackMediaPauseEvent } from '@objectiv/tracker-browser';
<video
play={(event) => {
trackMediaPauseEvent({ element: event.target })
}}
pause={(event) => {
trackMediaPauseEvent({ element: event.target })
}}
/>
<YouTube
onPlay={({ target: youTubePlayerInstance }) => {
trackMediaStartEvent({ element: youTubePlayerInstance.getIframe() })
}}
onPause={({ target: youTubePlayerInstance }) => {
trackMediaPauseEvent({ element: youTubePlayerInstance.getIframe() })
}}
/>

Did you know ?

trackMediaPauseEvent is just syntactic sugar on top of trackEvent.