com.ooyala.android.item.ContentItem Class Reference

Stores the info and metadata for the specified content item. More...

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

Public Member Functions
String	getEmbedCode ()
	Get the embedCode for this content item. More...
String	getExternalId ()
	Get the externalId for this content item. More...
String	getTitle ()
	Get the title for this content item. More...
String	getDescription ()
	Get the description for this content item. More...
boolean	hasVRContent ()
	Does this content item have VR content. More...
String	getAssetPCode ()
	Get the Asset PCode for this content item. More...
JSONObject	getMetadataJSON ()
	Get the inner metadata JSONObject for this content item. More...
JSONArray	getMetadataAllAds ()
	Get the all_ads JSONArray in the metadata for this content item. More...
abstract Video	firstVideo ()
	Subclasses must override this. More...
abstract int	getDuration ()
	Subclasses must override this. More...
FCCTVRating	getTVRating ()
ReturnState	update (JSONObject data)
	For internal use only. More...
List< String >	embedCodesToAuthorize ()
	For internal use only. More...
abstract Video	videoFromEmbedCode (String embedCode, Video currentItem)
String	getPromoImageURL (int width, int height)
	Returns a promo image URL for this content item that will be at least the specified dimensions. More...
String	getHostedAtUrl ()
	Returns a URL that video is hosted at for this content item. More...
String	getDefaultAudioTrackLanguage ()
boolean	isAuthorized ()
	Whether or not this AuthorizableItem is authorized. More...
int	getAuthCode ()
	The Auth Code from the authorization request. More...
String	getKey ()
boolean	isHeartbeatRequired ()
Map< String, String >	getMetadata ()
Map< String, ModuleData >	getModuleData ()
boolean	isOfflineVideo ()
void	setOfflineVideo (boolean isOfflineVideo)
SsaiMetadata	getSsaiMetadata ()
	Get SSAI metadata associated with the Content Item. More...

Static Public Member Functions
static ContentItem	create (JSONObject data, List< String > embedCodes)
static ContentItem	create (JSONObject data, String embedCode)
static List< String >	getEmbedCodes (List<? extends ContentItem > items)
static String	getAuthError (int authCode)
	Generate the authorization error of a video item. More...

Static Public Attributes
static final String	KEY_METADATA_HIGH_AVAILABILITY = "highAvailability"
static final String	KEY_METADATA_HA_ENABLED = "ha_enabled"
static final String	KEY_METADATA_ENABLED = "enabled"
static final String	KEY_METADATA_HA_COUNT = "ha_count"
static String []	authCodeDescription

Protected Attributes
String	_embedCode = null
String	_externalId = null
String	_contentToken = null
String	_title = null
String	_description = null
String	_promoImageURL = null
String	_assetPCode = null
String	_hostedAtURL = null
String	_defaultAudioTrackLanguage = null
boolean	_authorized = false
int	_authCode = AuthCode.NOT_REQUESTED
boolean	_heartbeatRequired
Map< String, String >	_metadata
Map< String, ModuleData >	_moduleData
JSONObject	_metadataJSON
JSONArray	_metadataAllAdsJSONArray
FCCTVRating	_tvRating
boolean	_hasVRContent = false
SsaiMetadata	_ssaiMetadata

Static Protected Attributes
static final String	KEY_EMBED_CODE = "embed_code"
static final String	KEY_EXTERNAL_ID = "external_id"
static final String	KEY_CONTENT_TOKEN = "content_token"
static final String	KEY_TITLE = "title"
static final String	KEY_DESCRIPTION = "description"
static final String	KEY_PROMO_IMAGE = "promo_image"
static final String	KEY_HOSTED_AT_URL = "hostedAtURL"
static final String	KEY_THUMBNAIL_IMAGE = "thumbnail_image"
static final String	KEY_ASSET_PCODE = "asset_pcode"
static final String	KEY_CONTENT_TYPE = "content_type"
static final String	KEY_ADS = "ads"
static final String	KEY_NEXT_CHILDREN = "next_children"
static final String	KEY_DURATION = "duration"
static final String	KEY_CLOSED_CAPTIONS = "closed_captions"
static final String	KEY_CLOSED_CAPTIONS_VTT = "closed_captions_vtt"
static final String	KEY_REQUIRE_HEARTBEAT = "require_heartbeat"
static final String	KEY_CODE = "code"
static final String	KEY_AUTHORIZED = "authorized"
static final String	KEY_CHILDREN = "children"
static final String	KEY_STREAMS = "streams"
static final String	KEY_MOVIE_ATTRIBUTES = "movie_attributes"
static final String	KEY_VR_TYPE = "vr360type"
static final String	KEY_DEFAULT_AUDIO_TRACK_LANGUAGE = "default_language"
static final String	KEY_METADATA = "metadata"
static final String	KEY_METADATA_BASE = "base"
static final String	KEY_METADATA_MODULES = "modules"
static final String	KEY_METADATA_MODULE_TYPE = "type"
static final String	KEY_METADATA_ALL_ADS = "all_ads"
static final String	KEY_METADATA_ALL_ADS_POSITION = "position"
static final String	KEY_METADATA_TVRATING_RATING = "tvrating"
static final String	KEY_METADATA_TVRATING_SUBRATINGS = "tvsubratings"
static final String	KEY_METADATA_TVRATING_CLICKTHROUGH_URL = "tvratingsurl"
static final String	KEY_METADATA_VR_CONTENT = "vrcontent"
static final String	KEY_EMBED_CODE_ATTRIBUTES = "attributes"
static final String	KEY_EMBED_CODE_PROVIDER = "provider"
static final String	KEY_SSAI_ENABLED = "ssai_enabled"
static final String	KEY_SSAI_VOD_ENABLED = "ssai_vod_enabled"
static final String	KEY_SSAI_VOD_ENABLED_MOVIE = "ssai_vod_enabled_movie_level"
static final String	CONTENT_TYPE_CHANNEL_SET = "MultiChannel"
static final String	CONTENT_TYPE_CHANNEL = "Channel"
static final String	CONTENT_TYPE_VIDEO = "Video"
static final String	CONTENT_TYPE_AUDIO = "Audio"
static final String	CONTENT_TYPE_LIVE_STREAM = "LiveStream"
static final String	VALUE_VR_TYPE = "mono"

Detailed Description

Stores the info and metadata for the specified content item.

Member Function Documentation

static ContentItem com.ooyala.android.item.ContentItem.create ( JSONObject  data, List< String >  embedCodes  )

static

static ContentItem com.ooyala.android.item.ContentItem.create ( JSONObject  data, String  embedCode  )

static

List<String> com.ooyala.android.item.ContentItem.embedCodesToAuthorize

(

)

For internal use only.

The embed codes to authorize for the AuthorizableItem

Returns

the embed codes to authorize as a List

Implements com.ooyala.android.item.AuthorizableItem.

abstract Video com.ooyala.android.item.ContentItem.firstVideo ( )

abstract

Subclasses must override this.

String com.ooyala.android.item.ContentItem.getAssetPCode

(

)

Get the Asset PCode for this content item.

Returns

Asset PCode for this content item

int com.ooyala.android.item.ContentItem.getAuthCode

(

)

The Auth Code from the authorization request.

Returns

an int with the status of the authorization request

Implements com.ooyala.android.item.AuthorizableItem.

static String com.ooyala.android.item.ContentItem.getAuthError ( int  authCode )

static

Generate the authorization error of a video item.

Parameters

authCode

Returns

a properly described OoyalaException

String com.ooyala.android.item.ContentItem.getDefaultAudioTrackLanguage

(

)

Returns

The default audio track language.

String com.ooyala.android.item.ContentItem.getDescription

(

)

Get the description for this content item.

Returns

description of this content item

abstract int com.ooyala.android.item.ContentItem.getDuration ( )

abstract

Subclasses must override this.

String com.ooyala.android.item.ContentItem.getEmbedCode

(

)

Get the embedCode for this content item.

Returns

embedCode of this content item

static List<String> com.ooyala.android.item.ContentItem.getEmbedCodes ( List<? extends ContentItem >  items )

static

String com.ooyala.android.item.ContentItem.getExternalId

(

)

Get the externalId for this content item.

Returns

externalId of this content item

String com.ooyala.android.item.ContentItem.getHostedAtUrl

(

)

Returns a URL that video is hosted at for this content item.

Returns

the url

String com.ooyala.android.item.ContentItem.getKey

(

)

Implements com.ooyala.android.util.OrderedMapValue< K >.

Map<String, String> com.ooyala.android.item.ContentItem.getMetadata

(

)

JSONArray com.ooyala.android.item.ContentItem.getMetadataAllAds

(

)

Get the all_ads JSONArray in the metadata for this content item.

Returns

all_ads JSONArray in the metadata for this content item

JSONObject com.ooyala.android.item.ContentItem.getMetadataJSON

(

)

Get the inner metadata JSONObject for this content item.

Returns

inner metadata JSONObject for this content item

Map<String, ModuleData> com.ooyala.android.item.ContentItem.getModuleData

(

)

String com.ooyala.android.item.ContentItem.getPromoImageURL	(	int	width,
		int	height
	)

Returns a promo image URL for this content item that will be at least the specified dimensions.

Parameters

width
height

Returns

the image url

SsaiMetadata com.ooyala.android.item.ContentItem.getSsaiMetadata

(

)

Get SSAI metadata associated with the Content Item.

Returns

SSAI metadata

String com.ooyala.android.item.ContentItem.getTitle

(

)

Get the title for this content item.

Returns

title of this content item

FCCTVRating com.ooyala.android.item.ContentItem.getTVRating

(

)

Returns

possibly null.

boolean com.ooyala.android.item.ContentItem.hasVRContent

(

)

Does this content item have VR content.

Returns

hasVRContent of this content item

boolean com.ooyala.android.item.ContentItem.isAuthorized

(

)

Whether or not this AuthorizableItem is authorized.

Returns

true if authorized, false if not

Implements com.ooyala.android.item.AuthorizableItem.

boolean com.ooyala.android.item.ContentItem.isHeartbeatRequired

(

)

Implements com.ooyala.android.item.AuthorizableItem.

boolean com.ooyala.android.item.ContentItem.isOfflineVideo

(

)

void com.ooyala.android.item.ContentItem.setOfflineVideo

(

boolean

isOfflineVideo

)

ReturnState com.ooyala.android.item.ContentItem.update

(

JSONObject

data

)

For internal use only.

Update the AuthorizableItem using the specified data (subclasses should override and call this)

Parameters

data	the data to use to update this AuthorizableItem

Returns

a ReturnState based on if the data matched or not (or parsing failed)

Implements com.ooyala.android.item.AuthorizableItem.

abstract Video com.ooyala.android.item.ContentItem.videoFromEmbedCode ( String  embedCode, Video  currentItem  )

abstract

Member Data Documentation

String com.ooyala.android.item.ContentItem._assetPCode = null

protected

int com.ooyala.android.item.ContentItem._authCode = AuthCode.NOT_REQUESTED

protected

boolean com.ooyala.android.item.ContentItem._authorized = false

protected

String com.ooyala.android.item.ContentItem._contentToken = null

protected

String com.ooyala.android.item.ContentItem._defaultAudioTrackLanguage = null

protected

String com.ooyala.android.item.ContentItem._description = null

protected

String com.ooyala.android.item.ContentItem._embedCode = null

protected

String com.ooyala.android.item.ContentItem._externalId = null

protected

boolean com.ooyala.android.item.ContentItem._hasVRContent = false

protected

boolean com.ooyala.android.item.ContentItem._heartbeatRequired

protected

String com.ooyala.android.item.ContentItem._hostedAtURL = null

protected

Map<String, String> com.ooyala.android.item.ContentItem._metadata

protected

JSONArray com.ooyala.android.item.ContentItem._metadataAllAdsJSONArray

protected

JSONObject com.ooyala.android.item.ContentItem._metadataJSON

protected

Map<String, ModuleData> com.ooyala.android.item.ContentItem._moduleData

protected

String com.ooyala.android.item.ContentItem._promoImageURL = null

protected

SsaiMetadata com.ooyala.android.item.ContentItem._ssaiMetadata

protected

String com.ooyala.android.item.ContentItem._title = null

protected

FCCTVRating com.ooyala.android.item.ContentItem._tvRating

protected

String [] com.ooyala.android.item.AuthorizableItem.authCodeDescription

staticinherited

final String com.ooyala.android.item.ContentItem.CONTENT_TYPE_AUDIO = "Audio"

staticprotected

final String com.ooyala.android.item.ContentItem.CONTENT_TYPE_CHANNEL = "Channel"

staticprotected

final String com.ooyala.android.item.ContentItem.CONTENT_TYPE_CHANNEL_SET = "MultiChannel"

staticprotected

final String com.ooyala.android.item.ContentItem.CONTENT_TYPE_LIVE_STREAM = "LiveStream"

staticprotected

final String com.ooyala.android.item.ContentItem.CONTENT_TYPE_VIDEO = "Video"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_ADS = "ads"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_ASSET_PCODE = "asset_pcode"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_AUTHORIZED = "authorized"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_CHILDREN = "children"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_CLOSED_CAPTIONS = "closed_captions"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_CLOSED_CAPTIONS_VTT = "closed_captions_vtt"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_CODE = "code"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_CONTENT_TOKEN = "content_token"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_CONTENT_TYPE = "content_type"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_DEFAULT_AUDIO_TRACK_LANGUAGE = "default_language"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_DESCRIPTION = "description"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_DURATION = "duration"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_EMBED_CODE = "embed_code"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_EMBED_CODE_ATTRIBUTES = "attributes"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_EMBED_CODE_PROVIDER = "provider"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_EXTERNAL_ID = "external_id"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_HOSTED_AT_URL = "hostedAtURL"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_METADATA = "metadata"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_METADATA_ALL_ADS = "all_ads"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_METADATA_ALL_ADS_POSITION = "position"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_METADATA_BASE = "base"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_METADATA_ENABLED = "enabled"

static

final String com.ooyala.android.item.ContentItem.KEY_METADATA_HA_COUNT = "ha_count"

static

final String com.ooyala.android.item.ContentItem.KEY_METADATA_HA_ENABLED = "ha_enabled"

static

final String com.ooyala.android.item.ContentItem.KEY_METADATA_HIGH_AVAILABILITY = "highAvailability"

static

final String com.ooyala.android.item.ContentItem.KEY_METADATA_MODULE_TYPE = "type"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_METADATA_MODULES = "modules"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_METADATA_TVRATING_CLICKTHROUGH_URL = "tvratingsurl"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_METADATA_TVRATING_RATING = "tvrating"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_METADATA_TVRATING_SUBRATINGS = "tvsubratings"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_METADATA_VR_CONTENT = "vrcontent"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_MOVIE_ATTRIBUTES = "movie_attributes"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_NEXT_CHILDREN = "next_children"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_PROMO_IMAGE = "promo_image"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_REQUIRE_HEARTBEAT = "require_heartbeat"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_SSAI_ENABLED = "ssai_enabled"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_SSAI_VOD_ENABLED = "ssai_vod_enabled"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_SSAI_VOD_ENABLED_MOVIE = "ssai_vod_enabled_movie_level"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_STREAMS = "streams"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_THUMBNAIL_IMAGE = "thumbnail_image"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_TITLE = "title"

staticprotected

final String com.ooyala.android.item.ContentItem.KEY_VR_TYPE = "vr360type"

staticprotected

final String com.ooyala.android.item.ContentItem.VALUE_VR_TYPE = "mono"

staticprotected