trackMediaEvent
Triggers a trackMediaEvent for the given TrackedElement.
trackMediaEvent = (parameters: {
element: TrackedElement;
locationStack?: LocationStack;
globalContexts?: GlobalContexts;
tracker?: BrowserTracker;
onError?: TrackerErrorHandlerCallback;
}) => void
Parameters
| type | default value | ||
|---|---|---|---|
| required | element | TrackedElement | |
| optional | locationStack | LocationStack | |
| optional | globalContexts | GlobalContexts | |
| optional | tracker | BrowserTracker | |
| optional | onError | TrackerErrorHandlerCallback | TrackerConsole.error |
Returns
trackMediaEvent is a void function.
Usage example
import { trackMediaEvent } from '@objectiv/tracker-browser';
<video
onLoad={(event) => {
trackMediaEvent({ element: event.target })
}}
/>
<YouTube
onCustomEvent={({ target: youTubePlayerInstance }) => {
trackMediaEvent({ element: youTubePlayerInstance.getIframe() })
}}
/>
Did you know ?
trackMediaEvent is just syntactic sugar on top of trackEvent.