trackMediaStartEvent
Triggers a trackMediaStartEvent for the given TrackedElement.
trackMediaStartEvent = (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
trackMediaStartEvent
is a void function.
Usage example
import { trackMediaStartEvent } from '@objectiv/tracker-browser';
<video
play={(event) => {
trackMediaStartEvent({ 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 ?
trackMediaStartEvent
is just syntactic sugar on top of trackEvent.