BCOVPlaylist Protocol Reference

Conforms to NSFastEnumeration
NSObject
Declared in BCOVPlaylist.h

Overview

Value class representing a playlist in the Brightcove Player SDK ecosystem. A playlist is an ordered collection of videos, as well as additional optional metadata about the collection in the form of properties. Note that because BCOVPlaylist implements NSFastEnumeration, it can be used in methods that take NSFastEnumeration parameters (such as [BCOVPlaybackController setVideos:]).

  videos required method

The BCOVVideo instances which comprise this playlist.

@property (nonatomic, readonly, copy) NSArray *videos

Discussion

The BCOVVideo instances which comprise this playlist.

Declared In

BCOVPlaylist.h

  properties required method

Additional properties or metadata related to this playlist.

@property (nonatomic, readonly, copy) NSDictionary *properties

Discussion

Additional properties or metadata related to this playlist.

Declared In

BCOVPlaylist.h

– update: required method

Returns a modified version of this playlist. Because BCOVPlaylist objects are immutable, an entirely new BCOVPlaylist must be created even if only a single change is needed. Therefore, this method provides a convenient way to obtain a temporary mutable copy of this instance and modify it (within updateBlock).

- (instancetype)update:(void ( ^ ) ( id<BCOVMutablePlaylist> mutablePlaylist ))updateBlock

Parameters

updateBlock

A block which is passed a mutable copy of this playlist.

Return Value

The copy of this cue point modified by updateBlock.

Discussion

Returns a modified version of this playlist. Because BCOVPlaylist objects are immutable, an entirely new BCOVPlaylist must be created even if only a single change is needed. Therefore, this method provides a convenient way to obtain a temporary mutable copy of this instance and modify it (within updateBlock).

Do not attempt to save a reference to the mutable playlist passed to updateBlock, as the behavior of doing this is undefined. Instead, make whatever modifications are necessary in the block and then capture the playlist object returned from this method.

Declared In

BCOVPlaylist.h