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)

BasePlayerViewProps
PlayerViewEvents
- PlayerViewProps

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

`Optional`config

config?: PlayerViewConfig

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

`Optional`customMessageHandler

customMessageHandler?: CustomMessageHandler

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

`Optional`fullscreenHandler

fullscreenHandler?: FullscreenHandler

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

`Optional`isFullscreenRequested

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.

`Optional`isPictureInPictureRequested

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.

`Optional`onAdBreakFinished

onAdBreakFinished?: (event: AdBreakFinishedEvent) => void

Event emitted when an ad break has finished.

`Optional`onAdBreakStarted

onAdBreakStarted?: (event: AdBreakStartedEvent) => void

Event emitted when an ad break has started.

`Optional`onAdClicked

onAdClicked?: (event: AdClickedEvent) => void

Event emitted when an ad has been clicked.

`Optional`onAdError

onAdError?: (event: AdErrorEvent) => void

Event emitted when an ad error has occurred.

`Optional`onAdFinished

onAdFinished?: (event: AdFinishedEvent) => void

Event emitted when an ad has finished.

`Optional`onAdManifestLoad

onAdManifestLoad?: (event: AdManifestLoadEvent) => void

Event emitted when an ad manifest starts loading.

`Optional`onAdManifestLoaded

onAdManifestLoaded?: (event: AdManifestLoadedEvent) => void

Event emitted when an ad manifest has been loaded.

`Optional`onAdQuartile

onAdQuartile?: (event: AdQuartileEvent) => void

Event emitted when an ad quartile has been reached.

`Optional`onAdScheduled

onAdScheduled?: (event: AdScheduledEvent) => void

Event emitted when an ad has been scheduled.

`Optional`onAdSkipped

onAdSkipped?: (event: AdSkippedEvent) => void

Event emitted when an ad has been skipped.

`Optional`onAdStarted

onAdStarted?: (event: AdStartedEvent) => void

Event emitted when an ad has started.

`Optional`onAudioAdded

onAudioAdded?: (event: AudioAddedEvent) => void

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

`Optional`onAudioChanged

onAudioChanged?: (event: AudioChangedEvent) => void

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

`Optional`onAudioRemoved

onAudioRemoved?: (event: AudioRemovedEvent) => void

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

`Optional`onCastAvailable

onCastAvailable?: (event: Event) => void

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

Remarks

Platform: iOS, Android

`Optional`onCastPaused

onCastPaused?: (event: Event) => void

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

Remarks

Platform: iOS, Android

`Optional`onCastPlaybackFinished

onCastPlaybackFinished?: (event: Event) => void

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

Remarks

Platform: iOS, Android

`Optional`onCastPlaying

onCastPlaying?: (event: Event) => void

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

Remarks

Platform: iOS, Android

`Optional`onCastStart

onCastStart?: (event: Event) => void

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

Remarks

Platform: iOS, Android

`Optional`onCastStarted

onCastStarted?: (event: CastStartedEvent) => void

Event emitted when the cast app is launched successfully.

Remarks

Platform: iOS, Android

`Optional`onCastStopped

onCastStopped?: (event: Event) => void

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

Remarks

Platform: iOS, Android

`Optional`onCastTimeUpdated

onCastTimeUpdated?: (event: Event) => void

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

Remarks

Platform: iOS, Android

`Optional`onCastWaitingForDevice

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.

Remarks

Platform: iOS, Android

`Optional`onCueEnter

onCueEnter?: (event: CueEnterEvent) => void

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

`Optional`onCueExit

onCueExit?: (event: CueExitEvent) => void

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

`Optional`onDestroy

onDestroy?: (event: Event) => void

Event emitted when the player is destroyed.

`Optional`onDownloadFinished

onDownloadFinished?: (event: DownloadFinishedEvent) => void

Emitted when a download was finished.

`Optional`onEvent

onEvent?: (event: Event) => void

All events emitted by the player.

`Optional`onFullscreenDisabled

onFullscreenDisabled?: (event: Event) => void

Event emitted when fullscreen mode has been disabled.

Remarks

Platform: iOS, Android

`Optional`onFullscreenEnabled

onFullscreenEnabled?: (event: Event) => void

Event emitted when fullscreen mode has been enabled.

Remarks

Platform: iOS, Android

`Optional`onFullscreenEnter

onFullscreenEnter?: (event: Event) => void

Event emitted when fullscreen mode has been entered.

Remarks

Platform: iOS, Android

`Optional`onFullscreenExit

onFullscreenExit?: (event: Event) => void

Event emitted when fullscreen mode has been exited.

Remarks

Platform: iOS, Android

`Optional`onMuted

onMuted?: (event: Event) => void

Event emitted when the player has been muted.

`Optional`onPaused

onPaused?: (event: PausedEvent) => void

Event emitted when the player has been paused.

`Optional`onPictureInPictureAvailabilityChanged

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

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

`Optional`onPictureInPictureEnter

onPictureInPictureEnter?: (event: Event) => void

Event emitted when the player enters Picture in Picture mode.

`Optional`onPictureInPictureEntered

onPictureInPictureEntered?: (event: Event) => void

Event emitted when the player entered Picture in Picture mode.

Remarks

Platform: iOS

`Optional`onPictureInPictureExit

onPictureInPictureExit?: (event: Event) => void

Event emitted when the player exits Picture in Picture mode.

`Optional`onPictureInPictureExited

onPictureInPictureExited?: (event: Event) => void

Event emitted when the player exited Picture in Picture mode.

Remarks

Platform: iOS

`Optional`onPlay

onPlay?: (event: PlayEvent) => void

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

`Optional`onPlaybackFinished

onPlaybackFinished?: (event: Event) => void

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

`Optional`onPlaybackSpeedChanged

onPlaybackSpeedChanged?: (event: PlaybackSpeedChangedEvent) => void

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

Remarks

Platform: iOS, tvOS

`Optional`onPlayerActive

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.

`Optional`onPlayerError

onPlayerError?: (event: ErrorEvent) => void

Event Emitted when a player error occurred.

`Optional`onPlayerWarning

onPlayerWarning?: (event: ErrorEvent) => void

Event emitted when a player warning occurred.

`Optional`onPlaying

onPlaying?: (event: PlayingEvent) => void

Emitted when playback has started.

`Optional`onReady

onReady?: (event: Event) => void

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

`Optional`onSeek

onSeek?: (event: SeekEvent) => void

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

`Optional`onSeeked

onSeeked?: (event: Event) => void

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

`Optional`onSourceError

onSourceError?: (event: ErrorEvent) => void

Event emitted when a source error occurred.

`Optional`onSourceLoad

onSourceLoad?: (event: SourceLoadEvent) => void

Event emitted when a new source loading has started.

`Optional`onSourceLoaded

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.

`Optional`onSourceUnloaded

onSourceUnloaded?: (event: SourceUnloadedEvent) => void

Event emitted when the current source has been unloaded.

`Optional`onSourceWarning

onSourceWarning?: (event: ErrorEvent) => void

Event emitted when a source warning occurred.

`Optional`onStallEnded

onStallEnded?: (event: Event) => void

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

`Optional`onStallStarted

onStallStarted?: (event: Event) => void

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

`Optional`onSubtitleAdded

onSubtitleAdded?: (event: SubtitleAddedEvent) => void

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

`Optional`onSubtitleChanged

onSubtitleChanged?: (event: SubtitleChangedEvent) => void

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

`Optional`onSubtitleRemoved

onSubtitleRemoved?: (event: SubtitleRemovedEvent) => void

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

`Optional`onTimeChanged

onTimeChanged?: (event: TimeChangedEvent) => void

Event emitted when the current playback time has changed.

`Optional`onTimeShift

onTimeShift?: (event: TimeShiftEvent) => void

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

`Optional`onTimeShifted

onTimeShifted?: (event: Event) => void

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

`Optional`onUnmuted

onUnmuted?: (event: Event) => void

Emitted when the player is unmuted.

`Optional`onVideoDownloadQualityChanged

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

Emitted when current video download quality has changed.

`Optional`onVideoPlaybackQualityChanged

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

Emitted when the current video playback quality has changed.

player

player: Player

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

`Optional`ref

ref?: RefObject<null>

`Optional`scalingMode

scalingMode?: ScalingMode

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

`Optional`style

style?: ViewStyle

Style of the PlayerView.

`Optional`viewRef

viewRef?: MutableRefObject<null>

Interface PlayerViewProps

Hierarchy (View Summary)

Index

Properties

Properties

Optionalconfig

OptionalcustomMessageHandler

OptionalfullscreenHandler

OptionalisFullscreenRequested

OptionalisPictureInPictureRequested

OptionalonAdBreakFinished

OptionalonAdBreakStarted

OptionalonAdClicked

OptionalonAdError

OptionalonAdFinished

OptionalonAdManifestLoad

OptionalonAdManifestLoaded

OptionalonAdQuartile

OptionalonAdScheduled

OptionalonAdSkipped

OptionalonAdStarted

OptionalonAudioAdded

OptionalonAudioChanged

OptionalonAudioRemoved

OptionalonCastAvailable

Remarks

OptionalonCastPaused

Remarks

OptionalonCastPlaybackFinished

Remarks

OptionalonCastPlaying

Remarks

OptionalonCastStart

Remarks

OptionalonCastStarted

Remarks

OptionalonCastStopped

Remarks

OptionalonCastTimeUpdated

Remarks

OptionalonCastWaitingForDevice

Remarks

OptionalonCueEnter

OptionalonCueExit

OptionalonDestroy

OptionalonDownloadFinished

OptionalonEvent

OptionalonFullscreenDisabled

Remarks

OptionalonFullscreenEnabled

Remarks

OptionalonFullscreenEnter

Remarks

OptionalonFullscreenExit

Remarks

OptionalonMuted

OptionalonPaused

OptionalonPictureInPictureAvailabilityChanged

OptionalonPictureInPictureEnter

OptionalonPictureInPictureEntered

Remarks

OptionalonPictureInPictureExit

OptionalonPictureInPictureExited

Remarks

OptionalonPlay

OptionalonPlaybackFinished

OptionalonPlaybackSpeedChanged

Remarks

OptionalonPlayerActive

OptionalonPlayerError

OptionalonPlayerWarning

OptionalonPlaying

OptionalonReady

OptionalonSeek

OptionalonSeeked

OptionalonSourceError

OptionalonSourceLoad

OptionalonSourceLoaded

OptionalonSourceUnloaded

OptionalonSourceWarning

`Optional`config

`Optional`customMessageHandler

`Optional`fullscreenHandler

`Optional`isFullscreenRequested

`Optional`isPictureInPictureRequested

`Optional`onAdBreakFinished

`Optional`onAdBreakStarted

`Optional`onAdClicked

`Optional`onAdError

`Optional`onAdFinished

`Optional`onAdManifestLoad

`Optional`onAdManifestLoaded

`Optional`onAdQuartile

`Optional`onAdScheduled

`Optional`onAdSkipped

`Optional`onAdStarted

`Optional`onAudioAdded

`Optional`onAudioChanged

`Optional`onAudioRemoved

`Optional`onCastAvailable

`Optional`onCastPaused

`Optional`onCastPlaybackFinished

`Optional`onCastPlaying

`Optional`onCastStart

`Optional`onCastStarted

`Optional`onCastStopped

`Optional`onCastTimeUpdated

`Optional`onCastWaitingForDevice

`Optional`onCueEnter

`Optional`onCueExit

`Optional`onDestroy

`Optional`onDownloadFinished

`Optional`onEvent

`Optional`onFullscreenDisabled

`Optional`onFullscreenEnabled

`Optional`onFullscreenEnter

`Optional`onFullscreenExit

`Optional`onMuted

`Optional`onPaused

`Optional`onPictureInPictureAvailabilityChanged

`Optional`onPictureInPictureEnter

`Optional`onPictureInPictureEntered

`Optional`onPictureInPictureExit

`Optional`onPictureInPictureExited

`Optional`onPlay

`Optional`onPlaybackFinished

`Optional`onPlaybackSpeedChanged

`Optional`onPlayerActive

`Optional`onPlayerError

`Optional`onPlayerWarning

`Optional`onPlaying

`Optional`onReady

`Optional`onSeek

`Optional`onSeeked

`Optional`onSourceError

`Optional`onSourceLoad

`Optional`onSourceLoaded

`Optional`onSourceUnloaded

`Optional`onSourceWarning

`Optional`onStallEnded

`Optional`onStallStarted

`Optional`onSubtitleAdded

`Optional`onSubtitleChanged

`Optional`onSubtitleRemoved

`Optional`onTimeChanged

`Optional`onTimeShift

`Optional`onTimeShifted

`Optional`onUnmuted

`Optional`onVideoDownloadQualityChanged

`Optional`onVideoPlaybackQualityChanged

`Optional`ref

`Optional`scalingMode

`Optional`style

`Optional`viewRef