- Release Notes and Announcements
- Release Notes
- TRTC Conference Official Editions Launched
- The commercial version of Conference is coming soon
- Terms and Conditions Applicable to $9.9 Starter Package
- Rules for the "First Subscription $100 Discount" Promotion
- Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
- TRTC Call Official Editions Launched
- License Required for Video Playback in New Version of LiteAV SDK
- TRTC to Offer Monthly Packages
- Product Introduction
- Purchase Guide
- Billing Overview
- RTC-Engine Packages
- TRTC Call Monthly Packages
- TRTC Conference Monthly Packages
- Pay-As-You-Go
- Billing Explanation for Subscription Package Duration
- Billing of On-Cloud Recording
- Billing of MixTranscoding and Relay to CDN
- Free Minutes
- FAQs
- Billing of Monitoring Dashboard
- Billing of Recording Delivery
- Overdue and Suspension Policy
- Refund Policies
- User Tutorial
- Free Demo
- Video Calling (Including UI)
- Overview (TUICallKit)
- Activate the Service（TUICallKit）
- Integration (TUICallKit)
- UI Customization (TUICallKit)
- Offline Call Push (TUICallKit)
- On-Cloud Recording (TUICallKit)
- Additional Features（TUICallKit）
- Server APIs (TUICallKit)
- Client APIs (TUICallKit)
- ErrorCode
- Release Notes (TUICallKit)
- FAQs(TUICallKit)
- Multi-Participant Conference (with UI)
- Live Streaming (Including UI)
- Voice Chat Room (with UI)
- Integration (No UI)
- SDK Download
- API Examples
- Integration Guide
- Client APIs
- Advanced Features
- Relay to CDN
- Enabling Advanced Permission Control
- RTMP Streaming with TRTC
- Utilizing Beautification Effects
- Testing Hardware Devices
- Testing Network Quality
- On-Cloud Recording
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Sending and Receiving Messages
- Event Callbacks
- Access Management
- How to push stream to TRTC room with OBS WHIP
- Server APIs
- Console Guide
- Solution
- FAQs
- Legacy Documentation
- Protocols and Policies
- TRTC Policy
- Glossary
- Release Notes and Announcements
- Release Notes
- TRTC Conference Official Editions Launched
- The commercial version of Conference is coming soon
- Terms and Conditions Applicable to $9.9 Starter Package
- Rules for the "First Subscription $100 Discount" Promotion
- Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
- TRTC Call Official Editions Launched
- License Required for Video Playback in New Version of LiteAV SDK
- TRTC to Offer Monthly Packages
- Product Introduction
- Purchase Guide
- Billing Overview
- RTC-Engine Packages
- TRTC Call Monthly Packages
- TRTC Conference Monthly Packages
- Pay-As-You-Go
- Billing Explanation for Subscription Package Duration
- Billing of On-Cloud Recording
- Billing of MixTranscoding and Relay to CDN
- Free Minutes
- FAQs
- Billing of Monitoring Dashboard
- Billing of Recording Delivery
- Overdue and Suspension Policy
- Refund Policies
- User Tutorial
- Free Demo
- Video Calling (Including UI)
- Overview (TUICallKit)
- Activate the Service（TUICallKit）
- Integration (TUICallKit)
- UI Customization (TUICallKit)
- Offline Call Push (TUICallKit)
- On-Cloud Recording (TUICallKit)
- Additional Features（TUICallKit）
- Server APIs (TUICallKit)
- Client APIs (TUICallKit)
- ErrorCode
- Release Notes (TUICallKit)
- FAQs(TUICallKit)
- Multi-Participant Conference (with UI)
- Live Streaming (Including UI)
- Voice Chat Room (with UI)
- Integration (No UI)
- SDK Download
- API Examples
- Integration Guide
- Client APIs
- Advanced Features
- Relay to CDN
- Enabling Advanced Permission Control
- RTMP Streaming with TRTC
- Utilizing Beautification Effects
- Testing Hardware Devices
- Testing Network Quality
- On-Cloud Recording
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Sending and Receiving Messages
- Event Callbacks
- Access Management
- How to push stream to TRTC room with OBS WHIP
- Server APIs
- Console Guide
- Solution
- FAQs
- Legacy Documentation
- Protocols and Policies
- TRTC Policy
- Glossary
Overview
Last updated: 2018-09-28 16:50:12
The documentation is not available now.
TRTC Web APIs include the feature APIs for active calling and the event notification APIs with trigger setting, wherein the feature APIs include basic feature APIs and advanced feature APIs, and the event notifications include basic event notifications and advanced event notifications. Junior developers can complete basic development access through basic feature APIs and basic event notifications, and can experience the main features of TRTC. Senior developers can complete the development through advanced feature APIs and advanced event notifications, and can experience the advanced features of TRTC.
Basic feature APIs
| API | Description |
|---|---|
| WebRTCAPI.fn.detectRTC | Detects whether it supports WebRTC |
| WebRTCAPI | Initialization |
| WebRTCAPI.enterRoom( WebRTCAPI.createRoom ) | Creates or enters an audio/video room |
| WebRTCAPI.quit | Exits an audio/video room |
Basic event notifications
| Event | Description |
|---|---|
| onLocalStreamAdd | Addition/update of local video stream |
| onRemoteStreamUpdate | Addition/update of remote video stream |
| onRemoteStreamRemove | Disconnection of remote video stream |
| onWebSocketClose | Disconnection of websocket |
| onRelayTimeout | Disconnection of video stream server after timeout |
| onKickout | Forced logout (The same user logged in repeatedly) |
Advanced feature APIs
| API | Description |
|---|---|
| WebRTCAPI.startRTC | Only used for active push |
| WebRTCAPI.stopRtc | Stops the push |
| WebRTCAPI.getLocalStream | Gets local audio/video stream |
| WebRTCAPI.updateStream | Updates video stream |
| WebRTCAPI.openVideo | Turns on video collection again during the push process |
| WebRTCAPI.closeVideo | Temporarily turns off video collection during the push process |
| WebRTCAPI.openAudio | Turns on audio collection again during the push process |
| WebRTCAPI.closeAudio | Temporarily turns off audio collection during the push process |
| WebRTCAPI.changeSpearRole | Switches audio and video parameter settings |
| WebRTCAPI.getVideoDevices | Enumerates video collection devices |
| WebRTCAPI.getAudioDevices | Enumerates audio collection devices |
| WebRTCAPI.chooseVideoDevice | Chooses the video collection device |
| WebRTCAPI.chooseAudioDevice | Chooses the audio collection device |
| WebRTCAPI.SoundMeter | Sound input detection |
Advanced event notifications
| Event | Description |
|---|---|
| onPeerConnectionAdd | Notification of PeerConnection addition. Please make sure you understand the role and significance of peer connection notification |
Update log
2.6.1
## WebRTCAPI.getSpeakerDevices This API is used to enumerate audio output devices ## WebRTCAPI.chooseSpeakerDevice This API is used to enumerate audio output devices
Yes
No
Was this page helpful?