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

    Interface PlayerViewProps

    PlayerView component props.

    interface PlayerViewProps {
        config?: PlayerViewConfig;
        customMessageHandler?: CustomMessageHandler;
        fullscreenHandler?: FullscreenHandler;
        isFullscreenRequested?: boolean;
        isPictureInPictureRequested?: boolean;
        onAdBreakFinished?: (event: AdBreakFinishedEvent) => void;
        onAdBreakStarted?: (event: AdBreakStartedEvent) => void;
        onAdClicked?: (event: AdClickedEvent) => void;
        onAdError?: (event: AdErrorEvent) => void;
        onAdFinished?: (event: AdFinishedEvent) => void;
        onAdManifestLoad?: (event: AdManifestLoadEvent) => void;
        onAdManifestLoaded?: (event: AdManifestLoadedEvent) => void;
        onAdQuartile?: (event: AdQuartileEvent) => void;
        onAdScheduled?: (event: AdScheduledEvent) => void;
        onAdSkipped?: (event: AdSkippedEvent) => void;
        onAdStarted?: (event: AdStartedEvent) => void;
        onAudioAdded?: (event: AudioAddedEvent) => void;
        onAudioChanged?: (event: AudioChangedEvent) => void;
        onAudioRemoved?: (event: AudioRemovedEvent) => void;
        onCastAvailable?: (event: Event) => void;
        onCastPaused?: (event: Event) => void;
        onCastPlaybackFinished?: (event: Event) => void;
        onCastPlaying?: (event: Event) => void;
        onCastStart?: (event: Event) => void;
        onCastStarted?: (event: CastStartedEvent) => void;
        onCastStopped?: (event: Event) => void;
        onCastTimeUpdated?: (event: Event) => void;
        onCastWaitingForDevice?: (event: CastWaitingForDeviceEvent) => void;
        onCueEnter?: (event: CueEnterEvent) => void;
        onCueExit?: (event: CueExitEvent) => void;
        onDestroy?: (event: Event) => void;
        onDownloadFinished?: (event: DownloadFinishedEvent) => void;
        onEvent?: (event: Event) => void;
        onFullscreenDisabled?: (event: Event) => void;
        onFullscreenEnabled?: (event: Event) => void;
        onFullscreenEnter?: (event: Event) => void;
        onFullscreenExit?: (event: Event) => void;
        onMuted?: (event: Event) => void;
        onPaused?: (event: PausedEvent) => void;
        onPictureInPictureAvailabilityChanged?: (
            event: PictureInPictureAvailabilityChangedEvent,
        ) => void;
        onPictureInPictureEnter?: (event: Event) => void;
        onPictureInPictureEntered?: (event: Event) => void;
        onPictureInPictureExit?: (event: Event) => void;
        onPictureInPictureExited?: (event: Event) => void;
        onPlay?: (event: PlayEvent) => void;
        onPlaybackFinished?: (event: Event) => void;
        onPlaybackSpeedChanged?: (event: PlaybackSpeedChangedEvent) => void;
        onPlayerActive?: (event: Event) => void;
        onPlayerError?: (event: ErrorEvent) => void;
        onPlayerWarning?: (event: ErrorEvent) => void;
        onPlaying?: (event: PlayingEvent) => void;
        onReady?: (event: Event) => void;
        onSeek?: (event: SeekEvent) => void;
        onSeeked?: (event: Event) => void;
        onSourceError?: (event: ErrorEvent) => void;
        onSourceLoad?: (event: SourceLoadEvent) => void;
        onSourceLoaded?: (event: SourceLoadedEvent) => void;
        onSourceUnloaded?: (event: SourceUnloadedEvent) => void;
        onSourceWarning?: (event: ErrorEvent) => void;
        onStallEnded?: (event: Event) => void;
        onStallStarted?: (event: Event) => void;
        onSubtitleAdded?: (event: SubtitleAddedEvent) => void;
        onSubtitleChanged?: (event: SubtitleChangedEvent) => void;
        onSubtitleRemoved?: (event: SubtitleRemovedEvent) => void;
        onTimeChanged?: (event: TimeChangedEvent) => void;
        onTimeShift?: (event: TimeShiftEvent) => void;
        onTimeShifted?: (event: Event) => void;
        onUnmuted?: (event: Event) => void;
        onVideoDownloadQualityChanged?: (
            event: VideoDownloadQualityChangedEvent,
        ) => void;
        onVideoPlaybackQualityChanged?: (
            event: VideoPlaybackQualityChangedEvent,
        ) => void;
        player: Player;
        ref?: RefObject<null>;
        scalingMode?: ScalingMode;
        style?: ViewStyle;
        viewRef?: MutableRefObject<null>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    config? customMessageHandler? fullscreenHandler? isFullscreenRequested? isPictureInPictureRequested? onAdBreakFinished? onAdBreakStarted? onAdClicked? onAdError? onAdFinished? onAdManifestLoad? onAdManifestLoaded? onAdQuartile? onAdScheduled? onAdSkipped? onAdStarted? onAudioAdded? onAudioChanged? onAudioRemoved? onCastAvailable? onCastPaused? onCastPlaybackFinished? onCastPlaying? onCastStart? onCastStarted? onCastStopped? onCastTimeUpdated? onCastWaitingForDevice? onCueEnter? onCueExit? onDestroy? onDownloadFinished? onEvent? onFullscreenDisabled? onFullscreenEnabled? onFullscreenEnter? onFullscreenExit? onMuted? onPaused? onPictureInPictureAvailabilityChanged? onPictureInPictureEnter? onPictureInPictureEntered? onPictureInPictureExit? onPictureInPictureExited? onPlay? onPlaybackFinished? onPlaybackSpeedChanged? onPlayerActive? onPlayerError? onPlayerWarning? onPlaying? onReady? onSeek? onSeeked? onSourceError? onSourceLoad? onSourceLoaded? onSourceUnloaded? onSourceWarning? onStallEnded? onStallStarted? onSubtitleAdded? onSubtitleChanged? onSubtitleRemoved? onTimeChanged? onTimeShift? onTimeShifted? onUnmuted? onVideoDownloadQualityChanged? onVideoPlaybackQualityChanged? player ref? scalingMode? style? viewRef?

    Properties

    config?: PlayerViewConfig

    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.

    onAdBreakFinished?: (event: AdBreakFinishedEvent) => void

    Event emitted when an ad break has finished.

    onAdBreakStarted?: (event: AdBreakStartedEvent) => void

    Event emitted when an ad break has started.

    onAdClicked?: (event: AdClickedEvent) => void

    Event emitted when an ad has been clicked.

    onAdError?: (event: AdErrorEvent) => void

    Event emitted when an ad error has occurred.

    onAdFinished?: (event: AdFinishedEvent) => void

    Event emitted when an ad has finished.

    onAdManifestLoad?: (event: AdManifestLoadEvent) => void

    Event emitted when an ad manifest starts loading.

    onAdManifestLoaded?: (event: AdManifestLoadedEvent) => void

    Event emitted when an ad manifest has been loaded.

    onAdQuartile?: (event: AdQuartileEvent) => void

    Event emitted when an ad quartile has been reached.

    onAdScheduled?: (event: AdScheduledEvent) => void

    Event emitted when an ad has been scheduled.

    onAdSkipped?: (event: AdSkippedEvent) => void

    Event emitted when an ad has been skipped.

    onAdStarted?: (event: AdStartedEvent) => void

    Event emitted when an ad has started.

    onAudioAdded?: (event: AudioAddedEvent) => void

    Event emitted when a new audio track is added to the player.

    onAudioChanged?: (event: AudioChangedEvent) => void

    Event emitted when the player's selected audio track has changed.

    onAudioRemoved?: (event: AudioRemovedEvent) => void

    Event emitted when an audio track is removed from the player.

    onCastAvailable?: (event: Event) => void

    Event emitted when casting to a cast-compatible device is available.

    iOS, Android

    onCastPaused?: (event: Event) => void

    Event emitted when the playback on a cast-compatible device was paused.

    iOS, Android

    onCastPlaybackFinished?: (event: Event) => void

    Event emitted when the playback on a cast-compatible device has finished.

    iOS, Android

    onCastPlaying?: (event: Event) => void

    Event emitted when playback on a cast-compatible device has started.

    iOS, Android

    onCastStart?: (event: Event) => void

    Event emitted when casting is initiated, but the user still needs to choose which device should be used.

    iOS, Android

    onCastStarted?: (event: CastStartedEvent) => void

    Event emitted when the cast app is launched successfully.

    iOS, Android

    onCastStopped?: (event: Event) => void

    Event emitted when casting to a cast-compatible device is stopped.

    iOS, Android

    onCastTimeUpdated?: (event: Event) => void

    Event emitted when the time update from the currently used cast-compatible device is received.

    iOS, Android

    onCastWaitingForDevice?: (event: CastWaitingForDeviceEvent) => void

    Event emitted when a cast-compatible device has been chosen and the player is waiting for the device to get ready for playback.

    iOS, Android

    onCueEnter?: (event: CueEnterEvent) => void

    Event emitted when a subtitle entry transitions into the active status.

    onCueExit?: (event: CueExitEvent) => void

    Event emitted when an active subtitle entry transitions into the inactive status.

    onDestroy?: (event: Event) => void

    Event emitted when the player is destroyed.

    onDownloadFinished?: (event: DownloadFinishedEvent) => void

    Emitted when a download was finished.

    onEvent?: (event: Event) => void

    All events emitted by the player.

    onFullscreenDisabled?: (event: Event) => void

    Event emitted when fullscreen mode has been disabled.

    iOS, Android

    onFullscreenEnabled?: (event: Event) => void

    Event emitted when fullscreen mode has been enabled.

    iOS, Android

    onFullscreenEnter?: (event: Event) => void

    Event emitted when fullscreen mode has been entered.

    iOS, Android

    onFullscreenExit?: (event: Event) => void

    Event emitted when fullscreen mode has been exited.

    iOS, Android

    onMuted?: (event: Event) => void

    Event emitted when the player has been muted.

    onPaused?: (event: PausedEvent) => void

    Event emitted when the player has been paused.

    onPictureInPictureAvailabilityChanged?: (
        event: PictureInPictureAvailabilityChangedEvent,
    ) => void

    Event mitted when the availability of the Picture in Picture mode changed.

    onPictureInPictureEnter?: (event: Event) => void

    Event emitted when the player enters Picture in Picture mode.

    onPictureInPictureEntered?: (event: Event) => void

    Event emitted when the player entered Picture in Picture mode.

    iOS

    onPictureInPictureExit?: (event: Event) => void

    Event emitted when the player exits Picture in Picture mode.

    onPictureInPictureExited?: (event: Event) => void

    Event emitted when the player exited Picture in Picture mode.

    iOS

    onPlay?: (event: PlayEvent) => void

    Event emitted when the player received an intention to start/resume playback.

    onPlaybackFinished?: (event: Event) => void

    Event emitted when the playback of the current media has finished.

    onPlaybackSpeedChanged?: (event: PlaybackSpeedChangedEvent) => void

    Emitted when the player transitions from one playback speed to another.

    iOS, tvOS

    onPlayerActive?: (event: Event) => void

    Event emitted when a source is loaded into the player. Seeking and time shifting are allowed as soon as this event is seen.

    onPlayerError?: (event: ErrorEvent) => void

    Event Emitted when a player error occurred.

    onPlayerWarning?: (event: ErrorEvent) => void

    Event emitted when a player warning occurred.

    onPlaying?: (event: PlayingEvent) => void

    Emitted when playback has started.

    onReady?: (event: Event) => void

    Emitted when the player is ready for immediate playback, because initial audio/video has been downloaded.

    onSeek?: (event: SeekEvent) => void

    Event emitted when the player is about to seek to a new position. Only applies to VoD streams.

    onSeeked?: (event: Event) => void

    Event emitted when seeking has finished and data to continue playback is available. Only applies to VoD streams.

    onSourceError?: (event: ErrorEvent) => void

    Event emitted when a source error occurred.

    onSourceLoad?: (event: SourceLoadEvent) => void

    Event emitted when a new source loading has started.

    onSourceLoaded?: (event: SourceLoadedEvent) => void

    Event emitted when a new source is loaded. This does not mean that the source is immediately ready for playback. ReadyEvent indicates the player is ready for immediate playback.

    onSourceUnloaded?: (event: SourceUnloadedEvent) => void

    Event emitted when the current source has been unloaded.

    onSourceWarning?: (event: ErrorEvent) => void

    Event emitted when a source warning occurred.

    onStallEnded?: (event: Event) => void

    Event emitted when the player ends stalling, due to enough data in the buffer.

    onStallStarted?: (event: Event) => void

    Event emitted when the player begins to stall and to buffer due to an empty buffer.

    onSubtitleAdded?: (event: SubtitleAddedEvent) => void

    Event emitted when a new subtitle track is added to the player.

    onSubtitleChanged?: (event: SubtitleChangedEvent) => void

    Event emitted when the player's selected subtitle track has changed.

    onSubtitleRemoved?: (event: SubtitleRemovedEvent) => void

    Event emitted when a subtitle track is removed from the player.

    onTimeChanged?: (event: TimeChangedEvent) => void

    Event emitted when the current playback time has changed.

    onTimeShift?: (event: TimeShiftEvent) => void

    Event mitted when the player starts time shifting. Only applies to live streams.

    onTimeShifted?: (event: Event) => void

    Event emitted when time shifting has finished and data is available to continue playback. Only applies to live streams.

    onUnmuted?: (event: Event) => void

    Emitted when the player is unmuted.

    onVideoDownloadQualityChanged?: (
        event: VideoDownloadQualityChangedEvent,
    ) => void

    Emitted when current video download quality has changed.

    onVideoPlaybackQualityChanged?: (
        event: VideoPlaybackQualityChangedEvent,
    ) => void

    Emitted when the current video playback quality has changed.

    player: Player

    Player instance (generally returned from usePlayer hook) that will control and render audio/video inside the PlayerView.

    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.

    viewRef?: MutableRefObject<null>

    Settings

    Member Visibility

    On This Page

    Properties
    configcustomMessageHandlerfullscreenHandlerisFullscreenRequestedisPictureInPictureRequestedonAdBreakFinishedonAdBreakStartedonAdClickedonAdErroronAdFinishedonAdManifestLoadonAdManifestLoadedonAdQuartileonAdScheduledonAdSkippedonAdStartedonAudioAddedonAudioChangedonAudioRemovedonCastAvailableonCastPausedonCastPlaybackFinishedonCastPlayingonCastStartonCastStartedonCastStoppedonCastTimeUpdatedonCastWaitingForDeviceonCueEnteronCueExitonDestroyonDownloadFinishedonEventonFullscreenDisabledonFullscreenEnabledonFullscreenEnteronFullscreenExitonMutedonPausedonPictureInPictureAvailabilityChangedonPictureInPictureEnteronPictureInPictureEnteredonPictureInPictureExitonPictureInPictureExitedonPlayonPlaybackFinishedonPlaybackSpeedChangedonPlayerActiveonPlayerErroronPlayerWarningonPlayingonReadyonSeekonSeekedonSourceErroronSourceLoadonSourceLoadedonSourceUnloadedonSourceWarningonStallEndedonStallStartedonSubtitleAddedonSubtitleChangedonSubtitleRemovedonTimeChangedonTimeShiftonTimeShiftedonUnmutedonVideoDownloadQualityChangedonVideoPlaybackQualityChangedplayerrefscalingModestyleviewRef