video-ad-sdk
Version:
VAST/VPAID SDK that allows video ads to be played on top of any player
39 lines (38 loc) • 2.88 kB
TypeScript
import type { VastChain, VastEventTrackerOptions } from '../types';
declare const linearTrackers: {
clickThrough: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
closeLinear: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
complete: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
creativeView: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
error: (vastChain: VastChain, { errorCode, tracker }: VastEventTrackerOptions) => void;
exitFullscreen: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
firstQuartile: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
fullscreen: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
iconClick: (_vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
iconView: (_vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
impression: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
midpoint: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
mute: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
notViewable: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
pause: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
playerCollapse: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
playerExpand: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
progress: (_vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
resume: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
rewind: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
skip: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
start: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
thirdQuartile: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
unmute: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
viewable: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
viewUndetermined: (vastChain: VastChain, { data, tracker }: VastEventTrackerOptions) => void;
};
/**
* Tracks the passed linear event.
*
* @param event name of the linear event we need to track. @see LinearEvents
* @param vastChain the ad VAST Chain.
* @param options Options Map. The allowed properties are:
*/
export declare const trackLinearEvent: (event: keyof typeof linearTrackers, vastChain: VastChain, { data, errorCode, tracker, logger }: VastEventTrackerOptions) => void;
export {};