trackMediaStopEvent

Triggers a trackMediaStopEvent for the given TrackedElement.

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

Parameters

typedefault value
requiredelementTrackedElement
optionallocationStackLocationStack
optionalglobalContextsGlobalContexts
optionaltrackerBrowserTracker
optionalonErrorTrackerErrorHandlerCallbackTrackerConsole.error

Returns

trackMediaStopEvent is a void function.

Usage example

import { trackMediaStopEvent } from '@objectiv/tracker-browser';
<video
onStop={(event) => {
trackMediaStopEvent({ element: event.target })
}}
/>
<YouTube
onStop={({ target: youTubePlayerInstance }) => {
trackMediaStopEvent({ element: youTubePlayerInstance.getIframe() })
}}
/>

Did you know ?

trackMediaStopEvent is just syntactic sugar on top of trackEvent.