SparkRTC
SparkRTC
All results for "
" in this service
All results for "
" in this service
What's New
Product Bulletin
Version Planning
[Discontinuation Notice] Discontinuation of SparkRTC Client SDKs
Service Overview
What Is SparkRTC?
Product Advantages
Scenarios
Functions
Constraints
Concepts
Getting Started
Getting Started
Best Practices
Cloud Recording and Playback
Overview
Single Stream Recording
Mixed Stream Recording
Implementing Audio and Video Calls
Web
Screen Sharing
Call Quality Monitoring
Playing an Audio File
Switching the Audio Mode
User Guide
Functions
App Management
Cloud Recording Management
Configuring a Recording Rule
Configuring Recording Callback
Analytics (Beta)
Calls
Data Insights
Real-Time Data
Diagnostics
Duration Statistics
OBS Authorization
API Reference
Before You Start
API Overview
Calling APIs
Making an API Request
Authentication
Response
Examples
Example 1: Creating a Single Stream Recording Job
Example 2: Creating a Mixed Stream Recording Job
OBS Bucket Management
Querying the OBS Bucket List
Querying the Object List in an OBS Bucket
Authorizing and Canceling OBS Bucket Authorization
Application callback management
Configuring a Recording Event Callback
Querying a Recording Event Callback
Single stream recording job management
Starting a Single Stream Recording Job
Querying a Single Stream Recording Job
Stopping a Single Stream Recording Job
Updates a single stream recording job
Application management
Creating an Application
Listing Applications
Querying an Application
Deleting an Application
Enabling an Application
Disabling an Application
Automatic recording configuration
Updating the Automatic Recording Configuration
Querying the Automatic Recording Configuration
Room management
Removes an online user.
Dismisses a room.
Mixed stream recording job management
Starting a Mixed Stream Recording Job
Querying a Mixed Stream Recording Job
Modifying a Mixed Stream Recording Job
Stopping a Mixed Stream Recording Job
Recording rule management
Creating or Updating a Recording Rule
Listing Recording Rules
Querying a Recording Rule
Updating a Recording Rule
Deleting a Recording Rule
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
Status Codes
Error Codes
Obtaining a Project ID
Obtaining an Account ID
Region Name Abbreviations
Receiving a Recording Event Callback Notification
Change History
SDK Reference
Before You Start
Main Functions
How to Use This Document
FAQs
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
GRS Country Codes
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
What Is Signature?
How Do I Obtain a Key?
How Does the Server Calculate the Value of signature?
Recording
Does SparkRTC Support Recording on the Local Server?
What Are the Differences Between Single Stream Recording and Mixed Stream Recording?
How Do I Restore a Deleted Recording File?
How Do I Authenticate a Recording Callback?
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?
General Reference
Glossary
Service Level Agreement
White Papers
Endpoints
Permissions