RoomProfile enum

Room mode

Inheritance

Constructors

RoomProfile()
const

Values

communication → const RoomProfile

Communication mode(default)

game → const RoomProfile

Game voice mode.

Low consumption of computing resources and network data.
Additional performance optimizations have been made for low-end devices:

  • Encodes frame length 40/60 for some low-end models.
  • Disables software 3A audio processing for some low-end models. Enhance iOS Compatibility with other screen recordings to avoid audio recordings being interrupted by RTC.
cloudGame → const RoomProfile

Cloud game mode.

Use this mode for game App requiring low latency.
In this mode, the call latency will be significantly reduced, but at the same time, weak network resistance and call sound quality will be affected to a certain extent, so before using this mode, it is highly recommended to consult technical support.

lowLatency → const RoomProfile

Cloud render mode featuring extra-low latency.

Choose this mode if it is not a game App yet requires low latency.
In this mode, latency will significantly decrease at the cost of lower audio quality as well as the bad performance with weak network signal.

chat → const RoomProfile

For 1 vs 1 video and audio calls

chatRoom → const RoomProfile

For voice calls only with 3 or more people

lwTogether → const RoomProfile

For scenarios such as "Watch together" and "Listen together". Multiple clients are capable of playing the same videos and audios synchronically.

In this mode, RTC does not involve the transportation of the sharing media but only synchronizes video/music playback across multiple clients via signaling.

gameHD → const RoomProfile

For game apps demanding high-resolution audio. In this mode, RTC plays audio using the media mode only.

coHost → const RoomProfile

For the events of co-hosting in the live-streaming.

During a livestreaming using a CDN network, one host can invite another host to join the co-hosting event using RTC.

interactivePodcast → const RoomProfile

For interactive podcasts that the host can have video and audio interactions with the audience.

Using communication mode, and whether to co-host or not will not have mode switching to avoid sudden volume changes.

ktv → const RoomProfile

For the online karaoke with high-quality audio and low latency.

In these scenarios, RTC transports the accompaniment and mixed audio, such as solo and non-realtime chorus.

chorus → const RoomProfile

For the online-chorusing scenarios requiring high-quality audio and low latency.

Contact our technical specialists before you apply it to your App.

vrChat → const RoomProfile

For VR chat.

This mode supports audio sampling rates up to 192 KHz, with the ability to turn on spherical stereo.
Available in 3.46 and later versions.

gameStreaming → const RoomProfile

For scenarios of streaming live videos to only one client on the LAN. It can be applied to devices on the Internet or LAN.

lanLiveStreaming → const RoomProfile

For 1-to-many live video streaming for LANs.

Maximum supported resolution is 8K, frame rate is 60fps, and bit rate is 100 Mbps.
A private media server is needed on the LAN.

meeting → const RoomProfile

For meeting Apps installed on personal devices.

meetingRoom → const RoomProfile

For meeting Apps installed on terminals of meeting rooms.

classroom → const RoomProfile

For the online classrooms and lectures that over 10 participants in the room are allowed to join the video chat.

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

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

Constants

values → const List<RoomProfile>
A constant List of the values in this enum, in order of their declaration.