bitmovin_player library
Classes
- AirPlayAvailableEvent
- Emitted when AirPlay is available.
- AirPlayChangedEvent
- Emitted when AirPlay playback starts or stops.
- AnalyticsApi
- Provides an API to interact with the Analytics collector of a Player.
- AnalyticsConfig
- Configures the behavior of the player analytics module.
- BitmovinCastManager
- Singleton, providing access to GoogleCast related features. Retrieve the singleton instance using initialize.
- BitmovinCastManagerApi
- Provides access to GoogleCast related features of Players.
- BitmovinCastManagerOptions
- The options to be used for initializing BitmovinCastManager
- CastAvailableEvent
- Emitted when casting to a cast-compatible device is available.
- CastPayload
-
Contains information for the
CastWaitingForDeviceEvent. - CastStartedEvent
- Emitted when the cast app is launched successfully.
- CastStartEvent
- Emitted when casting is initiated, but the user still needs to choose which device should be used.
- CastStoppedEvent
- Emitted when casting to a cast-compatible device is stopped.
- CastTimeUpdatedEvent
- Emitted when the time update from the currently used cast-compatible device is received.
- CastWaitingForDeviceEvent
- Emitted when a cast-compatible device has been chosen and the player is waiting for the device to get ready for playback.
- CueEnterEvent
- Emitted when a subtitle cue transitions into the active status.
- CueExitEvent
- Emitted when a subtitle cue transitions into the inactive status.
- CustomData
- Free-form data that can be used to enrich the analytics data.
- DefaultMetadata
- DefaultMetadata that can be used to enrich the analytics data. DefaultMetadata is not bound to a specific source and can be used to set fields for the lifecycle of the collector. If fields are specified in SourceMetadata and DefaultMetadata, SourceMetadata takes precedence.
- DrmConfig
- Provides DRM configuration for the player. On iOS, FairPlay is supported. On Android, Widevine is supported. See FairplayConfig and WidevineConfig for more information.
- ErrorEvent
- The common supertype implemented by all different error events that are emitted by the Player or Source.
- Event
- The common supertype implemented by all different player and source events.
- FairplayConfig
- Provides configuration options for FairPlay Streaming DRM. Only supported on iOS.
- FullscreenEnterEvent
- Emitted when the PlayerView goes into fullscreen mode.
- FullscreenExitEvent
- Emitted when the PlayerView leaves fullscreen mode.
- FullscreenHandler
- Handles the UI state change when fullscreen should be entered or exited.
- InfoEvent
- The common supertype implemented by all different info events that are emitted by the Player or Source.
- LicensingConfig
- Configures the behavior of the player license evaluation.
- LiveConfig
- Configures the behavior when playing live content.
- MediaTrackRole
- Describes the DASH Role of a SubtitleTrack as specified in ISO/IEC 23009-1:2019, section 5.8.4.2.
- MutedEvent
- Emitted when the player is muted.
- PausedEvent
- Emitted when the player is paused.
- PictureInPictureApi
- Provides an API to interact with the Picture-in-Picture mode of a PlayerView.
- PictureInPictureConfig
- Provides options to configure Picture-in-Picture playback.
- PictureInPictureEnteredEvent
- Is called when the PlayerView finished entering Picture-In-Picture mode.
- PictureInPictureEnterEvent
- Is called when the PlayerView is about to enter Picture-in-Picture mode.
- PictureInPictureExitedEvent
- Is called when the PlayerView finished exiting Picture-In-Picture mode.
- PictureInPictureExitEvent
- Is called when the PlayerView is about to exit Picture-In-Picture mode.
- PlaybackConfig
- Configures the playback behavior of the player.
- PlaybackFinishedEvent
- Emitted when playback of the Source has finished.
- Player
- Loads, controls and renders audio and video content represented through Sources.
- PlayerConfig
- Configures a new Player instance. Must not be modified after it was used to create a Player instance.
- PlayerListener
- Defines events that can be emitted by the player.
- PlayerView
- A view that provides the Bitmovin Player Web UI and default UI handling to an attached Player instance.
- PlayerViewConfig
- Configures a new PlayerView instance.
- PlayerViewState
- Provides the state for a PlayerView.
- PlayEvent
- Emitted when the player receives an intention to play (i.e Player.play).
- PlayingEvent
- Emitted when the player enters the playing state after calling Player.play.
- ReadyEvent
- Emitted when the player is ready to play and to handle API calls.
- RemoteControlConfig
- Configures remote playback behavior.
- SeekedEvent
- Emitted when seeking has finished and data is available to continue playback. Only applies to VoD streams.
- SeekEvent
- Emitted when the player starts seeking. Only applies to VoD streams.
- SeekPosition
- Represents a seeking position within a Source.
- Source
- Represents audio and video content that can be loaded into a Player to start a playback session.
- SourceAddedEvent
- Emitted when a Source was added to the player.
- SourceConfig
- Configures a Source that can be loaded into a Player.
- SourceErrorEvent
- Emitted when a source error occurred.
- SourceInfoEvent
- Emitted for neutral information provided by the source. The information provided with this event is only for analytical purposes and are subject to change. Thus, neither the timing nor the content should be used to trigger workflows, but may be used for logging.
- SourceLoadedEvent
- Emitted when a Source was loaded. This does not mean that the source is immediately ready for playback.
- SourceLoadEvent
- Emitted when a Source starts loading.
- SourceMetadata
- SourceMetadata that can be used to enrich the analytics data.
- SourceOptions
- Options to allow configuration of the source.
- SourceRemoteControlConfig
- The remote control config for a Source. Only available on iOS.
- SourceRemovedEvent
- Emitted when a Source was removed from the player.
- SourceUnloadedEvent
- Emitted when a Source was unloaded.
- SourceWarningEvent
- Emitted when a source warning occurred.
- StyleConfig
- Configures visual presentation and behaviour of the Player UI.
- SubtitleAddedEvent
- Emitted when a new SubtitleTrack is added.
- SubtitleChangedEvent
- Emitted when the selected SubtitleTrack is changed.
- SubtitleFormats
- The subtitle file formats that can be used to create a side-loaded SubtitleTrack. Please note that not all formats are supported on all platforms. Check the documentation for each constant for more information.
- SubtitleRemovedEvent
- Emitted when a SubtitleTrack is removed.
- SubtitleTrack
- Represents a subtitle track.
- TimeChangedEvent
- Emitted when the current playback time has changed.
- TimeShiftedEvent
- Called when time shifting has been finished and data is available to continue playback. Only applies to live streams.
- TimeShiftEvent
- Called when the player is about to time-shift to a new position. Only applies to live streams.
- UnmutedEvent
- Emitted when the player is unmuted.
- WarningEvent
- The common supertype implemented by all different warning events that are emitted by the Player or Source.
- WidevineConfig
- Provides configuration options for Widevine DRM. Only supported on Android.
Enums
- MediaFilter
- Defines how strictly potentially unsupported media tracks and qualities are filtered out of a playback session.
- RetryPolicy
- Specifies the retry behavior in case an analytics request cannot be sent.
- ScalingMode
- Specifies how the video content is scaled or stretched.
- SeekMode
- Represents the mode the player uses to seek. This is only available on Android.
- SourceType
- Available stream types for a Source.
- TimelineReferencePoint
- Reference points on a timeline to allow definition of relative offsets.