Updated on 2022-10-08 GMT+08:00

Concepts

App ID

The app ID is a unique identifier used by SparkRTC to identify apps. It is automatically generated when an app is created on the SparkRTC console.

Room

A room is an audio and video space where users can receive real-time audio and video from each other.
  • SparkRTC uses virtual rooms to isolate users.
  • Only users in the same room can receive audio and video from each other.
  • The naming rule of a room ID can be customized. A room ID contains 64 characters, including letters, digits, underscores (_), and hyphens (-).

User ID

Unique identifier used by SparkRTC to identify users in an app.

  • A user ID is a representation of a user in SparkRTC and can be customized.
  • A user ID contains 64 characters, including letters, digits, underscores (_), and hyphens (-).

Role

Role of a user in a room. Various roles have different permission models. There are three types of roles:

  • publisher: streamer who sends streams but does not receive streams. It is a role type reserved by SparkRTC.
  • joiner: interactive viewer who sends and receives streams.
  • player: common viewer who only receives streams.

In the SparkRTC demo, the role switch and co-hosting are performed by users of the joiner and player role.

Video Stream

Stream collected by cameras. SparkRTC can encode, receive, and send video streams of up to four resolutions (720p, 360p, 180p, and 90p) from the same source at the same time.

Presentation Stream

Sharing stream, which is the stream of the shared screen or program. The default resolution is 1080p. If the fluency is preferred, the presentation resolution will be changed to 720p.

Stream Mixing

Multiple pushed audio and video streams are combined into a single stream.

Dual Stream Mode

By default, only high-quality streams (720p) are encoded, received, and sent. In dual stream mode, high-quality streams (720p) and low-quality streams (360p) are both encoded, received, and sent.

Subscription

Operation that a user in a room receives audio and video streams from a remote user in the room.

Custom Collection and Rendering

By default, SparkRTC uses system audio and video devices to collect and render data. It also supports custom collection and rendering for screen recording playback, third-party beautification and special effects, and cloud gaming.

Packet Loss

Packet loss occurs when packets of real-time audio and video data traveling across a network fail to reach their destination.

Jitter

Variation in time delay of data packets transmitted continuously over a network connection

Freeze

Intermittent, unsmooth, or even frozen audio or video playback caused by poor network conditions or limited device performance during real-time audio and video transmission

Single Stream Recording

Audio and video streams of each user in a room are recorded as one file.

Mixed Stream Recording

Audio and video of multiple users in a room are mixed and recorded as one file.