ZegoLiveStreamingAudioVideoViewConfig class
Configuration options for audio/video views.
This class is used for the ZegoUIKitPrebuiltLiveStreamingConfig.audioVideoView property.
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
- ZegoLiveStreamingAudioVideoViewConfig({bool isVideoMirror = true, bool showUserNameOnView = true, bool showAvatarInAudioMode = true, bool showSoundWavesInAudioMode = true, bool useVideoViewAspectFill = true, bool visible(ZegoUIKitUser localUser, ZegoLiveStreamingRole localRole, ZegoUIKitUser targetUser, ZegoLiveStreamingRole targetUserRole)?, ZegoPlayCoHostAudioVideoCallback? playCoHostAudio, ZegoPlayCoHostAudioVideoCallback? playCoHostVideo, ZegoAudioVideoViewForegroundBuilder? foregroundBuilder, ZegoAudioVideoViewBackgroundBuilder? backgroundBuilder, ZegoLiveStreamingAudioVideoContainerBuilder? containerBuilder, Rect containerRect()?})
Properties
- backgroundBuilder ↔ ZegoAudioVideoViewBackgroundBuilder?
-
Background for the audio/video windows in a Live Streaming.
getter/setter pair
- containerBuilder ↔ ZegoLiveStreamingAudioVideoContainerBuilder?
-
Custom audio/video view. ( not for PK!! )
If you don't want to use the default view components, you can pass a custom component through this parameter.
and if return null, will be display the default view
getter/setter pair
- containerRect ↔ (Rect Function()?)
-
Specify the rect of the audio & video container.
If not specified, it defaults to display full.
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.
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.
getter/setter pair
- playCoHostAudio ↔ ZegoPlayCoHostAudioVideoCallback?
-
Whether to the play audio of the specified co-host?
The default behavior is play.
return false if you don't want to play target user's audio.
getter/setter pair
- playCoHostVideo ↔ ZegoPlayCoHostAudioVideoCallback?
-
Whether to the play video of the specified co-host?
The default behavior is play.
return false if you don't want to play target user's video.
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.
getter/setter pair
- showSoundWavesInAudioMode ↔ bool
-
Whether to display sound waveforms in audio mode.
getter/setter pair
- showUserNameOnView ↔ bool
-
Whether to display the username on the audio/video view.
getter/setter pair
- useVideoViewAspectFill ↔ bool
-
Video view mode.
getter/setter pair
- visible ↔ (bool Function(ZegoUIKitUser localUser, ZegoLiveStreamingRole localRole, ZegoUIKitUser targetUser, ZegoLiveStreamingRole targetUserRole)?)
-
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