RtcChannel class

The RtcChannel class.

Properties

channelId → String

The ID of RtcChannel

final

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

adjustUserPlaybackSignalVolume(String uid, int volume) → Future<void>

Adjusts the playback volume of a specified remote user.

destroy() → Future<void>

Destroys the RtcChannel instance.

getCallId() → Future<String?>

joinChannel(String token, String optionalUid, ChannelMediaOptions options) → Future<void>

Joins the channel with a user ID.

leaveChannel() → Future<void>

Leaves the current channel.

muteAllRemoteAudioStreams(bool muted) → Future<void>

Stops/Resumes receiving all remote audio streams.

muteAllRemoteVideoStreams(bool muted) → Future<void>

Stops/Resumes receiving all remote video streams.

muteRemoteAudioStream(String uid, bool muted) → Future<void>

Stops/Resumes receiving the audio stream of the specified user.

muteRemoteVideoStream(String uid, bool muted) → Future<void>

Stops/Resumes receiving the video stream of the specified user.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

publish() → Future<void>

Publishes the local stream to the channel.

renewToken(String token) → Future<void>

Renews the token when the current token expires.

setClientRole(ClientRole role) → Future<void>

Sets the role of a user.

setDefaultMuteAllRemoteAudioStreams(bool muted) → Future<void>

Sets whether to receive all remote audio streams by default.

setDefaultMuteAllRemoteVideoStreams(bool muted) → Future<void>

Sets whether to receive all remote video streams by default.

setEventHandler(RtcChannelEventHandler handler) → void

Sets the channel event handler.

setRemoteDefaultVideoStreamType(VideoStreamType streamType) → Future<void>

Sets the default video-stream type of the remote video stream when the remote user sends dual streams. Parameter streamType Sets the default video-stream type. See VideoStreamType.

setRemoteVideoStreamType(String uid, VideoStreamType streamType) → Future<void>

Sets the video stream type of the remote video stream when the remote user sends dual streams.

toString() → String

A string representation of this object.

inherited

unpublish() → Future<void>

Stops publishing a stream to the channel.

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

create(String channelId) → Future<RtcChannel>

Creates and gets an RtcChannel instance.

destroyAll() → void

Destroys all RtcChannel instance.