YoutubePlayerScaffold class

A widget the scaffolds the YoutubePlayer so that it can be moved around easily in the view and handles the fullscreen functionality.

Inheritance

Constructors

YoutubePlayerScaffold({Key? key, required Widget builder(BuildContext context, Widget player), required YoutubePlayerController controller, double aspectRatio = 16 / 9, bool autoFullScreen = true, List<DeviceOrientation> defaultOrientations = DeviceOrientation.values, Set<Factory<OneSequenceGestureRecognizer>> gestureRecognizers = const <Factory<OneSequenceGestureRecognizer>>{}, List<DeviceOrientation> fullscreenOrientations = const [DeviceOrientation.landscapeLeft, DeviceOrientation.landscapeRight], List<DeviceOrientation> lockedOrientations = const [DeviceOrientation.portraitUp, DeviceOrientation.portraitDown], bool enableFullScreenOnVerticalDrag = true, Color? backgroundColor, @Deprecated('Unused parameter. Use `YoutubePlayerParam.userAgent` instead.') String? userAgent})
Creates YoutubePlayerScaffold.
const

Properties

aspectRatio → double
The aspect ratio of the player.
final
autoFullScreen → bool
Whether the player should be fullscreen on device orientation changes.
final
backgroundColor → Color?
The background color of the WebView.
final
builder → Widget Function(BuildContext context, Widget player)
Builds the child widget.
final
controller → YoutubePlayerController
The player controller.
final
defaultOrientations → List<DeviceOrientation>
The default orientations for the device.
final
enableFullScreenOnVerticalDrag → bool
Enables switching full screen mode on vertical drag in the player.
final
fullscreenOrientations → List<DeviceOrientation>
The orientations that are used when in fullscreen.
final
gestureRecognizers → Set<Factory<OneSequenceGestureRecognizer>>
Which gestures should be consumed by the youtube player.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
lockedOrientations → List<DeviceOrientation>
The orientations that are used when not in fullscreen and auto rotate is disabled.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
userAgent → String?
The value used for the HTTP User-Agent: request header.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<YoutubePlayerScaffold>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

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