AgoraVideoButtons class
A UI class to style how the buttons look. Use this class to add, remove or customize the buttons in your live video calling application.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- AgoraVideoButtons
Constructors
-
AgoraVideoButtons({Key? key, required AgoraClient client, List<
BuiltInButtons> ? enabledButtons, List<Widget> ? extraButtons, bool? autoHideButtons, int autoHideButtonTime = 5, double? verticalButtonPadding, Alignment buttonAlignment = Alignment.bottomCenter, Widget? disconnectButtonChild, Widget? muteButtonChild, Widget? switchCameraButtonChild, Widget? disableVideoButtonChild, Widget? screenSharingButtonWidget, Widget? cloudRecordingButtonWidget, dynamic onDisconnect()?, bool? addScreenSharing = false, bool? cloudRecordingEnabled = false}) -
const
Properties
- addScreenSharing → bool?
-
Adds Screen Sharing button to the layout and let's user share their screen using the same. Currently only on Android and iOS. The deafult value is set to
false. So, if you want to add screen sharing set addScreenSharing totrue.final - autoHideButtons → bool?
-
Automatically hides the button class after a default time of 5 seconds if not set otherwise.
final
- autoHideButtonTime → int
-
The default auto hide time = 5 seconds
final
-
Alignment for the button class
final
- client → AgoraClient
-
final
- cloudRecordingButtonWidget → Widget?
-
final
- cloudRecordingEnabled → bool?
-
final
- disableVideoButtonChild → Widget?
-
Use this to style the disabled video button as per your liking while still keeping the default functionality.
final
- disconnectButtonChild → Widget?
-
Use this to style the disconnect button as per your liking while still keeping the default functionality.
final
-
enabledButtons
→ List<
BuiltInButtons> ? -
List of enabled buttons. Use this to remove any of the default button or change their order.
final
-
extraButtons
→ List<
Widget> ? -
List of buttons that are added next to the default buttons. The buttons class contains a horizontal scroll view.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- muteButtonChild → Widget?
-
Use this to style the mute mic button as per your liking while still keeping the default functionality.
final
- onDisconnect → dynamic Function()?
-
Agora VideoUIKit takes care of leaving the channel and destroying the engine. But if you want to add any other functionality to the disconnect button, use this.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- screenSharingButtonWidget → Widget?
-
final
- switchCameraButtonChild → Widget?
-
Use this to style the switch camera button as per your liking while still keeping the default functionality.
final
- verticalButtonPadding → double?
-
Adds a vertical padding to the set of button
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< AgoraVideoButtons> -
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