El contenido no se encuentra disponible en el idioma seleccionado. Estamos trabajando continuamente para agregar más idiomas. Gracias por su apoyo.
- What's New
- Product Bulletin
- Service Overview
- Getting Started
- Best Practices
- User Guide
-
API Reference
- Before You Start
- API Overview
- Calling APIs
- Examples
- OBS Bucket Management
- Application callback management
- Single stream recording job management
- Application management
- Automatic recording configuration
- Room management
- Mixed stream recording job management
- Recording rule management
-
Statistical Analysis
- Listing Rooms
- Listing Users
- Querying Real-Time Scale Data
- Querying Real-Time Scale Data Distribution
- Querying Real-Time Quality Data
- Querying Real-Time Network Data
- Querying Usage
- Querying Historical Scale Data
- Querying Historical Quality Data
- Querying User Call Indicators
- Querying Details
- Querying User Experience Exception Events (RCMS Service)
- Queries abnormal user experience events.
- Queries the distribution of users with abnormal events.
- Appendix
- Change History
-
SDK Reference
- Before You Start
- SDK Overview
-
Web SDK
- Browser Adaptation
- Preparations
- SDK Usage
- Basic Usage Logic
-
API Reference
- Main Entry (HRTC)
- Client Object (Client)
- Client Event Notification (ClientEvent)
- Stream Object (Stream)
- Local Stream Object (LocalStream)
- Remote Stream Object (RemoteStream)
- Stream Event Notification (RTCStreamEvent)
- Error Code (RtcError)
- Error Codes Reported on the Client
- Server Error Codes
- Granting the Permissions of Accessing Cameras or Microphones to a Browser
- FAQ
- Change History
- Access Authentication
- Appendix
-
FAQs
-
About SparkRTC
- What Is SparkRTC?
- What Are the Differences Between Real-Time Audio and Video and Livestreaming?
- Can SparkRTC Be Used Outside China?
- What Is SparkRTC RoomID and How Can I Name One?
- How Many Rooms Can Be Created in SparkRTC at Most at a Time?
- What Is SparkRTC UserID and How Can I Name One?
- What Are the Roles of SparkRTC?
- How Many Participants Are Allowed by SparkRTC in a Video Call?
- What Is the Latency of SparkRTC?
- Does SparkRTC Support Co-Hosting?
- Does SparkRTC Support Bidirectional Desktop Stream Push?
- Does SparkRTC Support Private Deployment?
- Does SparkRTC Support USB Cameras on PCs?
-
Billing
- When I Subscribe to SparkRTC Video and Audio Services, Is the Video Charged by Resolution Plus the Audio Charge?
- Does the Billing Vary with Bitrates When There Are Only Audios?
- How Do I View Bills and Fee Deduction Details?
- Can I Use the Postpaid Billing Mode?
- Why Am I Charged Even When There Is Only One Person in the Room and There Is No Audio/video Call?
- Signature
- Recording
-
SDK Usage
- Is Video Snapshot Capturing Supported?
- How Do I Create a Room?
- Why Can't the SparkRTC Apps Running on Two Mobile Phones Communicate with Each Other?
- How and When Is Authentication Signature Generated?
- Why Does the Program Crash when the onVideoStats, onAudioStatus, or onSubStreamStats Callback Is Triggered?
- Why Can I Hear My Own Voice from the Local Receiver?
- Can I Call setExternalAudioCapture, setExternalVideoCapture, or setExternalMediaFrameOutput After Entering a Room?
- Does SparkRTC Support Video Mirroring?
- How Do I Obtain Data Such as the Uplink and Downlink Bitrates, Resolution, Packet Loss Rate, and Audio Sampling Rate During an Audio/Video Call?
- Can I Set the Call Volume of a Local User? Can I Set the Playback Volume of Each Remote User?
- What Is the Difference Between enableLocalVideo and muteLocalVideo?
- What Is the Difference Between enableLocalAudioStream and muteLocalAudio?
- Does SparkRTC Support Permission Verification for Rooms?
- Does the PC Support Screen Sharing?
- Does SparkRTC Allow Others Users to View a Local Video During Real-Time Communications?
- Can I View Only Real-Time Audio Streams on SparkRTC?
- Can More Than One Presentation Stream Be Shared in a Room?
- Does SparkRTC Support 1080p?
- Can I Play Online Music for Background Music?
- Can I Create N RTC Objects on the Same Page and Log In to N Rooms Using N User IDs?
- Is the Streaming Resolution (Width and Height) on the Web Client Applicable to All Browsers?
- How Do I Clear Data in the Camera List After a Camera Is Removed from the SDK on the Web Client?
- Can the SDK on the Web Client Obtain the Current Volume?
- Can I Receive Notifications on a Web Client When a Remote User Leaves a Room?
- Why Is There Echo, Undesired Sound, Noise, or Low Volume During a Call on the Web Client?
- How Do I Switch to Another Camera or Microphone on the Web Client?
- Does SparkRTC Support the Whiteboard Function?
- Can I Enter Multiple Rooms with the Same User ID?
- How Long Is the Lifecycle of a Room on SparkRTC?
- Can I Use Bluetooth Headsets for Video Calls on SparkRTC?
- Can I Subscribe to Only Audio of 2/3/4 Participants During a Video Call?
- Will the Resolution of the Video Stream Change When the Size of a Specified Shared Window Changes?
- Can I Switch Between the Floating Window and Large and Small Windows During a Video Call?
- Can I Use the API for Sending Customized Messages to Implement Functions Such as Chat Rooms and On-Screen Comments?
- Can I Query All User IDs?
- Why Can't I Call the checkSystemRequirements API in the Web SDK?
-
Troubleshooting
- Why Can't I Hear When Joining a Meeting?
- Why Does Video Freezing Occur?
- What Do I Do If a Black Screen Occurs During Video Playback?
- Why Can't I Use the Camera?
- Why Can't I Join Another Room?
- What Do I Do If No Recording File Is Generated After SparkRTC Enables Cloud Recording?
- Why Can't I Join a Room?
-
About SparkRTC
- General Reference
Copied.
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
- 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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot
