AgoraChannelData class Null safety
Use this class to define the properties of a channel and the behaviour of a user inside that channel.
Constructors
- AgoraChannelData({ChannelProfile? channelProfile, ClientRole? clientRole, VideoEncoderConfiguration? videoEncoderConfiguration, bool? setCameraAutoFocusFaceModeEnabled, bool? enableDualStreamMode, StreamFallbackOptions? localPublishFallbackOption, StreamFallbackOptions? remoteSubscribeFallbackOption, AudioProfile? audioProfile, AudioScenario? audioScenario, BeautyOptions? setBeautyEffectOptions, bool? setCameraTorchOn, bool? muteAllRemoteAudioStreams, bool? muteAllRemoteVideoStreams, bool isActiveSpeakerDisabled = false})
Properties
- audioProfile ↔ AudioProfile?
-
Sets the audio parameters and application scenarios. [...]
read / write
- audioScenario ↔ AudioScenario?
-
Sets the audio parameters and application scenarios. [...]
read / write
- channelProfile → ChannelProfile?
-
The Agora RtcEngine differentiates channel profiles and applies different optimization algorithms accordingly. [...]
final
- clientRole ↔ ClientRole?
-
Sets the role of a user in a live interactive streaming.
This method applies only when channelProfile is set to ChannelProfile.LiveBroadcasting [...]
read / write
- enableDualStreamMode ↔ bool?
-
Enables/Disables the dual video stream mode. [...]
read / write
- hashCode → int
-
The hash code for this object. [...]
read-only, inherited
- isActiveSpeakerDisabled → bool
-
Active Speaker method automatically pins the active speaker to the main view. By default active speaker is enabled. [...]
final
- localPublishFallbackOption ↔ StreamFallbackOptions?
-
Sets the fallback option for the locally published video stream based on the network conditions. [...]
read / write
- muteAllRemoteAudioStreams ↔ bool?
-
Stops/Resumes receiving all remote video streams. [...]
read / write
- muteAllRemoteVideoStreams ↔ bool?
-
Stops/Resumes receiving all remote audio streams. [...]
read / write
- remoteSubscribeFallbackOption ↔ StreamFallbackOptions?
-
Sets the fallback option for the remotely subscribed video stream based on the network conditions. [...]
read / write
- runtimeType → Type
-
A representation of the runtime type of the object.
read-only, inherited
- setBeautyEffectOptions ↔ BeautyOptions?
-
Enhancess the image being streamed on the channel. [...]
read / write
- setCameraAutoFocusFaceModeEnabled ↔ bool?
-
Enables the camera auto-face focus function. [...]
read / write
- setCameraTorchOn ↔ bool?
-
Enables the camera flash function. [...]
read / write
- videoEncoderConfiguration ↔ VideoEncoderConfiguration?
-
Each video encoder configuration corresponds to a set of video parameters, including the resolution, frame rate, bitrate, and video orientation. [...]
read / write
Methods
-
copyWith(
{ChannelProfile? channelProfile, ClientRole? clientRole, VideoEncoderConfiguration? videoEncoderConfiguration, bool? setCameraAutoFocusFaceModeEnabled, bool? enableDualStreamMode, StreamFallbackOptions? localPublishFallbackOption, StreamFallbackOptions? remoteSubscribeFallbackOption, AudioProfile? audioProfile, AudioScenario? audioScenario, BeautyOptions? setBeautyEffectOptions, bool? setCameraTorchOn, bool? muteAllRemoteVideoStreams, bool? muteAllRemoteAudioStreams, bool? isActiveSpeakerDisabled}) → AgoraChannelData -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed. [...]
inherited
-
toString(
) → String -
A string representation of this object. [...]
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator. [...]
inherited