Bitmovin Player React Native SDK - v1.1.0
    Preparing search index...

    Interface BasePlayerViewProps

    Base PlayerView component props. Used to establish common props between NativePlayerView and PlayerView.

    interface BasePlayerViewProps {
        config?: PlayerViewConfig;
        customMessageHandler?: CustomMessageHandler;
        fullscreenHandler?: FullscreenHandler;
        isFullscreenRequested?: boolean;
        isPictureInPictureRequested?: boolean;
        ref?: RefObject<null>;
        scalingMode?: ScalingMode;
        style?: ViewStyle;
    }

    Hierarchy (View Summary)

    Index

    Properties

    Configures the visual presentation and behaviour of the PlayerView. The value must not be altered after setting it initially.

    customMessageHandler?: CustomMessageHandler

    The CustomMessageHandler that can be used to directly communicate with the embedded Bitmovin Web UI.

    fullscreenHandler?: FullscreenHandler

    The FullscreenHandler that is used by the PlayerView to control the fullscreen mode.

    isFullscreenRequested?: boolean

    Can be set to true to request fullscreen mode, or false to request exit of fullscreen mode. Should not be used to get the current fullscreen state. Use PlayerViewEvents.onFullscreenEnter and PlayerViewEvents.onFullscreenExit or the FullscreenHandler.isFullscreenActive property to get the current state. Using this property to change the fullscreen state, it is ensured that the embedded Player UI is also aware of potential fullscreen state changes. To use this property, a FullscreenHandler must be set.

    isPictureInPictureRequested?: boolean

    Can be set to true to request Picture in Picture mode, or false to request exit of Picture in Picture mode. Should not be used to get the current Picture in Picture state. Use PlayerViewEvents.onPictureInPictureEnter and PlayerViewEvents.onPictureInPictureExit.

    ref?: RefObject<null>
    scalingMode?: ScalingMode

    A value defining how the video is displayed within the parent container's bounds. Possible values are defined in ScalingMode.

    style?: ViewStyle

    Style of the PlayerView.