ZegoUIKitPrebuiltLiveStreamingConfig class
Configuration for initializing the Live Streaming
This class is used as the ZegoUIKitPrebuiltLiveStreaming.config parameter for the constructor of ZegoUIKitPrebuiltLiveStreaming.
Constructors
-
ZegoUIKitPrebuiltLiveStreamingConfig({bool turnOnCameraWhenJoining = true, bool useFrontFacingCamera = true, bool turnOnMicrophoneWhenJoining = true, bool useSpeakerWhenJoining = true, bool markAsLargeRoom = false, bool slideSurfaceToHide = true, bool showBackgroundTips = false, Map<
String, String> advanceConfigs = const {}, ZegoLayout? layout, Widget? foreground, Widget? background, ZegoLiveStreamingDialogInfo? confirmDialogInfo, ZegoBeautyPluginConfig? beauty, ZegoLiveStreamingSwipingConfig? swiping, ZegoAvatarBuilder? avatarBuilder, ZegoAudioVideoResourceMode? audienceAudioVideoResourceMode, @Deprecated('Use coHost.maxCoHostCount instead$deprecatedTipsV340') int? maxCoHostCount, @Deprecated('Use coHost.stopCoHostingWhenMicCameraOff instead$deprecatedTipsV340') bool? stopCoHostingWhenMicCameraOff, @Deprecated('Use coHost.disableCoHostInvitationReceivedDialog instead$deprecatedTipsV340') bool? disableCoHostInvitationReceivedDialog, @Deprecated('Use coHost.turnOnCameraWhenCohosted instead$deprecatedTipsV340') bool turnOnCameraWhenCohosted()?, ZegoUIKitPrebuiltLiveStreamingInnerText? translationText, ZegoUIKitVideoConfig? video, ZegoLiveStreamingAudioVideoViewConfig? audioVideoView, ZegoLiveStreamingEffectConfig? effect, ZegoLiveStreamingMemberListConfig? memberList, ZegoLiveStreamingMemberButtonConfig? memberButton, ZegoLiveStreamingDurationConfig? duration, ZegoLiveStreamingInRoomMessageConfig? message, ZegoLiveStreamingTopMenuBarConfig? topMenuBar, ZegoLiveStreamingBottomMenuBarConfig? bottomMenuBar, ZegoLiveStreamingPreviewConfig? preview, ZegoLiveStreamingPKBattleConfig? pkBattle, ZegoLiveStreamingMediaPlayerConfig? media, ZegoLiveStreamingCoHostConfig? coHost}) -
ZegoUIKitPrebuiltLiveStreamingConfig.audience({List<
IZegoUIKitPlugin> ? plugins}) - Default initialization parameters for the audience.
-
ZegoUIKitPrebuiltLiveStreamingConfig.host({List<
IZegoUIKitPlugin> ? plugins}) - Default initialization parameters for the host. If a configuration item does not meet your expectations, you can directly override its value.
Properties
-
advanceConfigs
↔ Map<
String, String> -
Set advanced engine configuration, Used to enable advanced functions.
For details, please consult ZEGO technical support.
getter/setter pair
- audienceAudioVideoResourceMode ↔ ZegoAudioVideoResourceMode?
-
audio video resource mode for audience
getter/setter pair
- audioVideoView ↔ ZegoLiveStreamingAudioVideoViewConfig
-
Configuration options for audio/video views.
getter/setter pair
- avatarBuilder ↔ ZegoAvatarBuilder?
-
Use this to customize the avatar, and replace the default avatar with it.
getter/setter pair
- background ↔ Widget?
-
The background of the live streaming.
getter/setter pair
- beauty ↔ ZegoBeautyPluginConfig?
-
advance beauty config
getter/setter pair
- bottomMenuBar ↔ ZegoLiveStreamingBottomMenuBarConfig
-
Configuration options for the bottom menu bar (toolbar).
getter/setter pair
- coHost ↔ ZegoLiveStreamingCoHostConfig
-
co-cohost config
getter/setter pair
- confirmDialogInfo ↔ ZegoLiveStreamingDialogInfo?
-
Confirmation dialog information when leaving the live streaming.
getter/setter pair
- duration ↔ ZegoLiveStreamingDurationConfig
-
Live Streaming timing configuration.
getter/setter pair
- effect ↔ ZegoLiveStreamingEffectConfig
-
Configuration options for voice changer, beauty effects and reverberation effects.
getter/setter pair
- foreground ↔ Widget?
-
The foreground of the live streaming.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- innerText ↔ ZegoUIKitPrebuiltLiveStreamingInnerText
-
Configuration options for modifying all text content on the UI.
getter/setter pair
- inRoomMessage ↔ ZegoLiveStreamingInRoomMessageConfig
-
Control options for the bottom-left message list.
getter/setter pair
- layout ↔ ZegoLayout?
-
Layout-related configuration. You can choose your layout here. such as
layout = ZegoLayout.gallery()
getter/setter pair - markAsLargeRoom ↔ bool
-
Mark is large room or not
getter/setter pair
- mediaPlayer ↔ ZegoLiveStreamingMediaPlayerConfig
-
Configuration options for media player.
getter/setter pair
- memberButton ↔ ZegoLiveStreamingMemberButtonConfig
-
Configuration related to the top member button
getter/setter pair
- memberList ↔ ZegoLiveStreamingMemberListConfig
-
Configuration related to the bottom member list, including displaying the member list, member list styles, and more.
getter/setter pair
- pkBattle ↔ ZegoLiveStreamingPKBattleConfig
-
Used to configure the parameters related to PK battles
if you want to listen event, please refer ZegoUIKitPrebuiltLiveStreamingEvents.pk
getter/setter pair
-
plugins
↔ List<
IZegoUIKitPlugin> -
Plugins, currently supports signaling, beauty.
if you need cohost function, you need to install
ZegoUIKitSignalingPlugin
getter/setter pair - preview ↔ ZegoLiveStreamingPreviewConfig
-
Used to configure the parameters related to the preview of the live streaming.
getter/setter pair
- role ↔ ZegoLiveStreamingRole
-
Specifies the initial role when joining the live streaming.
The role change after joining is not constrained by this property.
getter/setter pair
-
same as Flutter's Navigator's param
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showBackgroundTips ↔ bool
-
show background tips of live or not, default tips is 'No host is online.'
getter/setter pair
- slideSurfaceToHide ↔ bool
-
set whether the surface can be slid to hide, including the top toolbar, bottom toolbar, message list, and foreground
getter/setter pair
- swiping ↔ ZegoLiveStreamingSwipingConfig?
-
swiping config, if you wish to use swiping, please configure this config.
if it is null, this swiping will not be enabled.
the
liveID
will be the initial live id of swipinggetter/setter pair - topMenuBar ↔ ZegoLiveStreamingTopMenuBarConfig
-
Configuration options for the top menu bar (toolbar).
getter/setter pair
- turnOnCameraWhenJoining ↔ bool
-
Whether to open the camera when joining the live streaming.
getter/setter pair
- turnOnMicrophoneWhenJoining ↔ bool
-
Whether to open the microphone when joining the live streaming.
getter/setter pair
- useFrontFacingCamera ↔ bool
-
if you want to join the video conference with your front camera, set this value to true.
The default value is
true
.getter/setter pair - useSpeakerWhenJoining ↔ bool
-
Whether to use the speaker to play audio when joining the live streaming.
getter/setter pair
- video ↔ ZegoUIKitVideoConfig
-
configuration parameters for audio and video streaming, such as Resolution, Frame rate, Bit rate..
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