Instance Methods | Class Methods | Properties | List of all members
OOOoyalaPlayerViewController Class Reference

Main ViewController class for Ooyala player. More...

#import "OOOoyalaPlayerViewController.h"

+ Inheritance diagram for OOOoyalaPlayerViewController:

Instance Methods

(BOOL) - isFullscreen
 Get the fullscreen state. More...
 
(void) - setFullscreen:
 Set the fullscreen state. More...
 
(id) - initWithPlayer:
 Initialize the UI with an existing OOOoyalaPlayer object. More...
 
(id) - initWithPlayer:controlType:
 Initialize the UI with an existing OOOoyalaPlayer object and control type. More...
 
(OOControlsViewController *) - getControls
 Returns the currently active controls. More...
 
(void) - showControls
 Shows controls on the current player. More...
 
(void) - hideControls
 Hides controls on the current player. More...
 
(void) - setFullScreenButtonShowing:
 Sets visibility of full-screen button on inline player. More...
 
(void) - setVolumeButtonShowing:
 Sets visibility of volume button on inline player. More...
 
(void) - setFullScreenViewController:
 Sets the ViewController used to display controls in fullscreen mode. More...
 
(void) - setInlineViewController:
 Sets the ViewController used to display controls in inline mode. More...
 
(void) - updateClosedCaptionsViewPosition:withControlsHide:
 update closed caption view position More...
 

Class Methods

(NSDictionary *) + availableLocalizations
 Returns a dictionary of localization dictionaries. More...
 
(void) + setAvailableLocalizations:
 Sets the available localizations for the OoyalaPlayer. More...
 
(void) + loadDeviceLanguage
 Loads a dictionary of language strings according to language settings in the device. More...
 
(void) + useLanguageStrings:
 Instructs the player to use given dictionary of language, regardless of localization. More...
 
(NSDictionary *) + getLanguageSettings:
 Returns a dictionary of language according to the given language string. More...
 
(NSDictionary *) + currentLanguageSettings
 Returns a dictionary of current language. More...
 

Properties

OOOoyalaPlayerControlType initialControlType
 
OOOoyalaPlayer * player
 
UIView * inlineOverlay
 
UIView * fullscreenOverlay
 
OOClosedCaptionsStyle * closedCaptionsStyle
 The OOClosedCaptionsStyle to use when displaying closed captions. More...
 
BOOL autohideControls
 Property to decide if we want to enable or disable autohiding the controls after some time. More...
 

Detailed Description

Main ViewController class for Ooyala player.

OOOoyalaPlayerViewController.

Implements a default skin as well as convenience methods for accesssing and initializing underlying OOOoyalaPlayer.

OOOoyalaPlayerViewController.h in OoyalaSDK

Method Documentation

+ (NSDictionary *) availableLocalizations

Returns a dictionary of localization dictionaries.

The keys are strings of locale codes. the values are dictionaries of localized strings example: { "en" : { "LIVE": @"LIVE", @"Done": @"Done", ... }, "es" : { @"LIVE": @"En vivo", @"Done": @"Hecho", ... }, ... }

Returns
the dictionary of available localization.
+ (NSDictionary*) currentLanguageSettings

Returns a dictionary of current language.

- (OOControlsViewController *) getControls

Returns the currently active controls.

+ (NSDictionary*) getLanguageSettings: (NSString *)  language

Returns a dictionary of language according to the given language string.

- (void) hideControls

Hides controls on the current player.

- (id) initWithPlayer: (OOOoyalaPlayer *)  player

Initialize the UI with an existing OOOoyalaPlayer object.

Parameters
[in]playerReference to OOOoyalaPlayer object
- (id) initWithPlayer: (OOOoyalaPlayer *)  player
controlType: (OOOoyalaPlayerControlType)  controlType 

Initialize the UI with an existing OOOoyalaPlayer object and control type.

Parameters
[in]playerReference to OOOoyalaPlayer object
[in]controlTypeSelects inline or fullscreen only UI mode
- (BOOL) isFullscreen

Get the fullscreen state.

Returns
true if in fullscreen mode, false if not
+ (void) loadDeviceLanguage

Loads a dictionary of language strings according to language settings in the device.

+ (void) setAvailableLocalizations: (NSDictionary *)  localizations

Sets the available localizations for the OoyalaPlayer.

The "en" key must exist, do not remove it, but you can update any of the values there.

Parameters
[in]localizationsthe dictionary of translation dictionaries
- (void) setFullscreen: (BOOL)  fullscreen

Set the fullscreen state.

Parameters
[in]fullscreenwhether the view should be fullscreened
- (void) setFullScreenButtonShowing: (BOOL)  showing

Sets visibility of full-screen button on inline player.

Parameters
[in]showingTrue to show fullscreen button, false otherwise
- (void) setFullScreenViewController: (OOControlsViewController *)  controller

Sets the ViewController used to display controls in fullscreen mode.

Parameters
[in]controllerthe initialized ViewController to use
- (void) setInlineViewController: (OOControlsViewController *)  controller

Sets the ViewController used to display controls in inline mode.

Parameters
[in]controllerthe initialized ViewController to use
- (void) setVolumeButtonShowing: (BOOL)  showing

Sets visibility of volume button on inline player.

Parameters
[in]showingTrue to show fullscreen button, false otherwise
- (void) showControls

Shows controls on the current player.

- (void) updateClosedCaptionsViewPosition: (CGRect)  bottomControlsRect
withControlsHide: (BOOL)  hidden 

update closed caption view position

Parameters
[in]bottomControlsRectthe bottom controls rect
[in]hiddenYES if the bottom control is hidden, NO if it is not hidden
+ (void) useLanguageStrings: (NSDictionary *)  strings

Instructs the player to use given dictionary of language, regardless of localization.

Property Documentation

- (BOOL) autohideControls
readwritenonatomicassign

Property to decide if we want to enable or disable autohiding the controls after some time.

Default: true

- (OOClosedCaptionsStyle*) closedCaptionsStyle
readwritenonatomicstrong

The OOClosedCaptionsStyle to use when displaying closed captions.

- (UIView*) fullscreenOverlay
readwritenonatomicstrong
- (OOOoyalaPlayerControlType) initialControlType
readnonatomicassign
- (UIView*) inlineOverlay
readwritenonatomicstrong
- (OOOoyalaPlayer*) player
readwritenonatomicstrong
The documentation for this class was generated from the following file: