Fullscreen Protocol Reference


                    
                    
                    aspectRatio

Specifies how to handle the aspect ratio of the content.

Declaration

Swift

@available(*, deprecated, message: "This property will be removed with the next major release. Please use `THEOplayer.aspectRatio` instead.")
var aspectRatio: AspectRatio { get }


                    
                    
                    supportedInterfaceOrientations

The supported interface orientations for fullscreen mode as a UIInterfaceOrientationMask.

Declaration

Swift

var supportedInterfaceOrientations: UIInterfaceOrientationMask { get }


                    
                    
                    viewController

When in fullscreen presentation mode returns the FullscreenViewController that contains the player. Returns nil otherwise.

Declaration

Swift

var viewController: FullscreenViewController? { get }


                    
                    
                    viewControllerClass

The type of the FullscreenViewController that will be presented when the player goes to fullscreen presentation mode.

Declaration

Swift

var viewControllerClass: FullscreenViewController.Type? { get set }


                    
                    
                    presentationDelegate

The fullscreen delegate which allows control over the presentation of the fullscreen view controller. Setting it will override the default behavior.

Declaration

Swift

var presentationDelegate: FullscreenPresentationDelegate? { get set }


                    
                    
                    setAspectRatio(aspectRatio:)

Sets the current fullscreen aspect ratio.

Declaration

Swift

@available(*, deprecated, message: "This method will be removed with the next major release. Please use `THEOplayer.aspectRatio` instead.")
func setAspectRatio(aspectRatio: AspectRatio)

Parameters


                                aspectRatio

The AspectRatio to be used by the player.


                    
                    
                    setSupportedInterfaceOrientations(supportedInterfaceOrientations:)

Sets the supported interface orientations for fullscreen mode.

Declaration

Swift

func setSupportedInterfaceOrientations(supportedInterfaceOrientations: UIInterfaceOrientationMask)

Parameters


                                supportedInterfaceOrientations

The supported interface orientations.


                    
                    
                    addEventListener(type:listener:)

Adds the event listener of the given EventType.

Remark

When attaching a listener on the wrong object the application will crash.

Declaration

Swift

func addEventListener<E>(type: EventType<E>, listener: @escaping (E) -> ()) -> EventListener where E : EventProtocol

Parameters

`type`	`EventType` of the added event listener. See `FullscreenEventTypes` for possible values.
`listener`	Closure called when event is dispatched.

Return Value

The newly added EventListener.


                    
                    
                    removeEventListener(type:listener:)

Removes the event listener for the given EventType.

Declaration

Swift

func removeEventListener<E>(type: EventType<E>, listener: EventListener) where E : EventProtocol

Parameters

`type`	`EventType` of the event listener to be removed. See `FullscreenEventTypes` for possible values.
`listener`	`EventListener` which was added by `addEventListener(...)`.