Callbacks

Before starting

• Refer to the Video player instantiation input article to understand the role of the callbacks in the video player instantiation.
• Refer to the Basic instantiation code article to understand what part of code you can extend with the callbacks full list.

Callbacks full list

Property	Type	Default	Description
setAPI	function	NA	It exposes DIVA APIs (apiRef: DivaAPI) => void; Video API reference
setPluginsManager	function	NA	It exposes DIVA Plugins Manager APIs: register, remove and change the status of plugins (pluginsManager: DivaPluginsManagerAPI) => void; Plugins reference
onLog	function	NA	Logs callback (log: logger.LogEntry) => void;
onVideoIdChanges	function	NA	Called when current videos change (videoIds: string[]) => void;
onVideoMetadataChanges	function	NA	Called when videometadata of the main video changes (videoMetadata: VideoMetadataClean) => void;
onAnalyticEventonAnalytics	function	NA	Callback for generic analytic events (event: GenericEvent) => void;
onMediaAnalyticEventonMediaAnalytics	function	NA	Callback for media analytic events (event: MediaEvent) => void;
onBackButtonClick	function	NA	Called when the user clicks on the back button during End of Play (videoMetadata: VideoMetadataClean) => void; Note: The implementation of this callback affects the presence of the button itself
onPlaybackRate	function	NA	Called when playback speed of the main video changes (rate: number) => void;
onPlayerPosition	function	NA	Called when player position (both relative to the video logical start and unix timecode) of the main video changes (position: { relativePosition: number; absolutePosition: Date } ) => void;
onPlayerMaxPosition	function	NA	Called when player max position (both relative to the video logical start and unix timecode) of the main video changes (position: { relativePosition: number; absolutePosition: Date } ) => void;
onPlayerState	function	NA	Called when player state of the main video changes (state: PlayerState) => void;
onPreferredAudioTrack	function	NA	Called when the user select an audiotrack (value: string) => void;
onPreferredCCTrack	function	NA	Called when the user select a closed caption (value: string) => void;
onPreferredVideoQuality	function	NA	Called when the user select a video quality (value: number | 'auto') => void;
onVideoError	function	NA	Called on DIVA errors (videoError: VideoError, videoMetadata: VideoMetadataClean | undefined) => void;
onVideoEnd	function	NA	Called when video end is reached () => void;
onPlayerActionRequest	function	NA	Callback for actions called by API: play, pause, seek, seekBack, seekFroward, seekPercentage, seekAbsolute (value: DivaAction) => void;
onPlaybackSession	function	NA	Called on DIVA playback session changed. It returns also a unique identifier of the DIVA item. (value: { id: string; playbackSessionId: string }) => void;
onRelatedClick	function	NA	Called on user interaction to related item. It returns a boolean. If false, it means that the default behaviour (switch) will be executed. On WebTV, the default behaviour is never executed. (videoId: string;) => boolean;
onVolume	function	NA	Called on user volume change. (value: number;) => void;
onExit	function	NA	Called on user clicking on exit button. (videoMetadata: VideoMetadataClean | undefined) => void;
onSharing	function	NA	Called on user clicking on share button. (videoMetadata: VideoMetadataClean | undefined) => void;
onTtsMessage	function	NA	Callback for Text To Speech functionality export type TtsArgs = Record<string, boolean | number | string>; export interface TtsData { messages: string[]; event: string; args?: TtsArgs; } (data: TtsData) => void;