Events

This page shows the list of available callbacks to handle player notifications

Details

onAudioBecomingNoisy

Platforms: Android | iOS

Callback function that is called when the audio is about to become 'noisy' due to a change in audio outputs. Typically this is called when audio output is being switched from an external source like headphones back to the internal speaker. It's a good idea to pause the media when this happens so the speaker doesn't start blasting sound.

Payload: none

onAudioFocusChanged

Platform: Android

Callback function that is called when the audio focus changes. This is called when the audio focus is gained or lost. This is useful for determining if the media should be paused or not.

Payload:

Example:

{
  hasAudioFocus: true;
}

onAudioTracks

Platforms: Android | iOS

Callback function that is called when audio tracks change

Payload:

An array of

Example:

{
  audioTracks: [
    { language: 'es', title: 'Spanish', type: 'audio/mpeg', index: 0, selected: true },
    { language: 'en', title: 'English', type: 'audio/mpeg', index: 1 }
  ];
}

onBandwidthUpdate

Platforms: Android | iOS

Callback function that is called when the available bandwidth changes.

Payload:

Example on iOS:

{
  bitrate: 1000000;
}

Example on Android:

{
  bitrate: 1000000;
  width: 1920;
  height: 1080;
  trackId: 'some-track-id';
}

Note: On Android, you must set the reportBandwidth prop to enable this event. This is due to the high volume of events generated.

onBuffer

Platforms: Android | iOS | web

Callback function that is called when the player buffers.

Payload:

Example:

{
  isBuffering: true;
}

onControlsVisibilityChange

Platform: Android

Callback function that is called when the controls are hidden or shown. Not possible on iOS.

Payload:

Example:

{
  isVisible: true;
}

onEnd

Platforms: All

Callback function that is called when the player reaches the end of the media.

Payload: none

onError

Platforms: All

Callback function that is called when the player experiences a playback error.

Payload:

onExternalPlaybackChange

Platform: iOS

Callback function that is called when external playback mode for current playing video has changed. Mostly useful when connecting/disconnecting to Apple TV – it's called on connection/disconnection.

Payload:

Example:

{
  isExternalPlaybackActive: true;
}

onFullscreenPlayerWillPresent

Platforms: Android | iOS | visionOS

Callback function that is called when the player is about to enter fullscreen mode.

Payload: none

onFullscreenPlayerDidPresent

Platforms: Android | iOS | visionOS

Callback function that is called when the player has entered fullscreen mode.

Payload: none

onFullscreenPlayerWillDismiss

Platforms: Android | iOS | visionOS

Callback function that is called when the player is about to exit fullscreen mode.

Payload: none

onFullscreenPlayerDidDismiss

Platforms: Android | iOS | visionOS

Callback function that is called when the player has exited fullscreen mode.

Payload: none

onLoad

Platforms: All

Callback function that is called when the media is loaded and ready to play.

NOTE: tracks (audioTracks, textTracks & videoTracks) are not available on the web.

Payload:

Example:

{
  canPlaySlowForward: true,
  canPlayReverse: false,
  canPlaySlowReverse: false,
  canPlayFastForward: false,
  canStepForward: false,
  canStepBackward: false,
  currentTime: 0,
  duration: 5910.208984375,
  naturalSize: {
     height: 1080
     orientation: 'landscape'
     width: '1920'
  },
  audioTracks: [
    { language: 'es', title: 'Spanish', type: 'audio/mpeg', index: 0 },
    { language: 'en', title: 'English', type: 'audio/mpeg', index: 1 }
  ],
  textTracks: [
    { title: '#1 French', language: 'fr', index: 0, type: 'text/vtt' },
    { title: '#2 English CC', language: 'en', index: 1, type: 'text/vtt' },
    { title: '#3 English Director Commentary', language: 'en', index: 2, type: 'text/vtt' }
  ],
  videoTracks: [
    { index: 0, bitrate: 3987904, codecs: "avc1.640028", height: 720, trackId: "f1-v1-x3", width: 1280 },
    { index: 1, bitrate: 7981888, codecs: "avc1.640028", height: 1080, trackId: "f2-v1-x3", width: 1920 },
    { index: 2, bitrate: 1994979, codecs: "avc1.4d401f", height: 480, trackId: "f3-v1-x3", width: 848 }
  ],
  trackId: "720p 2400kbps"
}

onLoadStart

Platforms: All

Callback function that is called when the media starts loading.

Payload:

Example:

{
  isNetwork: true,
  type: '',
  uri: 'https://bitdash-a.akamaihd.net/content/sintel/hls/playlist.m3u8'
}

onPlaybackStateChanged

Platforms: Android | iOS | visionOS | web

Callback function that is called when the playback state changes.

Payload:

Example:

{
  isPlaying: true,
  isSeeking: false
}

onPictureInPictureStatusChanged

Platform: iOS

Callback function that is called when picture in picture becomes active or inactive.

Example:

{
  isActive: true;
}

onPlaybackRateChange

Platforms: All

Callback function that is called when the rate of playback changes - either paused or starts/resumes.

Example:

{
  playbackRate: 0, // indicates paused
}

onProgress

Platforms: All

Callback function that is called every progressUpdateInterval milliseconds with info about which position the media is currently playing.

Example:

{
  currentTime: 5.2,
  playableDuration: 34.6,
  seekableDuration: 888
}

onReadyForDisplay

Platforms: Android | iOS | Web

Callback function that is called when the first video frame is ready for display. This is when the poster is removed.

Payload: none

• iOS: readyForDisplay (opens in a new tab)
• Android STATE_READY (opens in a new tab)

onReceiveAdEvent

Platforms: Android | iOS

Callback function that is called when an AdEvent is received from the IMA's SDK.

Enum AdEvent possible values for Android (opens in a new tab) and iOS (opens in a new tab):

Payload:

Example:

{
  "data": {
    "key": "value"
  },
  "event": "LOG"
}

onRestoreUserInterfaceForPictureInPictureStop

Platforms: iOS | visionOS

Callback function that corresponds to Apple's restoreUserInterfaceForPictureInPictureStopWithCompletionHandler (opens in a new tab). Call restoreUserInterfaceForPictureInPictureStopCompleted inside of this function when done restoring the user interface.

Payload: none

onSeek

Platforms: Android | iOS | Windows UWP | web

Callback function that is called when a seek completes.

Payload:

Example:

{
  currentTime: 100.5;
  seekTime: 100;
}

Both the currentTime & seekTime are reported because the video player may not seek to the exact requested position in order to improve seek performance.

Note: on iOS, when controls are enable, this callback is not reported. This is a known limitation.

onTimedMetadata

Platforms: Android | iOS | visionOS

Callback function that is called when timed metadata becomes available

Payload:

Example:

{
  metadata: [
    {value: 'Streaming Encoder', identifier: 'TRSN'},
    {value: 'Internet Stream', identifier: 'TRSO'},
    {value: 'Any Time You Like', identifier: 'TIT2'},
  ];
}

onTextTrackDataChanged

Platforms: Android | iOS

Callback function that is called when new subtitle data is available. It provides the actual subtitle content for the current selected text track, if available (mainly WebVTT).

Payload:

Example:

{
  subtitleTracks: "This blade has a dark past.",
}

For details on how to control the visibility of subtitles, see the subtitleStyle section.

onTextTracks

Platforms: Android | iOS

Callback function that is called when text tracks change

Payload:

Example:

{
  textTracks: [
    {
      index: 0,
      title: 'Any Time You Like',
      type: 'srt',
      selected: true,
    },
  ];
}

onVideoTracks

Platform: Android

Callback function that is called when video tracks change

Payload:

Example:

{
  videoTracks: [
    {
      index: O,
      trackId: "0",
      codecs: 'video/mp4',
      width: 1920,
      height: 1080,
      bitrate: 10000,
      selected: true,
      rotation: 0,
    },
  ];
}

onVolumeChange

Platforms: Android | iOS | visionOS | web

Callback function that is called when the volume of player changes.

Note: This event applies to the volume of the player, not the volume of the device.

Payload:

Example:

{
  volume: 0.5;
}