VideoFeed class

The widget of video feed.

Inheritance

Constructors

VideoFeed({Key? key, required VideoFeedSource source, String? channel, String? playlist, String? playlistGroup, Map<String, List<String>>? dynamicContentParameters, String? hashtagFilterExpression, List<String>? productIds, String? contentId, VideoFeedMode? mode, bool? enablePictureInPicture, double? width, double? height, bool? wantKeepAlive, VideoFeedConfiguration? videoFeedConfiguration, VideoPlayerConfiguration? videoPlayerConfiguration, AdConfiguration? adConfiguration, VideoFeedCreatedCallback? onVideoFeedCreated, VideoFeedLoadFinishedCallback? onVideoFeedLoadFinished, VideoFeedEmptyCallback? onVideoFeedEmpty, VideoFeedDidStartPictureInPictureCallback? onVideoFeedDidStartPictureInPicture, VideoFeedDidStopPictureInPictureCallback? onVideoFeedDidStopPictureInPicture, VideoFeedGetFeedIdCallback? onVideoFeedGetFeedId})
const

Properties

adConfiguration → AdConfiguration?
Ad configuration of the feed.
final
channel → String?
The channel id of the feed. Required when the source is set as channel or playlist or dynamicContent.
final
contentId → String?
The video or live stream id.
final
dynamicContentParameters → Map<String, List<String>>?
The dynamic content parameters of the feed. Required when the source is set as dynamicContent.
final
enablePictureInPicture → bool?
Specifies if Picture in Picture is enabled.
final
hashCode → int
The hash code for this object.
no setterinherited
hashtagFilterExpression → String?
Hashtag filter expression is an s-expression used to provide feeds filtered by hashtags with specified criteria. Queries are specified with boolean predicates on what hashtags are there on the video. For instance, (and sport food) (or sport food) (and sport (or food comedy)) sport are all valid expressions. Non-UTF-8 characters are not allowed. If using boolean predicates, the expression needs to be wrapped with parenthesis. Required when the source is set as hashtagPlaylist.
final
height → double?
The height of the feed.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mode → VideoFeedMode?
One of three available display modes. Defaults to row.
final
onVideoFeedCreated → VideoFeedCreatedCallback?
The callback of video feed creation.
final
onVideoFeedDidStartPictureInPicture → VideoFeedDidStartPictureInPictureCallback?
The callback of the feed starting picture in picture. It means starting successfully when error equals to null. Only supported on iOS.
final
onVideoFeedDidStopPictureInPicture → VideoFeedDidStopPictureInPictureCallback?
The callback of the feed stopping picture in picture. It means stopping successfully when error equals to null. Only supported on iOS.
final
onVideoFeedEmpty → VideoFeedEmptyCallback?
The callback is triggered when there are no items in the video feed. The callback is triggered in the following cases:
final
onVideoFeedGetFeedId → VideoFeedGetFeedIdCallback?
The host app could use this callback to get feed id. The feed id can be used for conversion tracking.
final
onVideoFeedLoadFinished → VideoFeedLoadFinishedCallback?
The callback of the feed loading result. It means loading successfully when error equals to null.
final
playlist → String?
The playlist id of the feed. Required when the source is set as playlist.
final
playlistGroup → String?
Playlist group id of the feed. Required when the source is set as playlistGroup. Only supported on iOS.
final
productIds → List<String>?
Product ids used to generate the sku feed. Required when the source is set as sku.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
source → VideoFeedSource
The source of the feed. The playlistGroup is only supported on iOS. Defaults to discover.
final
videoFeedConfiguration → VideoFeedConfiguration?
The configuration of the feed.
final
videoPlayerConfiguration → VideoPlayerConfiguration?
The configuration of the player.
final
wantKeepAlive → bool?
Set this property to true if you want keep the widget alive during scrolling list out of view box. Default to false.
final
width → double?
The width of the feed.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<VideoFeed>
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