player-core/com.bitmovin.player.api/Player/getThumbnail

getThumbnail

abstract fun getThumbnail(time: Double): Thumbnail?

Deprecated

Use `Source.getThumbnail` on the currently active source instead e.g. Player.source.getThumbnail

Replace with

source?.getThumbnail
Content copied to clipboard

Returns a Thumbnail for the provided playback time in the currently active source. Supported thumbnail formats are

  • WebVtt configured via SourceConfig.thumbnailTrack

  • HLS Image Media Playlist in the multivariant playlist

  • DASH Image Adaptation Set as specified in DASH-IF IOP

If a WebVtt thumbnail track is provided, any potential in-manifest thumbnails are ignored. WebVtt and HLS Image Media Playlist thumbnail tracks will start loading once Source.loadingState transitions to LoadingState.Loading. DASH Image Adaptation Set are available once the Source.loadingState is LoadingState.Loaded.

This function returns null

  • if there is no active playback session

  • if the thumbnails for the active source were not loaded yet

  • if there are no thumbnails available for the active source

  • if there is no thumbnail available for the active source at the provided time

If time doesn't correspond to a thumbnail (potentially because it is not loaded yet), the first thumbnail before time is returned. If time is before the oldest thumbnail, the first thumbnail after time is returned. If time is after the the latest thumbnail, the first thumbnail before time is returned.

Limitations

  • There is currently no event in place that signals when WebVtt and HLS Image Media Playlist thumbnails are loaded

  • HLS Image Media Playlist and WebVtt thumbnails are only supported for VoD sources

This function is deprecated. Use Source.getThumbnail on the currently active source instead e.g. Player.source.getThumbnail