Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
com.ooyala.android.item.ChannelSet Class Reference
Inheritance diagram for com.ooyala.android.item.ChannelSet:
com.ooyala.android.item.ContentItem com.ooyala.android.item.PaginatedParentItem com.ooyala.android.item.AuthorizableItem com.ooyala.android.util.OrderedMapValue< K >

Public Member Functions

synchronized ReturnState update (JSONObject data)
 For internal use only. More...
 
Video firstVideo ()
 Get the first Video for this ChannelSet. More...
 
Video nextVideo (Channel currentItem)
 Get the next Video for this ChannelSet (this method should only be called at the end of a channel) More...
 
Video previousVideo (Channel currentItem)
 Get the previous Video for this ChannelSet (this method should only be called at the end of a channel) More...
 
int childrenCount ()
 The number of children this PaginatedParentItem has. More...
 
List< String > embedCodesToAuthorize ()
 For internal use only. More...
 
OrderedMap< String, Channel > getAllAvailableChildren ()
 Returns all of the children that were already retrieved from the server. More...
 
OrderedMap< String, Channel > getChannels ()
 
int getDuration ()
 The total duration (not including Ads) of this ChannelSet. More...
 
boolean hasMoreChildren ()
 Find out it this PaginatedParentItem has more children. More...
 
String getNextChildren ()
 For Internal Use Only. More...
 
Video videoFromEmbedCode (String embedCode, Video currentItem)
 Get the Video in this ChannelSet with the specified embed code. More...
 
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...
 
FCCTVRating getTVRating ()
 
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...
 
String getEmbedCode ()
 

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 Member Functions

void addChannel (Channel channel)
 

Protected Attributes

OrderedMap< String, Channel > _channels = new OrderedMap<String, Channel>()
 
String _nextChildren = null
 
boolean _isFetchingMoreChildren = false
 
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"
 

Member Function Documentation

void com.ooyala.android.item.ChannelSet.addChannel ( Channel  channel)
protected
int com.ooyala.android.item.ChannelSet.childrenCount ( )

The number of children this PaginatedParentItem has.

Returns
an int with the number of children

Implements com.ooyala.android.item.PaginatedParentItem.

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

For internal use only.

The embed codes to authorize for the AuthorizableItemInternal

Returns
the embed codes to authorize as a List

Implements com.ooyala.android.item.AuthorizableItem.

Video com.ooyala.android.item.ChannelSet.firstVideo ( )

Get the first Video for this ChannelSet.

Returns
the first Video this ChannelSet represents
OrderedMap<String, Channel> com.ooyala.android.item.ChannelSet.getAllAvailableChildren ( )

Returns all of the children that were already retrieved from the server.

Returns
an ordered map that contains all retrieved content items

Implements com.ooyala.android.item.PaginatedParentItem.

String com.ooyala.android.item.ContentItem.getAssetPCode ( )
inherited

Get the Asset PCode for this content item.

Returns
Asset PCode for this content item
int com.ooyala.android.item.ContentItem.getAuthCode ( )
inherited

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)
staticinherited

Generate the authorization error of a video item.

Parameters
authCode
Returns
a properly described OoyalaException
OrderedMap<String, Channel> com.ooyala.android.item.ChannelSet.getChannels ( )
String com.ooyala.android.item.ContentItem.getDefaultAudioTrackLanguage ( )
inherited
Returns
The default audio track language.
String com.ooyala.android.item.ContentItem.getDescription ( )
inherited

Get the description for this content item.

Returns
description of this content item
int com.ooyala.android.item.ChannelSet.getDuration ( )

The total duration (not including Ads) of this ChannelSet.

This only accounts for currently loaded channels.

Returns
an int with the total duration in seconds
String com.ooyala.android.item.PaginatedParentItem.getEmbedCode ( )
inherited
String com.ooyala.android.item.ContentItem.getEmbedCode ( )
inherited

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)
staticinherited
String com.ooyala.android.item.ContentItem.getExternalId ( )
inherited

Get the externalId for this content item.

Returns
externalId of this content item
String com.ooyala.android.item.ContentItem.getHostedAtUrl ( )
inherited

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

Returns
the url
String com.ooyala.android.item.ContentItem.getKey ( )
inherited

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

Map<String, String> com.ooyala.android.item.ContentItem.getMetadata ( )
inherited
JSONArray com.ooyala.android.item.ContentItem.getMetadataAllAds ( )
inherited

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 ( )
inherited

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 ( )
inherited
String com.ooyala.android.item.ChannelSet.getNextChildren ( )

For Internal Use Only.

Returns
the next children token for this PaginatedParentItem

Implements com.ooyala.android.item.PaginatedParentItem.

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

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 ( )
inherited

Get SSAI metadata associated with the Content Item.

Returns
SSAI metadata
String com.ooyala.android.item.ContentItem.getTitle ( )
inherited

Get the title for this content item.

Returns
title of this content item
FCCTVRating com.ooyala.android.item.ContentItem.getTVRating ( )
inherited
Returns
possibly null.
boolean com.ooyala.android.item.ChannelSet.hasMoreChildren ( )

Find out it this PaginatedParentItem has more children.

Returns
true if it does, false if it doesn't

Implements com.ooyala.android.item.PaginatedParentItem.

boolean com.ooyala.android.item.ContentItem.hasVRContent ( )
inherited

Does this content item have VR content.

Returns
hasVRContent of this content item
boolean com.ooyala.android.item.ContentItem.isAuthorized ( )
inherited

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 ( )
inherited

Implements com.ooyala.android.item.AuthorizableItem.

boolean com.ooyala.android.item.ContentItem.isOfflineVideo ( )
inherited
Video com.ooyala.android.item.ChannelSet.nextVideo ( Channel  currentItem)

Get the next Video for this ChannelSet (this method should only be called at the end of a channel)

Parameters
currentItemthe current Channel
Returns
the next Video from ChannelSet
Video com.ooyala.android.item.ChannelSet.previousVideo ( Channel  currentItem)

Get the previous Video for this ChannelSet (this method should only be called at the end of a channel)

Parameters
currentItemthe current Channel
Returns
the previous Video from ChannelSet
void com.ooyala.android.item.ContentItem.setOfflineVideo ( boolean  isOfflineVideo)
inherited
synchronized ReturnState com.ooyala.android.item.ChannelSet.update ( JSONObject  data)

For internal use only.

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

Parameters
datathe data to use to update this PaginatedParentItem
Returns
a ReturnState based on if the data matched or not (or parsing failed)

Implements com.ooyala.android.item.PaginatedParentItem.

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

Get the Video in this ChannelSet with the specified embed code.

Parameters
embedCodethe embed code to look up
currentItemthe current Video
Returns
the video in this ChannelSet with the specified embed code

Member Data Documentation

String com.ooyala.android.item.ContentItem._assetPCode = null
protectedinherited
int com.ooyala.android.item.ContentItem._authCode = AuthCode.NOT_REQUESTED
protectedinherited
boolean com.ooyala.android.item.ContentItem._authorized = false
protectedinherited
OrderedMap<String, Channel> com.ooyala.android.item.ChannelSet._channels = new OrderedMap<String, Channel>()
protected
String com.ooyala.android.item.ContentItem._contentToken = null
protectedinherited
String com.ooyala.android.item.ContentItem._defaultAudioTrackLanguage = null
protectedinherited
String com.ooyala.android.item.ContentItem._description = null
protectedinherited
String com.ooyala.android.item.ContentItem._embedCode = null
protectedinherited
String com.ooyala.android.item.ContentItem._externalId = null
protectedinherited
boolean com.ooyala.android.item.ContentItem._hasVRContent = false
protectedinherited
boolean com.ooyala.android.item.ContentItem._heartbeatRequired
protectedinherited
String com.ooyala.android.item.ContentItem._hostedAtURL = null
protectedinherited
boolean com.ooyala.android.item.ChannelSet._isFetchingMoreChildren = false
protected
Map<String, String> com.ooyala.android.item.ContentItem._metadata
protectedinherited
JSONArray com.ooyala.android.item.ContentItem._metadataAllAdsJSONArray
protectedinherited
JSONObject com.ooyala.android.item.ContentItem._metadataJSON
protectedinherited
Map<String, ModuleData> com.ooyala.android.item.ContentItem._moduleData
protectedinherited
String com.ooyala.android.item.ChannelSet._nextChildren = null
protected
String com.ooyala.android.item.ContentItem._promoImageURL = null
protectedinherited
SsaiMetadata com.ooyala.android.item.ContentItem._ssaiMetadata
protectedinherited
String com.ooyala.android.item.ContentItem._title = null
protectedinherited
FCCTVRating com.ooyala.android.item.ContentItem._tvRating
protectedinherited
String [] com.ooyala.android.item.AuthorizableItem.authCodeDescription
staticinherited
final String com.ooyala.android.item.ContentItem.CONTENT_TYPE_AUDIO = "Audio"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.CONTENT_TYPE_CHANNEL = "Channel"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.CONTENT_TYPE_CHANNEL_SET = "MultiChannel"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.CONTENT_TYPE_LIVE_STREAM = "LiveStream"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.CONTENT_TYPE_VIDEO = "Video"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_ADS = "ads"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_ASSET_PCODE = "asset_pcode"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_AUTHORIZED = "authorized"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_CHILDREN = "children"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_CLOSED_CAPTIONS = "closed_captions"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_CLOSED_CAPTIONS_VTT = "closed_captions_vtt"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_CODE = "code"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_CONTENT_TOKEN = "content_token"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_CONTENT_TYPE = "content_type"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_DEFAULT_AUDIO_TRACK_LANGUAGE = "default_language"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_DESCRIPTION = "description"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_DURATION = "duration"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_EMBED_CODE = "embed_code"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_EMBED_CODE_ATTRIBUTES = "attributes"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_EMBED_CODE_PROVIDER = "provider"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_EXTERNAL_ID = "external_id"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_HOSTED_AT_URL = "hostedAtURL"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA = "metadata"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_ALL_ADS = "all_ads"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_ALL_ADS_POSITION = "position"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_BASE = "base"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_ENABLED = "enabled"
staticinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_HA_COUNT = "ha_count"
staticinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_HA_ENABLED = "ha_enabled"
staticinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_HIGH_AVAILABILITY = "highAvailability"
staticinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_MODULE_TYPE = "type"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_MODULES = "modules"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_TVRATING_CLICKTHROUGH_URL = "tvratingsurl"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_TVRATING_RATING = "tvrating"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_TVRATING_SUBRATINGS = "tvsubratings"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_METADATA_VR_CONTENT = "vrcontent"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_MOVIE_ATTRIBUTES = "movie_attributes"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_NEXT_CHILDREN = "next_children"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_PROMO_IMAGE = "promo_image"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_REQUIRE_HEARTBEAT = "require_heartbeat"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_SSAI_ENABLED = "ssai_enabled"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_SSAI_VOD_ENABLED = "ssai_vod_enabled"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_SSAI_VOD_ENABLED_MOVIE = "ssai_vod_enabled_movie_level"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_STREAMS = "streams"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_THUMBNAIL_IMAGE = "thumbnail_image"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_TITLE = "title"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.KEY_VR_TYPE = "vr360type"
staticprotectedinherited
final String com.ooyala.android.item.ContentItem.VALUE_VR_TYPE = "mono"
staticprotectedinherited