If the number of receivable streams exceeds the set value, the local user receives the
After calling
After calling
After successfully calling this method, you will receive the
To play the media file from a specific position, do the following:
After successfully setting the spatial audio effect parameters of the media player, the SDK enables the spatial audio effect for the media player, and the local user can hear the media resources with a sense of space.
-If you need to disable the spatial audio effect for the media player, set the
If you need to disable the spatial audio effect for the media player, set
调用该方法停止播放后，如需重新播放，需要调用
When the method call succeeds, there is no return value; when fails, the
You can call this method to adjust the playback volume of a specified remote user. To adjust the playback volume of different remote users, call the method as many times, once for each remote user.
+You can call this method to adjust the playback volume of a specified remote user. To adjust the playback volume of different remote users, call the method as many times, once for each remote user.
After calling
This method can be called either before or after joining the channel.
+None.
+Call this method after joining a channel.
+You can call this method either before or after joining a channel.
Before calling any APIs in the
Before calling any APIs in the
After enabling the spatial audio effect, you can call
After enabling the spatial audio effect, you can call to set
Monotonic Time refers to a monotonically increasing time series whose value increases over time. The unit is milliseconds.
In custom video capture and custom audio capture scenarios, in order to ensure audio and video synchronization, Agora recommends that you call this method to obtain the current Monotonic Time of the SDK, and then pass this value into the timestamp parameter in the captured video frame (
This method can be called either before or after joining the channel.
+None.
+This method must be called after the SDK triggers the
None.
+A successful method call triggers the
The SDK disables face autofocus by default. To set face autofocus, call this method.
+The SDK disables face autofocus by default. To set face autofocus, call this method.
The SDK enables face autofocus by default. To set face autofocus, call this method.
-By default, the SDK disables face autofocus on Android and enables face autofocus on iOS. To set face autofocus, call this method.
-By default, the SDK disables face autofocus on Android and enables face autofocus on iOS. To set face autofocus, call this method.
+None.
+Whether to enable face autofocus:
To adjust the camera focal length configuration, It is recommended to call
Due to limitations on some Android devices, even if you set the focal length type according to the results returned in
Call this method before enabling local camera capture, such as before calling
None.
+Call this method after
None.
+In a spatial audio effect scenario, if the preset headphone equalization effect is not achieved after calling the
In a spatial audio effect scenario, if the preset headphone equalization effect
Call this method after
None.
+
In music education, physical education and other scenarios, teachers usually need to use a metronome so that students can practice with the correct beat. The meter is composed of a downbeat and upbeats. The first beat of each measure is called a downbeat, and the rest are called upbeats.
-In this method, you need to set the file path of the upbeat and downbeat, the number of beats per measure, the beat speed, and whether to send the sound of the metronome to remote users.
-After successfully calling this method, the SDK triggers the
In music education, physical education and other scenarios, teachers usually need to use a metronome so that students can practice with the correct beat. The meter is composed of a downbeat and upbeats. The first beat of each measure is called a downbeat, and the rest are called upbeats.
+This method can be called either before or after joining the channel.
+None.
+You can call this method to dynamically switch cameras based on the actual camera availability during the app's runtime, without having to restart the video stream or reconfigure the video source.
-You can call this method to dynamically switch cameras based on the actual camera availability during the app's runtime, without having to restart the video stream or reconfigure the video source.
+This method and
This method must be called after the camera is successfully enabled, that is, after the SDK triggers the
This method only switches the camera for the video stream captured by the first camera, that is, the video source set to
This method and
调用
You can call this method either before or after joining a channel.
+None.
+You can call this method to adjust the playback volume of a specified remote user. To adjust the playback volume of different remote users, call the method as many times, once for each remote user.
-Call this method after
None.
+Call this method after
This method enables the SDK to regularly report the volume information to the app of the local user who sends a stream and remote users (three users at most) whose instantaneous volumes are the highest. Once you call this method and users send streams in the channel, the SDK triggers the
Call this method after
None.
This group of methods is for Android and iOS only.
-By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To stop subscribing to a specified stream or all remote streams, call
This method enables users to join a channel. Users in the same channel can talk to each other, and multiple users in the same channel can start a group chat. Users with different App IDs cannot call each other.
-A successful call of this method triggers the following callbacks:
When the connection between the client and Agora's server is interrupted due to poor network conditions, the SDK tries reconnecting to the server. When the local client successfully rejoins the channel, the SDK triggers the
Compared to
相比
该方法可以在加入频道时设置媒体选项，如是否在频道内发布音视频流等。 用户加入频道时是否自动订阅频道内所有远端音视频流。 By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To unsubscribe, set
Call this method
This method allows a user to join the channel with the user account. After the user successfully joins the channel, the SDK triggers the following callbacks:
Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding
Compared to
调用该方法前，如果你未调用
Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding mute methods.
相比
This method allows a user to join the channel with the user account. After the user successfully joins the channel, the SDK triggers the following callbacks:
Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding
调用该方法前，如果你未调用
Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. 如果想取消订阅，可以通过设置
When the method call succeeds, there is no return value; when fails, the
You can call this method multiple times to join more than one channel.
-You can call this method multiple times to join more than one channel. If you want to join the same channel from different devices, ensure that the user IDs are different for all devices.
+This method can be called in scenarios involving multiple channels.
+Call this method after
In a multi-camera capture scenario, you need to call the
If you are already in a channel, you cannot rejoin it with the same user ID.
+Ensure that the app ID you use to generate
This callback notifies the application that a user joins a specified channel.
当你调用
当你调用
当你调用
None.
+When a user loses connection with the server because of network problems, the SDK automatically tries to reconnect and triggers this callback upon reconnection.
None.
+The SDK triggers this callback under one of the following circumstances:
None.
After a successful update, the local user can hear the change in the spatial position of the media player.
This method can be called either before or after joining the channel.
+None.
+This method can be called either before or after joining the channel.
+None.
+After connected to the Agora server, you can call this method to adjust the volume of the media file heard by the remote user.
This method can be called either before or after joining the channel.
+None.
+Call this method after calling
None.
+You can call this method either before or after joining a channel.
+None.
+On the Android platform, if you need to open a file in URI format, use
This method supports playing URI files starting with
If you want to choose the CDN route for playing the media resource, you can call the
This method is called asynchronously.
-If you need to play a media file, make sure you receive the
This method can be called either before or after joining the channel.
+None.
+You can call this method either before or after joining a channel.
+None.
+When the method call succeeds, there is no return value; when fails, the
After calling
None.
This method can be called either before or after joining the channel.
+None.
+After successfully calling this method, you will receive the
You can call this method either before or after joining a channel.
+None.
+The media player supports setting options through
The media player supports setting options through
The difference between this method and
需要提供技术预览或特别定制功能的场景。 In general, you don't need to know about the option settings. You can use the default option settings of the media player.
+Call this method after the
None.
+The difference between this method and
None.
+When the method call succeeds, there is no return value; when fails, the
You can call this method either before or after joining a channel.
+None.
+调用该方法停止播放后，如需重新播放，需要调用
Call this method after
None.
+When the method call succeeds, there is no return value; when fails, the
You need to call this method after calling
None.
+This method adjusts the volume of audio mixing for publishing (sending to other users).
-Call this method after calling
None.
+This method adjusts the audio mixing volume on both the local client and remote clients.
-Call this method after
None.
+When publishing video streams, you can call this method to replace the current video feeds with custom images.
Once you enable this function, you can select images to replace the video feeds through the
Agora recommends that you call this method after joining a channel.
+None.
+Retrieves the total duration (ms) of the audio.
-You need to call this method after calling
该方法需要在
None.
+This method helps troubleshoot audio volume‑related issues.
-You need to call this method after calling
该方法需要在
None.
+You can call this method either before or after joining a channel.
+None.
+相比
该方法可以在加入频道时设置媒体选项，如是否在频道内发布音视频流等。 用户加入频道时是否自动订阅频道内所有远端音视频流。 By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To unsubscribe, set
该方法可以在加入频道时设置媒体选项，如是否在频道内发布音视频流等。 用户加入频道时是否自动订阅频道内所有远端音视频流。 By default, the user subscribes to the audio and video streams of all the other users in the channel, giving rise to usage and billings. To unsubscribe, set
This method allows a user to join the channel with the user account and a token. After the user successfully joins the channel, the SDK triggers the following callbacks:
Once a user joins the channel, the user subscribes to the audio and video streams of all the other users in the channel by default, giving rise to usage and billing calculation. To stop subscribing to a specified stream or all remote streams, call the corresponding
When the method call succeeds, there is no return value; when fails, the
Call this method to set an SDK preset audio effect for the local user who sends an audio stream. This audio effect does not change the gender characteristics of the original voice. After setting an audio effect, all users in the channel can hear the effect.
This method can be called either before or after joining the channel.
-In a stereo music file, the left and right channels can store different audio data. According to your needs, you can set the channel mode to original mode, left channel mode, right channel mode, or mixed channel mode. For example, in the KTV scenario, the left channel of the music file stores the musical accompaniment, and the right channel stores the singing voice. If you only need to listen to the accompaniment, call this method to set the channel mode of the music file to left channel mode; if you need to listen to the accompaniment and the singing voice at the same time, call this method to set the channel mode to mixed channel mode.
-In a stereo music file, the left and right channels can store different audio data. According to your needs, you can set the channel mode to original mode, left channel mode, right channel mode, or mixed channel mode.
+For example, in the KTV scenario, the left channel of the music file stores the musical accompaniment, and the right channel stores the singing voice. 你可以根据实际需求进行设置：
该方法需要在
This method only applies to stereo audio files.
+Call this method to set the playback position of the music file to a different starting position (the default plays from the beginning).
-该方法需要在
None.
+To adjust the camera focal length configuration, It is recommended to call
Due to limitations on some Android devices, even if you set the focal length type according to the results returned in
Call this method before enabling local camera capture, such as before calling
None.
+To adjust the camera focal length configuration, It is recommended to call
Due to limitations on some Android devices, even if you set the focal length type according to the results returned in
None.
Most mobile phones have two audio routes: an earpiece at the top, and a speakerphone at the bottom. The earpiece plays at a lower volume, and the speakerphone at a higher volume. When setting the default audio route, you determine whether audio playback comes through the earpiece or speakerphone when no external audio device is connected.
In different scenarios, the default audio routing of the system is also different. See the following:
You can call this method to change the default audio route. After a successful method call, the SDK triggers the
You can call this method to change the default audio route.
The system audio route changes when an external audio device, such as a headphone or a Bluetooth audio device, is connected. See
在调用该方法设置默认音频路由后，系统实际音频路由会随着外接音频设备（有线耳机或蓝牙耳机）的连接发生改变。 See
Call this method before joining a channel. If you need to change the audio route after joining a channel, call
None.
+If the default audio route of the SDK or the setting in
For the default audio route in different scenarios, see
This method only sets the audio route in the current channel and does not influence the default audio route. If the user leaves the current channel and joins another channel, the default audio route is used.
-For the default audio route in different scenarios, see Audio Route
If the default audio route of the SDK or
Call this method after joining a channel.
+After initializing the local video view, you can call this method to update its rendering and mirror modes. It affects only the video view that the local user sees and does not impact the publishing of the local video.
The mirror mode of the local video view. See
The mirror mode of the local video view. See
For the local user:
This method can be called either before or after joining the channel.
+None.
+Formant ratio affects the timbre of voice. The smaller the value, the deeper the sound will be, and the larger, the sharper.
-You can call this method to set the formant ratio of local audio to change the timbre of human voice. After you set the formant ratio, all users in the channel can hear the changed voice. If you want to change the timbre and pitch of voice at the same time, Agora recommends using this method together with
Formant ratio affects the timbre of voice. The smaller the value, the deeper the sound will be, and the larger, the sharper. After you set the formant ratio, all users in the channel can hear the changed voice. If you want to change the timbre and pitch of voice at the same time, Agora recommends using this method together with
You can call this method to set the formant ratio of local audio to change the timbre of human voice.
+This method can be called either before or after joining the channel.
+None.
+This method can be called either before or after joining the channel.
+None.
+Specifies an SDK output log file. The log file records all log data for the SDK’s operation. Ensure that the directory for the log file exists and is writable.
-Ensure that you call
Specifies an SDK output log file. The log file records all log data for the SDK’s operation.
+该方法需要在
Ensure that the directory for the log file exists and is writable.
+Choose a level to see the logs preceding that level.
The mirror mode of the remote user view.
The SDK defaults to enabling low-quality video stream adaptive mode (
Depending on the default behavior of the sender and the specific settings when calling
The SDK will dynamically adjust the size of the corresponding video stream based on the size of the video window to save bandwidth and computing resources. The default aspect ratio of the low-quality video stream is the same as that of the high-quality video stream. According to the current aspect ratio of the high-quality video stream, the system will automatically allocate the resolution, frame rate, and bitrate of the low-quality video stream.
This method is used to switch the audio route from Bluetooth headphones to earpiece, wired headphones or speakers in communication audio mode (
This method is used to switch the audio route from Bluetooth headphones to earpiece, wired headphones or speakers in communication audio mode (
This method can be called either before or after joining the channel.
+Using this method and the
If set to
This method can be called either before or after joining the channel.
+To achieve better vocal effects, it is recommended that you call the following APIs before calling this method:
To achieve better vocal effects, it is recommended that you call the following APIs before calling this method:
Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting an audio effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios.
This method can be called either before or after joining the channel.
-This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path.
-The method is asynchronous, and the SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the
The SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the
This method takes a snapshot of a video stream from the specified user, generates a JPG image, and saves it to the specified path.
+Call this method after joining a channel.
+The mirror mode of the remote user view. See
The mirror mode of the remote user view:
The SDK has not taken the snapshot when the method call returns. After a successful method call, the SDK triggers the
Call this method after
当你调用
当你调用
当你调用
当你调用
当你调用
+
+
The alpha channel data output by using portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait).
By setting this parameter, you can render the video background into various effects, such as transparent, solid color, image, video, etc.
-The mirror mode of the view. See
Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees. See
Sets the mirror mode of the published local video stream. It only affects the video that the remote user sees.
The alpha channel data output by using portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait).
By setting this parameter, you can render the video background into various effects, such as transparent, solid color, image, video, etc.
-The stereo setting only takes effect when the SDK uses the media volume.
To learn more about the difference between media volume and call volume,
2: 1v1 视频通话
+ +The deprecated APIs are expected to be officially deleted in approximately one year. Agora recommends that you promptly replace them with the recommended APIs to avoid any impact on your online services.
-API 已在 SDK 中删除。 请使用推荐的替代 API 实现相关功能。
+