com.brightcove.player.mediacontroller

## Interface ThumbnailDocument

- All Known Implementing Classes:
    DefaultThumbnailDocument, SSAIThumbnailDocument

      public interface ThumbnailDocument

  The document containing an ordered list of `TimedThumbnail` for a particular `Video`

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static ThumbnailDocument` | `EMPTY` An empty `ThumbnailDocument`.

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `TimedThumbnail` | `get(long playheadPositionInMillis)` Gets the `TimedThumbnail` given the Video's playhead position
    `java.util.List<TimedThumbnail>` | `getAll()`

- - ### Field Detail

    - #### EMPTY

          static final ThumbnailDocument EMPTY

      An empty `ThumbnailDocument`. `get(long)` always return `TimedThumbnail.EMPTY` `getAll()` always return `Collections.emptyList()`

  - ### Method Detail

    - #### get

          @NonNull
          TimedThumbnail get(long playheadPositionInMillis)

      Gets the `TimedThumbnail` given the Video's playhead position
      Parameters:
        `playheadPositionInMillis` - the video playhead position
      Returns:
        a valid `TimedThumbnail` or `TimedThumbnail.EMPTY` if not found

    - #### getAll

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