com.google.android.exoplayer.text.webvtt

Class WebvttSubtitle

java.lang.Object

com.google.android.exoplayer.text.webvtt.WebvttSubtitle

All Implemented Interfaces:

Subtitle

public final class WebvttSubtitle
extends Object
implements Subtitle

A representation of a WebVTT subtitle.

Constructor Summary

Constructors

Constructor and Description
WebvttSubtitle(List<com.google.android.exoplayer.text.webvtt.WebvttCue> cues)

Method Summary

Modifier and Type	Method and Description
List<Cue>	getCues(long timeUs) Retrieve the subtitle cues that should be displayed at a given time.
long	getEventTime(int index) Gets the event time at a specified index.
int	getEventTimeCount() Gets the number of event times, where events are defined as points in time at which the cues returned by Subtitle.getCues(long) changes.
long	getLastEventTime() Convenience method for obtaining the last event time.
int	getNextEventTimeIndex(long timeUs) Gets the index of the first event that occurs after a given time (exclusive).

Methods inherited from class java.lang.Object

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

Constructor Detail

WebvttSubtitle

public WebvttSubtitle(List<com.google.android.exoplayer.text.webvtt.WebvttCue> cues)

Parameters:

cues - A list of the cues in this subtitle.

Method Detail

getNextEventTimeIndex

public int getNextEventTimeIndex(long timeUs)

Description copied from interface: Subtitle

Gets the index of the first event that occurs after a given time (exclusive).

Specified by:

getNextEventTimeIndex in interface Subtitle

Parameters:

timeUs - The time in microseconds.

Returns:

The index of the next event, or -1 if there are no events after the specified time.

getEventTimeCount

public int getEventTimeCount()

Description copied from interface: Subtitle

Gets the number of event times, where events are defined as points in time at which the cues returned by Subtitle.getCues(long) changes.

Specified by:

getEventTimeCount in interface Subtitle

Returns:

The number of event times.

getEventTime

public long getEventTime(int index)

Description copied from interface: Subtitle

Gets the event time at a specified index.

Specified by:

getEventTime in interface Subtitle

Parameters:

index - The index of the event time to obtain.

Returns:

The event time in microseconds.

getLastEventTime

public long getLastEventTime()

Description copied from interface: Subtitle

Convenience method for obtaining the last event time.

Specified by:

getLastEventTime in interface Subtitle

Returns:

The time of the last event in microseconds, or -1 if getEventTimeCount() == 0.

getCues

public List<Cue> getCues(long timeUs)

Description copied from interface: Subtitle

Retrieve the subtitle cues that should be displayed at a given time.

Specified by:

getCues in interface Subtitle

Parameters:

timeUs - The time in microseconds.

Returns:

A list of cues that should be displayed, possibly empty.