VideoPlayerConfiguration class
Configuration options for customizing the appearance and behavior of a video player.
VideoPlayerConfiguration provides a flexible way to define playback logic, theming,
interaction modes, and UI components of the OmniVideoPlayer.
This class is immutable and can be safely reused or cloned via copyWith.
- Annotations
Constructors
- VideoPlayerConfiguration.new({required VideoSourceConfiguration videoSourceConfiguration, PlayerUIVisibilityOptions playerUIVisibilityOptions = const PlayerUIVisibilityOptions(), OmniVideoPlayerThemeData playerTheme = const OmniVideoPlayerThemeData(), CustomPlayerWidgets customPlayerWidgets = const CustomPlayerWidgets(), String liveLabel = "LIVE", bool? enableBackgroundOverlayClip = true, dynamic globalKeyInitializer})
- Creates a new set of configuration options for a video player instance.
Properties
- customPlayerWidgets → CustomPlayerWidgets
-
Provides custom widget overrides like loading indicators, error placeholders, etc.
final
- enableBackgroundOverlayClip → bool?
-
Flag to enable or disable clipping of the background overlay using a rounded rectangle.
final
-
globalKeyInitializer
↔ GlobalKey<
VideoPlayerInitializerState> -
A global key for the video player initializer state.
latefinal
-
globalKeyPlayer
↔ GlobalKey<
State< StatefulWidget> > -
A unique global key for the player widget, don't use it!
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
- liveLabel → String
-
Label displayed for live streams.
final
- playerTheme → OmniVideoPlayerThemeData
-
Custom theming options for the video player controls and appearance.
final
- playerUIVisibilityOptions → PlayerUIVisibilityOptions
-
Flags that toggle visibility of player UI elements like seek bar, buttons, etc.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- videoSourceConfiguration → VideoSourceConfiguration
-
Defines how the video is loaded and played (URL, autoplay, volume, etc).
final
Methods
-
copyWith(
{VideoSourceConfiguration? videoSourceConfiguration, PlayerUIVisibilityOptions? playerUIVisibilityOptions, OmniVideoPlayerThemeData? playerTheme, CustomPlayerWidgets? customPlayerWidgets, String? liveLabel, bool? enableBackgroundOverlayClip}) → VideoPlayerConfiguration - Returns a new VideoPlayerConfiguration instance with specified fields overridden.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited