Fullscreen_Objc
@objc(THEOplayerFullscreen)
public protocol Fullscreen_Objc
The Fullscreen object helps you configure the settings of the fullscreen mode.
-
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 }
-
The supported interface orientations for fullscreen mode as a
UIInterfaceOrientationMask
.Declaration
Swift
var supportedInterfaceOrientations: UIInterfaceOrientationMask { get }
-
When in fullscreen presentation mode returns the
FullscreenViewController
that contains the player. Returns nil otherwise.Declaration
Swift
var viewController: FullscreenViewController? { get }
-
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 }
-
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 }
-
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. -
Sets the supported interface orientations for fullscreen mode.
Declaration
Swift
func setSupportedInterfaceOrientations(supportedInterfaceOrientations: UIInterfaceOrientationMask)
Parameters
supportedInterfaceOrientations
The supported interface orientations.
-
Adds the event listener of the given
EventType
.Remark
When attaching a listener on the wrong object the application will crash.
Declaration
Swift
@discardableResult func addEventListener(type: String, listener: @escaping (AspectRatioChangeEvent) -> ()) -> EventListener
Parameters
type
EventType
of the added event listener. SeeFullscreenEventTypes
for possible values.listener
Closure called when event is dispatched.
Return Value
The newly added
EventListener
. -
Removes the event listener for the given
EventType
.Declaration
Swift
func removeEventListener(type: String, listener: EventListener)
Parameters
type
EventType
of the event listener to be removed. SeeFullscreenEventTypes
for possible values.listener
EventListener
which was added byaddEventListener(...)
.