SurfaceView class

SurfaceView class for rendering local video. Extends from the RtcSurfaceView class. This class has the following corresponding classes: Android: SurfaceView (https://developer.android.com/reference/android/view/SurfaceView). iOS: UIView (https://developer.apple.com/documentation/uikit/uiview) Applies to the macOS and Windows platforms only.

Inheritance

Constructors

SurfaceView({Key? key, String? channelId, VideoRenderMode renderMode = VideoRenderMode.Hidden, VideoMirrorMode mirrorMode = VideoMirrorMode.Auto, bool zOrderOnTop = false, bool zOrderMediaOverlay = false, PlatformViewCreatedCallback? onPlatformViewCreated, Set<Factory<OneSequenceGestureRecognizer>>? gestureRecognizers})
Constructs the SurfaceView. Constructs the SurfaceView.
const
SurfaceView.screenShare({Key? key, VideoRenderMode renderMode = VideoRenderMode.Hidden, VideoMirrorMode mirrorMode = VideoMirrorMode.Disabled, PlatformViewCreatedCallback? onPlatformViewCreated, Set<Factory<OneSequenceGestureRecognizer>>? gestureRecognizers})
Constructs the SurfaceView.
const

Properties

channelId → String?
The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters: The 26 lowercase English letters: a to z. The 26 uppercase English letters: A to Z. The 10 numeric characters: 0 to 9. Space "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "", "", "^", "_", "{", "}", "|", "~", ","
finalinherited
gestureRecognizers → Set<Factory<OneSequenceGestureRecognizer>>?
The Gesture object.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
mirrorMode → VideoMirrorMode
The mirror mode of the view. See VideoMirrorMode .
finalinherited
onPlatformViewCreated → PlatformViewCreatedCallback?
This event is triggered when a platform view is created.
finalinherited
renderMode → VideoRenderMode
The rendering mode of the video. See VideoRenderMode .
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subProcess → bool
Whether to create a subprocess.
finalinherited
uid → int
The user ID.
finalinherited
zOrderMediaOverlay → bool
Whether to place the surface layer of the SurfaceView view on top of another SurfaceView in the window (but still below the window). This method is for Android only.
finalinherited
zOrderOnTop → bool
Whether to place the current screen on another layer of the current window. This method is for Android only.
finalinherited

Methods

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