Skip to main content

Bookmark

KollusBookmark Class​

com.kollus.sdk.media.content.KollusBookmark

A class for storing and managing information (time, title, image, etc.) about specific playback positions in video content. Handles bookmark data added by users or pre-configured by the customer.

Public Methods​

  • KollusBookmark()
  • int describeContents()
  • String getLabel()
  • int getLevel()
  • Bitmap getThumbnail()
  • int getTime()
  • String getTitle()
  • void setLabel(String label)
  • void setLevel(int level)
  • void setThumbnail(Bitmap bm)
  • void setTime(int time)
  • void setTitle(String title)
  • void writeToParcel(Parcel dest, int flags)

Static Public Methods​

  • static ArrayList<KollusBookmark> getBookmarkInfo(String jsonString)

Static Public Properties​

  • static final int NO_LEVEL = -1
  • static final int USER_LEVEL = 0
  • static final int PROVIDER_LEVEL = 1
  • static final int MAX_BOOKMARK = 1000

Constructors & Destructors​

com.kollus.sdk.media.content.KollusBookmark.KollusBookmark()

Internal SDK Only  Creates a bookmark object.

Method Details​

static ArrayList<KollusBookmark> com.kollus.sdk.media.content.KollusBookmark.getBookmarkInfo(String jsonString)

Internal SDK Only  Parses a JSON-formatted string and converts it into a list of KollusBookmark objects.

  • Parameters
    • jsonString: A JSON-formatted string of bookmark data
  • Returns: Bookmark list
String com.kollus.sdk.media.content.KollusBookmark.getLabel()

Retrieves the bookmark label.

  • Returns: Bookmark label
int com.kollus.sdk.media.content.KollusBookmark.getLevel()

Checks the creator (level) of the bookmark.

  • Returns: Bookmark level (USER_LEVEL, PROVIDER_LEVEL)
Bitmap com.kollus.sdk.media.content.KollusBookmark.getThumbnail()

Retrieves the thumbnail image captured from the video frame at the bookmark position.

  • Returns: Bookmark thumbnail bitmap
int com.kollus.sdk.media.content.KollusBookmark.getTime()

Checks the playback position where the bookmark is set.

  • Returns: Bookmark position (sec)
String com.kollus.sdk.media.content.KollusBookmark.getTitle()

Retrieves the name (title) of the bookmark.

  • Returns: Bookmark identifier name
void com.kollus.sdk.media.content.KollusBookmark.setLabel(String label)

Sets the bookmark label.

  • Parameters
    • label: Bookmark label
void com.kollus.sdk.media.content.KollusBookmark.setLevel(int level)

Sets the creator (level) of the bookmark.

  • Parameters
    • level: Bookmark level value to set
void com.kollus.sdk.media.content.KollusBookmark.setThumbnail(Bitmap bm)

Sets the thumbnail image to display at the bookmark position.

  • Parameters
    • bm: Thumbnail bitmap image to set
void com.kollus.sdk.media.content.KollusBookmark.setTime(int time)

Sets the playback position information at which the bookmark will be saved.

  • Parameters
    • time: Playback position at which to set the bookmark (sec)
void com.kollus.sdk.media.content.KollusBookmark.setTitle(String title)

Sets the name (title) of the bookmark.

  • Parameters
    • title: Bookmark identifier name

Property Details​

PropertyValueDescription
MAX_BOOKMARK1000Maximum number of bookmarks that can be registered per content
PROVIDER_LEVEL1Bookmark level pre-configured by the customer
USER_LEVEL0Bookmark level added by the user
NO_LEVEL-1State where no level information is specified

KollusPlayerBookmarkListener Interface​

com.kollus.sdk.media.KollusPlayerBookmarkListener

An interface for receiving all bookmark-related event states, including loading, adding, updating, and deleting bookmark data for content.

Public Methods​

  • void onBookmark(List<KollusBookmark> bookmark, boolean bWritable)
  • void onBookmarkDeleted(int position, boolean bDeleted)
  • void onBookmarkUpdated(int position, boolean bUpdated)
  • void onGetBookmarkError(int nErrorCode)

Method Details​

void com.kollus.sdk.media.KollusPlayerBookmarkListener.onBookmark(List<KollusBookmark> bookmark, boolean bWritable)

Called when official bookmarks (configured by the customer) or personal bookmarks (configured by the user) exist.

  • Parameters
    • bookmark: Bookmark list
    • bWritable: Whether the user can add bookmarks (true: allowed, false: not allowed)
void com.kollus.sdk.media.KollusPlayerBookmarkListener.onBookmarkDeleted(int position, boolean bDeleted)

Called when a bookmark is deleted. Depending on network conditions, there may be a delay between the deletion request and the actual callback.

  • Parameters
    • position: Position of the deleted bookmark (ms)
    • bDeleted: Whether the deletion was successful (true: success, false: failure)
void com.kollus.sdk.media.KollusPlayerBookmarkListener.onBookmarkUpdated(int position, boolean bUpdated)

Called when a bookmark is added or updated. Depending on network conditions, there may be a delay between the add request and the actual callback.

  • Parameters
    • position: Position of the updated bookmark (ms)
    • bUpdated: Whether the update was successful (true: success, false: failure)
void com.kollus.sdk.media.KollusPlayerBookmarkListener.onGetBookmarkError(int nErrorCode)

Called when a network error or JSON parsing error occurs, or when the error field value in the server response JSON is not 0.

  • Parameters
    • nErrorCode: Error code