OOClosedCaptions Class Reference

An object which represents all closed captions information for the asset. More...

#import <OOClosedCaptions.h>

Inheritance diagram for OOClosedCaptions:

Instance Methods
((unavailable("use initWithDictionary:")	- __attribute__
(instancetype)	- initWithDictionary:
	INTERNAL. More...
(OOReturnState)	- updateWithDictionary:
	INTERNAL. More...
(void)	- updateWithVttDictionary:
	INTERNAL. More...
(BOOL)	- fetchClosedCaptionsInfo
	INTERNAL. More...
(NSArray *)	- closedCaptionsForLanguage:
	Fetch the closed captions for the given language. More...
(OOCaption *)	- captionForLanguage:time:
	Fetch the OOCaption for a given language at the given time (in milliseconds) More...

Properties
NSArray *	languages
	List of available langauges. More...
NSString *	defaultLanguage
	Default close caption langauge. More...
NSURL *	url
	URL of the close captions source file. More...
NSDictionary *	vttCaptions
	the vtt caption dictionary More...

Detailed Description

An object which represents all closed captions information for the asset.

Method Documentation

- ((unavailable("use) initWithDictionary:

- (OOCaption *) captionForLanguage:		(NSString *)	language
time:		(Float64)	time

Fetch the OOCaption for a given language at the given time (in milliseconds)

Parameters

[in]	language	the language for which to fetch the OOCaption
[in]	time	the time in seconds

Returns

the OOCaption if it exists for that language and time combination, nil otherwise

- (NSArray *) closedCaptionsForLanguage:

(NSString *)

language

Fetch the closed captions for the given language.

Parameters

[in]

language

the language to fetch (if nil, empty, or not on languages, defaultLanguage will be used)

Returns

and NSArray containing the OOCaption objects

- (BOOL) fetchClosedCaptionsInfo

INTERNAL.

- (instancetype) initWithDictionary:

(NSDictionary *)

data

INTERNAL.

- (OOReturnState) updateWithDictionary:

(NSDictionary *)

data

INTERNAL.

- (void) updateWithVttDictionary:

(NSDictionary *)

data

INTERNAL.

Property Documentation

- (NSString*) defaultLanguage

readnonatomicassign

Default close caption langauge.

- (NSArray*) languages

readnonatomicassign

List of available langauges.

- (NSURL*) url

readnonatomicstrong

URL of the close captions source file.

- (NSDictionary*) vttCaptions

readnonatomicstrong

the vtt caption dictionary

---

The documentation for this class was generated from the following file:

• OOClosedCaptions.h