logo
On this page

How to handle issues when integrating Express SDK?

2023-04-11
Products / Plugins:Video Call / Audio Call / Live streaming
Platform / Framework:iOS / Android / macOS / Windows / Web / Electron

When integrating through "jCenter" on the Android platform, the "jCenter" dependency fails with the error: "Failed to resolve
.zego:express-audio
.x.x"?

Please confirm whether the SDK version you are depending on is the latest version. Check the current SDK version through SDK Release History. If it is not the latest version, the dependency will fail.

Why does the Electron platform fail to load the SDK when using the "Electron-Vue" framework?

The "Vue" framework needs to use "Webpack", and change the "require" parameter of "Webpack" to "window.require".

How to determine hardware support and permission authorization on the Web platform?

Hardware support can be determined through the checkSystemRequirements interface by obtaining "CapabilityDetection".

When calling the createEngine interface to create an engine, how to set the application scenario "scenario" that the App belongs to?

When calling the createEngine interface to create an engine, you need to set the application scenario through the "scenario" parameter. ZEGO Express SDK provides the following three scenarios. The preset values of ZegoAudioConfig class and ZegoEngineConfig class are different in different scenarios. For details, please refer to the table below. Developers can choose based on the actual needs of the App they are developing.

Note

If developers have customized scenario requirements, they can call the setAudioConfig interface to modify the CodecID property in the ZegoAudioConfig class, and contact ZEGOCLOUD Technical Support to modify the advancedConfig property in the ZegoEngineConfig class of the setEngineConfig interface.

Note
macOS and Windows platforms do not need to pay attention to the setAudioDeviceMode interface.
Enum ValuePreset ValueDetailsBusiness Scenario Recommendation
GENERAL (General Scenario)ZegoAudioConfig class "CodecID" property preset to "Normal2"
  • Default encoding bitrate: 48 kbps
  • Bitrate range: 16 kbps ~ 192 kbps
  • Support for dual channel: Yes
  • Latency: Around 500ms
  • Supported protocols: ZEGO proprietary protocol and RTMP protocol
  • Purpose: Can be used for RTC and CDN stream publishing
  • Transcoding description: Server-side transcoding is required when interoperating with Web SDK. Server-side cloud transcoding is not required when pushing to CDN.
  • Music radio
  • 1 V 1 music
setAudioDeviceMode specified parameter as "General"
  • Microphone status when on mic: Occupied
  • Microphone status when off mic: Released
  • Volume when on mic: Media
  • Volume when off mic: Media
COMMUNICATION (Real-time Communication)ZegoAudioConfig class "CodecID" property preset to "Low3"
  • Default encoding bitrate: 48 kbps
  • Bitrate range: 6 kbps ~ 192 kbps
  • Support for dual channel: Yes
  • Latency: Around 200ms
  • Supported protocols: ZEGO proprietary protocol
  • Purpose: RTC stream publishing only
  • Transcoding description: Server-side transcoding is required when interoperating with Web SDK. Server-side cloud transcoding is not required when pushing to CDN.
  • Voice chat room
  • Game team chat
  • Small class
  • 1 V 1 subject
  • Super small class
  • AI classroom
setAudioDeviceMode specified parameter as "Communication2"
  • Microphone status when on mic: Occupied
  • Microphone status when off mic: Occupied
  • Volume when on mic: Call
  • Volume when off mic: Call
LIVE (Live Streaming Scenario)ZegoAudioConfig class "CodecID" property preset to "Normal2"
  • Default encoding bitrate: 48 kbps
  • Bitrate range: 16 kbps ~ 192 kbps
  • Support for dual channel: Yes
  • Latency: Around 500ms
  • Supported protocols: ZEGO proprietary protocol and RTMP protocol
  • Purpose: Can be used for RTC and CDN stream publishing
  • Transcoding description: Server-side transcoding is required when interoperating with Web SDK. Server-side cloud transcoding is not required when pushing to CDN.
  • Show live streaming
  • E-commerce live streaming
  • Game live streaming
  • General live streaming
  • Large class
setAudioDeviceMode specified parameter as "Communication3"
  • Microphone status when on mic: Occupied
  • Microphone status when off mic: Released
  • Volume when on mic: Call
  • Volume when off mic: Media

Previous

Why is the whiteboard or file content seen on each end out of sync?

Next

How to get the log information of the ZegoEffects SDK?