streams/com.bitmovin.streams.config/FullscreenConfig

FullscreenConfig

class FullscreenConfig(var enable: Boolean = true, var immersive: Boolean = true, var autoRotate: Boolean = true, var minAspectRatioForLandscapeForce: Float = 1.2f, var maxAspectRatioForPortraitForce: Float = 0.8f, var screenDefaultOrientation: Int? = null, var autoPiPOnBackground: Boolean = true)

Configuration for the fullscreen behavior of the player.

Constructors

FullscreenConfig

constructor(enable: Boolean = true, immersive: Boolean = true, autoRotate: Boolean = true, minAspectRatioForLandscapeForce: Float = 1.2f, maxAspectRatioForPortraitForce: Float = 0.8f, screenDefaultOrientation: Int? = null, autoPiPOnBackground: Boolean = true)

Types

Companion

object Companion

Properties

autoPiPOnBackground

var autoPiPOnBackground: Boolean

Whether the player should automatically enter picture-in-picture mode when the app goes to the background while a stream being in fullscreen.

autoRotate

var autoRotate: Boolean

Whether the player should automatically change orientation.

enable

var enable: Boolean

Whether the fullscreen behavior should be enabled.

immersive

var immersive: Boolean

Whether the player should be in immersive mode. Recommended to be false if the EdgeToEdge is disabled on the Activity (may break on some very specific devices).

maxAspectRatioForPortraitForce

var maxAspectRatioForPortraitForce: Float

The maximum aspect ratio for forcing portrait orientation. Does not apply if autoRotate is false.

minAspectRatioForLandscapeForce

var minAspectRatioForLandscapeForce: Float

The minimum aspect ratio for forcing landscape orientation. Does not apply if autoRotate is false.

screenDefaultOrientation

var screenDefaultOrientation: Int?

The default orientation of the screen.Will be forced after fullscreen escape if non-null. If null, the screen orientation will automatically reset to the state after exiting fullscreen. Should correspond to one of the ActivityInfo.SCREEN_ORIENTATION_* constants.