AgoraVideoViewer class

A UI class to style how the video layout looks like. Use this class to choose between the two default layouts FloatingLayout and GridLayout, enable active speaker, display number of users, display mic and video state of the user.

Inheritance

Constructors

AgoraVideoViewer({Key? key, required AgoraClient client, Layout layoutType = Layout.grid, double? floatingLayoutContainerHeight, double? floatingLayoutContainerWidth, EdgeInsets floatingLayoutMainViewPadding = const EdgeInsets.fromLTRB(3, 0, 3, 3), EdgeInsets floatingLayoutSubViewPadding = const EdgeInsets.fromLTRB(3, 3, 0, 3), Widget disabledVideoWidget = const DisabledVideoWidget(), bool showAVState = false, bool enableHostControls = false, bool showNumberOfUsers = false, RenderModeType renderModeType = RenderModeType.renderModeHidden})
const

Properties

client → AgoraClient
final
disabledVideoWidget → Widget
Widget that will be displayed when the local or remote user has disabled it's video.
final
enableHostControls → bool
final
floatingLayoutContainerHeight → double?
Set the height of the container in the floating view. The default height is 0.2 of the total height.
final
floatingLayoutContainerWidth → double?
Set the width of the container in the floating view. The default width is 1/3 of the total width.
final
floatingLayoutMainViewPadding → EdgeInsets
Padding of the main user or the active speaker in the floating layout.
final
floatingLayoutSubViewPadding → EdgeInsets
Padding of the secondary user present in the list.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
layoutType → Layout
Choose between two default layouts Layout.floating and Layout.grid
final
renderModeType → RenderModeType
Render mode for local and remote video
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showAVState → bool
Display the camera and microphone status of a user. This feature is only available in the Layout.floating
final
showNumberOfUsers → bool
Display the total number of users in a channel.
final

Methods

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