com.ooyala.android.item.ClosedCaptions Class Reference

Inheritance diagram for com.ooyala.android.item.ClosedCaptions:

Public Member Functions
Set< String >	getLanguages ()
	Fetch the Set of supported languages codes. More...
Collection< String >	getLanguagesNames ()
	Fetch the Set of supported full languages names. More...
String	getLanguageCode (String languageName)
String	getDefaultLanguage ()
	Fetch the default language to display ClosedCaptions in. More...
URL	getURL ()
	Fetch the URL of the ClosedCaptions file. More...
void	setUrl (URL url)
boolean	fetchClosedCaptionsInfo ()
	Fetch the ClosedCaptions information required for playback. More...
List< Caption >	closedCaptionsForLanguage (String language)
	Fetch the list of Caption objects for the language specified. More...
Caption	getCaption (String language, double time)
	Fetch the Caption object corresponding to the language and time specified. More...

Protected Attributes
Map< String, String >	languages = new HashMap<>()
String	defaultLanguage = null
URL	url = null
Map< String, List< Caption > >	captions = new HashMap<String, List<Caption>>()

Member Function Documentation

List<Caption> com.ooyala.android.item.ClosedCaptions.closedCaptionsForLanguage

(

String

language

)

Fetch the list of Caption objects for the language specified.

Parameters

language

the language to fetch the Caption objects for

Returns

a list of Caption objects

boolean com.ooyala.android.item.ClosedCaptions.fetchClosedCaptionsInfo

(

)

Fetch the ClosedCaptions information required for playback.

This should get called automatically.

Returns

true if success, false if failure

Caption com.ooyala.android.item.ClosedCaptions.getCaption	(	String	language,
		double	time
	)

Fetch the Caption object corresponding to the language and time specified.

Parameters

language	the language to fetch the Caption object for
time	the time to fetch the Caption object for

Returns

the Caption object

String com.ooyala.android.item.ClosedCaptions.getDefaultLanguage

(

)

Fetch the default language to display ClosedCaptions in.

Returns

the default language to display ClosedCaptions in.

String com.ooyala.android.item.ClosedCaptions.getLanguageCode

(

String

languageName

)

Parameters

languageName

The full name of language.

Returns

The language code or null.

Set<String> com.ooyala.android.item.ClosedCaptions.getLanguages

(

)

Fetch the Set of supported languages codes.

Returns

The Set of supported languages codes.

Collection<String> com.ooyala.android.item.ClosedCaptions.getLanguagesNames

(

)

Fetch the Set of supported full languages names.

Returns

The Set of supported full languages names.

URL com.ooyala.android.item.ClosedCaptions.getURL

(

)

Fetch the URL of the ClosedCaptions file.

Returns

the URL pf the ClosedCaptions file.

void com.ooyala.android.item.ClosedCaptions.setUrl

(

URL

url

)

Member Data Documentation

Map<String, List<Caption> > com.ooyala.android.item.ClosedCaptions.captions = new HashMap<String, List<Caption>>()

protected

String com.ooyala.android.item.ClosedCaptions.defaultLanguage = null

protected

Map<String, String> com.ooyala.android.item.ClosedCaptions.languages = new HashMap<>()

protected

URL com.ooyala.android.item.ClosedCaptions.url = null

protected