VideoPlayerValue class
The duration, current position, buffering state, error state and settings of a VideoPlayerController.
- Annotations
Constructors
-
VideoPlayerValue({required Duration duration, Size size = Size.zero, Duration position = Duration.zero, Caption caption = Caption.none, Duration captionOffset = Duration.zero, List<
DurationRange> buffered = const <DurationRange>[], bool isInitialized = false, bool isPlaying = false, bool isLooping = false, bool isBuffering = false, double volume = 1.0, double playbackSpeed = 1.0, int rotationCorrection = 0, String? errorDescription, bool isCompleted = false}) -
Constructs a video with the given values. Only
durationis required. The rest will initialize with default values when unset.const - VideoPlayerValue.erroneous(String errorDescription)
-
Returns an instance with the given
errorDescription.const - VideoPlayerValue.uninitialized()
-
Returns an instance for a video that hasn't been loaded.
const
Properties
- aspectRatio → double
-
Returns
size.width/size.height.no setter -
buffered
→ List<
DurationRange> -
The currently buffered ranges.
final
- caption → Caption
-
The Caption that should be displayed based on the current position.
final
- captionOffset → Duration
-
The Duration that should be used to offset the current position to get the correct Caption.
final
- duration → Duration
-
The total duration of the video.
final
- errorDescription → String?
-
A description of the error if present.
final
- hasError → bool
-
Indicates whether or not the video is in an error state. If this is true
errorDescription should have information about the problem.
no setter
- hashCode → int
-
The hash code for this object.
no setteroverride
- isBuffering → bool
-
True if the video is currently buffering.
final
- isCompleted → bool
-
True if video has finished playing to end.
final
- isInitialized → bool
-
Indicates whether or not the video has been loaded and is ready to play.
final
- isLooping → bool
-
True if the video is looping.
final
- isPlaying → bool
-
True if the video is playing. False if it's paused.
final
- playbackSpeed → double
-
The current speed of the playback.
final
- position → Duration
-
The current playback position.
final
- rotationCorrection → int
-
Degrees to rotate the video (clockwise) so it is displayed correctly.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- size → Size
-
The size of the currently loaded video.
final
- volume → double
-
The current volume of the playback.
final
Methods
-
copyWith(
{Duration? duration, Size? size, Duration? position, Caption? caption, Duration? captionOffset, List< DurationRange> ? buffered, bool? isInitialized, bool? isPlaying, bool? isLooping, bool? isBuffering, double? volume, double? playbackSpeed, int? rotationCorrection, String? errorDescription = _defaultErrorDescription, bool? isCompleted}) → VideoPlayerValue - Returns a new instance that has the same values as this current instance, except for any overrides passed in as arguments to copyWith.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
override