AgoraChannelData class

Use this class to define the properties of a channel and the behaviour of a user inside that channel.

Constructors

AgoraChannelData({ChannelProfileType channelProfileType = ChannelProfileType.channelProfileCommunication, ClientRoleType clientRoleType = ClientRoleType.clientRoleBroadcaster, VideoEncoderConfiguration? videoEncoderConfiguration, bool setCameraAutoFocusFaceModeEnabled = false, bool enableDualStreamMode = false, StreamFallbackOptions? localPublishFallbackOption, StreamFallbackOptions? remoteSubscribeFallbackOption, AudioProfileType audioProfileType = AudioProfileType.audioProfileDefault, AudioScenarioType audioScenarioType = AudioScenarioType.audioScenarioDefault, BeautyOptions? setBeautyEffectOptions, bool setCameraTorchOn = false, bool muteAllRemoteAudioStreams = false, bool muteAllRemoteVideoStreams = false, bool isActiveSpeakerDisabled = false})

Properties

audioProfileType ↔ AudioProfileType

Sets the audio parameters and application scenarios.

getter/setter pair

audioScenarioType ↔ AudioScenarioType

Sets the audio parameters and application scenarios.

getter/setter pair

channelProfileType → ChannelProfileType

The Agora RtcEngine differentiates channel profiles and applies different optimization algorithms accordingly.

final

clientRoleType ↔ ClientRoleType

Sets the role of a user in a live interactive streaming. This method applies only when channelProfileType is set to ChannelProfileType.channelProfileLiveBroadcasting

getter/setter pair

enableDualStreamMode ↔ bool

Enables/Disables the dual video stream mode.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, 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.

getter/setter pair

muteAllRemoteAudioStreams ↔ bool

Stops/Resumes receiving all remote video streams.

getter/setter pair

muteAllRemoteVideoStreams ↔ bool

Stops/Resumes receiving all remote audio streams.

getter/setter pair

remoteSubscribeFallbackOption ↔ StreamFallbackOptions?

Sets the fallback option for the remotely subscribed video stream based on the network conditions.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

setBeautyEffectOptions ↔ BeautyOptions?

Enhancess the image being streamed on the channel.

getter/setter pair

setCameraAutoFocusFaceModeEnabled ↔ bool

Enables the camera auto-face focus function.

getter/setter pair

setCameraTorchOn ↔ bool

Enables the camera flash function.

getter/setter pair

videoEncoderConfiguration ↔ VideoEncoderConfiguration?

Each video encoder configuration corresponds to a set of video parameters, including the resolution, frame rate, bitrate, and video orientation.

getter/setter pair

Methods

copyWith({ChannelProfileType? channelProfileType, ClientRoleType? clientRoleType, VideoEncoderConfiguration? videoEncoderConfiguration, bool? setCameraAutoFocusFaceModeEnabled, bool? enableDualStreamMode, StreamFallbackOptions? localPublishFallbackOption, StreamFallbackOptions? remoteSubscribeFallbackOption, AudioProfileType? audioProfileType, AudioScenarioType? audioScenarioType, BeautyOptions? setBeautyEffectOptions, bool? setCameraTorchOn, bool? muteAllRemoteVideoStreams, bool? muteAllRemoteAudioStreams, bool? isActiveSpeakerDisabled}) → AgoraChannelData

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