Video Player

https://pub.dev/documentation/video_player/latest/
Admin
A Flutter plugin for iOS, Android, and Web that enables video playback on a widget surface with...
Tokens:15,766
Snippets:262
Trust Score:9.9
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### double startFraction(Duration duration)

Source: https://pub.dev/documentation/video_player/latest/video_player/DurationRange-class.html

Method to calculate the fraction of the start of the range relative to the total video duration.

```APIDOC
## double startFraction(Duration duration)

### Description
Assumes that `duration` is the total length of the video that this DurationRange is a segment form. It returns the percentage that start is through the entire video.

### Parameters
- **duration** (Duration) - Required - The total length of the video.

### Return Value
double - The percentage that start is through the entire video.
```

--------------------------------

### DurationRange(Duration start, Duration end)

Source: https://pub.dev/documentation/video_player/latest/video_player/DurationRange-class.html

Constructor for the DurationRange class.

```APIDOC
## DurationRange(Duration start, Duration end)

### Description
Constructs a DurationRange with the given start and end durations. Trusts that the given `start` and `end` are actually in order. They should both be non-null.

### Parameters
- **start** (Duration) - Required - The beginning of the segment described relative to the beginning of the entire video.
- **end** (Duration) - Required - The end of the segment described as a duration relative to the beginning of the entire video.

### Return Value
A new DurationRange instance.
```

--------------------------------

### captions

Source: https://pub.dev/documentation/video_player/latest/video_player/ClosedCaptionFile-class.html

Gets the full list of captions from a given file. This property is read-only and has no setter.

```APIDOC
## captions

### Description
Gets the full list of captions from a given file. This property is read-only and has no setter.

### Property
List<Caption> captions

### Type
List<Caption>

### Access
Read-only (no setter)

### Returns
The full list of captions from the file.

```

--------------------------------

### ClosedCaption usage with VideoPlayer

Source: https://pub.dev/documentation/video_player/latest/video_player/ClosedCaption-class.html

Example of using ClosedCaption in a Stack with a VideoPlayer. The text is taken from the controller's caption value. Requires VideoPlayerController.closedCaptionFile to be set for captions to appear.

```dart
Stack(children: <Widget>[
  VideoPlayer(_controller),
  ClosedCaption(text: _controller.value.caption.text),
]),
```

--------------------------------

### VideoPlayerController.file

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerController-class.html

Constructor for creating a VideoPlayerController from a file.

```APIDOC
## VideoPlayerController.file

### Description
Constructs a VideoPlayerController playing a video from a file.

### Constructor
`VideoPlayerController.file(File file, {Future<ClosedCaptionFile>? closedCaptionFile, VideoPlayerOptions? videoPlayerOptions, Map<String, String> httpHeaders = const <String, String>{}, VideoViewType viewType = platform_interface.VideoViewType.textureView})`

### Parameters
- **file** (File) - Required - The file object of the video.
- **closedCaptionFile** (Future<ClosedCaptionFile>?) - Optional - A future that resolves to a closed caption file.
- **videoPlayerOptions** (VideoPlayerOptions?) - Optional - Options for the video player.
- **httpHeaders** (Map<String, String>) - Optional - HTTP headers to use when loading the video, defaults to an empty map.
- **viewType** (VideoViewType) - Optional - The type of view to use, defaults to `platform_interface.VideoViewType.textureView`.

### Usage Example
```dart
final file = File('/path/to/video.mp4');
final controller = VideoPlayerController.file(file);
```
```

--------------------------------

### VideoPlayerWebOptions

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerWebOptions-class.html

Documentation for the VideoPlayerWebOptions class, including its constructor and properties.

```APIDOC
## VideoPlayerWebOptions

### Description
VideoPlayerWebOptions can be optionally used to set additional web settings.

### Constructor
`VideoPlayerWebOptions({VideoPlayerWebOptionsControls controls = const VideoPlayerWebOptionsControls.disabled(), bool allowContextMenu = true, bool allowRemotePlayback = true, Uri? poster})`

### Parameters
- **controls** (VideoPlayerWebOptionsControls) - Optional - Additional settings for how control options are displayed. Defaults to `const VideoPlayerWebOptionsControls.disabled()`.
- **allowContextMenu** (bool) - Optional - Whether context menu (right click) is allowed. Defaults to `true`.
- **allowRemotePlayback** (bool) - Optional - Whether remote playback is allowed. Defaults to `true`.
- **poster** (Uri?) - Optional - The URL of the poster image to be displayed before the video starts.

### Properties
- **controls** (VideoPlayerWebOptionsControls) - Additional settings for how control options are displayed.
- **allowContextMenu** (bool) - Whether context menu (right click) is allowed.
- **allowRemotePlayback** (bool) - Whether remote playback is allowed.
- **poster** (Uri?) - The URL of the poster image to be displayed before the video starts.

### Annotations
- `@immutable`
```

--------------------------------

### VideoPlayerWebOptionsControls.enabled({bool allowDownload = true, bool allowFullscreen = true, bool allowPlaybackRate = true, bool allowPictureInPicture = true})

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerWebOptionsControls-class.html

Enables controls and sets how the options are displayed

```APIDOC
## VideoPlayerWebOptionsControls.enabled({bool allowDownload = true, bool allowFullscreen = true, bool allowPlaybackRate = true, bool allowPictureInPicture = true})

### Description
Enables controls and sets how the options are displayed.

### Constructor
```dart
const VideoPlayerWebOptionsControls.enabled({
  bool allowDownload = true,
  bool allowFullscreen = true,
  bool allowPlaybackRate = true,
  bool allowPictureInPicture = true
})
```

### Parameters
- **allowDownload** (bool) - Optional - Whether downloaded control is displayed. Defaults to `true`.
- **allowFullscreen** (bool) - Optional - Whether fullscreen control is enabled. Defaults to `true`.
- **allowPlaybackRate** (bool) - Optional - Whether playback rate control is displayed. Defaults to `true`.
- **allowPictureInPicture** (bool) - Optional - Whether picture in picture control is displayed. Defaults to `true`.

### Returns
A const constructor that creates a VideoPlayerWebOptionsControls instance with controls enabled and configured.

### Example
```dart
final options = VideoPlayerWebOptionsControls.enabled(
  allowDownload: false,
  allowFullscreen: true,
  allowPlaybackRate: false,
  allowPictureInPicture: true
);
```
```

--------------------------------

### VideoAudioTrack class

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoAudioTrack-class.html

Documentation for the VideoAudioTrack class, including its constructor, properties, methods, and operators.

```APIDOC
## VideoAudioTrack

### Description
Represents an audio track in a video with its metadata. This class is immutable.

### Constructors

#### VideoAudioTrack({required String id, required bool isSelected, String? label, String? language, int? bitrate, int? sampleRate, int? channelCount, String? codec})

Constructs an instance of VideoAudioTrack.

- **id** (String) - Required - Unique identifier for the audio track.
- **isSelected** (bool) - Required - Whether this track is currently selected.
- **label** (String?) - Optional - Human-readable label for the track.
- **language** (String?) - Optional - Language code of the audio track (e.g., 'en', 'es', 'und').
- **bitrate** (int?) - Optional - Bitrate of the audio track in bits per second.
- **sampleRate** (int?) - Optional - Sample rate of the audio track in Hz.
- **channelCount** (int?) - Optional - Number of audio channels.
- **codec** (String?) - Optional - Audio codec used (e.g., 'aac', 'mp3', 'ac3').

### Properties

- **bitrate** (int?) - Bitrate of the audio track in bits per second.
- **channelCount** (int?) - Number of audio channels.
- **codec** (String?) - Audio codec used (e.g., 'aac', 'mp3', 'ac3').
- **id** (String) - Unique identifier for the audio track.
- **isSelected** (bool) - Whether this track is currently selected.
- **label** (String?) - Human-readable label for the track.
- **language** (String?) - Language code of the audio track (e.g., 'en', 'es', 'und').
- **sampleRate** (int?) - Sample rate of the audio track in Hz.

### Methods

- **toString()** → String - A string representation of this object.

### Operators

- **operator ==(Object other)** → bool - The equality operator.

```

--------------------------------

### VideoPlayerController.contentUri

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerController-class.html

Constructor for creating a VideoPlayerController from a content URI.

```APIDOC
## VideoPlayerController.contentUri

### Description
Constructs a VideoPlayerController playing a video from a contentUri.

### Constructor
`VideoPlayerController.contentUri(Uri contentUri, {Future<ClosedCaptionFile>? closedCaptionFile, VideoPlayerOptions? videoPlayerOptions, VideoViewType viewType = platform_interface.VideoViewType.textureView})`

### Parameters
- **contentUri** (Uri) - Required - The content URI of the video.
- **closedCaptionFile** (Future<ClosedCaptionFile>?) - Optional - A future that resolves to a closed caption file.
- **videoPlayerOptions** (VideoPlayerOptions?) - Optional - Options for the video player.
- **viewType** (VideoViewType) - Optional - The type of view to use, defaults to `platform_interface.VideoViewType.textureView`.

### Usage Example
```dart
final controller = VideoPlayerController.contentUri(Uri.parse('content://media/external/video/media/123'));
```
```

--------------------------------

### VideoPlayerController.asset

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerController-class.html

Constructor for creating a VideoPlayerController from an asset.

```APIDOC
## VideoPlayerController.asset

### Description
Constructs a VideoPlayerController playing a video from an asset.

### Constructor
`VideoPlayerController.asset(String dataSource, {String? package, Future<ClosedCaptionFile>? closedCaptionFile, VideoPlayerOptions? videoPlayerOptions, VideoViewType viewType = platform_interface.VideoViewType.textureView})`

### Parameters
- **dataSource** (String) - Required - The asset key to the video.
- **package** (String?) - Optional - The package name if the asset is from a package.
- **closedCaptionFile** (Future<ClosedCaptionFile>?) - Optional - A future that resolves to a closed caption file.
- **videoPlayerOptions** (VideoPlayerOptions?) - Optional - Options for the video player.
- **viewType** (VideoViewType) - Optional - The type of view to use, defaults to `platform_interface.VideoViewType.textureView`.

### Usage Example
```dart
final controller = VideoPlayerController.asset('assets/videos/sample.mp4');
```
```

--------------------------------

### VideoPlayerOptions constructor

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerOptions-class.html

Creates a VideoPlayerOptions instance with optional settings for mixing audio, background playback, preventing display sleep, web options, and back buffer duration.

```APIDOC
## VideoPlayerOptions({bool mixWithOthers = false, bool allowBackgroundPlayback = false, bool preventsDisplaySleepDuringVideoPlayback = true, VideoPlayerWebOptions? webOptions, int? backBufferDurationMs})

### Description
Set additional optional player settings.

### Parameters
- **mixWithOthers** (bool) - Optional - Set this to true to mix the video players audio with other audio sources. The default value is false.
- **allowBackgroundPlayback** (bool) - Optional - Set this to true to keep playing video in background, when app goes in background. The default value is false.
- **preventsDisplaySleepDuringVideoPlayback** (bool) - Optional - Whether the screen is prevented from sleeping during video playback. The default value is true.
- **webOptions** (VideoPlayerWebOptions?) - Optional - Additional web controls.
- **backBufferDurationMs** (int?) - Optional - The duration, in milliseconds, of media to retain in the buffer prior to the current playback position.

### Example
```dart
VideoPlayerOptions(
  mixWithOthers: true,
  allowBackgroundPlayback: true,
  preventsDisplaySleepDuringVideoPlayback: false,
  webOptions: VideoPlayerWebOptions(),
  backBufferDurationMs: 1000,
)
```
```

--------------------------------

### VideoPlayerController.networkUrl

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerController-class.html

Constructor for creating a VideoPlayerController from a network URI.

```APIDOC
## VideoPlayerController.networkUrl

### Description
Constructs a VideoPlayerController playing a network video.

### Constructor
`VideoPlayerController.networkUrl(Uri url, {VideoFormat? formatHint, Future<ClosedCaptionFile>? closedCaptionFile, VideoPlayerOptions? videoPlayerOptions, Map<String, String> httpHeaders = const <String, String>{}, VideoViewType viewType = platform_interface.VideoViewType.textureView})`

### Parameters
- **url** (Uri) - Required - The URI of the video.
- **formatHint** (VideoFormat?) - Optional - A hint about the video format.
- **closedCaptionFile** (Future<ClosedCaptionFile>?) - Optional - A future that resolves to a closed caption file.
- **videoPlayerOptions** (VideoPlayerOptions?) - Optional - Options for the video player.
- **httpHeaders** (Map<String, String>) - Optional - HTTP headers to use when loading the video, defaults to an empty map.
- **viewType** (VideoViewType) - Optional - The type of view to use, defaults to `platform_interface.VideoViewType.textureView`.

### Usage Example
```dart
final controller = VideoPlayerController.networkUrl(Uri.parse('https://example.com/video.mp4'));
```
```

--------------------------------

### VideoPlayerController.network

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerController-class.html

Constructor for creating a VideoPlayerController from a network URL.

```APIDOC
## VideoPlayerController.network

### Description
Constructs a VideoPlayerController playing a network video.

### Constructor
`VideoPlayerController.network(String dataSource, {VideoFormat? formatHint, Future<ClosedCaptionFile>? closedCaptionFile, VideoPlayerOptions? videoPlayerOptions, Map<String, String> httpHeaders = const <String, String>{}, VideoViewType viewType = platform_interface.VideoViewType.textureView})`

### Parameters
- **dataSource** (String) - Required - The URL of the video.
- **formatHint** (VideoFormat?) - Optional - A hint about the video format.
- **closedCaptionFile** (Future<ClosedCaptionFile>?) - Optional - A future that resolves to a closed caption file.
- **videoPlayerOptions** (VideoPlayerOptions?) - Optional - Options for the video player.
- **httpHeaders** (Map<String, String>) - Optional - HTTP headers to use when loading the video, defaults to an empty map.
- **viewType** (VideoViewType) - Optional - The type of view to use, defaults to `platform_interface.VideoViewType.textureView`.

### Usage Example
```dart
final controller = VideoPlayerController.network('https://example.com/video.mp4');
```
```

--------------------------------

### VideoTrack constructor

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoTrack-class.html

Constructs an instance of VideoTrack with required id and isSelected, and optional metadata fields.

```APIDOC
## VideoTrack({required String id, required bool isSelected, String? label, int? bitrate, int? width, int? height, double? frameRate, String? codec})

### Description
Constructs an instance of VideoTrack.

### Parameters
- **id** (String) - Required - Unique identifier for the video track.
- **isSelected** (bool) - Required - Whether this track is currently selected.
- **label** (String?) - Optional - Human-readable label for the track (e.g., "1080p", "720p").
- **bitrate** (int?) - Optional - Bitrate of the video track in bits per second.
- **width** (int?) - Optional - Video width in pixels.
- **height** (int?) - Optional - Video height in pixels.
- **frameRate** (double?) - Optional - Frame rate in frames per second.
- **codec** (String?) - Optional - Video codec used (e.g., "avc1", "hevc", "vp9").

### Return Value
A new VideoTrack instance.
```

--------------------------------

### build(BuildContext context) → Widget

Source: https://pub.dev/documentation/video_player/latest/video_player/ClosedCaption-class.html

Describes the part of the user interface represented by this widget. This method is called by the framework to build the widget's UI.

```APIDOC
## build(BuildContext context) → Widget

### Description
Describes the part of the user interface represented by this widget. This method is called by the framework to build the widget's UI.

### Method
build(BuildContext context) → Widget

### Parameters
- **context** (BuildContext) - The build context.

### Returns
Widget - The widget tree for the closed caption.
```

--------------------------------

### VideoProgressIndicator

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoProgressIndicator-class.html

Documentation for the VideoProgressIndicator widget constructor, properties, and methods.

```APIDOC
## VideoProgressIndicator(VideoPlayerController controller, {Key? key, VideoProgressColors colors = const VideoProgressColors(), required bool allowScrubbing, EdgeInsets padding = const EdgeInsets.only(top: 5.0)})

### Description
Constructs an instance that displays the play/buffering status of the video controlled by `controller`. If `allowScrubbing` is true, the widget will detect taps and drags and seek the video accordingly.

### Constructor
`VideoProgressIndicator(VideoPlayerController controller, {Key? key, VideoProgressColors colors = const VideoProgressColors(), required bool allowScrubbing, EdgeInsets padding = const EdgeInsets.only(top: 5.0)})`

### Parameters
- **controller** (VideoPlayerController) - Required - The VideoPlayerController that associates a video with this widget.
- **key** (Key?) - Optional - Controls how one widget replaces another widget in the tree.
- **colors** (VideoProgressColors) - Optional - The default colors used throughout the indicator. Defaults to `const VideoProgressColors()`.
- **allowScrubbing** (bool) - Required - When true, the widget will detect touch input and try to seek the video accordingly. The widget ignores such input when false.
- **padding** (EdgeInsets) - Optional - Allows for visual padding around the progress indicator that can still detect gestures via `allowScrubbing`. Defaults to `const EdgeInsets.only(top: 5.0)`.

### Properties
- **allowScrubbing** (bool) - final - When true, the widget will detect touch input and try to seek the video accordingly. The widget ignores such input when false.
- **colors** (VideoProgressColors) - final - The default colors used throughout the indicator.
- **controller** (VideoPlayerController) - final - The VideoPlayerController that actually associates a video with this widget.
- **padding** (EdgeInsets) - final - This allows for visual padding around the progress indicator that can still detect gestures via `allowScrubbing`.

### Methods
- **createState()** → State<VideoProgressIndicator> - Creates the mutable state for this widget at a given location in the tree. (override)

### Inherited Members
- **hashCode** (int) - The hash code for this object.
- **key** (Key?) - Controls how one widget replaces another widget in the tree.
- **runtimeType** (Type) - A representation of the runtime type of the object.
- **createElement()** → StatefulElement - Creates a StatefulElement to manage this widget's location in the tree.
- **debugDescribeChildren()** → List<DiagnosticsNode> - Returns a list of DiagnosticsNode objects describing this node's children.
- **debugFillProperties(DiagnosticPropertiesBuilder properties)** → void - Add additional properties associated with the node.
- **noSuchMethod(Invocation invocation)** → dynamic - Invoked when a nonexistent method or property is accessed.
- **toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style})** → DiagnosticsNode - Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
- **toString({DiagnosticLevel minLevel = DiagnosticLevel.info})** → String - A string representation of this object.
- **toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65})** → String - Returns a string representation of this node and its descendants.
- **toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug})** → String - Returns a one-line detailed description of the object.
- **toStringShort()** → String - A short, textual description of this widget.
- **operator ==(Object other)** → bool - The equality operator.
```

--------------------------------

### VideoPlayerValue Class

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerValue-class.html

Documentation for the VideoPlayerValue class, including constructors, properties, methods, and operators.

```APIDOC
## VideoPlayerValue Class

### Description
Represents the duration, current position, buffering state, error state, and settings of a VideoPlayerController.

### 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 [], 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, bool preventsDisplaySleepDuringVideoPlayback = true})

Constructs a video with the given values. Only `duration` is required. The rest will initialize with default values when unset.

#### VideoPlayerValue.erroneous(String errorDescription)

Returns an instance with the given `errorDescription`.

#### VideoPlayerValue.uninitialized()

Returns an instance for a video that hasn't been loaded.

### Properties

- **aspectRatio** (double) - Returns `size.width` / `size.height`.
- **buffered** (List<DurationRange>) - The currently buffered ranges.
- **caption** (Caption) - The Caption that should be displayed based on the current position.
- **captionOffset** (Duration) - The Duration that should be used to offset the current position to get the correct Caption.
- **duration** (Duration) - The total duration of the video.
- **errorDescription** (String?) - A description of the error if present.
- **hasError** (bool) - Indicates whether or not the video is in an error state. If this is true errorDescription should have information about the problem.
- **isBuffering** (bool) - True if the video is currently buffering.
- **isCompleted** (bool) - True if video has finished playing to end.
- **isInitialized** (bool) - Indicates whether or not the video has been loaded and is ready to play.
- **isLooping** (bool) - True if the video is looping.
- **isPlaying** (bool) - True if the video is playing. False if it's paused.
- **playbackSpeed** (double) - The current speed of the playback.
- **position** (Duration) - The current playback position.
- **preventsDisplaySleepDuringVideoPlayback** (bool) - Whether the screen is prevented from sleeping during video playback.
- **rotationCorrection** (int) - Degrees to rotate the video (clockwise) so it is displayed correctly.
- **size** (Size) - The size of the currently loaded video.
- **volume** (double) - The current volume of the playback.

### 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, bool? preventsDisplaySleepDuringVideoPlayback}) → VideoPlayerValue

Returns a new instance that has the same values as this current instance, except for any overrides passed in as arguments to copyWith.

#### toString() → String

A string representation of this object.

### Operators

#### operator ==(Object other) → bool

The equality operator.
```

--------------------------------

### VideoTrack methods

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoTrack-class.html

Methods available on VideoTrack instances.

```APIDOC
## Methods

### noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed. (inherited)

### toString() → String
A string representation of this object. (override)
```

--------------------------------

### allowDownload → bool

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerWebOptionsControls-class.html

Whether downloaded control is displayed

```APIDOC
## allowDownload → bool

### Description
Whether downloaded control is displayed.

### Type
`bool`

### Remarks
This property is final and read-only. It is set via the `enabled` constructor.

### Example
```dart
final options = VideoPlayerWebOptionsControls.enabled(allowDownload: false);
print(options.allowDownload); // false
```
```

--------------------------------

### WebVTTCaptionFile(String fileContents)

Source: https://pub.dev/documentation/video_player/latest/video_player/WebVTTCaptionFile-class.html

Parses a string into a ClosedCaptionFile, assuming the input is in the WebVTT file format.

```APIDOC
## WebVTTCaptionFile(String fileContents)

### Description
Parses a string into a ClosedCaptionFile, assuming `fileContents` is in the WebVTT file format.

### Constructor
`WebVTTCaptionFile(String fileContents)`

### Parameters
- **fileContents** (String) - Required - The WebVTT formatted string to parse.

### Returns
A new instance of WebVTTCaptionFile.

```

--------------------------------

### VideoPlayer(VideoPlayerController controller, {Key? key})

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayer-class.html

Constructor for the VideoPlayer widget. It uses the given controller for all video rendered in this widget.

```APIDOC
## VideoPlayer(VideoPlayerController controller, {Key? key})

### Description
Creates a VideoPlayer widget that uses the given controller for all video rendered in this widget.

### Constructor
VideoPlayer(VideoPlayerController controller, {Key? key})

### Parameters
- **controller** (VideoPlayerController) - Required - The VideoPlayerController responsible for the video being rendered in this widget.
- **key** (Key?) - Optional - Controls how one widget replaces another widget in the tree.

### Usage Example
dart
VideoPlayer(
  controller: myController,
)

```

--------------------------------

### allowFullscreen → bool

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerWebOptionsControls-class.html

Whether fullscreen control is enabled

```APIDOC
## allowFullscreen → bool

### Description
Whether fullscreen control is enabled.

### Type
`bool`

### Remarks
This property is final and read-only. It is set via the `enabled` constructor.

### Example
```dart
final options = VideoPlayerWebOptionsControls.enabled(allowFullscreen: false);
print(options.allowFullscreen); // false
```
```

--------------------------------

### ClosedCaptionFile()

Source: https://pub.dev/documentation/video_player/latest/video_player/ClosedCaptionFile-class.html

Constructs a ClosedCaptionFile instance. This is the default constructor for the abstract class.

```APIDOC
## ClosedCaptionFile()

### Description
Constructs a ClosedCaptionFile instance. This is the default constructor for the abstract class.

### Method
Constructor

### Signature
ClosedCaptionFile()

### Parameters
None

### Returns
A new instance of ClosedCaptionFile.

```

--------------------------------

### controlsList → String

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerWebOptionsControls-class.html

A string representation of disallowed controls

```APIDOC
## controlsList → String

### Description
A string representation of disallowed controls.

### Type
`String`

### Remarks
This property is read-only and has no setter. It is derived from the `allow*` properties.

### Example
```dart
final options = VideoPlayerWebOptionsControls.enabled(allowDownload: false, allowFullscreen: false);
print(options.controlsList); // e.g., 'nodownload nofullscreen'
```
```

--------------------------------

### Play network video with video_player in Flutter

Source: https://pub.dev/documentation/video_player/latest/index.html

Complete Flutter app that plays a network video using the video_player package. It initializes a VideoPlayerController with a network URL, shows the first frame after initialization, and toggles play/pause with a floating action button. The controller is disposed in dispose().

```dart
import 'package:flutter/material.dart';
import 'package:video_player/video_player.dart';

void main() => runApp(const VideoApp());

/// Stateful widget to fetch and then display video content.
class VideoApp extends StatefulWidget {
  const VideoApp({super.key});

  @override
  _VideoAppState createState() => _VideoAppState();
}

class _VideoAppState extends State<VideoApp> {
  late VideoPlayerController _controller;

  @override
  void initState() {
    super.initState();
    _controller =
        VideoPlayerController.networkUrl(
            Uri.parse('https://flutter.github.io/assets-for-api-docs/assets/videos/bee.mp4'),
          )
          ..initialize().then((_) {
            // Ensure the first frame is shown after the video is initialized, even before the play button has been pressed.
            setState(() {});
          });
  }

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Video Demo',
      home: Scaffold(
        body: Center(
          child: _controller.value.isInitialized
              ? AspectRatio(
                  aspectRatio: _controller.value.aspectRatio,
                  child: VideoPlayer(_controller),
                )
              : Container(),
        ),
        floatingActionButton: FloatingActionButton(
          onPressed: () {
            setState(() {
              _controller.value.isPlaying ? _controller.pause() : _controller.play();
            });
          },
          child: Icon(_controller.value.isPlaying ? Icons.pause : Icons.play_arrow),
        ),
      ),
    );
  }

  @override
  void dispose() {
    _controller.dispose();
    super.dispose();
  }
}

```

--------------------------------

### createState() → State<VideoPlayer>

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayer-class.html

Creates the mutable state for this widget at a given location in the tree. This method is overridden from StatefulWidget.

```APIDOC
## createState() → State<VideoPlayer>

### Description
Creates the mutable state for this widget at a given location in the tree. This method is overridden from StatefulWidget.

### Returns
State<VideoPlayer> - The mutable state for this widget.
```

--------------------------------

### VideoPlayerController Methods

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerController-class.html

This code snippet documents the public methods of the VideoPlayerController class that can be called directly by users to control video playback, including play, pause, seek, track selection, and settings.

```APIDOC
## dispose() → Future<void>

### Description
Discards any resources used by the object. This method is an override and should be called when the video player is no longer needed.

### Method
dispose

### Parameters
None

### Returns
Future<void> - A future that completes when the resources are released.
```

```APIDOC
## getAudioTracks() → Future<List<VideoAudioTrack>>

### Description
Gets the available audio tracks for the video. This method returns a list of audio tracks that can be selected for playback.

### Method
getAudioTracks

### Parameters
None

### Returns
Future<List<VideoAudioTrack>> - A future that resolves to a list of available audio tracks.
```

```APIDOC
## getVideoTracks() → Future<List<VideoTrack>>

### Description
Gets the available video tracks for the video. This method returns a list of video tracks that can be selected for playback.

### Method
getVideoTracks

### Parameters
None

### Returns
Future<List<VideoTrack>> - A future that resolves to a list of available video tracks.
```

```APIDOC
## initialize() → Future<void>

### Description
Attempts to open the given dataSource and load metadata about the video. This method must be called before playing the video.

### Method
initialize

### Parameters
None

### Returns
Future<void> - A future that completes when the video is initialized.
```

```APIDOC
## isAudioTrackSupportAvailable() → bool

### Description
Returns whether audio track selection is supported on this platform. This can be used to conditionally show audio track selection UI.

### Method
isAudioTrackSupportAvailable

### Parameters
None

### Returns
bool - True if audio track selection is supported, false otherwise.
```

```APIDOC
## isVideoTrackSupportAvailable() → bool

### Description
Whether video track selection is supported on this platform. This can be used to conditionally show video track selection UI.

### Method
isVideoTrackSupportAvailable

### Parameters
None

### Returns
bool - True if video track selection is supported, false otherwise.
```

```APIDOC
## pause() → Future<void>

### Description
Pauses the video. The video will stop playing and the current position will be retained.

### Method
pause

### Parameters
None

### Returns
Future<void> - A future that completes when the video is paused.
```

```APIDOC
## play() → Future<void>

### Description
Starts playing the video. If the video is paused, it will resume from the current position.

### Method
play

### Parameters
None

### Returns
Future<void> - A future that completes when the video starts playing.
```

```APIDOC
## seekTo(Duration position) → Future<void>

### Description
Sets the video's current timestamp to be at `moment`. The next time the video is played it will resume from the given `moment`.

### Method
seekTo

### Parameters
- **position** (Duration) - Required - The position to seek to in the video.

### Returns
Future<void> - A future that completes when the seek operation is done.
```

```APIDOC
## selectAudioTrack(String trackId) → Future<void>

### Description
Selects which audio track is chosen for playback from its `trackId`. The track ID should be obtained from the list returned by `getAudioTracks()`.

### Method
selectAudioTrack

### Parameters
- **trackId** (String) - Required - The identifier of the audio track to select.

### Returns
Future<void> - A future that completes when the audio track is selected.
```

```APIDOC
## selectVideoTrack(VideoTrack? track) → Future<void>

### Description
Selects which video track is chosen for playback. The track should be obtained from the list returned by `getVideoTracks()`.

### Method
selectVideoTrack

### Parameters
- **track** (VideoTrack?) - Required - The video track to select. Can be null to deselect.

### Returns
Future<void> - A future that completes when the video track is selected.
```

```APIDOC
## setCaptionOffset(Duration offset) → void

### Description
Sets the caption offset. This adjusts the timing of captions relative to the video.

### Method
setCaptionOffset

### Parameters
- **offset** (Duration) - Required - The offset to apply to captions.

### Returns
void
```

```APIDOC
## setClosedCaptionFile(Future<ClosedCaptionFile>? closedCaptionFile) → Future<void>

### Description
Sets a closed caption file. The file is provided as a future that resolves to a `ClosedCaptionFile`.

### Method
setClosedCaptionFile

### Parameters
- **closedCaptionFile** (Future<ClosedCaptionFile>?) - Required - The closed caption file to set.

### Returns
Future<void> - A future that completes when the closed caption file is set.
```

```APIDOC
## setLooping(bool looping) → Future<void>

### Description
Sets whether or not the video should loop after playing once. See also VideoPlayerValue.isLooping.

### Method
setLooping

### Parameters
- **looping** (bool) - Required - Whether the video should loop.

### Returns
Future<void> - A future that completes when the looping setting is applied.
```

```APIDOC
## setPlaybackSpeed(double speed) → Future<void>

### Description
Sets the playback speed of `this`. The speed is a multiplier, e.g., 1.0 for normal speed, 2.0 for double speed.

### Method
setPlaybackSpeed

### Parameters
- **speed** (double) - Required - The playback speed multiplier.

### Returns
Future<void> - A future that completes when the playback speed is set.
```

```APIDOC
## setPreventsDisplaySleepDuringVideoPlayback(bool preventsDisplaySleepDuringVideoPlayback) → Future<void>

### Description
Sets whether the screen is prevented from sleeping during video playback. This can be used to keep the screen on while watching a video.

### Method
setPreventsDisplaySleepDuringVideoPlayback

### Parameters
- **preventsDisplaySleepDuringVideoPlayback** (bool) - Required - Whether to prevent the screen from sleeping.

### Returns
Future<void> - A future that completes when the setting is applied.
```

```APIDOC
## setVolume(double volume) → Future<void>

### Description
Sets the audio volume of `this`. The volume is a value between 0.0 and 1.0.

### Method
setVolume

### Parameters
- **volume** (double) - Required - The volume level, from 0.0 (mute) to 1.0 (full volume).

### Returns
Future<void> - A future that completes when the volume is set.
```

--------------------------------

### enabled → bool

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerWebOptionsControls-class.html

Whether native controls are enabled

```APIDOC
## enabled → bool

### Description
Whether native controls are enabled.

### Type
`bool`

### Remarks
This property is final and read-only. It is `true` when constructed with `enabled()` and `false` when constructed with `disabled()`.

### Example
```dart
final options = VideoPlayerWebOptionsControls.enabled();
print(options.enabled); // true
```
```

--------------------------------

### allowPlaybackRate → bool

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerWebOptionsControls-class.html

Whether playback rate control is displayed

```APIDOC
## allowPlaybackRate → bool

### Description
Whether playback rate control is displayed.

### Type
`bool`

### Remarks
This property is final and read-only. It is set via the `enabled` constructor.

### Example
```dart
final options = VideoPlayerWebOptionsControls.enabled(allowPlaybackRate: false);
print(options.allowPlaybackRate); // false
```
```

--------------------------------

### VideoPlayerWebOptionsControls.disabled()

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerWebOptionsControls-class.html

Disables control options. Default behavior.

```APIDOC
## VideoPlayerWebOptionsControls.disabled()

### Description
Disables control options. Default behavior.

### Constructor
```dart
const VideoPlayerWebOptionsControls.disabled()
```

### Parameters
None.

### Returns
A const constructor that creates a VideoPlayerWebOptionsControls instance with controls disabled.

### Example
```dart
final options = VideoPlayerWebOptionsControls.disabled();
```
```

--------------------------------

### Add INTERNET permission to AndroidManifest.xml

Source: https://pub.dev/documentation/video_player/latest/index.html

Required in the Android manifest when using network-based videos. Place it in <project root>/android/app/src/main/AndroidManifest.xml.

```xml
<uses-permission android:name="android.permission.INTERNET"/>
```

--------------------------------

### ClosedCaption({Key? key, String? text, TextStyle? textStyle})

Source: https://pub.dev/documentation/video_player/latest/video_player/ClosedCaption-class.html

Creates a new closed caption widget, designed to be used with VideoPlayerValue.caption. The text parameter is the caption text to display, and textStyle specifies how the text should look.

```APIDOC
## ClosedCaption Constructor

### Description
Creates a new closed caption widget, designed to be used with VideoPlayerValue.caption. If text is null or empty, the widget will not display anything.

### Constructor
ClosedCaption({Key? key, String? text, TextStyle? textStyle})

### Parameters
- **key** (Key?) - Optional - Controls how one widget replaces another widget in the tree.
- **text** (String?) - Optional - The text that will be shown in the closed caption, or null if no caption should be shown. If the text is empty the caption will not be shown.
- **textStyle** (TextStyle?) - Optional - Specifies how the text in the closed caption should look.

### Usage Example
```dart
Stack(children: <Widget>[
  VideoPlayer(_controller),
  ClosedCaption(text: _controller.value.caption.text),
]),
```
```

--------------------------------

### VideoPlayerOptions properties

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerOptions-class.html

Properties of the VideoPlayerOptions class that allow reading the configured options.

```APIDOC
## Properties

### allowBackgroundPlayback → bool
Set this to true to keep playing video in background, when app goes in background. The default value is false.

### backBufferDurationMs → int?
The duration, in milliseconds, of media to retain in the buffer prior to the current playback position.

### mixWithOthers → bool
Set this to true to mix the video players audio with other audio sources. The default value is false.

### preventsDisplaySleepDuringVideoPlayback → bool
Whether the screen is prevented from sleeping during video playback.

### webOptions → VideoPlayerWebOptions?
Additional web controls.
```

--------------------------------

### allowPictureInPicture → bool

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayerWebOptionsControls-class.html

Whether picture in picture control is displayed

```APIDOC
## allowPictureInPicture → bool

### Description
Whether picture in picture control is displayed.

### Type
`bool`

### Remarks
This property is final and read-only. It is set via the `enabled` constructor.

### Example
```dart
final options = VideoPlayerWebOptionsControls.enabled(allowPictureInPicture: false);
print(options.allowPictureInPicture); // false
```
```

--------------------------------

### DataSourceType enum

Source: https://pub.dev/documentation/video_player/latest/video_player/DataSourceType.html

The DataSourceType enum defines the source from which a video is loaded. It includes values for asset, network, file, and contentUri (Android only).

```APIDOC
## DataSourceType enum

### Description
The way in which the video was originally loaded. This has nothing to do with the video's file type. It's just the place from which the video is fetched from.

### Values
- **asset** (const DataSourceType) - The video was included in the app's asset files.
- **network** (const DataSourceType) - The video was downloaded from the internet.
- **file** (const DataSourceType) - The video was loaded off of the local filesystem.
- **contentUri** (const DataSourceType) - The video is available via contentUri. Android only.

### Properties
- **hashCode** (int) - The hash code for this object. (inherited, no setter)
- **index** (int) - A numeric identifier for the enumerated value. (inherited, no setter)
- **name** (String) - The name of the enum value. (provided by the EnumName extension, no setter)
- **runtimeType** (Type) - A representation of the runtime type of the object. (inherited, no setter)

### Methods
- **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)

### Constants
- **values** (const List<DataSourceType>) - A constant List of the values in this enum, in order of their declaration.
```

--------------------------------

### VideoTrack properties

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoTrack-class.html

Properties of VideoTrack providing metadata about the video track.

```APIDOC
## Properties

### bitrate → int?
Bitrate of the video track in bits per second.

### codec → String?
Video codec used (e.g., "avc1", "hevc", "vp9").

### frameRate → double?
Frame rate in frames per second.

### height → int?
Video height in pixels.

### id → String
Unique identifier for the video track.

### isSelected → bool
Whether this track is currently selected.

### label → String?
Human-readable label for the track (e.g., "1080p", "720p").

### width → int?
Video width in pixels.
```

--------------------------------

### double endFraction(Duration duration)

Source: https://pub.dev/documentation/video_player/latest/video_player/DurationRange-class.html

Method to calculate the fraction of the end of the range relative to the total video duration.

```APIDOC
## double endFraction(Duration duration)

### Description
Assumes that `duration` is the total length of the video that this DurationRange is a segment form. It returns the percentage that start is through the entire video.

### Parameters
- **duration** (Duration) - Required - The total length of the video.

### Return Value
double - The percentage that start is through the entire video.
```

--------------------------------

### VideoTrack operators

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoTrack-class.html

Operators defined for VideoTrack.

```APIDOC
## Operators

### operator ==(Object other) → bool
The equality operator. (override)
```

--------------------------------

### controller → VideoPlayerController

Source: https://pub.dev/documentation/video_player/latest/video_player/VideoPlayer-class.html

The VideoPlayerController responsible for the video being rendered in this widget. This property is final and read-only.

```APIDOC
## controller → VideoPlayerController

### Description
The VideoPlayerController responsible for the video being rendered in this widget. This property is final and read-only.

### Type
VideoPlayerController

### Read-only
Yes
```
Tokens:
Raw