VideoPlayerController class

Controls a platform video player, and provides updates when the state is changing.

Instances must be initialized with initialize.

The video is displayed in a Flutter app by creating a VideoPlayer widget.

To reclaim the resources used by the player call dispose.

After dispose all further calls are ignored.

Inheritance

Constructors

VideoPlayerController.asset(String dataSource, {String? package})
Constructs a VideoPlayerController playing a video from an asset.
VideoPlayerController.file(String dataSource)
Constructs a VideoPlayerController playing a video from a file.
VideoPlayerController.network(String dataSource, {VideoFormat? formatHint})
Constructs a VideoPlayerController playing a video from obtained from the network.

Properties

dataSource → String
The URI to the video file. This will be in different formats depending on the DataSourceType of the original video.
final
dataSourceType → DataSourceType
Describes the type of data source this VideoPlayerController is constructed with.
final
formatHint → VideoFormat?
Android only. Will override the platform's generic file format detection with whatever is set here.
final
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
onCanPlay ↔ VoidCallback?
VideoController Callbacks
getter/setter pair
onCanPlayThrough ↔ VoidCallback?
getter/setter pair
onEnded ↔ VoidCallback?
getter/setter pair
onError ↔ void Function(int, String?)?
getter/setter pair
onPause ↔ VoidCallback?
getter/setter pair
onPlay ↔ VoidCallback?
getter/setter pair
onSeeked ↔ VoidCallback?
getter/setter pair
onSeeking ↔ void Function()?
getter/setter pair
onVolumeChange ↔ VoidCallback?
getter/setter pair
package → String?
Only set for asset videos. The package that the asset was loaded from.
final
position → Future<Duration?>
The position in the current video.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
textureId → int?
This is just exposed for testing. It shouldn't be used by anyone depending on the plugin.
no setter
value ↔ VideoPlayerValue
The current value stored in this notifier.
getter/setter pairinherited

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
dispose() → Future<void>
Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
override
initialize() → Future<int>
Attempts to open the given dataSource and load metadata about the video.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
pause() → Future<void>
Pauses the video.
play() → Future<void>
Starts playing the video.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
seekTo(Duration? position) → Future<void>
Sets the video's current timestamp to be at moment. The next time the video is played it will resume from the given moment.
setLooping(bool looping) → Future<void>
Sets whether or not the video should loop after playing once. See also VideoPlayerValue.isLooping.
setMuted(bool muted) → Future<void>
Sets whether or not video should be muted.
setVolume(double volume) → Future<void>
Sets the audio volume of this.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited