Instance Methods | Properties | List of all members
<OOPlayerProtocol> Protocol Reference

#import <OOPlayerProtocol.h>

+ Inheritance diagram for <OOPlayerProtocol>:

Instance Methods

(BOOL) - hasCustomControls
 
(void) - pause
 This is called when pause is clicked. More...
 
(void) - play
 This is called when play is clicked. More...
 
(void) - stop
 This is called when stop is clicked. More...
 
(Float64) - playheadTime
 Get the current playhead time. More...
 
(Float64) - duration
 Get the current item's duration. More...
 
(Float64) - buffer
 Get the current item's buffer. More...
 
(void) - seekToTime:
 Set the current playhead time of the player. More...
 
(UIImage *) - screenshot
 
(void) - setVideoGravity:
 
(void) - setClosedCaptionsLanguage:
 
(void) - disablePlaylistClosedCaptions
 

Properties

OOOoyalaPlayerState state
 This returns the player state. More...
 
BOOL seekable
 
CMTimeRange seekableTimeRange
 
BOOL allowsExternalPlayback
 
BOOL usesExternalPlaybackWhileExternalScreenIsActive
 
BOOL externalPlaybackActive
 
float rate
 
double bitrate
 
BOOL supportsVideoGravityButton
 
BOOL liveClosedCaptionsAvailable
 
float volume
 

Method Documentation

- (Float64) buffer

Get the current item's buffer.

Returns
buffer as CMTimeRange
- (void) disablePlaylistClosedCaptions

Reimplemented in OOStreamPlayer.

- (Float64) duration

Get the current item's duration.

Returns
duration as CMTime
- (BOOL) hasCustomControls
Returns
YES if the player will put its own controls on-screen; NO if the player wants the Ooyala controls to be used instead.
- (void) pause

This is called when pause is clicked.

- (void) play

This is called when play is clicked.

- (Float64) playheadTime

Get the current playhead time.

Returns
the current playhead time as CMTime
- (UIImage *) screenshot
Returns
current frame of playing asset
- (void) seekToTime: (Float64)  time

Set the current playhead time of the player.

Parameters
[in]timeCMTime to set the playhead time to
- (void) setClosedCaptionsLanguage: (NSString *)  language
- (void) setVideoGravity: (OOOoyalaPlayerVideoGravity)  gravity
- (void) stop

This is called when stop is clicked.

Property Documentation

- (BOOL) allowsExternalPlayback
readwritenonatomicassign
- (double) bitrate
readnonatomicassign
- (BOOL) externalPlaybackActive
readnonatomicassign
- (BOOL) liveClosedCaptionsAvailable
readnonatomicassign
- (float) rate
readwritenonatomicassign
- (BOOL) seekable
readwritenonatomicassign
- (CMTimeRange) seekableTimeRange
readnonatomicassign
- (OOOoyalaPlayerState) state
readnonatomicassign

This returns the player state.

Returns
the state
- (BOOL) supportsVideoGravityButton
readnonatomicassign
- (BOOL) usesExternalPlaybackWhileExternalScreenIsActive
readwritenonatomicassign
- (float) volume
readwritenonatomicassign
The documentation for this protocol was generated from the following file: