BCOVCuePoint Class Reference

Inherits from NSObject
Conforms to BCOVCuePoint
NSCopying
Declared in BCOVCuePoint.h

Overview

Implementation of the BCOVCuePoint protocol.

– initWithType:position:

Constructs a new cue point with the specified type and position.

- (instancetype)initWithType:(NSString *)type position:(CMTime)position

Parameters

type

The type of the new cue point.

position

The position of the new cue point.

Return Value

A new cue point with the specified type and position.

Discussion

Constructs a new cue point with the specified type and position.

Declared In

BCOVCuePoint.h

– initWithType:position:properties:

Constructs a new cue point with the specified type, position, and properties.

- (instancetype)initWithType:(NSString *)type position:(CMTime)position properties:(NSDictionary *)properties

Parameters

type

The type of the new cue point.

position

The position of the new cue point.

properties

The properties of the new cue point.

Return Value

A new cue point with the specified type, position, and properties.

Discussion

Constructs a new cue point with the specified type, position, and properties.

Declared In

BCOVCuePoint.h

– compare:

Returns an NSComparisionResult indicating whether this cue point’s position is earlier, the same, or later than the position of cuePoint. Only positions are compared.

- (NSComparisonResult)compare:(BCOVCuePoint *)cuePoint

Parameters

cuePoint

The cue point whose position is to be compared with this instance.

Return Value

Whether this cue point’s position is earlier, the same, or later.

Discussion

Returns an NSComparisionResult indicating whether this cue point’s position is earlier, the same, or later than the position of cuePoint. Only positions are compared.

Declared In

BCOVCuePoint.h

– hasPosition:

Returns YES if this instance’s position is position.

- (BOOL)hasPosition:(CMTime)position

Parameters

position

The position to test this instance’s position against.

Return Value

Whether this instance has the specified position.

Discussion

Returns YES if this instance’s position is position.

Declared In

BCOVCuePoint.h

– isEqualToCuePoint:

Returns YES if cuePoint is equivalent to this instance.

- (BOOL)isEqualToCuePoint:(BCOVCuePoint *)cuePoint

Parameters

cuePoint

The cue point to test for equivalence with this instance.

Return Value

Whether cuePoint is equivalent to this instance.

Discussion

Returns YES if cuePoint is equivalent to this instance.

Declared In

BCOVCuePoint.h

+ afterCuePointOfType:properties:

Returns a cue point with the specified type and properties whose position is kBCOVCuePointPositionTypeAfter.

+ (BCOVCuePoint *)afterCuePointOfType:(NSString *)type properties:(NSDictionary *)properties

Parameters

type

The type of the cue point to return.

properties

The properties of the cue point to return.

Return Value

The “after” cue point with the specified type and properties.

Discussion

Returns a cue point with the specified type and properties whose position is kBCOVCuePointPositionTypeAfter.

Declared In

BCOVCuePoint.h

+ beforeCuePointOfType:properties:

Returns a cue point with the specified type and properties whose position is kBCOVCuePointPositionTypeBefore.

+ (BCOVCuePoint *)beforeCuePointOfType:(NSString *)type properties:(NSDictionary *)properties

Parameters

type

The type of the cue point to return.

properties

The properties of the cue point to return.

Return Value

The “before” cue point with the specified type and properties.

Discussion

Returns a cue point with the specified type and properties whose position is kBCOVCuePointPositionTypeBefore.

Declared In

BCOVCuePoint.h

+ cuePointWithType:positionInSeconds:properties:

Returns a cue point with the specified type and properties whose position in seconds is at positionInSeconds.

+ (BCOVCuePoint *)cuePointWithType:(NSString *)type positionInSeconds:(NSTimeInterval)positionInSeconds properties:(NSDictionary *)properties

Parameters

type

The type of the cue point to return.

positionInSeconds

The position (in seconds) of this cue point into the timeline of the video which owns it.

properties

The properties of the cue point to return.

Return Value

The cue point with the specified type, position, and properties.

Discussion

Returns a cue point with the specified type and properties whose position in seconds is at positionInSeconds.

Declared In

BCOVCuePoint.h