Package com.brightcove.ssai.timeline
Class TimelineManager
java.lang.Object
com.brightcove.player.event.AbstractComponent
com.brightcove.ssai.timeline.TimelineManager
- All Implemented Interfaces:
Component,PlaybackListener,TickerObserver
@Emits(events="seekTo")
@ListensFor(events="skipAd")
public class TimelineManager
extends AbstractComponent
implements TickerObserver, PlaybackListener
Manages the state of the Timeline according to player playhead position.
-
Field Summary
Fields inherited from class com.brightcove.player.event.AbstractComponent
eventEmitter, listenerTokens -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanaddAdPodListener(AdPodListener adPodListener) Adds the Ad pod listener.longGets the content length.longGets current absolute playhead position.longGets current relative duration.longGets current relative playhead position.Returns an AdPod if it's currently playing an Ad, otherwise returns null.Gets the timeline if available.longGets the total length.booleanChecks if an ad is currently being played.voidonComplete(long duration) Indicates when the video playback has completed.voidonPause(long playheadPosition) Indicates a pause event.voidonPlay(long playheadPosition) Indicates a play event.voidonTick(long lastPlayheadPositionMillis, long currentPlayheadPositionMillis) A tick represent an poll from the underlying video player.booleanremoveAdPodListener(AdPodListener adPodListener) Removes the Ad pod listener.voidRemoved all Ad pod listeners.voidreset()Methods inherited from class com.brightcove.player.event.AbstractComponent
addListener, addOnceListener, getEventEmitter, removeListener, removeListeners
-
Constructor Details
-
TimelineManager
-
-
Method Details
-
getCurrentAbsolutePlayheadPosition
public long getCurrentAbsolutePlayheadPosition()Gets current absolute playhead position.- Returns:
- the current absolute playhead position
-
getCurrentRelativeDuration
public long getCurrentRelativeDuration()Gets current relative duration.- Returns:
- the current relative duration
-
getCurrentRelativePlayheadPosition
public long getCurrentRelativePlayheadPosition()Gets current relative playhead position.- Returns:
- the current relative playhead position
-
isPlayingAd
public boolean isPlayingAd()Checks if an ad is currently being played.- Returns:
- true if playing an ad.
-
getContentLength
public long getContentLength()Gets the content length.- Returns:
- the content length
-
getTotalLength
public long getTotalLength()Gets the total length.- Returns:
- the total length
-
getPlayingAdPod
Returns an AdPod if it's currently playing an Ad, otherwise returns null.- Returns:
- the playing Ad pod
-
getPlayingAd
-
getTimeline
Gets the timeline if available.- Returns:
- the timeline
-
getSeekListener
-
onTick
public void onTick(long lastPlayheadPositionMillis, long currentPlayheadPositionMillis) Description copied from interface:TickerObserverA tick represent an poll from the underlying video player.- Specified by:
onTickin interfaceTickerObserver- Parameters:
lastPlayheadPositionMillis- the last playhead position in millisecondscurrentPlayheadPositionMillis- the current playhead position in milliseconds
-
addAdPodListener
Adds the Ad pod listener.- Parameters:
adPodListener- the Ad pod listener- Returns:
- true if added successfully
-
removeAdPodListener
Removes the Ad pod listener.- Parameters:
adPodListener- the Ad pod listener- Returns:
- true if removed successfully
-
removeAllAdPodListeners
public void removeAllAdPodListeners()Removed all Ad pod listeners. -
onPlay
public void onPlay(long playheadPosition) Description copied from interface:PlaybackListenerIndicates a play event.- Specified by:
onPlayin interfacePlaybackListener- Parameters:
playheadPosition- the playhead position
-
onPause
public void onPause(long playheadPosition) Description copied from interface:PlaybackListenerIndicates a pause event.- Specified by:
onPausein interfacePlaybackListener- Parameters:
playheadPosition- the playhead position
-
onComplete
public void onComplete(long duration) Description copied from interface:PlaybackListenerIndicates when the video playback has completed.- Specified by:
onCompletein interfacePlaybackListener- Parameters:
duration- the duration
-
reset
public void reset()
-