rtc_local_view: SurfaceView

SurfaceView class for rendering local video. Extends from the rtc_render_view: RtcSurfaceView class.

class SurfaceView extends RtcSurfaceView {
                  const SurfaceView({
                    Key? key,
                    String? channelId,
                    renderMode = VideoRenderMode.Hidden,
                    mirrorMode = VideoMirrorMode.Auto,
                    zOrderOnTop = false,
                    zOrderMediaOverlay = false,
                    PlatformViewCreatedCallback? onPlatformViewCreated,
                    Set<Factory<OneSequenceGestureRecognizer>>? gestureRecognizers,
                  }) : super(
                          key: key,
                          uid: 0,
                          channelId: channelId,
                          renderMode: renderMode,
                          mirrorMode: mirrorMode,
                          zOrderOnTop: zOrderOnTop,
                          zOrderMediaOverlay: zOrderMediaOverlay,
                          onPlatformViewCreated: onPlatformViewCreated,
                          gestureRecognizers: gestureRecognizers,
                        );
                
                  const SurfaceView.screenShare({
                    Key? key,
                    renderMode = VideoRenderMode.Hidden,
                    mirrorMode = VideoMirrorMode.Disabled,
                    PlatformViewCreatedCallback? onPlatformViewCreated,
                    Set<Factory<OneSequenceGestureRecognizer>>? gestureRecognizers,
                  }) : super(
                          key: key,
                          uid: 0,
                          renderMode: renderMode,
                          mirrorMode: mirrorMode,
                          onPlatformViewCreated: onPlatformViewCreated,
                          gestureRecognizers: gestureRecognizers,
                          subProcess: true,
                        );
                }

This class has the following corresponding classes:

Android: SurfaceView.
iOS: UIView
Applies to the macOS and Windows platforms only.

Parameters

key

Specifiers of Widget, Element, and SemanticsNode. For details, see Flutter's official documentation for a description of the key object.

channelId

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
"!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","

renderMode

The rendering mode of the video. See VideoRenderMode.

mirrorMode

The mirror mode of the view. See VideoMirrorMode.

zOrderOnTop

Whether to place the current screen on another layer of the current window.

Note: This method is for Android only.

zOrderMediaOverlay

Whether to place the surface layer of the SurfaceView view on top of another SurfaceView in the window (but still below the window).

Note: This method is for Android only.

onPlatformViewCreated

This event is triggered when a platform view is created.

gestureRecognizers

The Gesture object.

subProcess

Whether to create a subprocess.