ZegoPrebuiltAudioVideoViewConfig class
Configuration options for audio/video views. These options allow you to customize the display effects of the audio/video views, such as showing microphone status and usernames. If you need to customize the foreground or background of the audio/video view, you can use foregroundBuilder and backgroundBuilder. If you want to hide user avatars or sound waveforms in audio mode, you can set showAvatarInAudioMode and showSoundWavesInAudioMode to false.
Constructors
- ZegoPrebuiltAudioVideoViewConfig({bool visible(ZegoUIKitUser localUser, ZegoUIKitUser targetUser)?, bool muteInvisible = true, bool isVideoMirror = true, bool showMicrophoneStateOnView = true, bool showCameraStateOnView = false, bool showUserNameOnView = true, ZegoAudioVideoViewForegroundBuilder? foregroundBuilder, ZegoAudioVideoViewBackgroundBuilder? backgroundBuilder, bool useVideoViewAspectFill = false, bool showAvatarInAudioMode = true, bool showSoundWavesInAudioMode = true})
Properties
- backgroundBuilder ↔ ZegoAudioVideoViewBackgroundBuilder?
-
Background for the audio/video windows in a Video Conference.
You can use any widget as the background for the audio/video windows. This can be a video, a GIF animation, an image, a web page, or any other widget.
If you need to dynamically change the background content, you should implement the logic for dynamic modification within the widget you return.
getter/setter pair
- foregroundBuilder ↔ ZegoAudioVideoViewForegroundBuilder?
-
You can customize the foreground of the audio/video view, which refers to the widget positioned on top of the view.
You can return any widget, and we will place it at the top of the audio/video view.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- isVideoMirror ↔ bool
-
Whether to mirror the displayed video captured by the camera.
This mirroring effect only applies to the front-facing camera.
Set it to true to enable mirroring, which flips the image horizontally.
getter/setter pair
- muteInvisible ↔ bool
-
true: not play audio if invisible
false: Although invisible, audio is also played
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showAvatarInAudioMode ↔ bool
-
Whether to display user avatars in audio mode.
Set it to false if you don't want to show user avatars in audio mode.
getter/setter pair
- showCameraStateOnView ↔ bool
-
Whether to display the camera status on the audio/video view.
Set it to false if you don't want to show the camera status on the audio/video view.
getter/setter pair
- showMicrophoneStateOnView ↔ bool
-
Whether to display the microphone status on the audio/video view.
Set it to false if you don't want to show the microphone status on the audio/video view.
getter/setter pair
- showSoundWavesInAudioMode ↔ bool
-
Whether to display sound waveforms in audio mode.
Set it to false if you don't want to show sound waveforms in audio mode.
getter/setter pair
- showUserNameOnView ↔ bool
-
Whether to display the username on the audio/video view.
Set it to false if you don't want to show the username on the audio/video view.
getter/setter pair
- useVideoViewAspectFill ↔ bool
-
Video view mode.
Set it to true if you want the video view to scale proportionally to fill the entire view, potentially resulting in partial cropping.
Set it to false if you want the video view to scale proportionally, potentially resulting in black borders.
getter/setter pair
- visible ↔ (bool Function(ZegoUIKitUser localUser, ZegoUIKitUser targetUser)?)
-
show target user's audio video view or not
return false if you don't want to show target user's audio video view.
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited