RTCRoom class abstract
Room instance
Constructors
- RTCRoom()
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- rangeAudio → RTCRangeAudio
-
Gets range audio instance.
no setter
- roomId → String
-
Gets the room ID.
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- spatialAudio → RTCSpatialAudio
-
Gets spatial audio instance.
no setter
Methods
-
destroy(
) → Future< void> - Exits and destroys the room created by calling RTCVideo.createRTCRoom.
-
joinRoom(
{required String token, required UserInfo userInfo, required RoomConfig roomConfig}) → Future< int?> - Joins the room.
-
leaveRoom(
) → Future< int?> - Leaves the room.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
pauseAllSubscribedStream(
PauseResumeControlMediaType mediaType) → Future< int?> - Pauses receiving remote media streams.
-
pauseForwardStreamToAllRooms(
) → Future< int?> - Pauses relaying media stream to all rooms after calling RTCRoom.startForwardStreamToRooms.
-
publishScreen(
MediaStreamType type) → Future< int?> - Publishes local screen sharing streams in the current room.
-
publishStream(
MediaStreamType type) → Future< int?> - Publishes media streams captured by camera/microphone in the current room.
-
resumeAllSubscribedStream(
PauseResumeControlMediaType mediaType) → Future< int?> - Resumes receiving remote media streams
-
resumeForwardStreamToAllRooms(
) → Future< int?> - Resumes relaying media streams paused by calling RTCRoom.pauseForwardStreamToAllRooms to all rooms.
-
sendRoomBinaryMessage(
Uint8List message) → Future< int?> - Sends binary messages to all other users in the room.
-
sendRoomMessage(
String message) → Future< int?> - Sends text messages to all other users in the room.
-
sendUserBinaryMessage(
{required String uid, required Uint8List message, required MessageConfig config}) → Future< int?> - Sends a binary message (P2P) to the specified user in the room.
-
sendUserMessage(
{required String uid, required String message, required MessageConfig config}) → Future< int?> - Sends a text message (P2P) to the specified user in the room.
-
setAudioSelectionConfig(
AudioSelectionPriority audioSelectionPriority) → Future< int?> - Valid since v3.56.1
-
setMultiDeviceAVSync(
String audioUid) → Future< int?> - Synchronizes published audio and video.
-
setRemoteRoomAudioPlaybackVolume(
int volume) → Future< int?> - Adjusts the audio playback volume from all the remote users in a room.
-
setRemoteVideoConfig(
{required String uid, required RemoteVideoConfig videoConfig}) → Future< int?> - Sets your expected configuration of the remote video stream that you want to subscribe to or have subscribed to.
-
setRoomExtraInfo(
{required String key, required String value}) → Future< int?> - Valid since v3.56.1
-
setRTCRoomEventHandler(
RTCRoomEventHandler eventHandler) → void - Sets the event handler to monitor callback events in the room.
-
setUserVisibility(
bool enable) → Future< int?> - Sets user visibility. The local user is visible to others by default before calling this API.
-
startForwardStreamToRooms(
List< ForwardStreamInfo> forwardStreamInfos) → Future<int?> - Starts relaying media stream across rooms.
-
stopForwardStreamToRooms(
) → Future< int?> - Stops relaying media streams to all rooms after calling RTCRoom.startForwardStreamToRooms
-
subscribeAllStreams(
MediaStreamType type) → Future< int?> - Subscribes to all remote media streams captured by camera/microphone, or updates the subscribe options of all subscribed user.
-
subscribeScreen(
{required String uid, required MediaStreamType type}) → Future< int?> - Subscribes to specific screen sharing media stream, or update subscription options.
-
subscribeStream(
{required String uid, required MediaStreamType type}) → Future< int?> - Subscribes to specific remote media streams captured by camera/microphone, or updates subscription options.
-
toString(
) → String -
A string representation of this object.
inherited
-
unpublishScreen(
MediaStreamType type) → Future< int?> - Stops publishing local screen sharing streams in the current room.
-
unpublishStream(
MediaStreamType type) → Future< int?> - Stops publishing media streams captured by camera/microphone in the current room.
-
unsubscribeAllStreams(
MediaStreamType type) → Future< int?> - Unsubscribes from all remote media streams captured by camera/microphone.
-
unsubscribeScreen(
{required String uid, required MediaStreamType type}) → Future< int?> -
Unsubscribes from specific screen sharing media stream.
You can call this API in both automatic subscription mode and manual subscription mode. -
unsubscribeStream(
{required String uid, required MediaStreamType type}) → Future< int?> -
Unsubscribes from specific remote media streams captured by camera/microphone.
You can call this API in both automatic subscription mode and manual subscription mode. -
updateForwardStreamToRooms(
List< ForwardStreamInfo> forwardStreamInfos) → Future<int?> - Updates information of the rooms where you want to relay the media stream to after calling RTCRoom.startForwardStreamToRooms.
-
updateToken(
String token) → Future< int?> - Updates Token.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited