OOCastPlayer Class Reference

#import <OOCastPlayer.h>

Inheritance diagram for OOCastPlayer:

Instance Methods
((unavailable("use initWithNamespace:deviceManager:castManager")	- __attribute__
(nonnull instancetype)	- initWithNamespace:castSession:castManager:
(void)	- registerWithOoyalaPlayer:
(void)	- updateMetadataCastItemPromoImg:castItemTitle:castItemDescription:
(void)	- enterCastModeWithOptions:embedToken:additionalInitParams:
(void)	- registerMiniController:
(void)	- deregisterMiniController:
(void)	- onExitCastMode
(void)	- forceAssetRejoin
(instancetype)	- initWithNamespace:castSession:castManager: [implementation]
(void)	- dealloc [implementation]
(void)	- setStateNotifier: [implementation]
(void)	- registerWithOoyalaPlayer: [implementation]
(void)	- updateMetadataCastItemPromoImg:castItemTitle:castItemDescription: [implementation]
(void)	- enterCastModeWithOptions:embedToken:additionalInitParams: [implementation]
(void)	- registerMiniController: [implementation]
(void)	- deregisterMiniController: [implementation]
(void)	- cleanupBeforeDeallocate [implementation]
(void)	- castNewContentWithOptions:embedToken:additionalInitParams: [implementation]
(void)	- syncCastUI [implementation]
(void)	- resetStateOnVideoChange [implementation]
(NSMutableDictionary *)	- buildInitDataWithOptions:embedToken:additionalInitParams: [implementation]
(void)	- observeValueForKeyPath:ofObject:change:context: [implementation]
(void)	- getReceiverPlayerState [implementation]
(void)	- updateVolumeTo: [implementation]
(OOOoyalaPlayerState)	- state [implementation]
(void)	- setState: [implementation]
(void)	- dismissMiniControllers [implementation]
(void)	- sendMuteMessageIfStartingVideoMuted [implementation]
(void)	- sendMessage: [implementation]
(NSInteger)	- makeRemoteMediaClientRequest:block: [implementation]
(void)	- updatePlayerStateFromTextMessage: [implementation]
(void)	- handleTextMessageEvent:withResults: [implementation]
(void)	- handlePlayheadTimeChanged: [implementation]
(void)	- handlePlaybackReady: [implementation]
(void)	- handlePlaying: [implementation]
(void)	- handlePaused: [implementation]
(void)	- handleContentTreeFetched: [implementation]
(void)	- handleClosedCaptionsInfoAvailable: [implementation]
(void)	- handleSeeked: [implementation]
(void)	- handlePlayed: [implementation]
(void)	- didReceiveTextMessage: [implementation]
	Called when a text message has been received on this channel. More...
(void)	- didConnect [implementation]
	Called when this channel has been connected, indicating that messages can now be exchanged with the Cast device over this channel. More...
(void)	- didDisconnect [implementation]
	Called when this channel has been disconnected, indicating that messages can no longer be exchanged with the Cast device over this channel. More...
(void)	- pause [implementation]
(void)	- play [implementation]
(void)	- stop [implementation]
	This is called when stop is clicked. More...
(void)	- setVideoGravity: [implementation]
	useless for chromecast More...
(BOOL)	- hasCustomControls [implementation]
(Float64)	- duration [implementation]
	Get the current item's duration. More...
(Float64)	- buffer [implementation]
	Get the current item's buffer. More...
(CMTimeRange)	- seekableTimeRange [implementation]
(BOOL)	- seekable [implementation]
(BOOL)	- supportsVideoGravityButton [implementation]
(void)	- setClosedCaptionsLanguage: [implementation]
(NSString *)	- convertClosedCaptionsLanguageForReceiver: [implementation]
(void)	- seekToTime: [implementation]
	Set the current playhead time of the player. More...
(UIImage *)	- screenshot [implementation]
(BOOL)	- tryToSeekToTime: [implementation]
(void)	- setVolume: [implementation]
(void)	- updateMiniControllers [implementation]
(void)	- request:didFailWithError: [implementation]
(void)	- remoteMediaClient:didUpdateMediaStatus: [implementation]
Instance Methods inherited from GCKCastChannel
(instancetype)	- initWithNamespace:
	Designated initializer. More...
(instancetype)	- NS_UNAVAILABLE
	Default initializer is not available. More...
(BOOL)	- sendTextMessage:error:
	Sends a text message on this channel. More...
(NSInteger)	- generateRequestID
	Generates a request ID for a new message. More...
(NSNumber *GCK_NULLABLE_TYPE)	- generateRequestNumber
	A convenience method which wraps the result of generateRequestID in an NSNumber. More...
(void)	- didChangeWritableState:
	Called when the writable state of this channel has changed. More...

Properties
OOStateNotifier *	stateNotifier
NSString *	embedCode
Float64	playheadTime
	Get the current playhead time. More...
NSString *	castItemTitle
NSString *	castItemDescription
NSString *	castItemPromoImg
BOOL	isMiniControllerInteractionAvailable
id< OOCastManagerInternalProtocol >	castManager [implementation]
OOOoyalaPlayer *	ooyalaPlayer [implementation]
GCKCastSession *	castSession [implementation]
NSMutableArray *	miniControllerList [implementation]
BOOL	isSeeking [implementation]
BOOL	isPlayQueued [implementation]
BOOL	liveClosedCaptionsAvailable [implementation]
BOOL	sameEmbedCode [implementation]
Properties inherited from GCKCastChannel
NSString *	protocolNamespace
	The channel's namespace. More...
BOOL	isConnected
	A flag indicating whether this channel is currently connected. More...
BOOL	isWritable
	A flag indicating whether this channel is currently writable. More...

Method Documentation

- ((unavailable("use) initWithNamespace:

- (Float64) buffer

implementation

Get the current item's buffer.

Returns

buffer as CMTimeRange

- (NSMutableDictionary *) buildInitDataWithOptions: (OOCastModeOptions *)  options embedToken: (NSString *)  embedToken additionalInitParams: (NSDictionary *)  additionalParams

implementation

- (void) castNewContentWithOptions: (OOCastModeOptions *)  options embedToken: (NSString *)  embedToken additionalInitParams: (NSDictionary *)  params

implementation

- (void) cleanupBeforeDeallocate

implementation

- (NSString *) convertClosedCaptionsLanguageForReceiver: (NSString *)  language

implementation

- (void) dealloc

implementation

- (void) deregisterMiniController:

(nullable id< OOCastMiniControllerProtocol >)

miniController

- (void) deregisterMiniController: (id<OOCastMiniControllerProtocol>)  miniController

implementation

- (void) didConnect

implementation

Called when this channel has been connected, indicating that messages can now be exchanged with the Cast device over this channel.

The default implementation is a no-op.

Implements GCKCastChannel.

- (void) didDisconnect

implementation

Called when this channel has been disconnected, indicating that messages can no longer be exchanged with the Cast device over this channel.

The default implementation is a no-op.

Implements GCKCastChannel.

- (void) didReceiveTextMessage: (NSString *)  message

implementation

Called when a text message has been received on this channel.

The default implementation is a no-op.

Parameters

message

The message.

Implements GCKCastChannel.

- (void) dismissMiniControllers

implementation

- (Float64) duration

implementation

Get the current item's duration.

Returns

duration as CMTime

- (void) enterCastModeWithOptions:		(nonnull OOCastModeOptions *)	options
embedToken:		(nonnull NSString *)	embedToken
additionalInitParams:		(nullable NSDictionary *)	params

- (void) enterCastModeWithOptions: (OOCastModeOptions *)  options embedToken: (NSString *)  embedToken additionalInitParams: (NSDictionary *)  params

implementation

- (void) forceAssetRejoin

- (void) getReceiverPlayerState

implementation

- (void) handleClosedCaptionsInfoAvailable: (NSDictionary *)  json

implementation

- (void) handleContentTreeFetched: (NSDictionary *)  json

implementation

- (void) handlePaused: (NSDictionary *)  json

implementation

- (void) handlePlaybackReady: (NSDictionary *)  json

implementation

- (void) handlePlayed: (NSDictionary *)  json

implementation

- (void) handlePlayheadTimeChanged: (NSDictionary *)  json

implementation

- (void) handlePlaying: (NSDictionary *)  json

implementation

- (void) handleSeeked: (NSDictionary *)  json

implementation

- (void) handleTextMessageEvent: (NSString *)  eventType withResults: (NSDictionary *)  results

implementation

- (BOOL) hasCustomControls

implementation

- (nonnull instancetype) initWithNamespace:		(nonnull NSString *)	appNamespace
castSession:		(nullable GCKCastSession *)	castSession
castManager:		(nullable id< OOCastManagerInternalProtocol >)	castManager

- (instancetype) initWithNamespace: (NSString *)  appNamespace castSession: (GCKCastSession *)  castSession castManager: (id<OOCastManagerInternalProtocol>)  castManager

implementation

- (NSInteger) makeRemoteMediaClientRequest: (NSString *)  log block: (GCKRequest *(^)(GCKRemoteMediaClient *))  block

implementation

- (void) observeValueForKeyPath: (NSString *)  keyPath ofObject: (id)  object change: (NSDictionary *)  change context: (void *)  context

implementation

- (void) onExitCastMode

- (void) pause

implementation

- (void) play

implementation

- (void) registerMiniController:

(nullable id< OOCastMiniControllerProtocol >)

miniController

- (void) registerMiniController: (id<OOCastMiniControllerProtocol>)  miniController

implementation

- (void) registerWithOoyalaPlayer:

(nullable OOOoyalaPlayer *)

ooyalaPlayer

- (void) registerWithOoyalaPlayer: (OOOoyalaPlayer *)  ooyalaPlayer

implementation

- (void) remoteMediaClient: (GCKRemoteMediaClient *)  client didUpdateMediaStatus: (GCKMediaStatus *GCK_NULLABLE_TYPE)  mediaStatus

implementation

Provided by category OOCastPlayer(GCKRemoteMediaClientListener).

- (void) request: (GCKRequest *)  request didFailWithError: (GCKError *)  error

implementation

- (void) resetStateOnVideoChange

implementation

- (UIImage *) screenshot

implementation

- (BOOL) seekable

implementation

- (CMTimeRange) seekableTimeRange

implementation

- (void) seekToTime: (Float64)  time

implementation

Set the current playhead time of the player.

Parameters

[in]

time

CMTime to set the playhead time to

- (void) sendMessage: (NSDictionary *)  message

implementation

- (void) sendMuteMessageIfStartingVideoMuted

implementation

- (void) setClosedCaptionsLanguage: (NSString *)  language

implementation

- (void) setState: (OOOoyalaPlayerState)  state

implementation

- (void) setStateNotifier: (OOStateNotifier *)  stateNotifier

implementation

- (void) setVideoGravity: (OOOoyalaPlayerVideoGravity)  gravity

implementation

useless for chromecast

- (void) setVolume: (float)  volume

implementation

- (OOOoyalaPlayerState) state

implementation

- (void) stop

implementation

This is called when stop is clicked.

- (BOOL) supportsVideoGravityButton

implementation

- (void) syncCastUI

implementation

- (BOOL) tryToSeekToTime: (Float64)  time

implementation

- (void) updateMetadataCastItemPromoImg:		(nullable NSString *)	castItemPromoImg
castItemTitle:		(nullable NSString *)	castItemTitle
castItemDescription:		(nullable NSString *)	castItemDescription

- (void) updateMetadataCastItemPromoImg: (NSString *)  castItemPromoImg castItemTitle: (NSString *)  castItemTitle castItemDescription: (NSString *)  castItemDescription

implementation

- (void) updateMiniControllers

implementation

- (void) updatePlayerStateFromTextMessage: (NSString *)  state

implementation

- (void) updateVolumeTo: (float)  volume

implementation

Property Documentation

- (NSString*) castItemDescription

readwritenonatomicassign

- (NSString*) castItemPromoImg

readwritenonatomicassign

- (NSString*) castItemTitle

readwritenonatomicassign

- (id<OOCastManagerInternalProtocol>) castManager

readwritenonatomicweakimplementation

- (GCKCastSession*) castSession

readwritenonatomicweakimplementation

- (NSString*) embedCode

readwritenonatomicassign

- (BOOL) isMiniControllerInteractionAvailable

readnonatomicassign

- (BOOL) isPlayQueued

readwritenonatomicassignimplementation

- (BOOL) isSeeking

readwritenonatomicassignimplementation

- (BOOL) liveClosedCaptionsAvailable

readwritenonatomicassignimplementation

- (NSMutableArray*) miniControllerList

readwritenonatomicassignimplementation

- (OOOoyalaPlayer*) ooyalaPlayer

readwritenonatomicweakimplementation

- (Float64) playheadTime

readwritenonatomicassign

Get the current playhead time.

Returns

the current playhead time as CMTime

- (BOOL) sameEmbedCode

readwritenonatomicassignimplementation

- (OOStateNotifier *) stateNotifier

readwritenonatomicassign

---

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

• OOCastPlayer.h
• OOCastPlayer.m