GiphyVideoView class
A widget that makes it easy to play back GiphyMedia clips video assets.
This widget provides a customizable view for displaying a Giphy video, including options for auto-playing the video, muting, and handling various callbacks for mute/unmute, playback state changes, and errors. The GiphyVideoView will only work for GiphyMedia where the isVideo property is true.
Note: GiphyVideoView has no advanced features for playback, volume, and buffering control. If you need some advanced features, you can easily integrate clips with other more advanced video players.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- GiphyVideoView
Constructors
- GiphyVideoView.new({Key? key, String? mediaId, GiphyMedia? media, bool autoPlay = true, bool muted = false, dynamic onMute()?, dynamic onUnmute()?, dynamic onPlaybackStateChanged(GiphyVideoViewPlaybackState state)?, dynamic onError(String description)?})
-
Constructs a GiphyVideoView.
const
Properties
- autoPlay → bool
-
Set it to true to start the video automatically.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- media → GiphyMedia?
-
The media item to display.
final
- mediaId → String?
-
The ID of the media item to display.
final
- muted → bool
-
Set to true or false to mute or unmute the player.
final
- onError → dynamic Function(String description)?
-
A callback function that will be called when an error occurs whilst attempting to play media.
final
- onMute → dynamic Function()?
-
A callback function that will be called when media is muted.
final
- onPlaybackStateChanged → dynamic Function(GiphyVideoViewPlaybackState state)?
-
A callback function that will be called when playback state changes.
final
- onUnmute → dynamic Function()?
-
A callback function that will be called when media is unmuted.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< GiphyVideoView> -
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, int wrapWidth = 65}) → 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