Package com.brightcove.player.mediacontroller

Class DefaultThumbnailDocument

java.lang.Object

com.brightcove.player.mediacontroller.DefaultThumbnailDocument

All Implemented Interfaces:

ThumbnailDocument

public final class DefaultThumbnailDocument
extends java.lang.Object
implements ThumbnailDocument

The default ThumbnailDocument used in the Thumbnail plugin.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultThumbnailDocument.StartTimeComparator	A Comparator used to sort TimedThumbnails based on their start time

Field Summary

Fields inherited from interface com.brightcove.player.mediacontroller.ThumbnailDocument

EMPTY

Constructor Summary

Constructors

Constructor	Description
DefaultThumbnailDocument(java.util.List<TimedThumbnail> timedThumbnailList, TimedThumbnailFilter timedThumbnailFilter)	Instantiate a DefaultThumbnailDocument given a list of TimedThumbnail and a TimedThumbnailFilter.

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
TimedThumbnail	get(long timeInMillis)	Gets the TimedThumbnail given the Video's playhead position
java.util.List<TimedThumbnail>	getAll()
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultThumbnailDocument

public DefaultThumbnailDocument(@NonNull
                                java.util.List<TimedThumbnail> timedThumbnailList,
                                @NonNull
                                TimedThumbnailFilter timedThumbnailFilter)

Instantiate a DefaultThumbnailDocument given a list of TimedThumbnail and a TimedThumbnailFilter. To avoid filtering such a list, set TimedThumbnailFilter.NO_FILTER

Parameters:

timedThumbnailList - list of TimedThumbnail

timedThumbnailFilter - the TimedThumbnailFilter

Method Detail

get

@NonNull
public TimedThumbnail get(long timeInMillis)

Description copied from interface: ThumbnailDocument

Gets the TimedThumbnail given the Video's playhead position

Specified by:

get in interface ThumbnailDocument

Parameters:

timeInMillis - the video playhead position

Returns:

a valid TimedThumbnail or TimedThumbnail.EMPTY if not found

getAll

@NonNull
public java.util.List<TimedThumbnail> getAll()

Specified by:

getAll in interface ThumbnailDocument

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object