This article describes possible API calls and configurations before joining a channel. Usually, you can quickly implement real-time communications by calling one or two APIs, but if your scenarios require high quality and stability, refer to the additional configurations here.
Unless otherwise specified, this article applies to the following platforms of Agora RTC SDK:
Log file configurations
For easier debugging and to ensure that the SDK outputs complete log files, Agora recommends calling
setLogFile immediately after initializing the Agora service. You can also use
setLogFilter to configure the log file size and output level. See How can I set the log file.
If your scenarios require high-fidelity audio, call
setAudioProfile before joining a channel, and set
GAME_STREAMING(3). See Set the Audio Profile for more configurations.
The SDK disables the video function by default. To enable video, call
enableVideo before joining a channel.
enableVideo enables capturing, encoding, sending the local video, and receiving the remote video. Agora recommends using the following methods for more precise control:
enableLocalVideo: Enables/Disables the local video capture.
muteLocalVideoStream: Stops/Resumes sending the local video stream.
muteRemoteVideoStream: Stops/Resumes receiving a specified remote video stream.
muteAllRemoteVideoStreams: Stops/Resumes receiving all remote video streams.
enableVideobefore joining a channel. Avoid calling both
enableVideobefore joining a channel. This action turns the camera on twice, and it takes longer to join the channel.
enableVideoresets the entire video module, Agora recommends you use the above four APIs to control different phases of video processing.
startPreview before joining a channel reduces the render time of the first video frame. If you have called
startPreview, ensure that you call
Interoperability with the Web SDK
If you are using Native SDKs earlier than v3.0.0 in live interactive streaming scenario, and your scenario involves the RTC SDK for Web, ensure that you call
enableWebSdkInteroperability before joining a channel.