AgoraRtcEngineKit
The basic interface of the Agora SDK that implements the core functions of real-time communication.
AgoraRtcEngineKit provides the main methods that your app can call.
addVideoWatermark [1/2]
Adds a watermark image to the local video.
- (int)addVideoWatermark:(AgoraImage * _Nonnull)watermark
- Deprecated:
- This method is deprecated. Use addVideoWatermark [2/2] instead.
This method adds a PNG watermark image to the local video stream in a live streaming session. Once the watermark image is added, all the users in the channel (CDN audience included) and the video capturing device can see and capture it. If you only want to add a watermark to the CDN live streaming, see descriptions in setLiveTranscoding.
- The URL descriptions are different for the local video and CDN live streaming: In a local video stream, URL refers to the absolute path of the added watermark image file in the local video stream. In a CDN live stream, URL refers to the URL address of the added watermark image in the CDN live streaming.
- The source file of the watermark image must be in the PNG file format. If the width and height of the PNG file differ from your settings in this method, the PNG file will be cropped to conform to your settings.
- The Agora SDK supports adding only one watermark image onto a local video or CDN live stream. The newly added watermark image replaces the previous one.
Parameters
- watermark
- The watermark image to be added to the local live streaming: AgoraImage.
Returns
- 0: Success.
- < 0: Failure.
addVideoWatermark [2/2]
Adds a watermark image to the local video.
- (int)addVideoWatermark:(NSURL* _Nonnull)url options:(WatermarkOptions* _Nonnull)options;
This method adds a PNG watermark image to the local video in the live streaming. Once the watermark image is added, all the audience in the channel (CDN audience included), and the capturing device can see and capture it. Agora supports adding only one watermark image onto the local video, and the newly watermark image replaces the previous one.
- If the orientation mode of the encoding video (AgoraVideoOutputOrientationMode) is fixed landscape mode or the adaptive landscape mode, the watermark uses the landscape orientation.
- If the orientation mode of the encoding video (AgoraVideoOutputOrientationMode) is fixed portrait mode or the adaptive portrait mode, the watermark uses the portrait orientation.
- When setting the watermark position, the region must be less than thesetVideoEncoderConfiguration dimensions set in the method; otherwise, the watermark image will be cropped.
- Ensure that call this method after enableVideo.
- If you only want to add a watermark to the Media Push, you can call this method or the setLiveTranscoding method.
- This method supports adding a watermark image in the PNG file format only. Supported pixel formats of the PNG image are RGBA, RGB, Palette, Gray, and Alpha_gray.
- If the dimensions of the PNG image differ from your settings in this method, the image will be cropped or zoomed to conform to your settings.
- If you have enabledthe local video preview by calling the startPreview method, you can use the
visibleInPreview
member to set whether or not the watermark is visible in the preview. - If you have enabled the mirror mode for the local video, the watermark on the local video is also mirrored. To avoid mirroring the watermark, Agora recommends that you do not use the mirror and watermark functions for the local video at the same time. You can implement the watermark function in your application layer.
Parameters
- url
- The local file path of the watermark image to be added. This method supports adding a watermark image from the local absolute or relative file path.
- options
- The options of the watermark image to be added. For details, see WatermarkOptions.
Returns
- 0: Success.
- < 0: Failure.
adjustAudioMixingPlayoutVolume
Adjusts the volume of audio mixing for local playback.
- (int)adjustAudioMixingPlayoutVolume:(NSInteger)volume;
audioMixingStateChanged(AgoraAudioMixingStateTypePlaying)
callback.Parameters
- volume
- The volume of audio mixing for local playback. The value ranges between 0 and 100 (default). 100 represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustAudioMixingPublishVolume
Adjusts the volume of audio mixing for publishing.
- (int)adjustAudioMixingPublishVolume:(NSInteger)volume;
This method adjusts the audio mixing volume on the remote clients.
Call this method after calling startAudioMixing [2/2] and receiving the audioMixingStateChanged(AgoraAudioMixingStateTypePlaying)
callback.
Parameters
- volume
- The volume of audio mixing for local playback. The value ranges between 0 and 100 (default). 100 represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustAudioMixingVolume
Adjusts the volume during audio mixing.
- (int)adjustAudioMixingVolume:(NSInteger)volume;
This method adjusts the audio mixing volume on both the local client and remote clients.
- Call this method after the startAudioMixing [2/2] method.
- This method does not affect the playback volume you set through the playEffect [3/3] method.
Parameters
- volume
- Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustAudioMixingPublishVolume
Adjusts the volume of audio mixing for publishing.
- (int)adjustAudioMixingPublishVolume:(NSInteger)volume;
This method adjusts the audio mixing volume on the remote clients.
Call this method after calling startAudioMixing [2/2] and receiving the audioMixingStateChanged(AgoraAudioMixingStateTypePlaying)
callback.
Parameters
- volume
- The volume of audio mixing for local playback. The value ranges between 0 and 100 (default). 100 represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustCustomAudioPublishVolume
Adjusts the volume of the custom external audio source when it is published in the channel.
- (int)adjustCustomAudioPublishVolume:(NSInteger)sourceId volume:(NSInteger)volume;
If you want to change the volume of the audio to be published, you need to call this method again.
Parameters
- sourceId
- The ID of external audio source. If you want to publish a custom external audio source, set this parameter to the ID of the corresponding custom audio track you want to publish.
- volume
- The volume of the audio source. The value can range from 0 to 100. 0 means mute; 100 means the original volume.
Returns
- 0: Success.
- < 0: Failure.
adjustPlaybackSignalVolume
Adjusts the playback signal volume of all remote users.
- (int)adjustPlaybackSignalVolume:(NSInteger)volume;
- This method adjusts the playback volume that is the mixed volume of all remote users.
- You can call this method either before or after joining a channel.
Parameters
- volume
-
The volume of the user. The value range is [0,400].
- 0: Mute.
- 100: (Default) The original volume.
- 400: Four times the original volume (amplifying the audio signals by four times).
Returns
- 0: Success.
- < 0: Failure.
adjustRecordingSignalVolume
Adjusts the capturing signal volume.
- (int)adjustRecordingSignalVolume:(NSInteger)volume;
You can call this method either before or after joining a channel.
Parameters
- volume
-
The volume of the user. The value range is [0,400].
- 0: Mute.
- 100: (Default) The original volume.
- 400: Four times the original volume (amplifying the audio signals by four times).
Returns
- 0: Success.
- < 0: Failure.
adjustUserPlaybackSignalVolume
Adjusts the playback signal volume of a specified remote user.
- (int)adjustUserPlaybackSignalVolume:(NSUInteger)uid volume:(int)volume;
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 joining a channel.
- The playback volume here refers to the mixed volume of a specified remote user.
Parameters
- uid
- The user ID of the remote user.
- volume
- Audio mixing volume. The value ranges between 0 and 100. The default value is 100, which means the original volume.
Returns
- 0: Success.
- < 0: Failure.
clearVideoWatermarks
Removes the watermark image from the video stream.
- (int)clearVideoWatermarks;
Returns
- 0: Success.
- < 0: Failure.
complain
Allows a user to complain about the call quality after a call ends.
- (int)complain:(NSString * _Nonnull)callId description:(NSString * _Nullable)description;
This method allows users to complain about the quality of the call. Call this method after the user leaves the channel.
Parameters
- callId
- The current call ID. You can get the call ID by calling getCallId.
- description
- (Optional) A description of the call. The string length should be less than 800 bytes.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid.
- 3: The SDK is not ready. Possible reasons include the following:
- The initialization of AgoraRtcEngineKit fails. Reinitialize the AgoraRtcEngineKit.
- No user has joined the channel when the method is called. Please check your code logic.
- The user has not left the channel when the rate or complain method is called. Please check your code logic.
- The audio module is disabled. The program is not complete.
configRhythmPlayer
Configures the virtual metronome.
- (int)configRhythmPlayer:(AgoraRhythmPlayerConfig * _Nullable)config;
After calling startRhythmPlayer, you can call this method to reconfigure the virtual metronome.
- After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning and controls the playback duration of each file according to beatsPerMinuteyou set in AgoraRhythmPlayerConfig. For example, if you set beatsPerMinute as
60
, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration. - By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in AgoraRtcChannelMediaOptions as
NO
.
Parameters
- config
- The metronome configuration. See AgoraRhythmPlayerConfig.
Returns
- 0: Success.
- < 0: Failure.
sharedEngineWithAppId
Creates and initializes AgoraRtcEngineKit.
+ (instancetype _Nonnull)sharedEngineWithAppId:(NSString * _Nonnull)appId delegate:(id<AgoraRtcEngineDelegate> _Nullable)delegate;
All called methods provided by the AgoraRtcEngineKit class are executed asynchronously. Agora recommends calling these methods in the same thread.
- Before calling other APIs, you must call this method to create the AgoraRtcEngineKit object.
- You can create the AgoraRtcEngineKit instance either by calling this method or by calling sharedEngineWithConfig. The difference between sharedEngineWithConfig and this method is that sharedEngineWithConfig supports more configurations when creating the AgoraRtcEngineKit instance, for example, specifying the region for connection and setting the log files.
- The SDK supports creating only one AgoraRtcEngineKit instance for an app.
Parameters
- appId
- The App ID issued by Agora for your project. Only users in apps with the same App ID can join the same channel and communicate with each other. An App ID can only be used to create one AgoraRtcEngineKit instance. To change your App ID, call destroy to destroy the current AgoraRtcEngineKit instance, and then create a new one.
- delegate
- The event handler for AgoraRtcEngineKit. See AgoraRtcEngineDelegate.
Returns
- The AgoraRtcEngineKit instance, if the method call succeeds.
- An error code, if the call fails,.
sharedEngineWithConfig
Creates and initializes AgoraRtcEngineKit.
+ (instancetype _Nonnull)sharedEngineWithConfig:(AgoraRtcEngineConfig * _Nonnull)config delegate:(id<AgoraRtcEngineDelegate> _Nullable)delegate;
All called methods provided by the AgoraRtcEngineKit class are executed asynchronously. Agora recommends calling these methods in the same thread.
- Before calling other APIs, you must call this method to create the AgoraRtcEngineKit object.
- You can create the AgoraRtcEngineKit instance either by calling this method or by calling sharedEngineWithAppId. The difference between sharedEngineWithAppId and this method is that this method supports more configurations when creating the AgoraRtcEngineKit instance, for example, specifying the region for connection and setting the log files.
- The SDK supports creating only one AgoraRtcEngineKit instance for an app.
Parameters
- config
-
Configurations for the AgoraRtcEngineKit instance. See AgoraRtcEngineConfig.
- delegate
- The event handler for AgoraRtcEngineKit. See AgoraRtcEngineDelegate.
Returns
- The AgoraRtcEngineKit instance, if the method call succeeds.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
- -7: The SDK is not initialized.
- -22: The resource request failed. The SDK fails to allocate resources because your app consumes too much system resource or the system resources are insufficient.
- -101: The App ID is invalid.
createDataStream [1/2]
Creates a data stream.
- (int)createDataStream:(NSInteger * _Nonnull)streamId reliable:(BOOL)reliable ordered:(BOOL)ordered;
Each user can create up to five data streams during the lifecycle of AgoraRtcEngineKit.
- Call this method after joining a channel.
- Agora does not support setting reliable as
YES
and ordered asYES
.
Parameters
- streamId
- Output parameter. Pointer to the ID of the created data stream.
- reliable
-
Whether or not the data stream is reliable:
YES
: The recipients receive the data from the sender within five seconds. If the recipient does not receive the data within five seconds, the SDK triggers the didOccurStreamMessageErrorFromUid callback and returns an error code.NO
: There is no guarantee that the recipients receive the data stream within five seconds and no error message is reported for any delay or missing data stream.
- ordered
-
Whether or not the recipients receive the data stream in the sent order:
YES
: The recipients receive the data in the sent order.NO
: The recipients do not receive the data in the sent order.
Returns
- 0: The data stream is successfully created.
- < 0: Failure.
createDataStream [2/2]
Creates a data stream.
- (int)createDataStream:(NSInteger * _Nonnull)streamId config:(AgoraDataStreamConfig * _Nonnull)config;
Creates a data stream. Each user can create up to five data streams in a single channel.
Compared with createDataStream [1/2], this method does not support data reliability. If a data packet is not received five seconds after it was sent, the SDK directly discards the data.
Parameters
- streamId
- Output parameter. Pointer to the ID of the created data stream.
- config
- The configurations for the data stream. See AgoraDataStreamConfig.
Returns
- 0: The data stream is successfully created.
- < 0: Failure.
createMediaPlayerWithDelegate
Creates one AgoraRtcMediaPlayerProtocol instance.
- (id<AgoraRtcMediaPlayerProtocol>_Nullable)createMediaPlayerWithDelegate: (id<AgoraRtcMediaPlayerDelegate>_Nullable)delegate;
Parameters
- delegate
- The event handler for AgoraRtcEngineKit. See AgoraRtcEngineDelegate.
Returns
- The AgoraRtcMediaPlayerProtocol instance, if the method call succeeds.
- An empty pointer , if the method call fails.
An AgoraRtcMediaPlayerProtocol instance, if the method call succeeds.
createCustomVideoTrack
Creates a customized video track.
- (unsigned int)createCustomVideoTrack;
- Call this method to create a video track and get the video track ID.
- In each channel's AgoraRtcChannelMediaOptions, set the customVideoTrackId parameter to the ID of the video track you want to publish, and set publishCustomVideoTrack to
YES
. - If you call pushExternalVideoFrame, and specify customVideoTrackId as the videoTrackId set in step 2, you can publish the corresponding custom video source in multiple channels.
Returns
- If the method call is successful, the video track ID is returned as the unique identifier of the video track.
- If the method call fails, a negative value is returned.
destroyCustomVideoTrack
Destroys the specified video track.
- (int)destroyCustomVideoTrack:(NSUInteger)videoTrackId;
Parameters
- videoTrackId
- The video track ID returned by calling the createCustomVideoTrack method.
Returns
- 0: Success.
- < 0: Failure.
delegate
Sets and retrieves AgoraRtcEngineDelegate.
@property(nonatomic, weak) id<AgoraRtcEngineDelegate> _Nullable delegate;
The SDK uses AgoraRtcEngineDelegate to inform the app on engine runtime events. All methods defined in the delegate are optional implementation methods.
destroy
Releases the AgoraRtcEngineKit instance.
+ (void)destroy;
This method releases all resources used by the Agora SDK. Use this method for apps in which users occasionally make voice or video calls. When users do not make calls, you can free up resources for other operations.
After a successful method call, you can no longer use any method or callback in the SDK anymore. If you want to use the real-time communication functions again, you must call sharedEngineWithConfig to create a new AgoraRtcEngineKit instance.
disableAudio
Disables the audio module.
- (int)disableAudio;
- This method disables the internal engine and can be called anytime after initialization. It is still valid after one leaves channel.
- This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the audio modules separately:
- enableLocalAudio: Whether to enable the microphone to create the local audio stream.
- muteLocalAudioStream: Whether to publish the local audio stream.
- muteRemoteAudioStream: Whether to subscribe and play the remote audio stream.
- muteAllRemoteAudioStreams: Whether to subscribe to and play all remote audio streams.
Returns
- 0: Success.
- < 0: Failure.
disableAudioSpectrumMonitor
Disables audio spectrum monitoring.
- (int)disableAudioSpectrumMonitor;
After calling enableAudioSpectrumMonitor, if you want to disable audio spectrum monitoring, you can call this method.
You can call this method either before or after joining a channel.
Returns
- 0: Success.
- < 0: Failure.
disableVideo
Disables the video module.
- (int)disableVideo;
This method disables video. You can call this method either before or after joining a channel. If you call it before joining a channel, an audio call starts when you join the channel. If you call it after joining a channel, a video call switches to an audio call. Call enableVideo to enable video.
A successful call of this method triggers the didVideoEnabled (NO
) callback on the remote client.
- This method affects the internal engine and can be called after leaving the channel.
- This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the video engine modules separately:
- enableLocalVideo: Whether to enable the camera to create the local video stream.
- muteLocalVideoStream: Whether to publish the local video stream.
- muteRemoteVideoStream: Whether to subscribe to and play the remote video stream.
- muteAllRemoteVideoStreams: Whether to subscribe to and play all remote video streams.
Returns
- 0: Success.
- < 0: Failure.
enableAudio
Enables the audio module.
- (int)enableAudio;
The audio mode is enabled by default.
- This method enables the internal engine and can be called anytime after initialization. It is still valid after one leaves channel.
- This method enables the audio module and takes some time to take effect. Agora recommends using the following API methods to control the audio module separately:
- enableLocalAudio: Whether to enable the microphone to create the local audio stream.
- muteLocalAudioStream: Whether to publish the local audio stream.
- muteRemoteAudioStream: Whether to subscribe and play the remote audio stream.
- muteAllRemoteAudioStreams: Whether to subscribe to and play all remote audio streams.
Returns
- 0: Success.
- < 0: Failure.
enableAudioSpectrumMonitor
Turns on audio spectrum monitoring.
- (int)enableAudioSpectrumMonitor:(int)intervalInMS;
If you want to obtain the audio spectrum data of local or remote users, you can register the audio spectrum observer and enable audio spectrum monitoring.
You can call this method either before or after joining a channel.
Parameters
- intervalInMS
-
The interval (in milliseconds) at which the SDK triggers the onLocalAudioSpectrum and onRemoteAudioSpectrum callbacks. The default value is 100. Do not set this parameter to less than 10 milliseconds, otherwise the calling of this method fails.
Returns
- 0: Success.
- < 0: Failure.
- -2: Invalid parameters.
enableAudioVolumeIndication
Enables the reporting of users' volume indication.
- (int)enableAudioVolumeIndication:(NSInteger)interval smooth:(NSInteger)smooth reportVad:(BOOL)reportVad;
This method enables the SDK to regularly report the volume information of the local user who sends a stream and remote users (up to three) whose instantaneous volumes are the highest to the app. Once you call this method and users send streams in the channel, the SDK triggers the reportAudioVolumeIndicationOfSpeakers callback at the time interval set in this method.
Parameters
- interval
- Sets the time interval between two consecutive volume indications:
- ≤ 0: Disables the volume indication.
- > 0: Time interval (ms) between two consecutive volume indications. You need to set this parameter to an integer multiple of 200. If the value is lower than 200, the SDK automatically adjusts the value to 200.
- smooth
- The smoothing factor sets the sensitivity of the audio volume indicator. The value ranges between 0 and 10. The recommended value is 3. The greater the value, the more sensitive the indicator.
- reportVad
-
YES
: Enable the voice activity detection of the local user. Once it is enabled,the vad parameter of the reportAudioVolumeIndicationOfSpeakers callback reports the voice activity status of the local user.NO
: (Default) Disable the voice activity detection of the local user. Once it is disabled, the vad parameter of the reportAudioVolumeIndicationOfSpeakers callback does not report the voice activity status of the local user, except for the scenario where the engine automatically detects the voice activity of the local user.
Returns
- 0: Success.
- < 0: Failure.
enableContentInspect
Enables or disables video screenshot and upload.
- (int)enableContentInspect:(BOOL)enabled config:(AgoraContentInspectConfig* _Nonnull)config;
When video screenshot and upload function is enabled, the SDK takes screenshots and upload videos sent by local users based on the type and frequency of the module you set in AgoraContentInspectConfig. After video screenshot and upload, the Agora server sends the callback notification to your app server in HTTPS requests and sends all screenshots to the third-party cloud storage service.
- Before calling this method, ensure that you contact contact technical support to enbale Agora video screenshot and upload service.
- This method relies on the video content moderation library
AgoraCIExtension.xcframework
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- enabled
- Whether to enable video screenshot and upload:
YES
: Enables video screenshot and upload.NO
: Disables video screenshot and upload.
- config
- Configuration of video screenshot and upload. See AgoraContentInspectConfig.
Returns
- 0: Success.
- < 0: Failure.
enableDualStreamMode [1/2]
Enables or disables dual-stream mode on the sender side.
- (int)enableDualStreamMode:(BOOL)enabled;
- High-quality video stream: High bitrate, high resolution.
- Low-quality video stream: Low bitrate, low resolution.
After you enable dual-stream mode, you can call setRemoteVideoStream to choose to receive either the high-quality video stream or the low-quality video stream on the subscriber side.
- This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.
- If you need to enable dual video streams in a multi-channel scenario, you can call the enableDualStreamModeEx method.
- You can call this method either before or after joining a channel.
Parameters
- enabled
-
Whether to enable dual-stream mode.
YES
: Enable dual-stream mode.NO
: (Default) Disable dual-stream mode.
Returns
- 0: Success.
- < 0: Failure.
enableDualStreamMode [2/2]
Enables or disables the dual-stream mode on the sender and sets the video stream.
- (int)enableDualStreamMode:(BOOL)enabled streamConfig:(AgoraSimulcastStreamConfig* _Nonnull)streamConfig;
- High-quality video stream: High bitrate, high resolution.
- Low-quality video stream: Low bitrate, low resolution.
After you enable dual-stream mode, you can call setRemoteVideoStream to choose to receive either the high-quality video stream or the low-quality video stream on the subscriber side.
- This method is applicable to all types of streams from the sender, including but not limited to video streams collected from cameras, screen sharing streams, and custom-collected video streams.
- If you need to enable dual video streams in a multi-channel scenario, you can call the enableDualStreamModeEx method.
- You can call this method either before or after joining a channel.
Parameters
- enabled
-
Whether to enable dual-stream mode:
YES
: Enable dual-stream mode.NO
: (Default) Disable dual-stream mode.
- streamConfig
-
The configuration of the low-quality video stream. See AgoraSimulcastStreamConfig.
Returns
- 0: Success.
- < 0: Failure.
enableEncryption
Enables/Disables the built-in encryption.
- (int)enableEncryption:(bool)enabled encryptionConfig:(AgoraEncryptionConfig * _Nonnull)config;
In scenarios requiring high security, Agora recommends calling this method to enable the built-in encryption before joining a channel.
All users in the same channel must use the same encryption mode and encryption key. After the user leaves the channel, the SDK automatically disables the built-in encryption. To enable the built-in encryption, call this method before the user joins the channel again.
Parameters
- enabled
-
Whether to enable built-in encryption:
- YES: Enable the built-in encryption.
- NO: Disable the built-in encryption.
- config
- Built-in encryption configurations. See AgoraEncryptionConfig.
Returns
- 0: Success.
- < 0: Failure.
- -2: An invalid parameter is used. Set the parameter with a valid value.
- -4: The built-in encryption mode is incorrect or the SDK fails to load the external encryption library. Check the enumeration or reload the external encryption library.
- -7: The SDK is not initialized. Initialize the AgoraRtcEngineKit instance before calling this method.
enableExtensionWithVendor
Enables/Disables extensions.
- (int)enableExtensionWithVendor:(NSString * __nonnull)provider extension:(NSString * __nonnull)extension enabled:(BOOL)enabled;
Ensure that you call this method before joining a channel.
- If you want to enable multiple extensions, you need to call this method multiple times.
- The data processing order of different extensions in the SDK is determined by the order in which the extensions are enabled. That is, the extension that is enabled first will process the data first.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- enabled
-
Whether to enable the extension:
YES
: Enable the extension.NO
: Disable the extension.
Returns
- 0: Success.
- < 0: Failure.
enableFaceDetection
Enables/Disables face detection for the local user.
- (int)enableFaceDetection:(bool)enable NS_SWIFT_NAME(enableFaceDetection(_:));
You can call this method either before or after joining a channel.
- The width and height of the local video.
- The position of the human face in the local view.
- The distance between the human face and the screen.
This method needs to be called after the camera is started (for example, by calling startPreview or joinChannelByToken [2/4]).
Parameters
- enable
- Whether to enable face detection for the local user:
YES
: Enable face detection.NO
: (Default) Disable face detection.
Returns
- 0: Success.
- < 0: Failure.
enableInEarMonitoring [1/2]
Enables in-ear monitoring.
- (int)enableInEarMonitoring:(BOOL)enabled;
This method enables or disables in-ear monitoring.
- Users must use wired earphones to hear their own voices.
- You can call this method either before or after joining a channel.
Parameters
- enabled
- Enables in-ear monitoring.
YES
: Enables in-ear monitoring.NO
: (Default) Disables in-ear monitoring.
Returns
- 0: Success.
- < 0: Failure.
enableInEarMonitoring [2/2]
Enables in-ear monitoring.
- (int)enableInEarMonitoring:(BOOL)enabled includeAudioFilters:(AgoraEarMonitoringFilterType)includeAudioFilters;
This method enables or disables in-ear monitoring.
- Users must use wired earphones to hear their own voices.
- You can call this method either before or after joining a channel.
Parameters
- enabled
- Enables or disables in-ear monitoring.
YES
: Enables in-ear monitoring.NO
: (Default) Disables in-ear monitoring.
- includeAudioFilters
- The audio filter of in-ear monitoring: See AgoraEarMonitoringFilterType.
Returns
- 0: Success.
- < 0: Failure.
enableLocalAudio
Enables/Disables the local audio capture.
- (int)enableLocalAudio:(BOOL)enabled;
The audio function is enabled by default. This method disables or re-enables the local audio function to stop or restart local audio capturing.
This method does not affect receiving or playing the remote audio streams, and enableLocalAudio(NO)
is applicable to scenarios where the user wants to receive remote audio streams without sending any audio stream to other users in the channel.
- This method is different from the muteLocalAudioStream method:
- enableLocalAudio: Disables/Re-enables the local audio capturing and processing. If you disable or re-enable local audio capturing using the enableLocalAudio method, the local user might hear a pause in the remote audio playback.
- muteLocalAudioStream: Sends/Stops sending the local audio streams.
- You can call this method either before or after joining a channel. Calling it before joining a channel only sets the device state, and it takes effect immediately after you join the channel.
Parameters
- enabled
-
YES
: (Default) Re-enable the local audio function, that is, to start the local audio capturing device (for example, the microphone).NO
: Disable the local audio function, that is, to stop local audio capturing.
Returns
- 0: Success.
- < 0: Failure.
enableLocalVideo
Enables/Disables the local video capture.
- (int)enableLocalVideo:(BOOL)enabled;
This method disables or re-enables the local video capturer, and does not affect receiving the remote video stream.
After calling enableVideo, the local video capturer is enabled by default. You can call enableLocalVideo(NO
) to disable the local video capturer. If you want to re-enable the local video, call enableLocalVideo(YES
).
After the local video capturer is successfully disabled or re-enabled, the SDK triggers the remoteVideoStateChangedOfUid callback on the remote client.
- You can call this method either before or after joining a channel.
- This method enables the internal engine and is valid after leaving the channel.
Parameters
- enabled
-
Whether to enable the local video capture.
YES
: (Default) Enable the local video capture.NO
: Disables the local video capture. Once the local video is disabled, the remote users can no longer receive the video stream of this user, while this user can still receive the video streams of the other remote users. When set toNO
, this method does not require a local camera.
Returns
- 0: Success.
- < 0: Failure.
enableMainQueueDispatch
Enables or disables dispatching delegate methods to the main queue.
- (int)enableMainQueueDispatch:(BOOL)enabled;
If disabled, the app should dispatch UI operations to the main queue.
Parameters
- enabled
-
YES
: Dispatch delegate methods to the main queue.NO
: Do not dispatch delegate methods to the main queue.
Returns
- 0: Success.
- < 0: Failure.
enableRemoteSuperResolution
Enables/Disables the super resolution algorithm for a remote user's video stream.
- (int)enableRemoteSuperResolution:(NSUInteger)uid enable:(BOOL)enable;
This function can effectively improve the resolution of the remote video picture seen by the local user, that is, the width and height (pixels) of the video received by the specified remote user are enlarged to 2 times original size.
- If the parameter superResolutionType >0: Super resolution is enabled.
- If the parameter superResolutionType =0: Super resolution is not enabled.
The super resolution feature requires extra system resources. To balance the visual experience and system consumption, this feature can only be enabled for a single remote user. If the local user uses super resolution on Android, the original resolution of the remote user's video cannot exceed 640 × 480 pixels.
- This method relies on the super resolution dynamic library
AgoraSuperResolutionExtension.xcframework
. If the dynamic library is deleted, the function cannot be enabled normally. - Because this method has certain system performance requirements, Agora recommends that you use the following devices or better:
- iOS:
- iPhone XR
- iPhone XS
- iPhone XS Max
- iPhone 11
- iPhone 11 Pro
- iPhone 11 Pro Max
- iPhone 12
- iPhone 12 mini
- iPhone 12 Pro
- iPhone 12 Pro Max
- iPhone 12 SE (2nd generation)
- iPad Pro 11-inch (3rd generation)
- iPad Pro 12.9-inch (3rd generation)
- iPad Air 3 (3rd generation)
- iPad Air 3 (4th generation)
- iOS:
Parameters
- uid
- The user ID of the remote user.
- enable
- Whether to enable super resolution for the remote user’s video:
YES
:Enable super resolution.NO
: Disable super resolution.
Returns
- 0: Success.
- < 0: Failure.
enableSoundPositionIndication
Enables/Disables stereo panning for remote users.
- (int)enableSoundPositionIndication:(BOOL)enabled;
Ensure that you call this method before joining a channel to enable stereo panning for remote users so that the local user can track the position of a remote user by calling setRemoteVoicePosition.
Parameters
- enabled
- Whether to enable stereo panning for remote users:
YES
: Enable stereo panning.NO
: Disable stereo panning.
Returns
- 0: Success.
- < 0: Failure.
enableVideo
Enables the video module.
- (int)enableVideo;
Call this method either before joining a channel or during a call. If this method is called before joining a channel, the call starts in the video mode. Call disableVideo to disable the video mode.
A successful call of this method triggers the remoteVideoStateChangedOfUid callback on the remote client.
- This method enables the internal engine and is valid after leaving the channel.
- This method resets the internal engine and takes some time to take effect. Agora recommends using the following API methods to control the video engine modules separately:
- enableLocalVideo: Whether to enable the camera to create the local video stream.
- muteLocalVideoStream: Whether to publish the local video stream.
- muteRemoteVideoStream: Whether to subscribe to and play the remote video stream.
- muteAllRemoteVideoStreams: Whether to subscribe to and play all remote video streams.
Returns
- 0: Success.
- < 0: Failure.
enableVideoImageSource
Sets whether to replace the current video feeds with images when publishing video streams.
- (int) enableVideoImageSource:(BOOL)enable options:(AgoraImageTrackOptions *_Nullable)options;
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 AgoraImageTrackOptions parameter. If you disable this function, the remote users see the video feeds that you publish.
Parameters
- enable
- Whether to replace the current video feeds with custom images:
YES
: Replace the current video feeds with custom images.NO
: (Default) Do not replace the current video feeds with custom images.
- options
- Image configurations. See AgoraImageTrackOptions.
Returns
- 0: Success.
- < 0: Failure.
enableVirtualBackground
Enables/Disables the virtual background.
- (int)enableVirtualBackground:(BOOL)enable backData:(AgoraVirtualBackgroundSource* _Nullable)backData NS_SWIFT_NAME(enableVirtualBackground(_:backData:));
The virtual background function allows you to replace the original background image of the local user or to blur the background. After successfully enabling the virtual background function, all users in the channel can see the customized background.
Call this method before calling enableVideo or startPreview.
- This function requires a high-performance device. Agora recommends that you use this function on devices with the following chips:
- Devices with an A9 chip and better, as follows:
- iPhone 6S and later
- iPad Air 3rd generation and later
- iPad 5th generation and later
- iPad Pro 1st generation and later
- iPad mini 5th generation and later
- Devices with an A9 chip and better, as follows:
- Agora recommends that you use this function in scenarios that meet the following conditions:
- A high-definition camera device is used, and the environment is uniformly lit.
- There are few objects in the captured video. Portraits are half-length and unobstructed. Ensure that the background is a solid color that is different from the color of the user's clothing.
Parameters
- enable
- Whether to enable virtual background:
YES
: Enable virtual background.NO
: Disable virtual background.
- backData
- The custom background image. See AgoraVirtualBackgroundSource. To adapt the resolution of the custom background image to that of the video captured by the SDK, the SDK scales and crops the custom background image while ensuring that the content of the custom background image is not distorted.
- segData
- Processing properties for background images. See AgoraSegmentationProperty.
Returns
- 0: Success.
- < 0: Failure.
- -1: The custom background image does not exist. Check the value of source in AgoraVirtualBackgroundSource.
- -2: The color format of the custom background image is invalid. Check the value of color in AgoraVirtualBackgroundSource.
- -3: The device does not support virtual background.
enableWebSdkInteroperability
Enables interoperability with the Agora Web SDK (applicable only in the live streaming scenarios).
- (int)enableWebSdkInteroperability:(BOOL)enabled;
- Deprecated:
- The SDK automatically enables interoperability with the Web SDK, so you no longer need to call this method.
This method enables or disables interoperability with the Agora Web SDK. If the channel has Web SDK users, ensure that you call this method, or the video of the Native user will be a black screen for the Web user.
This method is only applicable in live streaming scenarios, and interoperability is enabled by default in communication scenarios.
Parameters
- enabled
- Whether to enable interoperability with the Agora Web SDK.
YES
: Enable interoperability.NO
: (Default) Disable interoperability.
Returns
- 0: Success.
- < 0: Failure.
getAudioMixingCurrentPosition
Retrieves the playback position (ms) of the music file.
- (int)getAudioMixingCurrentPosition;
Retrieves the playback position (ms) of the audio.
- You need to call this method after calling startAudioMixing [2/2] and receiving the
audioMixingStateChanged(AgoraAudioMixingStateTypePlaying)
callback. - If you need to call getAudioMixingCurrentPosition multiple times, ensure that the time interval between calling this method is more than 500 ms.
Returns
- ≥ 0: The current playback position (ms) of the audio mixing, if this method call succeeds. 0 represents that the current music file does not start playing.
- < 0: Failure.
getAudioMixingDuration
Retrieves the duration (ms) of the music file.
- (int)getAudioMixingDuration;
Retrieves the total duration (ms) of the audio file.
You need to call this method after calling startAudioMixing [2/2] and receiving the audioMixingStateChanged(AgoraAudioMixingStateTypePlaying)
callback.
Returns
- ≥ 0: The audio mixing duration, if this method call succeeds.
- < 0: Failure.
getAudioMixingPlayoutVolume
Retrieves the audio mixing volume for local playback.
- (int)getAudioMixingPlayoutVolume;
This method retrieves the audio mixing volume for local playback. You can use it to troubleshoot audio volume related issues.
You need to call this method after calling startAudioMixing [2/2] and receiving the audioMixingStateChanged(AgoraAudioMixingStateTypePlaying)
callback.
Returns
- The audio mixing volume, if this method call succeeds. The value range is [0,100].
- < 0: Failure.
getAudioMixingPublishVolume
Retrieves the audio mixing volume for publishing.
- (int)getAudioMixingPublishVolume;
This method helps to troubleshoot audio volume‑related issues.
audioMixingStateChanged(AgoraAudioMixingStateTypePlaying)
callback.Returns
- The audio mixing volume, if this method call succeeds. The value range is [0,100].
- < 0: Failure.
getAudioTrackCount
Gets the index of audio tracks of the current music file.
- (int)getAudioTrackCount;
- You need to call this method after calling startAudioMixing [2/2] and receiving the
audioMixingStateChanged(AgoraAudioMixingStateTypePlaying)
callback.
Returns
- The SDK returns the index of the audio tracks if the method call succeeds.
- < 0: Failure.
getCallId
Retrieves the call ID.
- (NSString * _Nullable)getCallId;
When a user joins a channel on a client, a callId is generated to identify the call from the client. Some methods, such as rate and complain, must be called after the call ends to submit feedback to the SDK. These methods require the callId parameter.
Returns
The current call ID.
getCameraMaxZoomFactor
Gets the maximum zoom ratio supported by the camera.
- (CGFloat)cameraMaxZoomFactor;
- Call this method after enabling the local camera, for example, by calling joinChannelByToken [2/4], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Returns
The maximum zoom factor.
getConnectionState
Gets the current connection state of the SDK.
- (AgoraConnectionState)getConnectionState;
You can call this method either before or after joining a channel.
Returns
The current connection state. For details, see AgoraConnectionState.
getEffectCurrentPosition
Retrieves the playback position of the audio effect file.
- (int)getEffectCurrentPosition:(int)soundId NS_SWIFT_NAME(getEffectCurrentPosition(_:));
- (int)getEffectCurrentPosition:(int)soundId;
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
Returns
- The playback position (ms) of the specified audio effect file, if the method call succeeds.
- < 0: Failure.
getEffectDuration
Retrieves the duration of the audio effect file.
- (int)getEffectDuration:(NSString* _Nonnull)filePath NS_SWIFT_NAME(getEffectDuration(_:));
Parameters
- filePath
- File path:
- iOS or macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example:
/var/mobile/Containers/Data/audio.mp4
.
- iOS or macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example:
Returns
- The total duration (ms) of the specified audio effect file, if the method call succeeds.
- < 0: Failure.
getEffectsVolume
Retrieves the volume of the audio effects.
- (int)getEffectsVolume;
The volume range is [0,100]. The default value is 100, the original volume.
Returns
- Volume of the audio effects, if this method call succeeds.
- < 0: Failure.
getErrorDescription
Gets the warning or error description.
+ (NSString* _Nonnull)getErrorDescription: (NSInteger)error;
Parameters
- error
- The error code or warning code reported by the SDK.
Returns
The specific error or warning description.
getExtensionProperty [1/2]
Gets detailed information on the extensions.
- (NSString * _Nullable)getExtensionPropertyWithVendor:(NSString * __nonnull)provider extension:(NSString * __nonnull)extension key:(NSString * __nonnull)key;
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- key
- The key of the extension.
Returns
- The extension information, if the method call succeeds.
- An empty string, if the method call fails.
getExtensionProperty [2/2]
Gets detailed information on the extensions.
- (NSString * _Nullable)getExtensionPropertyWithVendor:(NSString * __nonnull)provider extension:(NSString * __nonnull)extension key:(NSString * __nonnull)key sourceType:(AgoraMediaSourceType)sourceType;
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- key
- The key of the extension.
- sourceType
- Source type of the extension. See AgoraMediaSourceType.
Returns
- The extension information, if the method call succeeds.
- An empty string, if the method call fails.
createMediaPlayerCacheManager
Creates one AgoraRtcMediaPlayerCacheManagerProtocol instance.
- (id<AgoraRtcMediaPlayerCacheManagerProtocol> _Nullable)createMediaPlayerCacheManager;
Make sure the AgoraRtcEngineKit is initialized before you call this method.
Returns
The AgoraRtcMediaPlayerCacheManagerProtocol instance.
getNativeHandle
Gets the C++ handle of the Native SDK.
- (void* _Nullable)getNativeHandle;
This method retrieves the C++ handle of the SDK, for example for registering the audio and video frame observer.
Returns
The native handle of the SDK.
getNetworkType
Gets the type of the local network connection.
- (int) getNetworkType;
- Since
- v4.0.1
You can use this method to get the type of network in use at any stage.
Returns
- ≥ 0: The method call is successful, and the local network connection type is returned.
- 0: The SDK disconnects from the network.
- 1: The network type is LAN.
- 2: The network type is Wi-Fi (including hotspots).
- 3: The network type is mobile 2G.
- 4: The network type is mobile 3G.
- 5: The network type is mobile 4G.
- 6: The network type is mobile 5G.
- < 0: The method call failed with an error code.
- -1: The network type is unknown.
getSdkVersion
Gets the SDK version.
+ (NSString * _Nonnull)getSdkVersion;
Parameters
Returns
The SDK version number. The format is a string.
getUserInfoWithUserId
Gets the user information by passing in the user ID.
- (AgoraUserInfo* _Nullable)getUserInfoByUid:(NSUInteger)uid withError:(AgoraErrorCode* _Nullable)error;
After a remote user joins the channel, the SDK gets the UID and User Account of the remote user, caches them in a mapping table object, and triggers the didUserInfoUpdatedWithUserId callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the AgoraUserInfo object by passing in the user ID.
Parameters
- uid
- The user ID.
- error
- Error code.
Returns
The AgoraUserInfo object that identifies the user information.
- A pointer to the AgoraUserInfo instance, if the method call succeeds.
- If the call fails, returns nil.
getUserInfoWithUserAccount
Gets the user information by passing in the User Account.
- (AgoraUserInfo* _Nullable)getUserInfoByUserAccount:(NSString* _Nonnull)userAccount withError:(AgoraErrorCode* _Nullable)error;
After a remote user joins the channel, the SDK gets the UID and User Account of the remote user, caches them in a mapping table object, and triggers the didUserInfoUpdatedWithUserId callback on the local client. After receiving the callback, you can call this method to get the user account of the remote user from the AgoraUserInfo object by passing in the user ID.
Parameters
- userAccount
- The user account.
- error
- Error code.
Returns
The AgoraUserInfo object that identifies the user information.
- A pointer to the AgoraUserInfo instance, if the method call succeeds.
- If the call fails, returns nil.
getVolumeOfEffect
Gets the volume of a specified audio effect.
- (int)getVolumeOfEffect:(int)soundId;
Parameters
- soundId
- The ID of the audio effect.
Returns
- The volume of the specified audio effect, if the method call succeeds. The value range is [0,100]. 100 represents the original volume.
- < 0: Failure.
isCameraAutoExposureFaceModeSupported
Checks whether the device supports auto exposure.
- (BOOL)isCameraAutoExposureFaceModeSupported;
- Call this method after enabling the local camera, for example, by calling joinChannelByToken [2/4], enableVideo, or enableLocalVideo,depending on which method you use to turn on your local camera.
Returns
YES
: The device supports auto exposure.NO
: The device does not support auto exposure.
isCameraAutoFocusFaceModeSupported
Checks whether the device supports the face auto-focus function.
- (BOOL)isCameraAutoFocusFaceModeSupported;
- Call this method after enabling the local camera, for example, by calling joinChannelByToken [2/4], enableVideo, or enableLocalVideo,depending on which method you use to turn on your local camera.
Returns
YES
: The device supports the face auto-focus function.NO
: The device does not support the face auto-focus function.
isCameraExposurePositionSupported
Checks whether the device supports manual exposure.
- (BOOL)isCameraExposurePositionSupported;
- Call this method after enabling the local camera, for example, by calling joinChannelByToken [2/4], enableVideo, or enableLocalVideo,depending on which method you use to turn on your local camera.
Returns
YES
: The device supports manual exposure.NO
: The device does not support manual exposure.
isCameraFocusSupported
Check whether the device supports the manual focus function.
- (BOOL)isCameraFocusPositionInPreviewSupported;
- Call this method after enabling the local camera, for example, by calling joinChannelByToken [2/4], enableVideo, or enableLocalVideo,depending on which method you use to turn on your local camera.
Returns
YES
: The device supports the manual focus function.NO
: The device does not support the manual focus function.
isCameraTorchSupported
Checks whether the device supports camera flash.
- (BOOL)isCameraTorchSupported NS_SWIFT_NAME(isCameraTorchSupported());
- Call this method after enabling the local camera, for example, by calling joinChannelByToken [2/4], enableVideo, or enableLocalVideo,depending on which method you use to turn on your local camera.
- The app enables the front camera by default. If your front camera does not support enabling the flash, this method returns NO. If you want to check whether the rear camera supports the flash function, call switchCamera before this method.
- On iPads with system version 15, even if isCameraTorchSupported returns
YES
, you might fail to successfully enable the flash by calling setCameraTorchOn due to system issues.
Returns
YES
: The device supports enabling the flash.NO
: The device does not support enabling the flash.
isCameraZoomSupported
Checks whether the device supports camera zoom.
- (BOOL)isCameraZoomSupported;
- Call this method after enabling the local camera, for example, by calling joinChannelByToken [2/4], enableVideo, or enableLocalVideo,depending on which method you use to turn on your local camera.
Returns
YES
: The device supports camera zoom.NO
: The device does not support camera zoom.
isSpeakerphoneEnabled
Checks whether the speakerphone is enabled.
- (BOOL)isSpeakerphoneEnabled;
Returns
YES
: The speakerphone is enabled, and the audio plays from the speakerphone.NO
: The speakerphone is not enabled, and the audio plays from devices other than the speakerphone. For example, the headset or earpiece.
joinChannelByToken [1/4]
Joins a channel.
- (int)joinChannelByToken:(NSString * _Nullable)token channelId:(NSString * _Nonnull)channelId info:(NSString * _Nullable)info uid:(NSUInteger)uid joinSuccess:(void(^ _Nullable)(NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))joinSuccessBlock;
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.
- The local client: The didJoinChannel and connectionChangedToState callbacks.
- The remote client: didJoinedOfUid, if the user joining the channel is in the Communication profile or is a host in the Live-broadcasting profile.
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 didRejoinChannel callback on the local client.
Parameters
- token
- The token generated on your server for authentication. See .
- channelId
-
The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- Space
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- info
- (Optional) Reserved for future use.
- uid
- The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the didJoinChannel callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
- joinSuccessBlock
- Occurs when a user joins a channel. If you implement both
joinSuccessBlock
and didJoinChannel, joinSuccessBlock takes higher priority than didJoinChannel. Agora recommends settingjoinSuccessBlock
asnil
to use didJoinChannel.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid. For example, the token is invalid, the uid parameter is not set to an integer, or the value of a member in the AgoraRtcChannelMediaOptions structure is invalid. You need to pass in a valid parameter and join the channel again.
- -3: Failes to initialize the AgoraRtcEngineKit object. You need to reinitialize the AgoraRtcEngineKit object.
- -7: The AgoraRtcEngineKit object has not been initialized. You need to initialize the AgoraRtcEngineKit object before calling this method.
- -8: AgoraRtcEngineKitThe internal state of the object is wrong. The typical cause is that you call this method to join the channel without calling stopEchoTest to stop the test after calling startEchoTestWithInterval to start a call loop test. You need to call stopEchoTest before calling this method.
- -17: The request to join the channel is rejected. The typical cause is that the user is in the channel. Agora recommends using the connectionChangedToState callback to get whether the user is in the channel. Do not call this method to join the channel unless you receive the AgoraConnectionStateDisconnected(1) state.
- -102: The channel name is invalid. You need to pass in a valid channel name inchannelId to rejoin the channel.
- -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
joinChannelByToken [2/4]
Joins a channel with media options.
- (int)joinChannelByToken:(NSString * _Nullable)token channelId:(NSString * _Nonnull)channelId uid:(NSUInteger)uid mediaOptions:(AgoraRtcChannelMediaOptions * _Nonnull)mediaOptions joinSuccess:(void(^ _Nullable)(NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))joinSuccessBlock;
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.
- The local client: The didJoinChannel and connectionChangedToState callbacks.
- The remote client: didJoinedOfUid, if the user joining the channel is in the Communication profile or is a host in the Live-broadcasting profile.
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 didRejoinChannel callback on the local client.
Compared to joinChannelByToken [1/4], this method adds the options parameter to configure whether to automatically subscribe to all remote audio and video streams in the channel when the user joins the channel. 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 the options parameter or call the mute methods accordingly.
- This method allows users to join only one channel at a time.
- Ensure that the app ID you use to generate the token is the same app ID that you pass in the sharedEngineWithConfig method; otherwise, you may fail to join the channel by token.
Parameters
- token
- The token generated on your server for authentication. See .
- channelId
-
The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- Space
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- uid
- The user ID. This parameter is used to identify the user in the channel for real-time audio and video interaction. You need to set and manage user IDs yourself, and ensure that each user ID in the same channel is unique. This parameter is a 32-bit unsigned integer. The value range is 1 to 232-1. If the user ID is not assigned (or set to 0), the SDK assigns a random user ID and returns it in the didJoinChannel callback. Your application must record and maintain the returned user ID, because the SDK does not do so.
- mediaOptions
- The channel media options. See AgoraRtcChannelMediaOptions.
- joinSuccessBlock
- Occurs when a user joins a channel. If you implement both
joinSuccessBlock
and didJoinChannel, joinSuccessBlock takes higher priority than didJoinChannel. Agora recommends settingjoinSuccessBlock
asnil
to use didJoinChannel.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid. For example, the token is invalid, the uid parameter is not set to an integer, or the value of a member in the AgoraRtcChannelMediaOptions structure is invalid. You need to pass in a valid parameter and join the channel again.
- -3: Failes to initialize the AgoraRtcEngineKit object. You need to reinitialize the AgoraRtcEngineKit object.
- -7: The AgoraRtcEngineKit object has not been initialized. You need to initialize the AgoraRtcEngineKit object before calling this method.
- -8: AgoraRtcEngineKitThe internal state of the object is wrong. The typical cause is that you call this method to join the channel without calling stopEchoTest to stop the test after calling startEchoTestWithInterval to start a call loop test. You need to call stopEchoTest before calling this method.
- -17: The request to join the channel is rejected. The typical cause is that the user is in the channel. Agora recommends using the connectionChangedToState callback to get whether the user is in the channel. Do not call this method to join the channel unless you receive the AgoraConnectionStateDisconnected(1) state.
- -102: The channel name is invalid. You need to pass in a valid channel name inchannelId to rejoin the channel.
- -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
joinChannelByToken [3/4]
Joins a channel with a User Account and Token.
- (int)joinChannelByToken:(NSString * _Nullable)token channelId:(NSString * _Nonnull)channelId userAccount:(NSString * _Nonnull)userAccount joinSuccess:(void(^ _Nullable)(NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))joinSuccessBlock;
- The local client: didLocalUserRegisteredWithUserId, didJoinChannel and connectionChangedToState callbacks.
- The remote client: didJoinedOfUid and didUserInfoUpdatedWithUserId, if the user joining the channel is in the communication profile or is a host in the live streaming profile.
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.
Parameters
- token
- The token generated on your server for authentication. See .
- channelId
-
The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- Space
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- userAccount
-
The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as nil. Supported characters are (89 in total):
- The 26 lowercase English letters: a to z.
- The 26 uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- Space
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- joinSuccessBlock
- Occurs when a user joins a channel. If you implement both
joinSuccessBlock
and didJoinChannel, joinSuccessBlock takes higher priority than didJoinChannel. Agora recommends settingjoinSuccessBlock
asnil
to use didJoinChannel.
Returns
- 0: Success.
- < 0: Failure.
- 2: The parameter is invalid.
- 3: The initialization of the SDK fails. You can try to initialize the SDK again.
- 5: The request is rejected.
- 17: The request to join the channel is rejected. Since the SDK only supports users to join one AgoraRtcEngineKit channel at a time; this error code will be returned when the user who has joined the AgoraRtcEngineKit channel calls the join channel method in the AgoraRtcEngineKit class again with a valid channel name.
joinChannelByToken [4/4]
Joins the channel with a user account, and configures whether to automatically subscribe to audio or video streams after joining the channel.
- (int)joinChannelByToken:(NSString * _Nullable)token channelId:(NSString * _Nonnull)channelId userAccount:(NSString * _Nonnull)userAccount mediaOptions:(AgoraRtcChannelMediaOptions * _Nonnull)mediaOptions joinSuccess:(void(^ _Nullable)(NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))joinSuccessBlock;
- The local client: didLocalUserRegisteredWithUserId, didJoinChannel and connectionChangedToState callbacks.
- The remote client: The didJoinedOfUid callback if the user is in the COMMUNICATION profile, and the didUserInfoUpdatedWithUserId callback if the user is a host in the LIVE_BROADCASTING profile.
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.
Compared to joinChannelByToken [3/4], this method adds the options parameter to configure whether to automatically subscribe to all remote audio and video streams in the channel when the user joins the channel. 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 the options parameter or call the mute methods accordingly.
Parameters
- token
- The token generated on your server for authentication. See .
- channelId
-
The channel name. This parameter signifies the channel in which users engage in real-time audio and video interaction. Under the premise of the same App ID, users who fill in the same channel ID enter the same channel for audio and video interaction. The string length must be less than 64 bytes. Supported characters:
- All lowercase English letters: a to z.
- All uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- Space
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- userAccount
-
The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as nil. Supported characters are (89 in total):
- The 26 lowercase English letters: a to z.
- The 26 uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- Space
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
- mediaOptions
- The channel media options. See AgoraRtcChannelMediaOptions.
- joinSuccessBlock
- Occurs when a user joins a channel. If you implement both
joinSuccessBlock
and didJoinChannel, joinSuccessBlock takes higher priority than didJoinChannel. Agora recommends settingjoinSuccessBlock
asnil
to use didJoinChannel.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid. For example, the token is invalid, the uid parameter is not set to an integer, or the value of a member in the AgoraRtcChannelMediaOptions structure is invalid. You need to pass in a valid parameter and join the channel again.
- -3: Failes to initialize the AgoraRtcEngineKit object. You need to reinitialize the AgoraRtcEngineKit object.
- -7: The AgoraRtcEngineKit object has not been initialized. You need to initialize the AgoraRtcEngineKit object before calling this method.
- -8: AgoraRtcEngineKitThe internal state of the object is wrong. The typical cause is that you call this method to join the channel without calling stopEchoTest to stop the test after calling startEchoTestWithInterval to start a call loop test. You need to call stopEchoTest before calling this method.
- -17: The request to join the channel is rejected. The typical cause is that the user is in the channel. Agora recommends using the connectionChangedToState callback to get whether the user is in the channel. Do not call this method to join the channel unless you receive the AgoraConnectionStateDisconnected(1) state.
- -102: The channel name is invalid. You need to pass in a valid channel name inchannelId to rejoin the channel.
- -121: The user ID is invalid. You need to pass in a valid user ID in uid to rejoin the channel.
leaveChannel [1/2]
Leaves a channel.
- (int)leaveChannel:(void(^ _Nullable)(AgoraChannelStats * _Nonnull stat))leaveChannelBlock;
This method releases all resources related to the session.
This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel.
After joining the channel, you must call this method or leaveChannel [2/2] to end the call, otherwise, the next call cannot be started.
- The local client: didLeaveChannelWithStats.
- The remote client: didOfflineOfUid, if the user joining the channel is in the Communication profile, or is a host in the Live-broadcasting profile.
- If you call destroy immediately after calling this method, the SDK does not trigger the didLeaveChannelWithStats callback.
Parameters
- leaveChannelBlock
-
This callback indicates that a user leaves a channel, and provides the statistics of the call in AgoraChannelStats.
Returns
- 0: Success.
- < 0: Failure.
- -1(ERR_FAILED): A general error occurs (no specified reason).
- -2 (ERR_INVALID_ARGUMENT): The parameter is invalid.
- -7(ERR_NOT_INITIALIZED): The SDK is not initialized.
leaveChannel [2/2]
Leaves a channel.
- (int)leaveChannel:(AgoraLeaveChannelOptions * _Nonnull)options leaveChannelBlock:(void (^ _Nullable)(AgoraChannelStats * _Nonnull))leaveChannelBlock;
This method lets the user leave the channel, for example, by hanging up or exiting the call.
After joining the channel, you must call this method or leaveChannel [1/2] to end the call, otherwise, the next call cannot be started.
No matter whether you are currently in a call or not, you can call this method without side effects. This method releases all resources related to the session.
This method call is asynchronous. When this method returns, it does not necessarily mean that the user has left the channel. After you leave the channel, the SDK triggers the didLeaveChannelWithStats callback.
A successful call of this method triggers the following callbacks: The local client: didLeaveChannelWithStats. The remote client: didOfflineOfUid, if the user joining the channel is in the COMMUNICATION profile, or is a host in the LIVE_BROADCASTING profile.
- If you call destroy immediately after calling this method, the SDK does not trigger the didLeaveChannelWithStats callback.
Parameters
- options
- The options for leaving the channel. See AgoraLeaveChannelOptions.
- leaveChannelBlock
-
This callback indicates that a user leaves a channel, and provides the statistics of the call in AgoraChannelStats.
Returns
- 0: Success.
- < 0: Failure.
muteAllRemoteAudioStreams
Stops or resumes subscribing to the audio streams of all remote users.
- (int)muteAllRemoteAudioStreams:(BOOL)mute;
After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.
- Call this method after joining a channel.
- If you do not want to subscribe the audio streams of remote users before joining a channel, you can call joinChannelByToken [2/4] and set autoSubscribeAudio as
NO
. - See recommended settings in Set the Subscribing State.
Parameters
- mute
-
Whether to stop subscribing to the audio streams of all remote users:
YES
: Stop subscribing to the audio streams of all remote users.NO
: (Default) Subscribe to the audio streams of all remote users by default.
Returns
- 0: Success.
- < 0: Failure.
muteAllRemoteVideoStreams
Stops or resumes subscribing to the video streams of all remote users.
- (int)muteAllRemoteVideoStreams:(BOOL)mute;
After successfully calling this method, the local user stops or resumes subscribing to the audio streams of all remote users, including all subsequent users.
- Call this method after joining a channel.
- If you do not want to subscribe the video streams of remote users before joining a channel, you can call joinChannelByToken [2/4] and set autoSubscribeVideo as
NO
.
Parameters
- mute
-
Whether to stop subscribing to the video streams of all remote users.
YES
: Stop subscribing to the video streams of all remote users.NO
: (Default) Subscribe to the audio streams of all remote users by default.
Returns
- 0: Success.
- < 0: Failure.
muteLocalAudioStream
Stops or resumes publishing the local audio stream.
- (int)muteLocalAudioStream:(BOOL)mute;
Parameters
- mute
-
Whether to stop publishing the local audio stream.
YES
: Stop publishing the local audio stream.NO
: (Default) Resumes publishing the local audio stream.
Returns
- 0: Success.
- < 0: Failure.
muteLocalVideoStream
Stops or resumes publishing the local video stream.
- (int)muteLocalVideoStream:(BOOL)mute;
A successful call of this method triggers the didVideoMuted callback on the remote client.
- This method executes faster than the enableLocalVideo(
NO
) method, which controls the sending of the local video stream. - This method does not affect any ongoing video recording, because it does not disable the camera.
Parameters
- mute
-
Whether to stop publishing the local video stream.
YES
: Stop publishing the local video stream.NO
: (Default) Publish the local video stream.
Returns
- 0: Success.
- < 0: Failure.
muteRemoteAudioStream
Cancels or resumes subscribing to the specified remote user's audio stream.
- (int)muteRemoteAudioStream:(NSUInteger)uid mute:(BOOL)mute;
- Call this method after joining a channel.
Parameters
- uid
- The user ID of the specified user.
- mute
-
Whether to stop subscribing to the audio stream of the specified user.
YES
: Unsubscribe from the specified user's audio stream.NO
: (Default) Subscribes to the specified user's audio stream.
Returns
- 0: Success.
- < 0: Failure.
muteRemoteVideoStream
Cancels or resumes subscribing to the specified remote user's video stream.
- (int)muteRemoteVideoStream:(NSUInteger)uid mute:(BOOL)mute;
- Call this method after joining a channel.
Parameters
- uid
- The user ID of the specified user.
- mute
-
Whether to subscribe to the specified remote user's video stream.
YES
: Unsubscribe from the specified user's video stream.NO
: (Default) Subscribes to the specified user's video stream.
Returns
- 0: Success.
- < 0: Failure.
pauseAllChannelMediaRelay
Pauses the media stream relay to all destination channels.
- (int)pauseAllChannelMediaRelay;
After the cross-channel media stream relay starts, you can call this method to pause relaying media streams to all destination channels; after the pause, if you want to resume the relay, call resumeAllChannelMediaRelay.
After a successful method call, the SDK triggers the didReceiveChannelMediaRelayEvent callback to report whether the media stream relay is successfully paused.
Returns
- 0: Success.
- < 0: Failure.
pauseAudioMixing
Pauses playing the music file.
- (int)pauseAudioMixing;
Call this method after joining a channel.
Returns
- 0: Success.
- < 0: Failure.
pauseAllEffects
Pauses playing all audio effect files.
- (int)pauseAllEffects;
Returns
- 0: Success.
- < 0: Failure.
pauseEffect
Pauses playing a specified audio effect file.
- (int)pauseEffect:(int)soundId;
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
Returns
- 0: Success.
- < 0: Failure.
playEffect [1/3]
Plays the specified local or online audio effect file.
- (int)playEffect:(int)soundId filePath:(NSString* _Nonnull)filePath loopCount:(NSInteger)loopCount pitch:(double)pitch pan:(double)pan gain:(NSInteger)gain;
To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. For a better user experience, Agora recommends playing no more than three audio effect files at the same time. After the playback of an audio effect file completes, the SDK triggers the rtcEngineDidAudioEffectFinish callback.
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of soundId in preloadEffect.
- filePath
-
The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example:
/var/mobile/Containers/Data/audio.mp4
. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. See supported audio formats. - loopCount
-
The number of times the audio effect loops.
- ≥ 0: The number of playback times. For example, 1 means looping one time, which means playing the audio effect two times in total.
- -1: Play the audio effect in an infinite loop.
- pitch
- The pitch of the audio effect. The value range is 0.5 to 2.0. The default value is 1.0, which means the original pitch. The lower the value, the lower the pitch.
- pan
-
The spatial position of the audio effect. The value ranges between -1.0 and 1.0:
- -1.0: The audio effect is heard on the left of the user.
- 0.0: The audio effect is heard in front of the user.
- 1.0: The audio effect is heard on the right of the user.
- gain
- The volume of the audio effect. The value range is 0.0 to 100.0. The default value is 100.0, which means the original volume. The smaller the value, the lower the volume.
Returns
- 0: Success.
- < 0: Failure.
playEffect [2/3]
Plays the specified local or online audio effect file.
- (int)playEffect:(int)soundId filePath:(NSString* _Nonnull)filePath loopCount:(NSInteger)loopCount pitch:(double)pitch pan:(double)pan gain:(NSInteger)gain publish:(BOOL)publish;
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of soundId in preloadEffect.
- filePath
-
Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of filePath in preloadEffect.
- loopCount
-
The number of times the audio effect loops.
- ≥ 0: The number of playback times. For example, 1 means looping one time, which means playing the audio effect two times in total.
- -1: Play the audio effect in an infinite loop.
- pitch
- The pitch of the audio effect. The value range is 0.5 to 2.0. The default value is 1.0, which means the original pitch. The lower the value, the lower the pitch.
- pan
-
The spatial position of the audio effect. The value ranges between -1.0 and 1.0:
- -1.0: The audio effect is heard on the left of the user.
- 0.0: The audio effect is heard in front of the user.
- 1.0: The audio effect is heard on the right of the user.
- gain
- The volume of the audio effect. The value range is 0.0 to 100.0. The default value is 100.0, which means the original volume. The smaller the value, the lower the volume.
- publish
-
Whether to publish the audio effect to the remote users.
YES
: Publish the audio effect to the remote users. Both the local user and remote users can hear the audio effect.NO
: Do not publish the audio effect to the remote users. Only the local user can hear the audio effect.
Returns
- 0: Success.
- < 0: Failure.
playEffect [3/3]
Plays the specified local or online audio effect file.
- (int)playEffect:(int)soundId filePath:(NSString* _Nonnull)filePath loopCount:(NSInteger)loopCount pitch:(double)pitch pan:(double)pan gain:(NSInteger)gain publish:(BOOL)publish startPos:(int)startPos;
To play multiple audio effect files at the same time, call this method multiple times with different soundId and filePath. For a better user experience, Agora recommends playing no more than three audio effect files at the same time. After the playback of an audio effect file completes, the SDK triggers the rtcEngineDidAudioEffectFinish callback.
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of soundId in preloadEffect.
- filePath
-
The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example:
/var/mobile/Containers/Data/audio.mp4
. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. See supported audio formats.Attention: If you have preloaded an audio effect into memory by calling preloadEffect, ensure that the value of this parameter is the same as that of filePath in preloadEffect. - loopCount
-
The number of times the audio effect loops.
- ≥ 0: The number of playback times. For example, 1 means looping one time, which means playing the audio effect two times in total.
- -1: Play the audio effect in an infinite loop.
- pitch
- The pitch of the audio effect. The value range is 0.5 to 2.0. The default value is 1.0, which means the original pitch. The lower the value, the lower the pitch.
- pan
-
The spatial position of the audio effect. The value ranges between -1.0 and 1.0:
- -1.0: The audio effect is heard on the left of the user.
- 0.0: The audio effect is heard in front of the user.
- 1.0: The audio effect is heard on the right of the user.
- gain
- The volume of the audio effect. The value range is 0.0 to 100.0. The default value is 100.0, which means the original volume. The smaller the value, the lower the volume.
- publish
-
Whether to publish the audio effect to the remote users:
YES
: Publish the audio effect to the remote users. Both the local user and remote users can hear the audio effect.NO
: Do not publish the audio effect to the remote users. Only the local user can hear the audio effect.
- startPos
-
The playback position (ms) of the audio effect file.
Returns
- 0: Success.
- < 0: Failure.
preloadEffect
Preloads a specified audio effect file into the memory.
- (int)preloadEffect:(int)soundId filePath:(NSString* _Nonnull)filePath;
To ensure smooth communication, limit the size of the audio effect file. Agora recommends using this method to preload the audio effect before calling joinChannelByToken [2/4].
- This method does not support online audio effect files.
- For the audio file formats supported by this method, see What formats of audio files the Agora RTC SDK support.
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
- filePath
- File path:
- iOS or macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example:
/var/mobile/Containers/Data/audio.mp4
.
- iOS or macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example:
Returns
- 0: Success.
- < 0: Failure.
pullPlaybackAudioFrameRawData
Pulls the remote audio data.
- (BOOL)pullPlaybackAudioFrameRawData:(void * _Nonnull)data lengthInByte:(NSUInteger)lengthInByte;
Before calling this method, you need to call enableExternalAudioSink to notify the app to enable and set the external rendering.
After a successful method call, the app pulls the decoded and mixed audio data for playback.
- This method only supports pulling data from custom audio source. If you need to pull the data captured by the SDK, do not call this method.
- Call this method after joining a channel.
- Once you enable the external audio sink, the app will not retrieve any audio data from the onPlaybackAudioFrame callback.
- The difference between this method and the onPlaybackAudioFrame callback is as follows:
- The SDK sends the audio data to the app through the onPlaybackAudioFrame callback. Any delay in processing the audio frames may result in audio jitter.
- After a successful method call, the app automatically pulls the audio data from the SDK. After setting the audio data parameters, the SDK adjusts the frame buffer and avoids problems caused by jitter in the external audio playback.
Parameters
- data
- The remote audio data to be pulled. The data type is
byte[]
. - lengthInByte
- The data length (byte). The value of this parameter is related to the audio duration, and the values of the
sampleRate
andchannels
parameters that you set in enableExternalAudioSink.lengthInByte
=sampleRate
/1000 × 2 ×channels
× audio duration (ms).
Returns
YES
: Success.NO
: Failure.
pullPlaybackAudioFrameSampleBufferByLengthInByte
Pulls remote audio data in the SampleBuffer format.
- (CMSampleBufferRef _Nullable)pullPlaybackAudioFrameSampleBufferByLengthInByte:(NSUInteger)lengthInByte;
Before calling this method, you need to call enableExternalAudioSink to notify the app to enable and set the external rendering.
After a successful method call, the app pulls the decoded and mixed audio data for playback.
- This method only supports pulling data from custom audio source. If you need to pull the data captured by the SDK, do not call this method.
- Call this method after joining a channel.
- Once you enable the external audio sink, the app will not retrieve any audio data from the onPlaybackAudioFrame callback.
- The difference between this method and the onPlaybackAudioFrame callback is as follows:
- The SDK sends the audio data to the app through the onPlaybackAudioFrame callback. Any delay in processing the audio frames may result in audio jitter.
- After a successful method call, the app automatically pulls the audio data from the SDK. After setting the audio data parameters, the SDK adjusts the frame buffer and avoids problems caused by jitter in the external audio playback.
Parameters
- lengthInByte
- The data length (byte). The value of this parameter is related to the audio duration, and the values of the
sampleRate
andchannels
parameters that you set in enableExternalAudioSink.lengthInByte
=sampleRate
/1000 × 2 ×channels
× audio duration (ms).
Returns
YES
: Success.NO
: Failure.
pushExternalAudioFrameRawData
Pushes the external audio frame.
- (int)pushExternalAudioFrameRawData:(void * _Nonnull)data samples:(NSInteger)samples sourceId:(NSInteger)sourceId timestamp:(NSTimeInterval)timestamp;
Parameters
- data
- External audio data.
- samples
- Number of samples for the push.
- timestamp
- The timestamp (ms) of the external audio frame. It is required. You can use it to restore the order of the captured audio frame, or synchronize audio and video frames in video-related scenarios (including scenarios where external video sources are used).
- sourceId
- The ID of external audio source. If you want to publish a custom external audio source, set this parameter to the ID of the corresponding custom audio track you want to publish.
Returns
- 0: Success.
- < 0: Failure.
pushExternalAudioFrameNSData
Pushes the external audio frames to the SDK.
- (int)pushExternalAudioFrameNSData:(NSData * _Nonnull)data sourceId:(NSInteger)sourceId timestamp:(NSTimeInterval)timestamp;
Make sure you set the publishCustomAudioTrack in the AgoraRtcChannelMediaOptions as YES
before calling this method.
Parameters
- data
- External audio data.
- timestamp
- The timestamp (ms) of the external audio frame. It is required. You can use it to restore the order of the captured audio frame, or synchronize audio and video frames in video-related scenarios (including scenarios where external video sources are used).
- sourceId
- The ID of external audio source. If you want to publish a custom external audio source, set this parameter to the ID of the corresponding custom audio track you want to publish.
Returns
- 0: Success.
- < 0: Failure.
pushExternalAudioFrameSampleBuffer
Pushes external CMSampleBuffer audio frames.
- (int)pushExternalAudioFrameSampleBuffer:(CMSampleBufferRef _Nonnull)sampleBuffer;
Parameters
- sampleBuffer
- The sample buffer.
Returns
- 0: Success.
- < 0: Failure.
pushExternalVideoFrame
Pushes the external raw video frame to the SDK.
- (BOOL)pushExternalVideoFrame:(AgoraVideoFrame * _Nonnull)frame;
To push the unencoded external raw video frame to the SDK, call setExternalVideoSource, set enabled as YES
, and set encodedFrame as NO
.
Parameters
- frame
-
The external raw video frame to be pushed. See AgoraVideoFrame.
Returns
YES
: Pushes the external raw video frame to the SDK successfully.NO
: Fails to push external raw video frame to the SDK.
rate
Allows a user to rate a call after the call ends.
- (int)rate:(NSString * _Nonnull)callId rating:(NSInteger)rating description:(NSString * _Nullable)description;
Parameters
- callId
- The current call ID. You can get the call ID by calling getCallId.
- rating
- The rating of the call. The value is between 1 (lowest score) and 5 (highest score). If you set a value out of this range, the SDK returns the -2 (
ERR_INVALID_ARGUMENT
) error. - description
- (Optional) A description of the call. The string length should be less than 800 bytes.
Returns
- 0: Success.
- < 0: Failure.
- -2 (
ERR_INVALID_ARGUMENT
). - -3 (
ERR_NOT_READY
).
- -2 (
registerAudioEncodedFrameObserver
Registers an encoded audio observer.
- (int)setAudioEncodedFrameDelegate:(id<AgoraAudioEncodedFrameDelegate> _Nonnull)delegate config:(AgoraAudioEncodedFrameDelegateConfig * _Nonnull) config;
- Call this method after joining a channel.
- You can call this method or the startAudioRecording [2/2] method to set the audio content and audio quality. Agora recommends not using this method and startAudioRecording [2/2] at the same time; otherwise, only the method called later takes effect.
Parameters
- config
- Observer settings for the encoded audio. See AgoraAudioEncodedFrameDelegateConfig.
- delegate
- The encoded audio observer. See AgoraAudioEncodedFrameDelegate.
Returns
- 0: Success.
- < 0: Failure.
setAudioFrameDelegate
Registers an audio frame observer object.
- (BOOL)setAudioFrameDelegate:(id<AgoraAudioFrameDelegate> _Nullable)delegate;
Call this method to register an audio frame observer object (register a callback). When you need the SDK to trigger onMixedAudioFrame, onRecordAudioFrame, onPlaybackAudioFrame or onEarMonitoringAudioFrame callback, you need to use this method to register the callbacks.
Parameters
- delegate
-
The observer object instance. See AgoraAudioFrameDelegate. Set the value as nil to release the instance. Agora recommends calling after receiving didLeaveChannelWithStats to release the audio observer object.
Returns
YES
: Success.NO
: Failure.
registerAudioSpectrumDelegate
Registers an audio spectrum observer.
- (int)registerAudioSpectrumDelegate:(id<AgoraAudioSpectrumDelegate> _Nullable )delegate;
After successfully registering the audio spectrum observer and calling enableAudioSpectrumMonitor to enable the audio spectrum monitoring, the SDK reports the callback that you implement in the AgoraAudioSpectrumDelegate class at the time interval you set.
Parameters
- delegate
-
The Audio spectrum observer. See AgoraAudioSpectrumDelegate.
Returns
- 0: Success.
- < 0: Failure.
registerLocalUserAccountWithAppID
Registers a user account.
- (int)registerLocalUserAccountWithAppID:(NSString * _Nonnull)appID userAccount:(NSString * _Nonnull)userAccount;
Once registered, the user account can be used to identify the local user when the user joins the channel. After the registration is successful, the user account can identify the identity of the local user, and the user can use it to join the channel.
After the user successfully registers a user account, the SDK triggers the didLocalUserRegisteredWithUserId callback on the local client, reporting the user ID and user account of the local user.
- Call registerLocalUserAccountWithAppID to create a user account, and then call joinChannelByToken [4/4] to join the channel.
- Call the joinChannelByToken [4/4] method to join the channel.
The difference between the two ways is that the time elapsed between calling the registerLocalUserAccountWithAppID method and joining the channel is shorter than directly calling joinChannelByToken [4/4].
- Ensure that you set the userAccount parameter; otherwise, this method does not take effect.
- Ensure that the userAccount is unique in the channel.
- To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the ID of the user is set to the same parameter type.
Parameters
- appID
- The App ID of your project on Agora Console.
- userAccount
-
The user account. This parameter is used to identify the user in the channel for real-time audio and video engagement. You need to set and manage user accounts yourself and ensure that each user account in the same channel is unique. The maximum length of this parameter is 255 bytes. Ensure that you set this parameter and do not set it as nil. Supported characters are (89 in total):
- The 26 lowercase English letters: a to z.
- The 26 uppercase English letters: A to Z.
- All numeric characters: 0 to 9.
- Space
- "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "= ", ".", ">", "?", "@", "[", "]", "^", "_", "{", "}", "|", "~", ","
Returns
- 0: Success.
- < 0: Failure.
setMediaMetadataDelegate
Registers the metadata observer.
- (BOOL)setMediaMetadataDelegate:(id<AgoraMediaMetadataDelegate> _Nullable)metadataDelegate withType:(AgoraMetadataType)type;
You need to implement the AgoraMediaMetadataDelegate class and specify the metadata type in this method. This method enables you to add synchronized metadata in the video stream for more diversified live interactive streaming, such as sending shopping links, digital coupons, and online quizzes.
A successful call of this method triggers the metadataMaxSize callback.
Parameters
- observer
- The metadata observer. See AgoraMediaMetadataDelegate.
- type
-
The metadata type. The SDK currently only supports AgoraMetadataTypeVideo. See AgoraMetadataType.
Returns
- 0: Success.
- < 0: Failure.
registerVideoEncodedFrameObserver
Registers a receiver object for the encoded video image.
- (BOOL)setEncodedVideoFrameDelegate:(id<AgoraEncodedVideoFrameDelegate> _Nullable)delegate;
- Call this method after joining a channel.
- If you register an IVideoEncodedFrameObserver object, you cannot register an AgoraVideoFrameDelegate object.
Parameters
- delegate
- The observer object instance. See IVideoEncodedFrameObserver. Set the value as nil to release the instance.
Returns
YES
: Success.NO
: Failure.
setVideoFrameDelegate
Registers a video frame observer object.
- (BOOL)setVideoFrameDelegate:(id<AgoraVideoFrameDelegate> _Nullable)delegate;
You need to implement the AgoraVideoFrameDelegate class in this method and register callbacks according to your scenarios. After you successfully register the video frame observer, the SDK triggers the registered callbacks each time a video frame is received.
- When handling the video data returned in the callbacks, pay attention to the changes in the width and height parameters, which may be adapted under the following circumstances:
- When the network condition deteriorates, the video resolution decreases incrementally.
- If the user adjusts the video profile, the resolution of the video returned in the callbacks also changes.
- Ensure that you call this method before joining a channel.
Parameters
- delegate
- The observer object instance. See AgoraVideoFrameDelegate. To release the instance, set the value as nil.
Returns
YES
: Success.NO
: Failure.
resumeAllChannelMediaRelay
Resumes the media stream relay to all destination channels.
- (int)resumeAllChannelMediaRelay;
After calling the pauseAllChannelMediaRelay method, you can call this method to resume relaying media streams to all destination channels.
After a successful method call, the SDK triggers the didReceiveChannelMediaRelayEvent callback to report whether the media stream relay is successfully resumed.
Returns
- 0: Success.
- < 0: Failure.
resumeAllEffects
Resumes playing all audio effects.
- (int)resumeAllEffects;
Returns
- 0: Success.
- < 0: Failure.
resumeEffect
Resumes playing a specified audio effect.
- (int)resumeEffect:(int)soundId;
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
Returns
- 0: Success.
- < 0: Failure.
setEffectsVolume
Sets the volume of the audio effects.
- (int)setEffectsVolume:(NSInteger)volume;
Parameters
- volume
- The playback volume. The value range is [0, 100]. The default value is 100, which represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
setVolumeOfEffect
Sets the volume of a specified audio effect.
- (int)setVolumeOfEffect:(int)soundId withVolume:(int)volume;
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
- volume
- The playback volume. The value range is [0, 100]. The default value is 100, which represents the original volume.
Returns
- 0: Success.
- < 0: Failure.
stopAllEffects
Stops playing all audio effects.
- (int)stopAllEffects;
Returns
- 0: Success.
- < 0: Failure.
stopEffect
Stops playing a specified audio effect.
- (int)stopEffect:(int)soundId;
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
Returns
- 0: Success.
- < 0: Failure.
unloadEffect
Releases a specified preloaded audio effect from the memory.
- (int)unloadEffect:(int)soundId;
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
Returns
- 0: Success.
- < 0: Failure.
renewToken
Gets a new token when the current token expires after a period of time.
- (int)renewToken:(NSString * _Nonnull)token;
- The SDK triggers the tokenPrivilegeWillExpire callback.
- The connectionChangedToState callback reports AgoraConnectionChangedReasonTokenExpired(9).
Parameters
- token
- The new token.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid. For example, the token is invalid. You need to fill in a valid parameter.
- -7: The AgoraRtcEngineKit object has not been initialized. You need to initialize the AgoraRtcEngineKit object before calling this method.
resumeAudioMixing
Resumes playing and mixing the music file.
- (int)resumeAudioMixing;
This method resumes playing and mixing the music file. Call this method when you are in a channel.
Returns
- 0: Success.
- < 0: Failure.
selectAudioTrack
Selects the audio track used during playback.
- (int)selectAudioTrack:(int)index;
After getting the track index of the audio file, you can call this method to specify any track to play. For example, if different tracks of a multi-track file store songs in different languages, you can call this method to set the playback language.
Parameters
- index
- The index of the audio track.
Returns
- 0: Success.
- < 0: Failure.
sendCustomReportMessage
Reports customized messages.
- (int)sendCustomReportMessage:(NSString * _Nullable)messageId category:(NSString * _Nullable)category event:(NSString * _Nullable)event label:(NSString * _Nullable)label value:(NSInteger)value;
Agora supports reporting and analyzing customized messages. This function is in the beta stage with a free trial. The ability provided in its beta test version is reporting a maximum of 10 message pieces within 6 seconds, with each message piece not exceeding 256 bytes and each string not exceeding 100 bytes. To try out this function, contact support@agora.io and discuss the format of customized messages with us.
sendStreamMessage
Sends data stream messages.
- (int)sendStreamMessage:(NSInteger)streamId data:(NSData * _Nonnull)data;
- Up to 30 packets can be sent per second in a channel with each packet having a maximum size of 1 KB.
- Each client can send up to 6 KB of data per second.
- Each user can have up to five data streams simultaneously.
A successful method call triggers the receiveStreamMessageFromUid callback on the remote client, from which the remote user gets the stream message. A failed method call triggers the didOccurStreamMessageErrorFromUid callback on the remote client.
- Ensure that you call createDataStream [2/2] to create a data channel before calling this method.
- In live streaming scenarios, this method only applies to hosts.
Parameters
- streamId
- The data stream ID. You can get the data stream ID by calling createDataStream [2/2].
- data
- The data to be sent.
Returns
- 0: Success.
- < 0: Failure.
setAdvancedAudioOptions
Sets audio advanced options.
- (int)setAdvancedAudioOptions:(AgoraAdvancedAudioOptions * _Nonnull)options;
If you have advanced audio processing requirements, such as capturing and sending stereo audio, you can call this method to set advanced audio options.
- Call this method after calling joinChannelByToken [2/4], enableAudio and enableLocalAudio.
Parameters
- options
- The advanced options for audio. See AgoraAdvancedAudioOptions.
Returns
- 0: Success.
- < 0: Failure.
setAudioEffectParameters
Sets parameters for SDK preset audio effects.
- (int)setAudioEffectParameters:(AgoraAudioEffectPreset)preset param1:(int)param1 param2:(int)param2;
- 3D voice effect: Sets the cycle period of the 3D voice effect.
- Pitch correction effect: Sets the basic mode and tonic pitch of the pitch correction effect. Different songs have different modes and tonic pitches. Agora recommends bounding this method with interface elements to enable users to adjust the pitch correction interactively.
After setting the audio parameters, all users in the channel can hear the effect.
- You can call this method either before or after joining a channel.
- To get better audio effect quality, Agora recommends calling and setting scenario in setAudioProfile [1/2] as AgoraAudioScenarioGameStreaming(3) before calling this method.
- Do not set the profile parameter in setAudioProfile [1/2] to AgoraAudioProfileSpeechStandard(1), or the method does not take effect.
- This method works best with the human voice. Agora does not recommend using this method for audio containing music.
- After calling setAudioEffectParameters, Agora recommends not calling the following methods, or the settings in setAudioEffectParameters are overridden:
Parameters
- preset
- The options for SDK preset audio effects:
- AgoraAudioEffectPresetRoomAcous3DVoice, 3D voice effect:
- You need to set the profile parameter in setAudioProfile [1/2] to AgoraAudioProfileMusicStandardStereo(3) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator; otherwise, the enumerator setting does not take effect.
- If the 3D voice effect is enabled, users need to use stereo audio playback devices to hear the anticipated voice effect.
- AgoraAudioEffectPresetPitchCorrection; pitch correction effect: To achieve better audio effect quality, Agora recommends setting the profile parameter in setAudioProfile [1/2] to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before setting this enumerator.
- AgoraAudioEffectPresetRoomAcous3DVoice, 3D voice effect:
- param1
-
- If you set preset to AgoraAudioEffectPresetRoomAcous3DVoice, param1 indicates the cycle period of the 3D voice effect. The value range is [1,60], in seconds. The default value is 10, indicating that the voice moves around you every 10 seconds.
- If you set preset to AgoraAudioEffectPresetPitchCorrection, param1 indicates the basic mode of the pitch correction effect:
1
: (Default) Natural major scale.2
: Natural minor scale.3
: Japanese pentatonic scale.
- param2
-
- If you set preset to AgoraAudioEffectPresetRoomAcous3DVoice, you need to set param2 to
0
. - If you set preset to AgoraAudioEffectPresetPitchCorrection, param2 indicates the tonic pitch of the pitch correction effect:
1
: A2
: A#3
: B4
: (Default) C5
: C#6
: D7
: D#8
: E9
: F10
: F#11
: G12
: G#
- If you set preset to AgoraAudioEffectPresetRoomAcous3DVoice, you need to set param2 to
Returns
- 0: Success.
- < 0: Failure.
setAudioEffectPreset
Sets an SDK preset audio effect.
- (int)setAudioEffectPreset:(AgoraAudioEffectPreset)preset;
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.
To get better audio effect quality, Agora recommends calling setAudioProfile [1/2] and setting the scenario parameter as AgoraAudioScenarioGameStreaming (3) before calling this method.
- You can call this method either before or after joining a channel.
- Do not set the profile parameter in setAudioProfile [1/2] to AgoraAudioProfileSpeechStandard(1), or the method does not take effect.
- This method works best with the human voice. Agora does not recommend using this method for audio containing music.
- If you call setAudioEffectPreset and set enumerators except for AgoraAudioEffectPresetRoomAcous3DVoice or AgoraAudioEffectPresetPitchCorrection, do not call setAudioEffectParameters; otherwise, setAudioEffectPreset is overridden.
- After calling setAudioEffectPreset, Agora recommends not calling the following methods, or the settings in setAudioEffectPreset are overridden:
- This method relies on the voice beautifier dynamic library
AgoraAudioBeautyExtension.xcframework
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- preset
- The options for SDK preset audio effects. See AgoraAudioEffectPreset.
Returns
- 0: Success.
- < 0: Failure.
setAudioMixingDualMonoMode
Sets the channel mode of the current audio file.
- (int)setAudioMixingDualMonoMode:(AgoraAudioMixingDualMonoMode)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. 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.
- Call this method after calling startAudioMixing [2/2] and receiving the
audioMixingStateChanged (AgoraAudioMixingStateTypePlaying)
callback. - This method only applies to stereo audio files.
Parameters
- mode
- The channel mode. See AgoraAudioMixingDualMonoMode.
Returns
- 0: Success.
- < 0: Failure.
setAudioMixingPitch
Sets the pitch of the local music file.
- (int)setAudioMixingPitch:(NSInteger)pitch;
When a local music file is mixed with a local human voice, call this method to set the pitch of the local music file only.
audioMixingStateChanged(AgoraAudioMixingStateTypePlaying)
callback.Parameters
- pitch
- Sets the pitch of the local music file by the chromatic scale. The default value is 0, which means keeping the original pitch. The value ranges from -12 to 12, and the pitch value between consecutive values is a chromatic value. The greater the absolute value of this parameter, the higher or lower the pitch of the local music file.
Returns
- 0: Success.
- < 0: Failure.
setAudioMixingPosition
Sets the audio mixing position.
- (int)setAudioMixingPosition:(NSInteger)pos;
Call this method to set the playback position of the music file to a different starting position, rather than playing the file from the beginning.
audioMixingStateChanged(AgoraAudioMixingStateTypePlaying)
callback.Parameters
- pos
- Integer. The playback position (ms).
Returns
- 0: Success.
- < 0: Failure.
setAudioProfile [1/2]
Sets the audio profile and audio scenario.
- (int)setAudioProfile:(AgoraAudioProfile)profile scenario:(AgoraAudioScenario)scenario;
- Deprecated:
- This method is deprecated. If you need to set the audio profile, use setAudioProfile [2/2]; if you need to set the audio scenario, use setAudioScenario.
- You can call this method either before or after joining a channel.
- In scenarios requiring high-quality audio, such as online music tutoring, Agora recommends you set profile as
AgoraAudioProfileMusicHighQuality(4)
and scenario asAgoraAudioScenarioGameStreaming(3)
.
Parameters
- profile
-
The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See AgoraAudioProfile.
- scenario
- The audio scenarios. See AgoraAudioScenario. Under different audio scenarios, the device uses different volume types.
Returns
- 0: Success.
- < 0: Failure.
setAudioProfile [2/2]
Sets the audio parameters and application scenarios.
- (int)setAudioProfile:(AgoraAudioProfile)profile;
- You can call this method either before or after joining a channel.
- In scenarios requiring high-quality audio, such as online music tutoring, Agora recommends you set
profile
asAgoraAudioProfileMusicHighQuality (4)
. - If you want to set the audio scenario, call sharedEngineWithConfig and set audioScenario in the AgoraRtcEngineConfig struct.
Parameters
- profile
-
The audio profile, including the sampling rate, bitrate, encoding mode, and the number of channels. See AgoraAudioProfile.
Returns
- 0: Success.
- < 0: Failure.
setAudioScenario
Sets audio scenarios.
- (int)setAudioScenario:(AgoraAudioScenario)scenario;
Parameters
- scenario
- The audio scenarios. See AgoraAudioScenario. Under different audio scenarios, the device uses different volume types.
Returns
- 0: Success.
- < 0: Failure.
setBeautyEffectOptions
Sets the image enhancement options.
- (int)setBeautyEffectOptions:(BOOL)enable options:(AgoraBeautyOptions* _Nullable)options;
Enables or disables image enhancement, and sets the options.
- Call this method before calling enableVideo or startPreview.
- This method relies on the video enhancement dynamic library
AgoraClearVisionExtension.xcframework
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- enable
- Whether to enable the image enhancement function:
YES
: Enable the image enhancement function.NO
: (Default) Disable the image enhancement function.
- options
- The image enhancement options. See AgoraBeautyOptions.
Returns
- 0: Success.
- < 0: Failure.
setCameraAutoFocusFaceModeEnabled
Sets whether to enable face autofocus.
- (BOOL)setCameraAutoFocusFaceModeEnabled:(BOOL)enable;
The SDK enables face autofocus by default. To set face autofocus, call this method.
- Call this method after the camera is started, such as after joinChannelByToken [2/4], enableVideo, or enableLocalVideo.
Parameters
- enable
-
Whether to enable face autofocus:
YES
: Enable face autofocus.NO
: Disable face autofocus.
Returns
YES
: Success.NO
: Failure.
setCameraCapturerConfiguration
Sets the camera capture configuration.
- (int)setCameraCapturerConfiguration:(AgoraCameraCapturerConfiguration * _Nullable)config;
- Call this method before calling joinChannelByToken [2/4], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Parameters
- config
- The camera capturer configuration. See AgoraCameraCapturerConfiguration.
Returns
- 0: Success.
- < 0: Failure.
setCameraExposurePosition
Sets the camera exposure position.
- (BOOL)setCameraExposurePosition:(CGPoint)positionInView;
This method needs to be called after the camera is started (for example, by calling startPreview or joinChannelByToken [2/4]).
After a successful method call, the SDK triggers the cameraExposureDidChangedToRect callback.
Parameters
- positionInView
- The horizontal and vertical coordinates of the touchpoint in the view.
Returns
- 0: Success.
- < 0: Failure.
setCameraFocusPositionInPreview
Sets the camera manual focus position.
- (BOOL)setCameraFocusPositionInPreview:(CGPoint)position;
This method needs to be called after the camera is started (for example, by calling startPreview or joinChannelByToken [2/4]). After a successful method call, the SDK triggers the cameraFocusDidChangedToRect callback.
Parameters
- position
- The coordinates of the touchpoint in the view.
Returns
- 0: Success.
- < 0: Failure.
setCameraTorchOn
Enables the camera flash.
- (BOOL)setCameraTorchOn:(BOOL)isOn NS_SWIFT_NAME(setCameraTorchOn(_:));
- Call this method before calling joinChannelByToken [2/4], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Parameters
- isOn
-
Whether to turn on the camera flash:
YES
: Turn on the flash.NO
: (Default) Turn off the flash.
Returns
- 0: Success.
- < 0: Failure.
setCameraZoomFactor
Sets the camera zoom ratio.
- (CGFloat)setCameraZoomFactor:(CGFloat)zoomFactor;
- Call this method before calling joinChannelByToken [2/4], enableVideo, or enableLocalVideo, depending on which method you use to turn on your local camera.
Parameters
- zoomFactor
- The camera zoom ratio. The value ranges between 1.0 and the maximum zoom supported by the device. You can get the maximum zoom ratio supported by the device by calling the getCameraMaxZoomFactor method.
Returns
- The camera zoom factor value, if successful.
- < 0: Failure.
setChannelProfile
Sets the channel profile.
- (int)setChannelProfile:(AgoraChannelProfile)profile;
After initializing the SDK, the default channel profile is the live streaming profile. You can call this method to set the usage scenario of Agora channel. The Agora SDK differentiates channel profiles and applies optimization algorithms accordingly. For example, it prioritizes smoothness and low latency for a video call and prioritizes video quality for interactive live video streaming.
- To ensure the quality of real-time communication, Agora recommends that all users in a channel use the same channel profile.
- This method must be called and set before joinChannelByToken [2/4], and cannot be set again after joining the channel.
- The default audio route and video encoding bitrate are different in different channel profiles. For details, see setDefaultAudioRouteToSpeakerphone and setVideoEncoderConfiguration.
Parameters
- profile
-
The channel profile. See AgoraChannelProfile.
Returns
- 0(ERR_OK): Success.
- < 0: Failure.
- -2(ERR_INVALID_ARGUMENT): The parameter is invalid.
- -7(ERR_NOT_INITIALIZED): The SDK is not initialized.
setCloudProxy
Sets the Agora cloud proxy service.
- (int)setCloudProxy:(AgoraCloudProxyType)proxyType NS_SWIFT_NAME(setCloudProxy(_:));
When users' network access is restricted by a firewall, configure the firewall to allow specific IP addresses and ports provided by Agora; then, call this method to enable the cloud proxy and set the cloud proxy type with the proxyType parameter.
After successfully connecting to the cloud proxy, the SDK triggers the connectionChangedToState (AgoraConnectionStateConnecting, AgoraConnectionChangedReasonSettingProxyServer) callback.
To disable the cloud proxy that has been set, call the setCloudProxy (AgoraNoneProxyType)
.
To change the cloud proxy type that has been set, call the setCloudProxy (AgoraNoneProxyType)
first, and then call the setCloudProxy to set the proxyType you want.
- Agora recommends that you call this method before joining the channel or after leaving the channel.
- When a user is behind a firewall and uses the Force UDP cloud proxy, the services for the Media Push and cohosting across channels are not available.
- When you use the Force TCP cloud proxy, note that an error would occur when calling the startAudioMixing [2/2] method to play online music files in the HTTP protocol. The services for the Media Push and cohosting across channels use the cloud proxy with the TCP protocol.
Parameters
- proxyType
-
The type of the cloud proxy. See AgoraCloudProxyType.
This parameter is mandatory. The SDK reports an error if you do not pass in a value.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is invalid.
- -7: The SDK is not initialized.
setClientRole [1/2]
Sets the client role.
- (int)setClientRole:(AgoraClientRole)role;
You can call this method either before or after joining the channel to set the user role as audience or host.
If you call this method to set the user's role as the host before joining the channel and set the local video property through the setupLocalVideo method, the local video preview is automatically enabled when the user joins the channel.
- The local client: didClientRoleChanged.
- The remote client: didJoinedOfUid or
didOfflineOfUid(AgoraUserOfflineReasonBecomeAudience)
.
Parameters
- role
-
The user role. See AgoraClientRole.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
- -7: The SDK is not initialized.
setClientRole [2/2]
Sets the user role and level in an interactive live streaming channel.
- (int)setClientRole:(AgoraClientRole)role options:(AgoraClientRoleOptions * _Nullable)options;
In the interactive live streaming profile, the SDK sets the user role as audience by default. You can call this method to set the user role as host.
You can call this method either before or after joining a channel.
If you call this method to set the user's role as the host before joining the channel and set the local video property through the setupLocalVideo method, the local video preview is automatically enabled when the user joins the channel.
- Calls muteLocalAudioStream and muteLocalVideoStream to change the publishing state.
- Triggers didClientRoleChanged on the local client.
- Triggers didJoinedOfUid or didOfflineOfUid on the remote client.
- The user role (role) determines the permissions that the SDK grants to a user, such as permission to send local streams, receive remote streams, and push streams to a CDN address.
- The user level (level) determines the level of services that a user can enjoy within the permissions of the user's role. For example, an audience member can choose to receive remote streams with low latency or ultra-low latency. User level affects the pricing of services.
Parameters
- role
- The user role in the interactive live streaming. See AgoraClientRole.
- options
- The detailed options of a user, including the user level. See AgoraClientRoleOptions.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
- -2: The parameter is invalid.
- -5: The request is rejected.
- -7: The SDK is not initialized.
setDefaultAudioRouteToSpeakerphone
Sets the default audio playback route.
- (int)setDefaultAudioRouteToSpeakerphone:(BOOL)defaultToSpeaker;
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.
- Voice call: Earpiece.
- Audio broadcast: Speakerphone.
- Video call: Speakerphone.
- Video broadcast: Speakerphone.
You can call this method to change the default audio route. After a successful method call, the SDK triggers the didAudioRouteChanged callback.
The system audio route changes when an external audio device, such as a headphone or a Bluetooth audio device, is connected. See Principles for Changing the Audio Route.
Parameters
- defaultToSpeaker
- Whether to set the speakerphone as the default audio route:
YES
: Set the speakerphone as the default audio route.NO
: Set the earpiece as the default audio route.
Returns
- 0: Success.
- < 0: Failure.
setDualStreamMode [1/2]
Sets dual-stream mode on the sender side.
- (int)setDualStreamMode:(AgoraSimulcastStreamMode)mode;
- Since
- v4.0.1
The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to AgoraAutoSimulcastStream. If you want to modify this behavior, you can call this method and modify the mode to AgoraDisableSimulcastStream(always never send low-quality video streams) or AgoraEnableSimulcastStream (always send low-quality video streams).
- When calling this method and setting mode to AgoraDisableSimulcastStream, it has the same effect as
enableDualStreamMode [1/2](NO)
. - When calling this method and setting mode to AgoraEnableSimulcastStream, it has the same effect as
enableDualStreamMode [1/2](YES)
. - Both methods can be called before and after joining a channel. If they are used at the same time, the settings in the method called later shall prevail.
Parameters
- mode
- The mode in which the video stream is sent. See AgoraSimulcastStreamMode.
Returns
- 0: Success.
- < 0: Failure.
setDualStreamMode [2/2]
Sets dual-stream mode configuration on the sender, and sets the low-quality video stream.
- (int)setDualStreamMode:(AgoraSimulcastStreamMode)mode streamConfig:(AgoraSimulcastStreamConfig* _Nonnull)streamConfig;
- Since
- v4.0.1
The SDK enables the low-quality video stream auto mode on the sender by default, which is equivalent to calling this method and setting the mode to AgoraAutoSimulcastStream. If you want to modify this behavior, you can call this method and modify the mode to AgoraDisableSimulcastStream(always never send low-quality video streams) or AgoraEnableSimulcastStream (always send low-quality video streams).
The difference between this method and setDualStreamMode [1/2] is that this method can also configure the low-quality video stream, and the SDK sends the stream according to the configuration in streamConfig.
- When calling this method and setting mode to AgoraDisableSimulcastStream, it has the same effect as
enableDualStreamMode [1/2](NO)
. - When calling this method and setting mode to AgoraEnableSimulcastStream, it has the same effect as
enableDualStreamMode [1/2](YES)
. - Both methods can be called before and after joining a channel. If they are used at the same time, the settings in the method called later shall prevail.
Parameters
- mode
- The mode in which the video stream is sent. See AgoraSimulcastStreamMode.
- streamConfig
-
The configuration of the low-quality video stream. See AgoraSimulcastStreamConfig.
Returns
- 0: Success.
- < 0: Failure.
setEffectPosition
Sets the playback position of an audio effect file.
- (int)setEffectPosition:(int)soundId pos:(NSInteger)pos NS_SWIFT_NAME(setEffectPosition(_:pos:));
After a successful setting, the local audio effect file starts playing at the specified position.
Parameters
- soundId
- The audio effect ID. The ID of each audio effect file is unique.
- pos
- The playback position (ms) of the audio effect file.
Returns
- 0: Success.
- < 0: Failure.
setEarMonitoringAudioFrameParametersWithSampleRate
Sets the format of the in-ear monitoring raw audio data.
- (int)setEarMonitoringAudioFrameParametersWithSampleRate:(NSInteger)sampleRate channel:(NSInteger)channel mode:(AgoraAudioRawFrameOperationMode)mode samplesPerCall:(NSInteger)samplesPerCall;
This method is used to set the in-ear monitoring audio data format reported by the onEarMonitoringAudioFrame callback.
- Before calling this method, you need to call enableInEarMonitoring [2/2], and set includeAudioFilters to AgoraEarMonitoringFilterBuiltInAudioFilters or AgoraEarMonitoringFilterNoiseSuppression.
- The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval (sec) = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onEarMonitoringAudioFrame callback according to the sampling interval.
Parameters
- sampleRate
- The sample rate of the audio data reported in the onEarMonitoringAudioFrame callback, which can be set as 8,000, 16,000, 32,000, 44,100, or 48,000 Hz.
- channel
-
The number of audio channels reported in the onEarMonitoringAudioFrame callback.
- 1: Mono.
- 2: Stereo.
- mode
-
The use mode of the audio frame. See AgoraAudioRawFrameOperationMode.
- samplesPerCall
- The number of data samples reported in the onEarMonitoringAudioFrame callback, such as 1,024 for the Media Push.
Returns
- 0: Success.
- < 0: Failure.
setEnableSpeakerphone
Enables/Disables the audio route to the speakerphone.
- (int)setEnableSpeakerphone:(BOOL)enableSpeaker;
After a successful method call, the SDK triggers the didAudioRouteChanged callback.
You can call this method before joining a channel, when in a channel, or after leaving a channel. However, Agora recommends calling this method only when you are in a channel to change the audio route temporarily.
- If you do not have a clear requirement for transient settings, Agora recommends calling setDefaultAudioRouteToSpeakerphone to set the audio route.
- Any user behavior or audio-related API call might change the transient setting of setEnableSpeakerphone. See Audio Route for detailed change principles.
- Due to system limitations, if the user uses an external audio playback device such as a Bluetooth or wired headset on an iOS device, this method does not take effect.
Parameters
- enableSpeaker
-
Whether to set the speakerphone as the default audio route:
YES
: Set the speakerphone as the audio route temporarily.NO
: Do not set the speakerphone as the audio route.
Returns
- 0: Success.
- < 0: Failure.
setEncryptionMode
Sets the built-in encryption mode.
- (int)setEncryptionMode:(NSString * _Nullable)encryptionMode;
- Deprecated:
- Use enableEncryption instead.
The Agora SDK supports built-in encryption, which is set to the AES-128-GCM mode by default. Call this method to use other encryption modes. All users in the same channel must use the same encryption mode and secret. Refer to the information related to the AES encryption algorithm on the differences between the encryption modes.
Parameters
- encryptionMode
-
The following encryption modes:
- "
aes-128-xts
": 128-bit AES encryption, XTS mode. - "
aes-128-ecb
": 128-bit AES encryption, ECB mode. - "
aes-256-xts
": 256-bit AES encryption, XTS mode. - "
sm4-128-ecb
": 128-bit SM4 encryption, ECB mode. - "
aes-128-gcm
": 128-bit AES encryption, GCM mode. - "
aes-256-gcm
": 256-bit AES encryption, GCM mode. - "": When this parameter is set as null, the encryption mode is set as "
aes-128-gcm
" by default.
- "
Returns
- 0: Success.
- < 0: Failure.
setEncryptionSecret
Enables built-in encryption with an encryption password before users join a channel.
- (int)setEncryptionSecret:(NSString * _Nullable)secret;
- Deprecated:
- This method is deprecated. Use enableEncryption instead.
Before joining the channel, you need to call this method to set the secret parameter to enable the built-in encryption. All users in the same channel should use the same secret. The secret is automatically cleared once a user leaves the channel. If you do not specify the secret or secret is set as null, the built-in encryption is disabled.
- Do not use this method for CDN live streaming.
- For optimal transmission, ensure that the encrypted data size does not exceed the original data size + 16 bytes. 16 bytes is the maximum padding size for AES encryption.
Parameters
- secret
- The encryption password.
Returns
- 0: Success.
- < 0: Failure.
setExtensionPropertyWithVendor
Sets the properties of the extension.
- (int)setExtensionPropertyWithVendor:(NSString * __nonnull)provider extension:(NSString * __nonnull)extension key:(NSString * __nonnull)key value:(NSString * __nonnull)value;
After enabling the extension, you can call this method to set the properties of the extension.
Parameters
- provider
- The name of the extension provider.
- extension
- The name of the extension.
- key
- The key of the extension.
- value
- The value of the extension key.
Returns
- 0: Success.
- < 0: Failure.
setExtensionProviderPropertyWithVendor
Sets the properties of the extension provider.
- (int) setExtensionProviderPropertyWithVendor:(NSString * __nonnull)provider key:(NSString * __nonnull)key value:(NSString * __nonnull)value;
You can call this method to set the attributes of the extension provider and initialize the relevant parameters according to the type of the provider.
Call this method after enableExtensionWithVendor, and before enabling the audio (enableAudio/enableLocalAudio) or the video (enableVideo/enableLocalVideo).
Parameters
- provider
- The name of the extension provider.
- key
- The key of the extension.
- value
- The value of the extension key.
Returns
- 0: Success.
- < 0: Failure.
enableExternalAudioSink
Sets the external audio sink.
- (void)enableExternalAudioSink:(BOOL)enabled sampleRate:(NSUInteger)sampleRate channels:(NSUInteger)channels;
This method applies to scenarios where you want to use external audio data for playback. After you set the external audio sink, you can call pullPlaybackAudioFrameRawData to pull remote audio frames. The app can process the remote audio and play it with the audio effects that you want.
Parameters
- enabled
-
Whether to enable or disable the external audio sink:
YES
: Enables the external audio sink.NO
: (Default) Disables the external audio sink.
- sampleRate
-
The sample rate (Hz) of the external audio sink, which can be set as 16000, 32000, 44100, or 48000.
- channels
- The number of audio channels of the external audio sink:
- 1: Mono.
- 2: Stereo.
setExternalAudioSource [1/2]
Sets the external audio source.
- (int)setExternalAudioSource:(BOOL)enabled sampleRate:(NSInteger)sampleRate channels:(NSInteger)channels;
Call this method before calling joinChannelByToken [1/4] and startPreview.
Parameters
- enabled
-
YES
: Enable the external audio source.NO
: (Default) Disable the external audio source.
- sampleRate
- The sample rate (Hz) of the external audio source, which can be set as 8000, 16000, 32000, 44100, or 48000.
- channels
-
The number of audio channels of the external audio source:
- 1: Mono.
- 2: Stereo.
Returns
- 0: Success.
- < 0: Failure.
setExternalAudioSource [2/2]
Sets the external audio source parameters.
- (int)setExternalAudioSource:(BOOL)enabled sampleRate:(NSInteger)sampleRate channels:(NSInteger)channels sourceNumber:(NSInteger)sourceNumber localPlayback:(BOOL)localPlayback publish:(BOOL)publish;
Parameters
- enabled
-
Whether to enable the external audio source:
YES
: Enable the external audio source.NO
: (Default) Disable the external audio source.
- sampleRate
- The sample rate (Hz) of the external audio source, which can be set as
8000
,16000
,32000
,44100
, or48000
. - channels
- The number of channels of the external audio source, which can be set as
1
(Mono) or2
(Stereo). - sourceNumber
- The number of external audio sources. The value of this parameter should be larger than 0. The SDK creates a corresponding number of custom audio tracks based on this parameter value and names the audio tracks starting from 0. In AgoraRtcChannelMediaOptions, you can set publishCustomAudioSourceId to the ID of the audio track you want to publish.
- localPlayback
-
Whether to play the external audio source:
YES
: Play the external audio source.NO
: (Default) Do not play the external source.
- publish
-
Whether to publish audio to the remote users:
YES
: (Default) Publish audio to the remote users.NO
: Do not publish audio to the remote users
Returns
- 0: Success.
- < 0: Failure.
setExternalVideoSource
Configures the external video source.
- (void)setExternalVideoSource:(BOOL)enable useTexture:(BOOL)useTexture sourceType:(AgoraExternalVideoSourceType)sourceType;
Parameters
- enable
- Whether to use the external video source:
YES
: Use the external video source. The SDK prepares to accept the external video frame.NO
: (Default) Do not use the external video source.
- useTexture
- Whether to use the external video frame in the Texture format.
YES
: Use the external video frame in the Texture format.NO
: (Default) Do not use the external video frame in the Texture format.
- sourceType
- Whether to encode the external video frame, see AgoraExternalVideoSourceType.
setHeadphoneEQPreset
Sets the preset headphone equalization effect.
- (int)setHeadphoneEQPreset:(AgoraHeadphoneEQPreset)preset;
- Since
- v4.0.1
This method is mainly used in spatial audio effect scenarios. You can select the preset headphone equalizer to listen to the audio to achieve the expected audio experience.
Parameters
- preset
- The preset headphone equalization effect. See AgoraHeadphoneEQPreset.
Returns
- 0: Success.
- < 0: Failure.
- -1: A general error occurs (no specified reason).
setInEarMonitoringVolume
Sets the volume of the in-ear monitor.
- (int)setInEarMonitoringVolume:(NSInteger)volume;
- Users must use wired earphones to hear their own voices.
- You can call this method either before or after joining a channel.
Parameters
- volume
- The volume of the in-ear monitor. The value ranges between 0 and 100. The default value is 100.
Returns
- 0: Success.
- < 0: Failure.
setLocalRenderMode [1/2]
Sets the local video display mode.
- (int)setLocalRenderMode:(NSUInteger)uid mode:(AgoraVideoRenderMode) mode;
- Deprecated:
- This method is deprecated. Use setLocalRenderMode [2/2] instead.
Call this method to set the local video display mode. This method can be called multiple times during a call to change the display mode.
Parameters
- mode
-
The local video display mode. See AgoraVideoRenderMode.
- uid
- The user ID.
Returns
- 0: Success.
- < 0: Failure.
setLocalRenderMode [2/2]
Updates the display mode of the local video view.
- (int)setLocalRenderMode:(AgoraVideoRenderMode)mode mirror:(AgoraVideoMirrorMode)mirror;
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, not the published local video stream.
- Ensure that you have called the setupLocalVideo method to initialize the local video view before calling this method.
- During a call, you can call this method as many times as necessary to update the display mode of the local video view.
Parameters
- mode
-
The local video display mode. See AgoraVideoRenderMode.
- mirror
-
The rendering mode of the local video view. See AgoraVideoMirrorMode.
Attention: If you use a front camera, the SDK enables the mirror mode by default; if you use a rear camera, the SDK disables the mirror mode by default.
Returns
- 0: Success.
- < 0: Failure.
setLocalVideoMirrorMode
Sets the local video mirror mode.
- (int)setLocalVideoMirrorMode:(AgoraVideoMirrorMode)mode;
- Deprecated:
- This method is deprecated.
Parameters
- mode
-
The local video mirror mode. See AgoraVideoMirrorMode.
Returns
- 0: Success.
- < 0: Failure.
setLocalVoiceEqualizationOfBandFrequency
Sets the local voice equalization effect.
- (int)setLocalVoiceEqualizationOfBandFrequency:(AgoraAudioEqualizationBandFrequency)bandFrequency withGain:(NSInteger)gain;
Parameters
- bandFrequency
- The band frequency. The value ranges between 0 and 9; representing the respective 10-band center frequencies of the voice effects, including 31, 62, 125, 250, 500, 1k, 2k, 4k, 8k, and 16k Hz. For more details, see AgoraAudioEqualizationBandFrequency.
- gain
- The gain of each band in dB. The value ranges between -15 and 15. The default value is 0.
Returns
- 0: Success.
- < 0: Failure.
setLocalVoicePitch
Changes the voice pitch of the local speaker.
- (int)setLocalVoicePitch:(double)pitch;
Parameters
- pitch
- The local voice pitch. The value range is [0.5,2.0]. The lower the value, the lower the pitch. The default value is 1 (no change to the pitch).
Returns
- 0: Success.
- < 0: Failure.
setLocalVoiceReverbOfType
Sets the local voice reverberation.
- (int)setLocalVoiceReverbOfType:(AgoraAudioReverbType)reverbType withValue:(NSInteger)value;
The SDK also provides the setAudioEffectPreset method, which allows you to directly implement preset reverb effects for such as pop, R&B, and KTV.
Parameters
- reverbType
- The reverberation key. Agora provides five reverberation keys; see AgoraAudioReverbType for details.
- value
- The value of the reverberation key.
Returns
- 0: Success.
- < 0: Failure.
setLocalVoiceReverbPreset
Sets the local voice reverberation option, including the virtual stereo.
- (int) setLocalVoiceReverbPreset:(AgoraAudioReverbPreset)reverbPreset;
- Deprecated:
- Use setAudioEffectPreset or setVoiceBeautifierPreset instead.
This method sets the local voice reverberation for users in a COMMUNICATION channel or hosts in a LIVE_BROADCASTING channel. After successfully calling this method, all users in the channel can hear the voice with reverberation.
- When using the enumeration value prefixed with
AUDIO_REVERB_FX
, ensure that you set the profile parameter in setAudioProfile [1/2] to AgoraAudioProfileMusicHighQuality (4) or AgoraAudioProfileMusicHighQualityStereo (5) before calling this method. Otherwise, the method setting is invalid. - When calling the AUDIO_VIRTUAL_STEREO method, Agora recommends setting the profile parameter in setAudioProfile [1/2] as AgoraAudioProfileMusicHighQualityStereo (5).
- This method works best with the human voice, and Agora does not recommend using it for audio containing music and a human voice.
- You can call this method either before or after joining a channel.
Parameters
- reverbPreset
The local voice reverberation option. The default value is AgoraAudioReverbPresetOff, which means the original voice. For more details, see AgoraAudioReverbPreset. To achieve better voice effects, Agora recommends the enumeration whose name begins with
AUDIO_REVERB_FX
.
Returns
- 0: Success.
- < 0: Failure.
setLogFile
Sets the log file.
- (int)setLogFile:(NSString * _Nonnull)filePath;
- Deprecated:
- Use the
mLogConfig
parameter in sharedEngineWithConfig method instead.
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 this method immediately after calling the sharedEngineWithConfig method to initialize the AgoraRtcEngineKit, or the output log may not be complete.
Parameters
- filePath
- The complete path of the log files. These log files are encoded in UTF-8.
Returns
- 0: Success.
- < 0: Failure.
setLogFileSize
Sets the log file size.
- (int)setLogFileSize:(NSUInteger)fileSizeInKBytes;
- Deprecated:
- Use the
logConfig
parameter in sharedEngineWithConfig instead.
By default, the SDK generates five SDK log files and five API call log files with the following rules:
- The SDK log files are:
agorasdk.log
,agorasdk.1.log
,agorasdk.2.log
,agorasdk.3.log
, andagorasdk.4.log
. - The API call log files are:
agoraapi.log
,agoraapi.1.log
,agoraapi.2.log
,agoraapi.3.log
, andagoraapi.4.log
. - The default size for each SDK log file is 1,024 KB; the default size for each API call log file is 2,048 KB. These log files are encoded in UTF-8.
- The SDK writes the latest logs in
agorasdk.log
oragoraapi.log
. - When
agorasdk.log
is full, the SDK processes the log files in the following order:- Delete the
agorasdk.4.log
file (if any). - Rename
agorasdk.3.log
toagorasdk.4.log
. - Rename
agorasdk.2.log
toagorasdk.3.log
. - Rename
agorasdk.1.log
toagorasdk.2.log
. - Create a new
agorasdk.log
file.
- Delete the
- The overwrite rules for the
agoraapi.log
file are the same as foragorasdk.log
.
This method is used to set the size of the agorasdk.log
file only and does not effect the agoraapi.log file
.
Parameters
- fileSizeInKBytes
-
The size (KB) of an
agorasdk.log
file. The value range is [128,20480]. The default value is 1,024 KB. If you setfileSizeInKByte
smaller than 128 KB, the SDK automatically adjusts it to 128 KB; if you setfileSizeInKByte
greater than 20,480 KB, the SDK automatically adjusts it to 20,480 KB.
Returns
- 0: Success.
- < 0: Failure.
setLogFilter
Sets the log output level of the SDK.
- (int)setLogFilter:(NSUInteger)filter;
- Deprecated:
- Use logConfig in sharedEngineWithConfig instead.
This method sets the output log level of the SDK. You can use one or a combination of the log filter levels. The log level follows the sequence of AgoraLogFilterOff, AgoraLogFilterCritical, AgoraLogFilterError, AgoraLogFilterWarning, AgoraLogFilterInfo, and AgoraLogFilterDebug. Choose a level to see the logs preceding that level.
If, for example, you set the log level to AgoraLogFilterWarning, you see the logs within levels AgoraLogFilterCritical, AgoraLogFilterError, and AgoraLogFilterWarning.
Parameters
- filter
-
The output log level of the SDK. See AgoraLogFilter.
Returns
- 0: Success.
- < 0: Failure.
setLogLevel
Sets the output log level of the SDK.
- (int)setLogLevel:(AgoraLogLevel)level;
- Deprecated:
- This method is deprecated. Use AgoraRtcEngineConfig instead to set the log output level.
Choose a level to see the logs preceding that level.
Parameters
- level
- The log level: AgoraLogLevel.
Returns
- 0: Success.
- < 0: Failure.
setMediaMetadataDataSource
Sets the data source of the metadata.
- (BOOL)setMediaMetadataDataSource:(id<AgoraMediaMetadataDataSource> _Nullable)metadataDataSource withType:(AgoraMetadataType)type;
You need to implement the AgoraMediaMetadataDataSource protocol in this method and specify the data format of the metadata. After a successful method call, the SDK triggers the metadataMaxSize callback.
This method can be used with setMediaMetadataDelegate to add synchronized metadata in the video stream for more diversified live interactions, such as sending shopping links, digital coupons, and online quizzes.
Parameters
- metadataDataSource
- The AgoraMediaMetadataDataSource protocol.
- type
-
The metadata type. The SDK currently only supports AgoraMetadataTypeVideo. See AgoraMetadataType.
Returns
YES
: Success.NO
: Failure.
setMixedAudioFrameParametersWithSampleRate
Sets the audio data format reported by onMixedAudioFrame.
- (int)setMixedAudioFrameParametersWithSampleRate:(NSInteger)sampleRate channel:(NSInteger)channel samplesPerCall:(NSInteger)samplesPerCall;
Parameters
- sampleRate
-
The sample rate (Hz) of the audio data, which can be set as
8000
,16000
,32000
,44100
, or48000
.
- channel
-
The number of channels of the audio data, which can be set as
1
(Mono) or2
(Stereo).
- samplesPerCall
-
Sets the number of samples. In Media Push scenarios, set it as
1024
.
The SDK triggers the onMixedAudioFrame callback according to the sample interval. Sample interval (sec) = samplePerCall
/(sampleRate
× channel
) Ensure that the value of sample interval is more than or equal to 0.01.
Returns
- 0: Success.
- < 0: Failure.
setParameters
Provides the technical preview functionalities or special customizations by configuring the SDK with JSON options.
- (int)setParameters:(NSString * _Nonnull)options;
Contact support@agora.io for details about JSON options.
Parameters
- options
- Pointer to the set parameters in a JSON string.
Returns
- 0: Success.
- < 0: Failure.
setPlaybackAudioFrameBeforeMixingParametersWithSampleRate
Sets the audio data format reported by onPlaybackAudioFrameBeforeMixing.
- (int)setPlaybackAudioFrameBeforeMixingParametersWithSampleRate:(NSInteger)sampleRate channel:(NSInteger)channel;
Parameters
- sampleRate
-
The sample rate (Hz) of the audio data, which can be set as
8000
,16000
,32000
,44100
, or48000
.
- channel
-
The number of channels of the external audio source, which can be set as
1
(Mono) or2
(Stereo).
Returns
- 0: Success.
- < 0: Failure.
setPlaybackAudioFrameParametersWithSampleRate
Sets the audio data format for playback.
- (int)setPlaybackAudioFrameParametersWithSampleRate:(NSInteger)sampleRate channel:(NSInteger)channel mode:(AgoraAudioRawFrameOperationMode)mode samplesPerCall:(NSInteger)samplesPerCall;
Sets the data format for the onPlaybackAudioFrame callback.
- Ensure that you call this method before joining a channel.
- The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onPlaybackAudioFrame callback according to the sampling interval.
Parameters
- sampleRate
- The sample rate returned in the onPlaybackAudioFrame callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
- channel
-
The number of channels returned in the onPlaybackAudioFrame callback:
- 1: Mono.
- 2: Stereo.
- mode
-
The use mode of the audio frame. See AgoraAudioRawFrameOperationMode.
- samplesPerCall
- The number of data samples returned in the onPlaybackAudioFrame callback, such as 1024 for the Media Push.
Returns
- 0: Success.
- < 0: Failure.
setRecordingAudioFrameParametersWithSampleRate
Sets the format of the captured raw audio data.
- (int)setRecordingAudioFrameParametersWithSampleRate:(NSInteger)sampleRate channel:(NSInteger)channel mode:(AgoraAudioRawFrameOperationMode)mode samplesPerCall:(NSInteger)samplesPerCall;
Sets the audio format for the onRecordAudioFrame callback.
- Ensure that you call this method before joining a channel.
- The SDK calculates the sampling interval based on the samplesPerCall, sampleRate and channel parameters set in this method.Sample interval = samplePerCall/(sampleRate × channel). Ensure that the sample interval ≥ 0.01 (s). The SDK triggers the onRecordAudioFrame callback according to the sampling interval.
Parameters
- sampleRate
- The sample rate returned in the onRecordAudioFrame callback, which can be set as 8000, 16000, 32000, 44100, or 48000 Hz.
- channel
-
The number of channels returned in the onRecordAudioFrame callback:
- 1: Mono.
- 2: Stereo.
- mode
-
The use mode of the audio frame. See AgoraAudioRawFrameOperationMode.
- samplesPerCall
- The number of data samples returned in the onRecordAudioFrame callback, such as 1024 for the Media Push.
Returns
- 0: Success.
- < 0: Failure.
setRemoteDefaultVideoStreamType
Sets the default stream type of subscrption for remote video streams.
- (int)setRemoteDefaultVideoStreamType:(AgoraVideoStreamType)streamType;
Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode [2/2] (NO)
, the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.
By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.
The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request.
The result of this method returns in the didApiCallExecute callback.
- Call this method before joining a channel. Agora does not support changing the default subscribed video stream type after joining a channel.
- If you call both this method and setRemoteVideoStream, the SDK applies the settings in the setRemoteVideoStream method.
Parameters
- streamType
-
The default video-stream type. See AgoraVideoStreamType.
Returns
- 0: Success.
- < 0: Failure.
setRemoteRenderMode [1/2]
Sets the video display mode of a specified remote user.
- (int)setRemoteRenderMode:(NSUInteger)uid mode:(AgoraVideoRenderMode) mode;
- Deprecated:
- This method is deprecated. Use setRemoteRenderMode [2/2] instead.
Call this method to set the video display mode of a specified remote user. This method can be called multiple times during a call to change the display mode.
Parameters
- userId
- The user ID of the remote user.
- renderMode
-
The rendering mode of the remote user view. For details, see AgoraVideoRenderMode.
Returns
- 0: Success.
- < 0: Failure.
setRemoteRenderMode [2/2]
Updates the display mode of the video view of a remote user.
- (int)setRemoteRenderMode:(NSUInteger)uid mode:(AgoraVideoRenderMode)mode mirror:(AgoraVideoMirrorMode)mirror;
After initializing the video view of a remote user, you can call this method to update its rendering and mirror modes. This method affects only the video view that the local user sees.
- Please call this method after initializing the remote view by calling the setupRemoteVideo method.
- During a call, you can call this method as many times as necessary to update the display mode of the video view of a remote user.
Parameters
- uid
- The user ID of the remote user.
- mode
-
The rendering mode of the remote user view. For details, see AgoraVideoRenderMode.
- mirror
-
The mirror mode of the remote user view. For details, see AgoraVideoMirrorMode.
Returns
- 0: Success.
- < 0: Failure.
setRemoteSubscribeFallbackOption
Sets the fallback option for the remotely subscribed video stream based on the network conditions.
- (int)setRemoteSubscribeFallbackOption:(AgoraStreamFallbackOptions)option;
When the network is not ideal, the quality of live audio and video can be degraded. If option is set as AgoraStreamFallbackOptionVideoStreamLow or AgoraStreamFallbackOptionAudioOnly, the SDK automatically switches the video from a high-quality stream to a low-quality stream or disables the video when the downlink network conditions cannot support both audio and video to guarantee the quality of the audio. The SDK monitors the network quality and restores the video stream when the network conditions improve.
When the remote video stream falls back to audio-only or when the audio-only stream switches back to the video, the SDK triggers the didRemoteSubscribeFallbackToAudioOnly callback.
Parameters
- option
- The fallback option for the remotely subscribed video stream. The default value is AgoraStreamFallbackOptionVideoStreamLow(1). See AgoraStreamFallbackOptions.
Returns
- 0: Success.
- < 0: Failure.
setRemoteVideoStream
Sets the stream type of the remote video.
- (int)setRemoteVideoStream:(NSUInteger)uid type:(AgoraVideoStreamType)streamType;
Under limited network conditions, if the publisher has not disabled the dual-stream mode using enableDualStreamMode [2/2](NO)
, the receiver can choose to receive either the high-quality video stream or the low-quality video stream. The high-quality video stream has a higher resolution and bitrate, and the low-quality video stream has a lower resolution and bitrate.
By default, users receive the high-quality video stream. Call this method if you want to switch to the low-quality video stream. This method allows the app to adjust the corresponding video stream type based on the size of the video window to reduce the bandwidth and resources. The aspect ratio of the low-quality video stream is the same as the high-quality video stream. Once the resolution of the high-quality video stream is set, the system automatically sets the resolution, frame rate, and bitrate of the low-quality video stream.
The SDK enables the low-quality video stream auto mode on the sender by default (not actively sending low-quality video streams). The host at the receiving end can call this method to initiate a low-quality video stream stream request on the receiving end, and the sender automatically switches to the low-quality video stream mode after receiving the request.
The result of this method returns in the didApiCallExecute callback.
Parameters
- uid
- The user ID.
- streamType
-
The video stream type: AgoraVideoStreamType.
Returns
- 0: Success.
- < 0: Failure.
setRemoteVoicePosition
Sets the 2D position (the position on the horizontal plane) of the remote user's voice.
- (int)setRemoteVoicePosition:(NSUInteger)uid pan:(double)pan gain:(double)gain;
This method sets the 2D position and volume of a remote user, so that the local user can easily hear and identify the remote user's position.
When the local user calls this method to set the voice position of a remote user, the voice difference between the left and right channels allows the local user to track the real-time position of the remote user, creating a sense of space. This method applies to massive multiplayer online games, such as Battle Royale games.
- For this method to work, enable stereo panning for remote users by calling the enableSoundPositionIndication method before joining a channel.
- For the best voice positioning, Agora recommends using a wired headset.
- Call this method after joining a channel.
Parameters
- uid
- The user ID of the remote user.
- pan
- The voice position of the remote user. The value ranges from -1.0 to 1.0:
- 0.0: (Default) The remote voice comes from the front.
- -1.0: The remote voice comes from the left.
- 1.0: The remote voice comes from the right.
- gain
- The volume of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original volume of the remote user). The smaller the value, the lower the volume.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeAudioBlacklist
Set the blocklist of subscriptions for audio streams.
- (int)setSubscribeAudioBlacklist:(NSArray <NSNumber *> *_Nonnull)blacklist;
You can call this method to specify the audio streams of a user that you do not want to subscribe to.
- You can call this method either before or after joining a channel.
- The blocklist is not affected by the setting in muteRemoteAudioStream, muteAllRemoteAudioStreams and autoSubscribeAudio in AgoraRtcChannelMediaOptions.
- Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
- If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
Parameters
- blacklist
-
The user ID list of users that you do not want to subscribe to.
If you want to specify the audio streams of a user that you do not want to subscribe to, add the user ID in this list. If you want to remove a user from the blocklist, you need to call the setSubscribeAudioBlacklist method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeAudioWhitelist
Sets the allowlist of subscriptions for audio streams.
- (int)setSubscribeAudioWhitelist:(NSArray <NSNumber *> *_Nonnull)whitelist;
You can call this method to specify the audio streams of a user that you want to subscribe to.
- You can call this method either before or after joining a channel.
- The allowlist is not affected by the setting in muteRemoteAudioStream, muteAllRemoteAudioStreams and autoSubscribeAudio in AgoraRtcChannelMediaOptions.
- Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
- If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
Parameters
- whitelist
-
The user ID list of users that you want to subscribe to.
If you want to specify the audio streams of a user for subscription, add the user ID in this list. If you want to remove a user from the allowlist, you need to call the setSubscribeAudioWhitelist method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeVideoBlacklist
Set the bocklist of subscriptions for video streams.
- (int)setSubscribeVideoBlacklist:(NSArray <NSNumber *> *_Nonnull)blacklist;
You can call this method to specify the video streams of a user that you do not want to subscribe to.
- You can call this method either before or after joining a channel.
- The blocklist is not affected by the setting in muteRemoteVideoStream, muteAllRemoteVideoStreams and autoSubscribeAudio in AgoraRtcChannelMediaOptions.
- Once the blocklist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
- If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
Parameters
- blacklist
-
The user ID list of users that you do not want to subscribe to.
If you want to specify the video streams of a user that you do not want to subscribe to, add the user ID of that user in this list. If you want to remove a user from the blocklist, you need to call the setSubscribeVideoBlacklist method to update the user ID list; this means you only add the uid of users that you do not want to subscribe to in the new user ID list.
Returns
- 0: Success.
- < 0: Failure.
setSubscribeVideoWhitelist
Set the allowlist of subscriptions for video streams.
- (int)setSubscribeVideoWhitelist:(NSArray <NSNumber *> *_Nonnull)whitelist;
You can call this method to specify the video streams of a user that you want to subscribe to.
- You can call this method either before or after joining a channel.
- The allowlist is not affected by the setting in muteRemoteVideoStream, muteAllRemoteVideoStreams and autoSubscribeAudio in AgoraRtcChannelMediaOptions.
- Once the allowlist of subscriptions is set, it is effective even if you leave the current channel and rejoin the channel.
- If a user is added in the allowlist and blocklist at the same time, only the blocklist takes effect.
Parameters
-
The user ID list of users that you want to subscribe to.
If you want to specify the video streams of a user for subscription, add the user ID of that user in this list. If you want to remove a user from the allowlist, you need to call the setSubscribeVideoWhitelist method to update the user ID list; this means you only add the uid of users that you want to subscribe to in the new user ID list.
Returns
- 0: Success.
- < 0: Failure.
setupLocalVideo
Initializes the local video view.
- (int)setupLocalVideo:(AgoraRtcVideoCanvas * _Nullable)local;
This method initializes the video view of a local stream on the local device. It affects only the video view that the local user sees, not the published local video stream. Call this method to bind the local video stream to a video view and to set the rendering and mirror modes of the video view.
After initialization, call this method to set the local video and then join the channel. The local video still binds to the view after you leave the channel. To unbind the local video from the view, set the view parameter as nil.
- You can call this method either before or after joining a channel.
- To update the rendering or mirror mode of the local video view during a call, use the setLocalRenderMode [2/2] method.
Parameters
- local
- Local video display properties. See AgoraRtcVideoCanvas.
Returns
- 0: Success.
- < 0: Failure.
setupRemoteVideo
Initializes the video view of a remote user.
- (int)setupRemoteVideo:(AgoraRtcVideoCanvas * _Nonnull)remote;
This method initializes the video view of a remote stream on the local device. It affects only the video view that the local user sees. Call this method to bind the remote video stream to a video view and to set the rendering and mirror modes of the video view.
You need to specify the ID of the remote user in this method. If the remote user ID is unknown to the application, set it after the app receives the didJoinedOfUid callback.
To unbind the remote user from the view, set the view parameter to NULL.
Once the remote user leaves the channel, the SDK unbinds the remote user.
- To update the rendering or mirror mode of the remote video view during a call, use the setRemoteRenderMode [2/2] method.
- If you use the Agora recording feature, the recording client joins the channel as a dummy client, triggering the didJoinedOfUid callback. Do not bind the dummy client to the app view because the dummy client does not send any video streams. If your app does not recognize the dummy client, bind the remote user to the view when the SDK triggers the firstRemoteVideoDecodedOfUid callback.
Parameters
- remote
-
The remote video view and settings. See AgoraRtcVideoCanvas.
Returns
- 0: Success.
- < 0: Failure.
setVideoDenoiserOptions
Sets video noise reduction.
- (int)setVideoDenoiserOptions:(BOOL)enable options:(AgoraVideoDenoiserOptions* _Nullable)options NS_SWIFT_NAME(setVideoDenoiserOptions(_:options:));
Underlit environments and low-end video capture devices can cause video images to contain significant noise, which affects video quality. In real-time interactive scenarios, video noise also consumes bitstream resources and reduces encoding efficiency during encoding.
You can call this method to enable the video noise reduction feature and set the options of the video noise reduction effect.
- Call this method after calling enableVideo.
- Video noise reduction has certain requirements for equipment performance. If your device overheats after you enable video noise reduction, Agora recommends modifying the video noise reduction options to a less performance-consuming level or disabling video noise reduction entirely.
- Both this method and setExtensionPropertyWithVendor can turn on video noise reduction function:
- When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
- When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionPropertyWithVendor.
- This method relies on the video enhancement dynamic library
AgoraClearVisionExtension.xcframework
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- enable
- Whether to enable video noise reduction:
YES
: Enable video noise reduction.NO
: (Default) Disable video noise reduction.
- options
- The video noise reduction options. See AgoraVideoDenoiserOptions.
Returns
- 0: Success.
- < 0: Failure.
setVideoEncoderConfiguration
Sets the video encoder configuration.
- (int)setVideoEncoderConfiguration:(AgoraVideoEncoderConfiguration * _Nonnull)config;
Sets the encoder configuration for the local video.
Parameters
- config
- Video profile. See AgoraVideoEncoderConfiguration.
Returns
- 0: Success.
- < 0: Failure.
setVideoProfile [1/2]
Sets the video encoder configuration.
- (int)setVideoProfile:(AgoraVideoProfile)profile swapWidthAndHeight:(BOOL)swapWidthAndHeight
- Deprecated:
- This method is deprecated. Use setVideoEncoderConfiguration instead.
This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before enableVideo to reduce the time to render the first video frame.
Parameters
- profile
-
The video profile. See AgoraVideoProfile.
- swapWidthAndHeight
-
The SDK outputs video with a fixed width and height according to the video profile (profile) you selected. This parameter sets whether to swap width and height of the video:
YES
: Swap the width and height.NO
: (Default) Do not swap the width and height.
Returns
- 0: Success.
- < 0: Failure.
setVideoProfile [2/2]
Sets the video encoder configuration.
- (int)setVideoResolution:(CGSize)size andFrameRate:(NSInteger)frameRate bitrate:(NSInteger)bitrate;
- Deprecated:
- This method is deprecated. Use setVideoEncoderConfiguration instead.
This method sets the video encoder configuration. You can call this method either before or after joining a channel. If the user does not need to reset the video encoding properties after joining the channel, Agora recommends calling this method before enableVideo to reduce the time to render the first video frame.
Parameters
- width
- The width of the video. The maximum value of width × height is 1280 × 720.
- height
- The height of the video. The maximum value of width × height is 1280 × 720.
- frameRate
- The frame rate of the video. The highest value is 30. You can set the parameter as 5, 10, 15, 24, and 30.
- bitrate
- The bitrate of the video. You need to manually work out the bitrate according to the width, height, and frame rate. With the same width and height, the bitrate varies with the frame rate:
- If the frame rate is 5 fps, divide the recommended bitrate by 2.
- If the frame rate is 15 fps, use the recommended bitrate.
- If the frame rate is 30 fps, multiply the recommended bitrate by 1.5.
- Calculate the bitrate according to the ratio if you choose other frame rates.
- If you set a bitrate beyond the proper range, the SDK automatically adjusts the bitrate to a value within the proper range.
setVideoQualityParameters
Sets the preferences for high-quality video. (LIVE_BROADCASTING only).
- (int)setVideoQualityParameters:(BOOL)preferFrameRateOverImageQuality;
- Deprecated:
- This method is deprecated. Agora recommends using the degradationPreference parameter in the AgoraVideoEncoderConfiguration class to set the video quality preference.
Parameters
- preferFrameRateOverImageQuality
-
Whether to prioritize smoothness or image quality.
YES
: Prioritizes smoothness.NO
: (Default) Prioritizes the image quality.
Returns
- 0: Success.
- < 0: Failure.
setVoiceBeautifierParameters
Sets parameters for the preset voice beautifier effects.
- (int)setVoiceBeautifierParameters:(AgoraVoiceBeautifierPreset)preset param1:(int)param1 param2:(int)param2;
Call this method to set a gender characteristic and a reverberation effect for the singing beautifier effect. This method sets parameters for the local user who sends an audio stream. After setting the audio parameters, all users in the channel can hear the effect.
For better voice effects, Agora recommends that you call setAudioProfile [1/2] and set scenario to AgoraAudioScenarioGameStreaming(3) and profile to AgoraAudioProfileMusicHighQuality(4) or AgoraAudioProfileMusicHighQualityStereo(5) before calling this method.
- You can call this method either before or after joining a channel.
- Do not set the profile parameter in setAudioProfile [1/2] to AgoraAudioProfileSpeechStandard(1), or the method does not take effect.
- This method works best with the human voice. Agora does not recommend using this method for audio containing music.
- After calling setVoiceBeautifierParameters, Agora recommends not calling the following methods, because they can override settings in setVoiceBeautifierParameters:
Parameters
- preset
- The option for the preset audio effect:
SINGING_BEAUTIFIER
: The singing beautifier effect.
- param1
- The gender characteristics options for the singing voice:
1
: A male-sounding voice.2
: A female-sounding voice.
- param2
- The reverberation effect options for the singing voice:
1
: The reverberation effect sounds like singing in a small room.2
: The reverberation effect sounds like singing in a large room.3
: The reverberation effect sounds like singing in a hall.
Returns
- 0: Success.
- < 0: Failure.
setVoiceBeautifierPreset
Sets a preset voice beautifier effect.
- (int)setVoiceBeautifierPreset:(AgoraVoiceBeautifierPreset)preset;
Call this method to set a preset voice beautifier effect for the local user who sends an audio stream. After setting a voice beautifier effect, all users in the channel can hear the effect. You can set different voice beautifier effects for different scenarios. For the applicable scenarios of each voice beautifier effect, refer to Set the Voice Effect.
For better voice effects, Agora recommends that you call setAudioProfile [1/2] and set scenario to AgoraAudioScenarioGameStreaming (3) and profile to AgoraAudioProfileMusicHighQuality (4) or AgoraAudioProfileMusicHighQualityStereo(5) before calling this method.
- You can call this method either before or after joining a channel.
- Do not set the profile parameter in setAudioProfile [1/2] to AgoraAudioProfileSpeechStandard(1), or the method does not take effect.
- This method works best with the human voice. Agora does not recommend using this method for audio containing music.
- After calling setVoiceBeautifierPreset, Agora recommends not calling the following methods, because they can override settings in setVoiceBeautifierPreset:
- This method relies on the voice beautifier dynamic library
AgoraAudioBeautyExtension.xcframework
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- preset
-
The preset voice beautifier effect options: AgoraVoiceBeautifierPreset.
Returns
- 0: Success.
- < 0: Failure.
setVoiceConversionPreset
Sets a preset voice beautifier effect.
- (int)setVoiceConversionPreset:(AgoraVoiceConversionPreset)preset;
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. For the applicable scenarios of each voice beautifier effect, refer to Set the Voice Effect.
To achieve better audio effect quality, Agora recommends that you call setAudioProfile [1/2] and set the profile to AgoraAudioProfileMusicHighQuality (4) or AgoraAudioProfileMusicHighQualityStereo (5) and scenario to AgoraAudioScenarioGameStreaming(3) before calling this method.
- You can call this method either before or after joining a channel.
- Do not set the profile parameter in setAudioProfile [1/2] to AgoraAudioProfileSpeechStandard(1), or the method does not take effect.
- This method works best with the human voice. Agora does not recommend using this method for audio containing music.
- After calling setVoiceConversionPreset, Agora recommends not calling the following methods, or the settings in setVoiceConversionPreset are overridden:
- This method relies on the voice beautifier dynamic library
AgoraAudioBeautyExtension.xcframework
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- preset
-
The options for the preset voice beautifier effects: AgoraVoiceConversionPreset.
Returns
- 0: Success.
- < 0: Failure.
startAudioMixing [1/2]
Starts playing the music file.
- (int)startAudioMixing:(NSString * _Nonnull)filePath loopback:(BOOL)loopback replace:(BOOL)replace cycle:(NSInteger)cycle;
- Deprecated:
- Use startAudioMixing [2/2] instead.
This method mixes the specified local or online audio file with the audio from the microphone, or replaces the microphone's audio with the specified local or remote audio file. A successful method call triggers the audioMixingStateChanged (AgoraAudioMixingStateTypePlaying) callback. When the audio mixing file playback finishes, the SDK triggers the audioMixingStateChanged (AgoraAudioMixingStateTypeStopped) callback on the local client.
- You can call this method either before or after joining a channel. If you need to call startAudioMixing [1/2] multiple times, ensure that the time interval between calling this method is more than 500 ms.
- If the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL, the SDK reports the warn code 701.
Parameters
- filePath
-
The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example:
/var/mobile/Containers/Data/audio.mp4
. Supported audio formats include MP3, AAC, M4A, MP4, WAV, and 3GP. See supported audio formats. - loopback
-
Whether to play music files only on the local client:
YES
: Only play music files on the local client so that only the local user can hear the music.NO
: Publish music files to remote clients so that both the local user and remote users can hear the music.
- cycle
-
The number of times the music file plays.
- ≥ 0: The number of playback times. For example, 0 means that the SDK does not play the music file while 1 means that the SDK plays once.
- -1: Play the audio file in an infinite loop.
Returns
- 0: Success.
- < 0: Failure.
startAudioMixing [2/2]
Starts playing the music file.
- (int)startAudioMixing:(NSString* _Nonnull)filePath loopback:(BOOL)loopback cycle:(NSInteger)cycle startPos:(NSInteger)startPos;
This method mixes the specified local or online audio file with the audio from the microphone, or replaces the microphone's audio with the specified local or remote audio file. A successful method call triggers the audioMixingStateChanged(AgoraAudioMixingStateTypePlaying)
callback. When the audio mixing file playback finishes, the SDK triggers the audioMixingStateChanged(AgoraAudioMixingStateTypeStopped)
callback on the local client.
- You can call this method either before or after joining a channel. If you need to call startAudioMixing [2/2] multiple times, ensure that the time interval between calling this method is more than 500 ms.
- If the local music file does not exist, the SDK does not support the file format, or the the SDK cannot access the music file URL, the SDK reports the warn code 701.
- For the audio file formats supported by this method, see What formats of audio files the Agora RTC SDK support.
Parameters
- filePath
- File path:
- iOS or macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example:
/var/mobile/Containers/Data/audio.mp4
.
- iOS or macOS: The absolute path or URL address (including the suffixes of the filename) of the audio effect file. For example:
- loopback
-
Whether to only play music files on the local client:
YES
: Only play music files on the local client so that only the local user can hear the music.NO
: Publish music files to remote clients so that both the local user and remote users can hear the music.
- cycle
-
The number of times the music file plays.
- ≥ 0: The number of playback times. For example, 0 means that the SDK does not play the music file while 1 means that the SDK plays once.
- -1: Play the audio file in an infinite loop.
- startPos
- The playback position (ms) of the music file.
Returns
- 0: Success.
- < 0: Failure.
startAudioRecording [1/2]
Starts the audio recording on the client.
- (int)startAudioRecording:(NSString * _Nonnull)filePath quality:(AgoraAudioRecordingQuality)quality;
- Deprecated:
- This method is deprecated as of v2.9.1. It has a fixed recording sample rate of 32 kHz. Use startAudioRecording [2/2] instead.
.wav
: Large file size with high fidelity..aac
: Small file size with low fidelity.
Ensure that the directory for the recording file exists and is writable. This method should be called after the joinChannelByToken [1/4] method. The recording automatically stops when you call the leaveChannel [1/2] method.
Parameters
- filePath
- The absolute path (including the filename extensions) of the recording file. For example:
/var/mobile/Containers/Data/audio.mp4
.Attention:Ensure that the path for the recording file exists and is writable.
- quality
- Audio recording quality. See AgoraAudioRecordingQuality.
Returns
- 0: Success.
- < 0: Failure.
startAudioRecording [2/2]
Starts the audio recording on the client.
- (int)startAudioRecordingWithConfig:(AgoraAudioRecordingConfiguration * _Nonnull)config;
- WAV: High-fidelity files with typically larger file sizes. For example, the size of a WAV file with a sample rate of 32,000 Hz and a recording duration of 10 minutes is around 73 MB.
- AAC: Low-fidelity files with typically smaller file sizes. For example, if the sample rate is 32,000 Hz and the recording quality is AgoraAudioRecordingQualityMedium, the file size for a 10-minute recording is approximately 2 MB.
Once the user leaves the channel, the recording automatically stops.
Parameters
- config
- Recording configuration. See AgoraAudioRecordingConfiguration.
Returns
- 0: Success.
- < 0: Failure.
startChannelMediaRelay
Starts relaying media streams across channels. This method can be used to implement scenarios such as co-host across channels.
- (int)startChannelMediaRelay:(AgoraChannelMediaRelayConfiguration * _Nonnull)config;
- If the channelMediaRelayStateDidChange callback returns AgoraChannelMediaRelayStateRunning (2) and AgoraChannelMediaRelayErrorNone (0), and the didReceiveChannelMediaRelayEvent callback returns AgoraChannelMediaRelayEventSentToDestinationChannel (4); it means that the SDK starts relaying media streams between the source channel and the destination channel.
- If the channelMediaRelayStateDidChange callback returns AgoraChannelMediaRelayStateFailure (3), an exception occurs during the media stream relay.
- Call this method after joining the channel.
- This method takes effect only when you are a host in a live streaming channel.
- After a successful method call, if you want to call this method again, ensure that you call the stopChannelMediaRelay method to quit the current relay.
- You need to contact technical support before implementing this function.
- We do not support string type of UID in this API.
Parameters
- config
- The configuration of the media stream relay. See AgoraChannelMediaRelayConfiguration.
Returns
- 0: Success.
- < 0: Failure.
startEchoTest
Starts an audio call test.
- (int)startEchoTest:(void(^ _Nullable) (NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))successBlock;
- Deprecated:
- This method is deprecated, use startEchoTestWithInterval instead.
This method starts an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly. To conduct the test, the user speaks, and the recording is played back within 10 seconds. If the user can hear the recording within the interval, the audio devices and network connection are working properly.
- Call this method before joining a channel.
- After calling startEchoTest, you must call stopEchoTest to end the test. Otherwise, the app cannot perform the next echo test, and you cannot join the channel.
- In the live streaming channels, only a host can call this method.
Parameters
- successBlock
- The SDK triggers the successBlock callback if this method call is successful.
Returns
- 0: Success.
- < 0: Failure.
startEchoTestWithInterval
Starts an audio call test.
- (int)startEchoTestWithInterval:(NSInteger)interval successBlock:(void(^ _Nullable) (NSString * _Nonnull channel, NSUInteger uid, NSInteger elapsed))successBlock;
- Deprecated:
- This method is deprecated as of v4.0.1. Use startEchoTestWithConfig instead.
This method starts an audio call test to determine whether the audio devices (for example, headset and speaker) and the network connection are working properly. To conduct the test, let the user speak for a while, and the recording is played back within the set interval. If the user can hear the recording within the interval, the audio devices and network connection are working properly.
- Call this method before joining a channel.
- After calling startEchoTestWithInterval, you must call stopEchoTest to end the test. Otherwise, the app cannot perform the next echo test, and you cannot join the channel.
- In the live streaming channels, only a host can call this method.
Parameters
- interval
- The time interval (s) between when you speak and when the recording plays back. The value range is [2, 10], and the default value is 10.
- successBlock
- The SDK triggers the successBlock callback if this method call is successful.
Returns
- 0: Success.
- < 0: Failure.
startEchoTestWithConfig
Starts an audio and video call loop test.
- (int)startEchoTestWithConfig:(AgoraEchoTestConfiguration* _Nonnull)config;
Before joining a channel, to test whether the user's local sending and receiving streams are normal, you can call this method to perform an audio and video call loop test, which tests whether the audio and video devices and the user's upstream and downstream networks are working properly.
- Call this method before joining a channel.
- After calling this method, call stopEchoTest to end the test; otherwise, the user cannot perform the next audio and video call loop test and cannot join the channel.
- In live streaming scenarios, this method only applies to hosts.
Parameters
- config
- The configuration of the audio and video call loop test. See AgoraEchoTestConfiguration.
Returns
- 0: Success.
- < 0: Failure.
startLastmileProbeTest
Starts the last mile network probe test.
- (int)startLastmileProbeTest:(AgoraLastmileProbeConfig *_Nullable)config;
This method starts the last-mile network probe test before joining a channel to get the uplink and downlink last mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT).
- lastmileQuality: The SDK triggers this callback within two seconds depending on the network conditions. This callback rates the network conditions and is more closely linked to the user experience.
- lastmileProbeTestResult: The SDK triggers this callback within 30 seconds depending on the network conditions. This callback returns the real-time statistics of the network conditions and is more objective.
- Before a user joins a channel, call this method to check the uplink network quality.
- In a live streaming channel, call this method to check the uplink network quality before an audience member switches to a host.
- Do not call other methods before receiving the lastmileQuality and lastmileProbeTestResult callbacks. Otherwise, the callbacks may be interrupted.
- A host should not call this method after joining a channel (when in a call).
Parameters
- config
- The configurations of the last-mile network probe test. See AgoraLastmileProbeConfig.
Returns
- 0: Success.
- < 0: Failure.
startPreview
Enables the local video preview.
- (int)startPreview;
- Call setupLocalVideo to set the local preview window.
- Call enableVideo to enable the video.
- The local preview enables the mirror mode by default.
- After the local video preview is enabled, if you call leaveChannel [1/2] to exit the channel, the local preview remains until you call stopPreview to disable it.
Returns
- 0: Success.
- < 0: Failure.
startRhythmPlayer
Enables the virtual metronome.
- (int)startRhythmPlayer:(NSString * _Nonnull)sound1 sound2:(NSString * _Nonnull)sound2 config:(AgoraRhythmPlayerConfig * _Nullable)config;
In music education, physical education, and other scenarios, teachers might 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 paths of the upbeat and downbeat files, the number of beats per measure, the tempo, and whether to send the sound of the metronome to remote users.
- After enabling the virtual metronome, the SDK plays the specified audio effect file from the beginning and controls the playback duration of each file according to beatsPerMinuteyou set in AgoraRhythmPlayerConfig. For example, if you set beatsPerMinute as
60
, the SDK plays one beat every second. If the file duration exceeds the beat duration, the SDK only plays the audio within the beat duration. - By default, the sound of the virtual metronome is published in the channel. If you do not want the sound to be heard by the remote users, you can set publishRhythmPlayerTrack in AgoraRtcChannelMediaOptions as
NO
.
Parameters
- sound1
- The absolute path or URL address (including the filename extensions) of the file for the downbeat. For example:
/var/mobile/Containers/Data/audio.mp4
. For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK v4.0.0 support. - sound2
- The absolute path or URL address (including the filename extensions) of the file for the upbeats. For example:
/var/mobile/Containers/Data/audio.mp4
. For the audio file formats supported by this method, see What formats of audio files does the Agora RTC SDK v4.0.0 support. - config
- The metronome configuration. See AgoraRhythmPlayerConfig.
Returns
- 0: Success.
- < 0: Failure.
- -22: Cannot find audio effect files. You need to set the correct paths for sound1 and sound2.
startScreenCapture
Starts screen sharing.
- (int)startScreenCapture:(AgoraScreenCaptureParameters2* _Nullable)parameters NS_SWIFT_NAME(startScreenCapture(_:));
- Call this method before joining a channel, then call joinChannelByToken [2/4] to join channel and set publishScreenCaptureVideo to
YES
to start screen sharing. - Call this method after joining a channel, then call updateChannelWithMediaOptions and set publishScreenCaptureVideo to
YES
to start screen sharing.
When the state of the screen sharing extension process changes, the SDK triggers the localVideoStateChangedOfState callback accordingly. When the type of sourceType is AgoraVideoSourceTypeScreen, the state parameter indicates the state of the screen sharing.
- On the iOS platform, screen sharing is only available on iOS 12.0 and later.
- The billing for the screen sharing stream is based on the dimensions in AgoraScreenVideoParameters. When you do not pass in a value, Agora bills you at 1280 × 720; when you pass a value in, Agora bills you at that value. See Pricing.
- If you are using the custom audio source instead of the SDK to capture audio, Agora recommends you add the keep-alive processing logic to your application to avoid screen sharing stopping when the application goes to the background.
- This feature requires high-performance device , and Agora recommends that you use it on iPhone X and later models.
- This method relies on the iOS screen sharing dynamic library
AgoraReplayKitExtension.xcframework.
If the dynamic library is deleted, screen sharing cannot be enabled normally.
Parameters
- parameters
- The screen sharing encoding parameters. The default video dimension is 1920 x 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See AgoraScreenCaptureParameters2.
Returns
- 0: Success.
- < 0: Failure.
- -2: The parameter is null.
stopRhythmPlayer
Disables the virtual metronome.
- (int)stopRhythmPlayer;
After calling startRhythmPlayer, you can call this method to disable the virtual metronome.
Returns
- 0: Success.
- < 0: Failure.
setColorEnhanceOptions
Sets color enhancement.
- (int)setColorEnhanceOptions:(BOOL)enable options:(AgoraColorEnhanceOptions* _Nullable)options NS_SWIFT_NAME(setColorEnhanceOptions(_:options:));
The video images captured by the camera can have color distortion. The color enhancement feature intelligently adjusts video characteristics such as saturation and contrast to enhance the video color richness and color reproduction, making the video more vivid.
You can call this method to enable the color enhancement feature and set the options of the color enhancement effect.
- Call this method after calling enableVideo.
- The color enhancement feature has certain performance requirements on devices. With color enhancement turned on, Agora recommends that you change the color enhancement level to one that consumes less performance or turn off color enhancement if your device is experiencing severe heat problems.
- Both this method and setExtensionPropertyWithVendor can enable color enhancement:
- When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
- When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionPropertyWithVendor.
- This method relies on the video enhancement dynamic library
AgoraClearVisionExtension.xcframework
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- enable
- Whether to enable color enhancement:
YES
Enable color enhancement.NO
: (Default) Disable color enhancement.
- options
- The color enhancement options. See AgoraColorEnhanceOptions.
Returns
- 0: Success.
- < 0: Failure.
setLowlightEnhanceOptions
Sets low-light enhancement.
- (int)setLowlightEnhanceOptions:(BOOL)enable options:(AgoraLowlightEnhanceOptions* _Nullable)options NS_SWIFT_NAME(setLowlightEnhanceOptions(_:options:));
The low-light enhancement feature can adaptively adjust the brightness value of the video captured in situations with low or uneven lighting, such as backlit, cloudy, or dark scenes. It restores or highlights the image details and improves the overall visual effect of the video.
You can call this method to enable the color enhancement feature and set the options of the color enhancement effect.
- Call this method after calling enableVideo.
- Dark light enhancement has certain requirements for equipment performance. The low-light enhancement feature has certain performance requirements on devices. If your device overheats after you enable low-light enhancement, Agora recommends modifying the low-light enhancement options to a less performance-consuming level or disabling low-light enhancement entirely.
- Both this method and setExtensionPropertyWithVendor can turn on low-light enhancement:
- When you use the SDK to capture video, Agora recommends this method (this method only works for video captured by the SDK).
- When you use an external video source to implement custom video capture, or send an external video source to the SDK, Agora recommends using setExtensionPropertyWithVendor.
- This method relies on the video enhancement dynamic library
AgoraClearVisionExtension.xcframework
. If the dynamic library is deleted, the function cannot be enabled normally.
Parameters
- enable
- Whether to enable low-light enhancement function:
YES
: Enable low-light enhancement function.NO
: (Default) Disable low-light enhancement function.
- options
- The low-light enhancement options. See AgoraLowlightEnhanceOptions.
Returns
- 0: Success.
- < 0: Failure.
setVideoEncoderConfiguration
Sets the video encoder configuration.
- (int)setVideoEncoderConfiguration:(AgoraVideoEncoderConfiguration * _Nonnull)config;
Sets the encoder configuration for the local video.
Parameters
- config
- Video profile. See AgoraVideoEncoderConfiguration.
Returns
- 0: Success.
- < 0: Failure.
startRtmpStreamWithoutTranscoding
Starts Media Push without transcoding.
- (int)startRtmpStreamWithoutTranscoding:(NSString* _Nonnull)url;
You can call this method to push an audio or video stream to the specified CDN address. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.
After you call this method, the SDK triggers the rtmpStreamingChangedToState callback on the local client to report the state of the Media Push.
- Ensure that you enable the media push service before using this function.
- Call this method after joining a channel.
- Only hosts in the LIVE_BROADCASTING profile can call this method.
- If you want to retry pushing streams after a failed push, make sure to call stopRtmpStream first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
Parameters
- url
- The address of media push. The format is RTMP or RTMPS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported.
Returns
- 0: Success.
- < 0: Failure.
- -2: url is null or the string length is 0.
- -7: The SDK is not initialized before calling this method.
startRtmpStreamWithTranscoding
Starts Media Push and sets the transcoding configuration.
- (int)startRtmpStreamWithTranscoding:(NSString* _Nonnull)url transcoding:(AgoraLiveTranscoding* _Nullable)transcoding;
You can call this method to push an audio or video stream to the specified CDN address and set the transcoding configuration. This method can push media streams to only one CDN address at a time, so if you need to push streams to multiple addresses, call this method multiple times.
After you call this method, the SDK triggers the rtmpStreamingChangedToState callback on the local client to report the state of the Media Push.
- Ensure that you enable the media push service before using this function.
- Call this method after joining a channel.
- Only hosts in the LIVE_BROADCASTING profile can call this method.
- If you want to retry pushing streams after a failed push, make sure to call stopRtmpStream first, then call this method to retry pushing streams; otherwise, the SDK returns the same error code as the last failed push.
Parameters
- url
- The address of media push. The format is RTMP or RTMPS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported.
- transcoding
-
The transcoding configuration for media push. See AgoraLiveTranscoding.
Returns
- 0: Success.
- < 0: Failure.
- -2: url is null or the string length is 0.
- -7: The SDK is not initialized before calling this method.
stopAudioMixing
Stops playing and mixing the music file.
- (int)stopAudioMixing;
This method stops the audio mixing. Call this method when you are in a channel.
Returns
- 0: Success.
- < 0: Failure.
stopAudioRecording
Stops the audio recording on the client.
- (int)stopAudioRecording;
Returns
- 0: Success.
- < 0: Failure.
stopChannelMediaRelay
Stops the media stream relay. Once the relay stops, the host quits all the destination channels.
- (int)stopChannelMediaRelay;
After a successful method call, the SDK triggers the channelMediaRelayStateDidChange callback. If the callback reports AgoraChannelMediaRelayStateIdle (0) and AgoraChannelMediaRelayErrorNone (0), the host successfully stops the relay.
Returns
- 0: Success.
- < 0: Failure.
stopEchoTest
Stops the audio call test.
- (int)stopEchoTest;
Returns
- 0: Success.
-
< 0: Failure.
- -5(ERR_REFUSED): Failed to stop the echo test. The echo test may not be running.
stopLastmileProbeTest
Stops the last mile network probe test.
- (int)stopLastmileProbeTest;
Returns
- 0: Success.
- < 0: Failure.
stopPreview
Stops the local video preview.
- (int)stopPreview;
After calling startPreview to start the preview, if you want to close the local video preview, please call this method.
Returns
- 0: Success.
- < 0: Failure.
stopRtmpStream
Stops pushing media streams to a CDN.
- (int)stopRtmpStream:(NSString* _Nonnull)url;
You can call this method to stop the live stream on the specified CDN address. This method can stop pushing media streams to only one CDN address at a time, so if you need to stop pushing streams to multiple addresses, call this method multiple times.
After you call this method, the SDK triggers the rtmpStreamingChangedToState callback on the local client to report the state of the streaming.
Parameters
- url
- The address of media push. The format is RTMP or RTMPS. The character length cannot exceed 1024 bytes. Special characters such as Chinese characters are not supported.
Returns
- 0: Success.
- < 0: Failure.
stopScreenCapture
Stops screen sharing.
- (int)stopScreenCapture NS_SWIFT_NAME(stopScreenCapture());
Returns
- 0: Success.
- < 0: Failure.
switchCamera
Switches between front and rear cameras.
- (int)switchCamera;
This method needs to be called after the camera is started (for example, by calling startPreview or joinChannelByToken [2/4]).
Returns
- 0: Success.
- < 0: Failure.
takeSnapshot
Takes a snapshot of a video stream.
- (NSInteger)takeSnapshot:(NSInteger)uid filePath:(NSString* _Nonnull)filePath;
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 snapshotTaken callback to report whether the snapshot is successfully taken, as well as the details for that snapshot.
- Call this method after joining a channel.
- This method takes a snapshot of the published video stream specified in AgoraRtcChannelMediaOptions.
- If the user's video has been preprocessed, for example, watermarked or beautified, the resulting snapshot includes the pre-processing effect.
Parameters
- uid
- The user ID. Set uid as 0 if you want to take a snapshot of the local user's video.
- filePath
-
The local path (including filename extensions) of the snapshot. For example:
- iOS:
/App Sandbox/Library/Caches/example.jpg
- iOS:
Returns
- 0: Success.
- < 0: Failure.
unregisterAudioSpectrumDelegate
Unregisters the audio spectrum observer.
- (int) unregisterAudioSpectrumDelegate:(id<AgoraAudioSpectrumDelegate> _Nullable)delegate;
After calling registerAudioSpectrumDelegate, if you want to disable audio spectrum monitoring, you can call this method.
Parameters
- delegate
- The audio spectrum observer. See AgoraAudioSpectrumDelegate.
Returns
- 0: Success.
- < 0: Failure.
updateChannelWithMediaOptions
Updates the channel media options after joining the channel.
- (int)updateChannelWithMediaOptions:(AgoraRtcChannelMediaOptions* _Nonnull)mediaOptions;
Parameters
- mediaOptions
- The channel media options. See AgoraRtcChannelMediaOptions.
Returns
- 0: Success.
- < 0: Failure.
- -2: The value of a member in the AgoraRtcChannelMediaOptions structure is invalid. For example, the token or the user ID is invalid. You need to fill in a valid parameter.
- -7: The AgoraRtcEngineKit object has not been initialized. You need to initialize the AgoraRtcEngineKit object before calling this method.
- -8: The internal state of the AgoraRtcEngineKit object is wrong. The possible reason is that the user is not in the channel. Agora recommends using the connectionChangedToState callback to get whether the user is in the channel. If you receive the AgoraConnectionStateDisconnected (1) or AgoraConnectionStateFailed (5) state, the user is not in the channel. You need to call joinChannelByToken [2/4] to join a channel before calling this method.
updateChannelMediaRelay
Updates the channels for media stream relay.
- (int)updateChannelMediaRelay:(AgoraChannelMediaRelayConfiguration * _Nonnull)config;
After the media relay starts, if you want to relay the media stream to more channels, or leave the current relay channel, you can call this method.
After a successful method call, the SDK triggers the didReceiveChannelMediaRelayEvent callback with the AgoraChannelMediaRelayEventUpdateDestinationChannel (7) state code.
channelMediaRelayStateDidChange (AgoraChannelMediaRelayStateRunning, AgoraChannelMediaRelayErrorNone)
; otherwise, the method call fails.Parameters
- config
- The configuration of the media stream relay. For more details, see AgoraChannelMediaRelayConfiguration.
Returns
- 0: Success.
- < 0: Failure.
updateRtmpTranscoding
Updates the transcoding configuration.
- (int)updateRtmpTranscoding:(AgoraLiveTranscoding* _Nullable)transcoding;
After you start pushing media streams to CDN with transcoding, you can dynamically update the transcoding configuration according to the scenario. The SDK triggers the rtcEngineTranscodingUpdated callback after the transcoding configuration is updated.
Parameters
- transcoding
-
The transcoding configuration for media push. See AgoraLiveTranscoding.
Returns
- 0: Success.
- < 0: Failure.
updateScreenCapture
Updates the screen sharing parameters.
- (int)updateScreenCapture:(AgoraScreenCaptureParameters2* _Nonnull)parameters NS_SWIFT_NAME(updateScreenCapture(_:));
- Call this method, and set captureAudio to
YES
. - Call updateChannelWithMediaOptions, and set publishScreenCaptureAudio to
YES
to publish the audio captured by the screen.
- On the iOS platform, screen sharing is only available on iOS 12.0 and later.
Parameters
- parameters
- The screen sharing encoding parameters. The default video resolution is 1920 × 1080, that is, 2,073,600 pixels. Agora uses the value of this parameter to calculate the charges. See AgoraScreenCaptureParameters2.
Returns
- 0: Success.
- < 0: Failure.
ERR_INVALID_STATE
: The screen sharing state is invalid. Probably because you have shared other screens or windows. Try calling stopScreenCapture to stop the current sharing and start sharing the screen again.ERR_INVALID_ARGUMENT
: The parameter is invalid.