this class implements video stream object More...

#import "OOVideo.h"

+ Inheritance diagram for OOVideo:

Instance Methods

(instancetype) - initWithUnbundledVideo:
 Initialize a OOVideo using the specified data (subclasses should override this) More...
 
(instancetype) - initWithUnbundledStreams:ads:
 
(instancetype) - initWithDictionary:embedCode:api:
 
(instancetype) - initWithDictionary:embedCode:parent:api:
 
(OOReturnState) - updateWithDictionary:
 
(BOOL) - updateHighAvailabilityWithDictionary:
 
(OOVideo *) - firstVideo
 Get the first OOVideo for this OOVideo, which is this OOVideo. More...
 
(OOVideo *) - nextVideo
 Get the next OOVideo for this OOVideo from the parent. More...
 
(OOVideo *) - previousVideo
 Get the previous OOVideo for this OOVideo from the parent. More...
 
(OOVideo *) - videoFromEmbedCode:withCurrentItem:
 
(BOOL) - fetchPlaybackInfo
 
(id) - fetchPlaybackInfo:
 
(BOOL) - hasAds
 Check if the OOVideo has ads. More...
 
(BOOL) - hasClosedCaptions
 Check if the OOVideo has Closed Captions. More...
 
(void) - insertAd:
 Insert an OOAdSpot to play during this video. More...
 
(void) - filterAds:
 Edit the list of ads, allowing for removal of ads. More...
 
(BOOL) - isSsaiEnabled
 
(void) - updateClosedCaptionsFromManifest:
 Update the list of languages using the manifest. More...
 
(OOStream *) - currentStream
 Get the current stream. More...
 
- Instance Methods inherited from OOContentItem
(instancetype) - initWithEmbedCode:title:description:
 Initialize a OOContentItem. More...
 
(NSString *) - getPromoImageURLForWidth:height:
 Get the promo image URL for this content item that will be at least the specified dimensions. More...
 
(NSArray *) - embedCodesToAuthorize
 
(Float64) - duration
 The total duration (not including Ads) of this OOContentItem. More...
 

Protected Attributes

NSMutableArray * ads
 
OOClosedCaptionsclosedCaptions
 
OOChannelparent
 This OOVideo's parent OOChannel if it exists (could be a OODynamicChannel) More...
 
Float64 duration
 The OOVideo's Total Duration (Length) More...
 
BOOL live
 Whether or not the video is live. More...
 
- Protected Attributes inherited from OOContentItem
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

NSURL * fairplayKeyURL
 If this is an offline Fairplay asset, this is where the Fairplay key is located. More...
 
int retryCount
 Keeps track of the number of retries already done for a given error. More...
 
NSString * defaultLanguageCode
 The OOContentItem's Default language Code (eng, deu etc.) More...
 
- Properties inherited from OOContentItem
NSDictionary * metadata
 
NSDictionary * moduleData
 
BOOL heartbeatRequired
 
OOFCCTVRatingtvRating
 
NSString * assetPcode
 The OOContentItem's Promo Image URL. More...
 
NSDictionary * movieAttributes
 
BOOL needsMidStreamCheck
 
int midStreamCheckInterval
 
NSMutableArray * externalAds
 

Additional Inherited Members

- Class Methods inherited from OOContentItem
(OOContentItem *) + contentItemFromDictionary:embedCode:api:
 
(OOContentItem *) + contentItemFromDictionary:embedCodes:api:
 

Detailed Description

this class implements video stream object

OOVideo.

OOVideo.h in OoyalaSDK

Method Documentation

- (OOStream *) currentStream

Get the current stream.

Returns
the current stream

Provided by category OOVideo(Internal).

- (BOOL) fetchPlaybackInfo
- (id) fetchPlaybackInfo: (void(^)(BOOL))  callback
- (void) filterAds: (NSPredicate *)  predicate

Edit the list of ads, allowing for removal of ads.

Parameters
predicateblock that returns TRUE for ads to keep, FALSE for ads to remove.
- (OOVideo *) firstVideo

Get the first OOVideo for this OOVideo, which is this OOVideo.

Returns
self

Reimplemented from OOContentItem.

- (BOOL) hasAds

Check if the OOVideo has ads.

Returns
whether the OOVideo has ads or not
- (BOOL) hasClosedCaptions

Check if the OOVideo has Closed Captions.

Returns
whether the OOVideo has closed captions or not
- (instancetype) initWithDictionary: (NSDictionary *)  data
embedCode: (NSString *)  theEmbedCode
api: (OOPlayerAPIClient *)  theAPI 

Reimplemented from OOContentItem.

- (instancetype) initWithDictionary: (NSDictionary *)  data
embedCode: (NSString *)  theEmbedCode
parent: (OOChannel *)  theParent
api: (OOPlayerAPIClient *)  theAPI 
- (instancetype) initWithUnbundledStreams: (NSArray *)  theStreams
ads: (NSArray *)  theAds 
- (instancetype) initWithUnbundledVideo: (OOUnbundledVideo *)  unbundledVideo

Initialize a OOVideo using the specified data (subclasses should override this)

Parameters
[in]unbundledVideodefines the streams and ads to use initializing the OOVideo.
- (void) insertAd: (OOManagedAdSpot *)  ad

Insert an OOAdSpot to play during this video.

Parameters
adthe OOAdSpot to play during this video
- (BOOL) isSsaiEnabled
- (OOVideo *) nextVideo

Get the next OOVideo for this OOVideo from the parent.

Returns
nil if this is the last OOVideo or there is no parent, otherwise the next OOVideo
- (OOVideo *) previousVideo

Get the previous OOVideo for this OOVideo from the parent.

Returns
nil if this is the first OOVideo or there is no parent, otherwise the previous OOVideo
- (void) updateClosedCaptionsFromManifest: (NSArray *)  languages

Update the list of languages using the manifest.

Parameters
[in]languagesan array with all the available languages in manifest

Provided by category OOVideo(Internal).

- (BOOL) updateHighAvailabilityWithDictionary: (NSDictionary *)  data
- (OOReturnState) updateWithDictionary: (NSDictionary *)  data

Reimplemented from OOContentItem.

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

Reimplemented from OOContentItem.

Member Data Documentation

- (NSMutableArray *) ads
readnonatomicassignprotected
- (OOClosedCaptions *) closedCaptions
readnonatomicassignprotected
- (Float64) duration
readnonatomicassignprotected

The OOVideo's Total Duration (Length)

- (BOOL) live
readnonatomicassignprotected

Whether or not the video is live.

- (OOChannel *) parent
readnonatomicassignprotected

This OOVideo's parent OOChannel if it exists (could be a OODynamicChannel)

Property Documentation

- (NSString*) defaultLanguageCode
readnonatomicassign

The OOContentItem's Default language Code (eng, deu etc.)

- (NSURL*) fairplayKeyURL
readnonatomicassign

If this is an offline Fairplay asset, this is where the Fairplay key is located.

- (int) retryCount
readwritenonatomicassign

Keeps track of the number of retries already done for a given error.

Used by the HA plugin to try an reset the video with the player.


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