useMediaLoadEventTracker

Returns a ready-to-trigger trackMediaLoadEvent by retrieving ReactTracker instance and LocationStack automatically.

useMediaLoadEventTracker = (
hookParameters: {
tracker?: Tracker,
options?: TrackEventOptions,
locationStack?: LocationStack,
globalContexts?: GlobalContexts
} = {}
) => (
callbackParameters: {
tracker?: Tracker,
options?: TrackEventOptions,
locationStack?: LocationStack,
globalContexts?: GlobalContexts
} = {}
) => Promise<TrackerEvent>

Parameters

The hook and callback share tracker, options, locationStack and globalContexts parameters.

This allows composing the Event's payload by combining parameters provided to the hook and/or the callback:

  • tracker: Custom tracker instance. By default, useTracker() is used, which can be overridden by providing this parameter to the hook, or later to the callback. If both hook and callback have tracker parameters, the callback takes precedence.

  • options: The callback options are shallow merged onto the hook's ones. E.g. the parameters with the same name from the callback's options will overwrite the hook's ones.

  • locationStack: The callback and hook LocationStack are merged with the result of useLocationStack(). This allows to combine the LocationStack of parent components with the virtual Locations provided to either the hook or callback, or both.

  • globalContexts: The callback and hook GlobalContexts items are simply merged together.


Hook Parameters

typedefault value
optionaltrackerReactTrackeruseTracker()
optionaloptionsTrackEventOptions
optionallocationStackLocationStackuseLocationStack()
optionalglobalContextsGlobalContexts

Callback Parameters

typedefault value
optionaltrackerReactTracker
optionaloptionsTrackEventOptions
optionallocationStackLocationStack
optionalglobalContextsGlobalContexts

TrackEventOptions

The Tracker can leverage its Queue for sending synchronous events. Here is an overview of how that works:

Returns

A callback with the same parameters of the hook itself.

(callbackParameters: {
tracker?: Tracker,
options?: TrackEventOptions,
locationStack?: LocationStack,
globalContexts?: GlobalContexts
} = {}) => Promise<TrackerEvent>

Usage

Scenario: declaratively wrapping a third party media player with callbacks
import { MediaPlayerContextWrapper, useMediaLoadEventTracker } from "@objectiv/tracker-react";

const trackMediaLoad = useMediaLoadEventTracker();

<MediaPlayerContextWrapper id={video.id}>
<VideoPlayer
video={video}
onReady={() => {
trackMediaLoad();
}}
/>
</MediaPlayerContextWrapper>
Scenario: virtual location wrapper
import { makeMediaPlayerContext } from "@objectiv/tracker-core";
import { useMediaLoadEventTracker } from "@objectiv/tracker-react";

const trackMediaLoad = useMediaLoadEventTracker();

<RandomVideoPlayer
onReady={(randomVideo) => {
trackMediaLoad({
// Wrap this event in a virtual location representing the video
locationStack: [
makeMediaPlayerContext({
id: randomVideo.id
})
]
});
}}
/>