BookmarksManager

Manager that manages playback session's bookmark events i.e. the "continue-watching" position of the content.

Types

Link copied to clipboard
data class AssetBookmarkConfiguration(val assetID: String, val seasonId: String? = null, val episodeId: String? = null, val seasonNumber: Int? = null, val episodeNumber: Int? = null, val musicId: String? = null, val mode: Mode? = null, val nextEpisodeDetails: BookmarksPutRecord? = null, val contentType: String? = null)

A container for a media asset specific, required and optional metadata to perform BookmarksService operations.

Link copied to clipboard
data class BookmarksConfiguration(val assetID: String, val bookmarksEndPointURL: String, val bookmarkSyncIntervalMs: Long = DEFAULT_BOOKMARK_SYNC_INTERVAL_MILLIS, val bookmarkDeleteThreshold: Float? = null, val bookmarkDeleteThresholdPositionMs: Long? = null, val seasonId: String? = null, val episodeId: String? = null, val seasonNumber: Int? = null, val episodeNumber: Int? = null, val videoId: String? = null, val mode: Mode? = null, val nextEpisodeDetails: BookmarksPutRecord? = null, val contentType: String? = null)

Holds all the required and optional metadata to perform bookmarks operations.

Link copied to clipboard
data class BookmarksServiceConfiguration(val bookmarksEndPointURL: String, val bookmarkSyncIntervalMs: Long = DEFAULT_BOOKMARK_SYNC_INTERVAL_MILLIS, val bookmarkDeleteThreshold: Float? = null, val bookmarkDeleteThresholdPositionMs: Long? = null)

A container for the BookmarksService specific, required and optional metadata to perform BookmarksService operations.

Link copied to clipboard

Callback for observing media playlist item transitions. This is typically used for scenarios like tracking progress in a continuous playback session (e.g., binge-watching episodes) where the player automatically moves from one item to the next.

Properties

Link copied to clipboard

The BookmarksManager.BookmarksConfiguration instance that holds all the relevant metadata to execute bookmarking operations.

Link copied to clipboard
abstract val player: ComposablePlayer

ComposablePlayer instance that provides PlaybackState and playback position information which is used to fire bookmark calls at requisite points of time / player events.

Functions

Link copied to clipboard
open fun setNextEpisodeDetails(episodeDetail: BookmarksPutRecord)

Sets the details of the next episode to be used for bookmark operations.