BCOVCuePointCollection Class Reference

Inherits from NSObject
Conforms to NSCopying
NSFastEnumeration
Declared in BCOVCuePointCollection.h

Overview

A collection of cue points, each element ordered by its position according to the natural ordering of CMTime values.

– initWithArray:

Constructs and returns a BCOVCuePointCollection from the cue points in the specified array. The returned collection will be ordered according to the positions of the cue points. The ordering of multiple cue points with the same position is not guaranteed.

- (instancetype)initWithArray:(NSArray *)cuePoints

Parameters

cuePoints

The new cue point collection’s cue points.

Return Value

The new cue point collection with the specified cue points.

Discussion

Constructs and returns a BCOVCuePointCollection from the cue points in the specified array. The returned collection will be ordered according to the positions of the cue points. The ordering of multiple cue points with the same position is not guaranteed.

Declared In

BCOVCuePointCollection.h

– initWithCuePoint:

Constructs and returns a BCOVCuePointCollection with a single cue point.

- (instancetype)initWithCuePoint:(BCOVCuePoint *)cuePoint

Parameters

cuePoint

The new cue point collection’s cue point.

Return Value

The new cue point collection with the specified cue point.

Discussion

Constructs and returns a BCOVCuePointCollection with a single cue point.

Declared In

BCOVCuePointCollection.h

– array

Returns this collection’s cue point objects in an array. The elements of the array will have the same order as the ordering of cue points in this collection.

- (NSArray *)array

Return Value

This collection’s cue points in an array.

Discussion

Returns this collection’s cue point objects in an array. The elements of the array will have the same order as the ordering of cue points in this collection.

Declared In

BCOVCuePointCollection.h

– count

Returns the number of cue points in this collection.

- (NSUInteger)count

Return Value

The number of cue points in this collection.

Discussion

Returns the number of cue points in this collection.

Declared In

BCOVCuePointCollection.h

– cuePointsAfterTime:

Returns all cue points in this collection after the specified time.

- (instancetype)cuePointsAfterTime:(CMTime)time

Parameters

time

The time after which corresponding cue points should be returned.

Return Value

All cue points in this collection after the specified time.

Discussion

Returns all cue points in this collection after the specified time.

Declared In

BCOVCuePointCollection.h

– cuePointsBeforeTime:

Returns all cue points in this collection before the specified time.

- (instancetype)cuePointsBeforeTime:(CMTime)time

Parameters

time

The time before which corresponding cue points should be returned.

Return Value

All cue points in this collection before the specified time.

Discussion

Returns all cue points in this collection before the specified time.

Declared In

BCOVCuePointCollection.h

– cuePointsAtTime:

Returns all cue points in this collection at exactly the specified time.

- (instancetype)cuePointsAtTime:(CMTime)time

Parameters

time

The time at which corresponding cue points should be returned.

Return Value

All cue points in this collection at exactly the specified time.

Discussion

Returns all cue points in this collection at exactly the specified time.

Declared In

BCOVCuePointCollection.h

– cuePointsAtOrAfterTime:

Returns all cue points in this collection at or after the specified time.

- (instancetype)cuePointsAtOrAfterTime:(CMTime)time

Parameters

time

The time at or after which corresponding cue points should be returned.

Return Value

All cue points in this collection at or after the specified time.

Discussion

Returns all cue points in this collection at or after the specified time.

Declared In

BCOVCuePointCollection.h

– cuePointsAtOrBeforeTime:

Returns all cue points in this collection at or before the specified time.

- (instancetype)cuePointsAtOrBeforeTime:(CMTime)time

Parameters

time

The time at or before which corresponding cue points should be returned.

Return Value

All cue points in this collection at or before the specified time.

Discussion

Returns all cue points in this collection at or before the specified time.

Declared In

BCOVCuePointCollection.h

– cuePointsAfterTime:beforeTime:

Returns all cue points in this collection between the specified times.

- (instancetype)cuePointsAfterTime:(CMTime)lowerBound beforeTime:(CMTime)upperBound

Parameters

lowerBound

The lower boundary, at or below which cue points should not be returned.

upperBound

The upper boundary, at or above which cue points should not be returned.

Return Value

All cue points in this collection between the specified times.

Discussion

Returns all cue points in this collection between the specified times.

Declared In

BCOVCuePointCollection.h

– cuePointsAfterTime:atOrBeforeTime:

Returns all cue points in this collection between the specified times, inclusive of the upper bound.

- (instancetype)cuePointsAfterTime:(CMTime)lowerBound atOrBeforeTime:(CMTime)upperBound

Parameters

lowerBound

The lower boundary, at or below which cue points should not be returned.

upperBound

The upper boundary, above which cue points should not be returned.

Return Value

All cue points in this collection between the specified times.

Discussion

Returns all cue points in this collection between the specified times, inclusive of the upper bound.

Declared In

BCOVCuePointCollection.h

– cuePointsAtOrAfterTime:beforeTime:

Returns all cue points in this collection between the specified times, inclusive of the lower bound.

- (instancetype)cuePointsAtOrAfterTime:(CMTime)lowerBound beforeTime:(CMTime)upperBound

Parameters

lowerBound

The lower boundary, below which cue points should not be returned.

upperBound

The upper boundary, at or above which cue points should not be returned.

Return Value

All cue points in this collection between the specified times.

Discussion

Returns all cue points in this collection between the specified times, inclusive of the lower bound.

Declared In

BCOVCuePointCollection.h

– cuePointsAtOrAfterTime:atOrBeforeTime:

Returns all cue points in this collection, at or between the specified times.

- (instancetype)cuePointsAtOrAfterTime:(CMTime)lowerBound atOrBeforeTime:(CMTime)upperBound

Parameters

lowerBound

The lower boundary, below which cue points should not be returned.

upperBound

The upper boundary, above which cue points should not be returned.

Return Value

All cue points in this collection, at or between the specified times.

Discussion

Returns all cue points in this collection, at or between the specified times.

Declared In

BCOVCuePointCollection.h

– cuePointsOfType:

Returns all cue points in this collection of the specified type.

- (instancetype)cuePointsOfType:(NSString *)type

Parameters

type

The type of cue points to be returned.

Return Value

All cue points in this collection, of the specified type.

Discussion

Returns all cue points in this collection of the specified type.

Declared In

BCOVCuePointCollection.h

– isEqualToCollection:

Returns YES if this instance has the same cue points in the same order as collection.

- (BOOL)isEqualToCollection:(BCOVCuePointCollection *)collection

Parameters

collection

The collection with which to compare this instance.

Return Value

Whether this instance is equivalent to collection.

Discussion

Returns YES if this instance has the same cue points in the same order as collection.

Declared In

BCOVCuePointCollection.h

– objectAtIndexedSubscript:

Returns the cue point at the specified index, or nil if the specified index is greater than the highest index into the collection.

- (BCOVCuePoint *)objectAtIndexedSubscript:(NSUInteger)index

Parameters

index

The index into this collection of the desired cue point.

Return Value

The cue point at the specified index, or nil if this collection does not have a cue point at that index.

Discussion

Returns the cue point at the specified index, or nil if the specified index is greater than the highest index into the collection.

Declared In

BCOVCuePointCollection.h

+ collectionWithArray:

Returns a new cue point collection containing the specified cue points.

+ (instancetype)collectionWithArray:(NSArray *)cuePoints

Parameters

cuePoints

An array of cue point objects to include in the collection.

Return Value

A new cue point collection containing the specified cue points.

Discussion

Returns a new cue point collection containing the specified cue points.

Declared In

BCOVCuePointCollection.h

+ emptyCollection

Returns a singleton cue point collection containing no cue points.

+ (instancetype)emptyCollection

Return Value

A singleton cue point collection containing no cue points.

Discussion

Returns a singleton cue point collection containing no cue points.

Declared In

BCOVCuePointCollection.h