A single playable content item, such as video. More...

#import "OOContentItem.h"

+ Inheritance diagram for OOContentItem:

Instance Methods

(instancetype) - initWithEmbedCode:title:description:
 Initialize a OOContentItem. More...
 
(instancetype) - initWithDictionary:embedCode:api:
 
(OOReturnState) - updateWithDictionary:
 
(NSString *) - getPromoImageURLForWidth:height:
 Get the promo image URL for this content item that will be at least the specified dimensions. More...
 
(NSArray *) - embedCodesToAuthorize
 
(OOVideo *) - firstVideo
 Get the first OOVideo for this OOContentItem. More...
 
(OOVideo *) - videoFromEmbedCode:withCurrentItem:
 
(Float64) - duration
 The total duration (not including Ads) of this OOContentItem. More...
 

Class Methods

(OOContentItem *) + contentItemFromDictionary:embedCode:api:
 
(OOContentItem *) + contentItemFromDictionary:embedCodes:api:
 

Protected Attributes

NSString * embedCode
 The OOContentItem's Embed Code. More...
 
NSString * externalId
 The OOContentItem's External ID if it exists. More...
 
NSString * title
 The OOContentItem's Title. More...
 
NSString * itemDescription
 The OOContentItem's Description. More...
 
NSString * promoImageURL
 The OOContentItem's Promo Image URL. More...
 
NSString * hostedAtURL
 The OOContentItem's Hosted At URL. More...
 
OOPlayerAPIClient * api
 
BOOL authorized
 Whether or not this OOContentItem is authorized. More...
 
BOOL haEnabled
 
OOAuthCode authCode
 The response code from the authorize call. More...
 
SsaiMetadata * ssaiMetadata
 
NSString * contentType
 

Properties

NSDictionary * metadata
 
NSDictionary * moduleData
 
BOOL heartbeatRequired
 
OOFCCTVRatingtvRating
 
NSString * assetPcode
 The OOContentItem's Promo Image URL. More...
 
NSDictionary * movieAttributes
 
BOOL needsMidStreamCheck
 
int midStreamCheckInterval
 
NSMutableArray * externalAds
 

Detailed Description

A single playable content item, such as video.

OOContentItem.

OOContentItem.h in OoyalaSDK

Method Documentation

+ (OOContentItem *) contentItemFromDictionary: (NSDictionary *)  data
embedCode: (NSString *)  embedCode
api: (OOPlayerAPIClient *)  api 
+ (OOContentItem *) contentItemFromDictionary: (NSDictionary *)  data
embedCodes: (NSArray *)  embedCodes
api: (OOPlayerAPIClient *)  api 
- (Float64) duration

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

Returns
an Float64 with the total duration in seconds

Reimplemented in OOChannel, OOChannelSet, and OODynamicChannel.

- (NSArray *) embedCodesToAuthorize

Reimplemented in OODynamicChannel.

- (OOVideo *) firstVideo

Get the first OOVideo for this OOContentItem.

Returns
the first OOVideo this OOContentItem represents

Reimplemented in OOVideo, OOChannel, and OOChannelSet.

- (NSString *) getPromoImageURLForWidth: (NSInteger)  width
height: (NSInteger)  height 

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

Parameters
[in]widththe minimum width
[in]heightthe minimum height
Returns
a string containing the promo image URL
- (instancetype) initWithDictionary: (NSDictionary *)  data
embedCode: (NSString *)  theEmbedCode
api: (OOPlayerAPIClient *)  theAPI 

Reimplemented in OOVideo, OOChannel, and OOChannelSet.

- (instancetype) initWithEmbedCode: (NSString *)  theEmbedCode
title: (NSString *)  theTitle
description: (NSString *)  theDescription 

Initialize a OOContentItem.

Parameters
[in]theEmbedCodethe embed code
[in]theTitlethe title
[in]theDescriptionthe description
Returns
the initialized OOContentItem
- (OOReturnState) updateWithDictionary: (NSDictionary *)  data

Reimplemented in OOVideo, OOChannel, OOChannelSet, and OODynamicChannel.

- (OOVideo *) videoFromEmbedCode: (NSString *)  embedCode
withCurrentItem: (OOVideo *)  currentItem 

Reimplemented in OOVideo, OOChannel, and OOChannelSet.

Member Data Documentation

- (OOPlayerAPIClient *) api
readnonatomicassignprotected
- (OOAuthCode) authCode
readnonatomicassignprotected

The response code from the authorize call.

- (BOOL) authorized
readnonatomicassignprotected

Whether or not this OOContentItem is authorized.

- (NSString *) contentType
readnonatomicassignprotected
- (NSString *) embedCode
readnonatomicassignprotected

The OOContentItem's Embed Code.

- (NSString *) externalId
readnonatomicassignprotected

The OOContentItem's External ID if it exists.

- (BOOL) haEnabled
readnonatomicassignprotected
- (NSString *) hostedAtURL
readnonatomicassignprotected

The OOContentItem's Hosted At URL.

- (NSString *) itemDescription
readnonatomicassignprotected

The OOContentItem's Description.

- (NSString *) promoImageURL
readnonatomicassignprotected

The OOContentItem's Promo Image URL.

- (SsaiMetadata *) ssaiMetadata
readnonatomicassignprotected
- (NSString *) title
readnonatomicassignprotected

The OOContentItem's Title.

Property Documentation

- (NSString*) assetPcode
readnonatomicassign

The OOContentItem's Promo Image URL.

- (NSMutableArray*) externalAds
readnonatomicassign
- (BOOL) heartbeatRequired
readwritenonatomicassign
- (NSDictionary*) metadata
readnonatomicassign
- (int) midStreamCheckInterval
readnonatomicassign
- (NSDictionary*) moduleData
readnonatomicassign
- (NSDictionary*) movieAttributes
readnonatomicassign
- (BOOL) needsMidStreamCheck
readnonatomicassign
- (OOFCCTVRating*) tvRating
readnonatomicassign

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