BCOVPlaybackControllerBasicDelegate Protocol Reference

Conforms to NSObject
Declared in BCOVPlaybackController.h

Overview

Conform to this protocol to receive basic playback information for each session.

– playbackController:didAdvanceToPlaybackSession:

Called when the controller advances to a new playback session, which happens when -advanceToNext is called. When a delegate is set on a playback controller, this method is called with the most recently advanced-to playback session (where applicable).

- (void)playbackController:(id<BCOVPlaybackController>)controller didAdvanceToPlaybackSession:(id<BCOVPlaybackSession>)session

Parameters

controller

The playback controller receiving the new session.

session

The playback session that was advanced.

Discussion

Called when the controller advances to a new playback session, which happens when -advanceToNext is called. When a delegate is set on a playback controller, this method is called with the most recently advanced-to playback session (where applicable).

Declared In

BCOVPlaybackController.h

– playbackController:playbackSession:didChangeDuration:

Called when a playback session’s duration is updated. When a delegate is set on a playback controller, this method is called with the most recently updated duration for the session. A session duration can change as the media playback continues to load, as it is refined with more precise information.

- (void)playbackController:(id<BCOVPlaybackController>)controller playbackSession:(id<BCOVPlaybackSession>)session didChangeDuration:(NSTimeInterval)duration

Parameters

controller

The playback controller to which this instance serves as delegate.

session

The playback session whose duration changed.

duration

The most recently updated session duration.

Discussion

Called when a playback session’s duration is updated. When a delegate is set on a playback controller, this method is called with the most recently updated duration for the session. A session duration can change as the media playback continues to load, as it is refined with more precise information.

Declared In

BCOVPlaybackController.h

– playbackController:playbackSession:didChangeExternalPlaybackActive:

Called when a playback session’s external playback active status is updated. When a delegate is set on a playback controller, this method is called with the current external playback active status for the session.

- (void)playbackController:(id<BCOVPlaybackController>)controller playbackSession:(id<BCOVPlaybackSession>)session didChangeExternalPlaybackActive:(BOOL)externalPlaybackActive

Parameters

controller

The playback controller to which this instance serves as delegate.

session

The playback session whose external playback status changed.

externalPlaybackActive

Whether external playback is active.

Discussion

Called when a playback session’s external playback active status is updated. When a delegate is set on a playback controller, this method is called with the current external playback active status for the session.

Declared In

BCOVPlaybackController.h

– playbackController:playbackSession:didPassCuePoints:

Called when a session’s playhead passes cue points registered with its video. This will occur regardless of whether the playhead passes the cue point time for standard progress (playback), or seeking (forward or backward) through the media. When a delegate is set on a playback controller, this method will only be called for future cue point events (any events that have already occurred will not be reported).

- (void)playbackController:(id<BCOVPlaybackController>)controller playbackSession:(id<BCOVPlaybackSession>)session didPassCuePoints:(NSDictionary *)cuePointInfo

Parameters

controller

The playback controller to which this instance serves as delegate.

session

The playback session whose cue points were passed.

cuePointInfo

A dictionary of information about the cue point event.

Discussion

Called when a session’s playhead passes cue points registered with its video. This will occur regardless of whether the playhead passes the cue point time for standard progress (playback), or seeking (forward or backward) through the media. When a delegate is set on a playback controller, this method will only be called for future cue point events (any events that have already occurred will not be reported).

If multiple cue points are registered to a time or times that fall between the “previous time” and “current time” for a cue point event, all cue points after the “previous time” and before or on “current time” will be included in the cue point collection. Put differently, multiple cue points at the same time are aggregated into a single cue point event whose collection will contain all of those cue points. The most likely scenario in which this would happen is when seeking across a time range that includes multiple cue points (potentially at different times) – this will result in a single cue point event whose previous time is the point at which seek began, whose current time is the destination of the seek, and whose cue points are all of the cue points whose time fell within that range.

The cuePointInfo dictionary will contain the following keys and values for each cue point event:

kBCOVPlaybackSessionEventKeyPreviousTime: the progress interval immediately preceding the cue points for which this event was received. kBCOVPlaybackSessionEventKeyCurrentTime: the progress interval on or immediately after the cue points for which this event was received. kBCOVPlaybackSessionEventKeyCuePoints: the BCOVCuePointCollection of cue points for which this event was received.

Declared In

BCOVPlaybackController.h

– playbackController:playbackSession:didProgressTo:

Called with the playback session’s playback progress. As the session’s media plays, this method is called periodically with the latest progress interval. When a delegate is set on a playback controller, this method will only be called with progress information that has not yet occurred.

- (void)playbackController:(id<BCOVPlaybackController>)controller playbackSession:(id<BCOVPlaybackSession>)session didProgressTo:(NSTimeInterval)progress

Parameters

controller

The playback controller to which this instance serves as delegate.

session

The playback session making progress.

progress

The time interval of the session’s current playback progress.

Discussion

Called with the playback session’s playback progress. As the session’s media plays, this method is called periodically with the latest progress interval. When a delegate is set on a playback controller, this method will only be called with progress information that has not yet occurred.

Declared In

BCOVPlaybackController.h

– playbackController:didCompletePlaylist:

Called when the end of the video playlist has been reached, after the the last video (including post-rolls) has played to the end. Only called when autoAdvance is set to YES on the playback controller.

- (void)playbackController:(id<BCOVPlaybackController>)controller didCompletePlaylist:(id<NSFastEnumeration>)playlist

Parameters

controller

The playback controller to which this instance serves as delegate.

playlist

The list of BCOVVideo objects that were played. Do not assume that this is an NSArray.

Discussion

Called when the end of the video playlist has been reached, after the the last video (including post-rolls) has played to the end. Only called when autoAdvance is set to YES on the playback controller.

Declared In

BCOVPlaybackController.h

– playbackController:playbackSession:didReceiveLifecycleEvent:

Called when a playback session receives a lifecycle event. This method is called only for lifecycle events that occur after the delegate is set (previous lifecycle events will not be buffered/delivered to the delegate).

- (void)playbackController:(id<BCOVPlaybackController>)controller playbackSession:(id<BCOVPlaybackSession>)session didReceiveLifecycleEvent:(BCOVPlaybackSessionLifecycleEvent *)lifecycleEvent

Parameters

controller

The playback controller to which this instance serves as delegate.

session

The playback session whose lifecycle events were received.

lifecycleEvent

The lifecycle event received by the session.

Discussion

Called when a playback session receives a lifecycle event. This method is called only for lifecycle events that occur after the delegate is set (previous lifecycle events will not be buffered/delivered to the delegate).

The lifecycle event types are listed along with the BCOVPlaybackSessionLifecycleEvent class.

Declared In

BCOVPlaybackController.h

– playbackController:playbackSession:didChangeSeekableRanges:

Called when a playback session’s seekable ranges is updated. When a delegate is set on a playback controller, this method is called with the most recently updated seekable ranges for the session. A session seekable ranges can change as the media playback continues to load.

- (void)playbackController:(id<BCOVPlaybackController>)controller playbackSession:(id<BCOVPlaybackSession>)session didChangeSeekableRanges:(NSArray *)seekableRanges

Parameters

controller

The playback controller to which this instance serves as delegate.

session

The playback session whose seekable ranges changed.

seekableRanges

An array of NSValue about the most recently updated session seekableRanges.

Discussion

Called when a playback session’s seekable ranges is updated. When a delegate is set on a playback controller, this method is called with the most recently updated seekable ranges for the session. A session seekable ranges can change as the media playback continues to load.

Declared In

BCOVPlaybackController.h