VideoViewController

A AgoraVideoView controller for rendering local and remote video.

class VideoViewController
    with VideoViewControllerBaseMixin
    implements VideoViewControllerBase {
  VideoViewController({
    required this.rtcEngine,
    required this.canvas,
    this.useFlutterTexture = false,
    this.useAndroidSurfaceView = false,
  }) : connection = const RtcConnection();

  VideoViewController.remote({
    required this.rtcEngine,
    required this.canvas,
    required this.connection,
    this.useFlutterTexture = false,
    this.useAndroidSurfaceView = false,
  }) : assert(connection.channelId != null);

  @override
  final RtcEngine rtcEngine;

  @override
  final VideoCanvas canvas;

  @override
  final RtcConnection connection;

  @override
  final bool useFlutterTexture;

  @override
  final bool useAndroidSurfaceView;

  @protected
  @override
  int getVideoSourceType() {
    return canvas.uid! == 0
        ? VideoSourceType.videoSourceCamera.value()
        : VideoSourceType.videoSourceRemote.value();
  }
}
On different platforms, the default view corresponding to this class is different:

Attributes

rtcEngine
RtcEngine.
canvas
Local video display properties. See VideoCanvas.
connection
The connection information. See RtcConnection.
useFlutterTexture
Whether to use FlutterTexture to render video:
  • true: Use FlutterTexture to render video.
  • false: Do not use FlutterTexture to render video.
Note: FlutterTexture applies to iOS, macOS and Windows platforms.
useAndroidSurfaceView
Whether to use Android SurfaceView to render video:
  • true: Use Android SurfaceView to render video.
  • false: Do not use Android SurfaceView to render video.
Note: Android SurfaceView applies to Android platform only.

VideoViewControllerBase

A AgoraVideoView controller for rendering local and remote video.

abstract class VideoViewControllerBase {
  RtcEngine get rtcEngine;
  VideoCanvas get canvas;
  RtcConnection? get connection;
  bool get useFlutterTexture;
  bool get useAndroidSurfaceView;
  Future<void> dispose();
}
On different platforms, the default view corresponding to this class is different:

Attributes

rtcEngine
RtcEngine.
canvas
The local video view and settings. See VideoCanvas.
connection
The connection information. See RtcConnection.
useFlutterTexture
Whether to use FlutterTexture to render video:
  • true: Use FlutterTexture to render video.
  • false: Do not use FlutterTexture to render video.
Note: FlutterTexture applies to iOS, macOS and Windows platforms.
useAndroidSurfaceView
Whether to use Android SurfaceView to render video:
  • true: Use Android SurfaceView to render video.
  • false: Do not use Android SurfaceView to render video.
Note: Android SurfaceView applies to Android platform only.

VideoViewController

Constructor for the VideoViewController class used to render local video.

VideoViewController({
required this.rtcEngine,
required this.canvas,
this.useFlutterTexture = false,
this.useAndroidSurfaceView = false,
}) : connection = const RtcConnection();

Parameters

rtcEngine
RtcEngine.
canvas
Local video display properties. See VideoCanvas.
useFlutterTexture
Whether to use FlutterTexture to render video:
  • true: Use FlutterTexture to render video.
  • false: Do not use FlutterTexture to render video.
Note: FlutterTexture applies to iOS, macOS and Windows platforms.
useAndroidSurfaceView
Whether to use Android SurfaceView to render video:
  • true: Use Android SurfaceView to render video.
  • false: Do not use Android SurfaceView to render video.
Note: Android SurfaceView applies to Android platform only.