AliRtcEngine interface

API reference

For more information about all APIs, see AliRtcEngine.

Contents

Basic APIs

Channel APIs

Publishing APIs

Subscription APIs

Video APIs

Video Sharing APIs

Audio APIs

Accompaniment and Sound Effects

Media Engine APIs

Live Stream Bypass APIs

Cross-channel Co-hosting APIs

Preview APIs

Remote User Query APIs

Device Management APIs (Mac only)

Video Layout Recording APIs (Mac only)

Other APIs

API details

• setH5CompatibleMode: Sets whether to enable H5 compatibility.

  + (void)setH5CompatibleMode:(BOOL)comp;

  Parameters

  Name	Type	Description
  comp	BOOL	Specifies whether to enable H5 compatibility. `YES`: H5 compatibility is enabled. `NO`: H5 compatibility is disabled. The default value is `NO`.

  Important The current version does not support changing the H5 compatibility mode after an AliRtcEngine instance is created. You must call this method before you create the instance.
• getH5CompatibleMode: Checks whether H5 compatibility mode is set.

  + (BOOL)getH5CompatibleMode;

  Return value

  `YES`: H5 compatibility is enabled. `NO`: H5 compatibility is disabled.

• sharedInstance: Creates an AliRtcEngine instance.

  + (instancetype _Nonnull )sharedInstance:(id<AliRtcEngineDelegate>_Nullable)delegate extras:(NSString *_Nullable)extras;

  Parameters

  Name	Type	Description
  delegate	id<AliRtcEngineDelegate>_Nullable	The delegate for listening to callbacks.
  extras	NSString *_Nullable	Configures special SDK features using JSON configurations. For more information, see extras feature description. If no special features are needed, you can pass an empty string: "".

  Important Only one primary instance can exist at a time.
• destroy: Releases the SDK instance.

  + (void)destroy;

  Important Call this method after all operations are complete.
• uploadLog: Uploads logs. By default, logs are automatically uploaded after a user leaves a session.

  + (void)uploadLog;

• setLogDirPath: Sets the path to save the SDK log file.

  + (int)setLogDirPath:(NSString *_Nullable)logDirPath;

  Parameters

  Name	Type	Description
  logDirPath	NSString *_Nullable	The absolute path to save the log file. The default path for iOS is Library/Caches/Ali_RTC_Log. The default path for Mac is /Users/xxx/Documents/Ali_RTC_Log.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Important Call this method before you call any other SDK methods to prevent log loss. The application must ensure that the specified directory exists and is writable.
• setLogLevel: Sets the log level.

  - (void)setLogLevel:(AliRtcLogLevel)logLevel;

  Parameters

  Name	Type	Description
  logLevel	AliRtcLogLevel	The log level. The default value is AliRtcLogLevelInfo.

• joinChannel: Joins a channel.

  - (int)joinChannel:(AliRtcAuthInfo *_Nonnull)authInfo name:(NSString *_Nullable)userName onResult:(void(^_Nullable)(NSInteger errCode,NSString * _Nonnull channel,NSInteger elapsed))onResult;

  Parameters

  Name	Type	Description
  authInfo	AliRtcAuthInfo	The authentication information.
  userName	String	The display name of the user, not the user ID.
  onResult	void(^_Nullable)(NSInteger errCode,NSString * _Nonnull channel,NSInteger elapsed)	This callback is invoked when the method call is complete.

  Note After you successfully join a channel, you must call leaveChannel to leave the current channel before joining another one. If you fail to join a channel and need to retry, you do not need to call leaveChannel first.
• leaveChannel: Leaves a channel.

  - (int)leaveChannel;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note

  • For versions 1.15 and later, the engine can only be destroyed using the destroy method.
  • For versions earlier than 1.15, the AliRtcEngine instance is destroyed when you leave a channel. To perform operations such as joining a channel again, you must re-initialize the AliRtcEngine instance by calling `getInstance`.
  • If you are not in a channel, calling leaveChannel does not affect the instance, but it sends a notification message to other users in the channel.
• switchChannel: Switches to another channel.

  - (int)switchChannel:(AliRtcAuthInfo *_Nonnull)authInfo;

  Parameters

  Name	Type	Description
  authInfo	AliRtcAuthInfo	The authentication information.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  • If the ERR_SDK_INVALID_STATE error is returned, check if the channel mode or role is incorrect, or if you are not currently in a channel.
  • If `ERR_INVALID_ARGUMENTS` is returned, check whether the authentication information is valid, or whether you are trying to join the same channel.
  • `ERR_INNER` indicates an internal SDK state error.
  Note

  • This method can be used only by a viewer (`AliRtcClientRolelive`) in interactive live streaming mode (`AliRtcInteractivelive`).
  • This is an asynchronous method. After you successfully switch channels by calling this method, the SDK first triggers the onLeaveChannelResult callback for leaving the original channel, and then triggers the `onJoinChannelResult` callback for joining the new channel.
• isInCall: Checks whether the user is in a channel.

  - (BOOL)isInCall;

  Return value

  `YES`: The user is in a channel. `NO`: The user is not in a channel.

• setChannelProfile: Sets the channel mode.

  - (int)setChannelProfile:(AliRtcChannelProfile)profile;

  Parameters

  Name	Type	Description
  profile	AliRtcChannelProfile	The channel type. The default value is AliRtcCommunication.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note You can call this method only before you join a channel. You cannot change the channel mode during a session. You can change it after you leave the channel.
• createChannelWithDelegate: Creates an AliRtcEngine sub-channel instance.

  - (AliRtcEngine *_Nullable)createChannelWithDelegate:(id<AliRtcEngineDelegate>_Nonnull)delegate extras:(NSString *_Nullable)extras;

  Parameters

  Name	Type	Description
  delegate	id<AliRtcEngineDelegate>_Nonnull	The delegate of the returned SDK instance object.
  extras	NSString *_Nullable	Configures special SDK features using JSON configurations. For more information, see extras feature description. If no special features are needed, you can pass an empty string: @"".

  Return value

  Returns a sub-channel instance on success, or `nil` on failure.

• destroyChannel: Destroys the sub-channel created by createChannelWithDelegate.

  - (void)destroyChannel;

• publishLocalVideoStream: Sets whether to publish the camera stream.

  - (int)publishLocalVideoStream:(BOOL)enable;

  Parameters

  Name	Type	Description
  enable	boolean	`YES`: sends the video. `NO`: stops sending the video. The default value is `YES`.

• isLocalVideoStreamPublished: Checks whether the camera stream is published.

  - (BOOL)isLocalVideoStreamPublished;

  Return value

  `YES`: The camera stream is published. `NO`: The camera stream is not published.

• isScreenSharePublished: Checks whether the screen stream is published.

  - (BOOL)isScreenSharePublished;

  Return value

  `YES`: The screen stream is published. `NO`: The screen stream is not published.

• publishLocalAudioStream: Sets whether to publish the audio stream.

  - (int)publishLocalAudioStream:(BOOL)enable;

  Parameters

  Name	Type	Description
  enable	boolean	`YES`: sends the local audio stream. `NO`: stops the stream ingest. The default value is `YES`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• isLocalAudioStreamPublished: Checks whether the audio stream is published.

  - (BOOL)isLocalAudioStreamPublished;

  Return value

  YES allows pushing, and NO disallows pushing.

• publishLocalDualStream: Sets whether to publish the secondary video stream.

  - (int)publishLocalDualStream:(BOOL)enable;

  Parameters

  Name	Type	Description
  enable	BOOL	`YES`: publishes the secondary stream. `NO`: does not publish the secondary stream. The default value is `NO`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• isDualStreamPublished: Checks whether the secondary video stream is published.

  - (BOOL)isDualStreamPublished;

  Return value

  YES allows pushing. NO disallows pushing.

• setRemoteVideoStreamType: Sets the subscribed camera stream type to high-quality or low-quality.

  - (int)setRemoteVideoStreamType:(NSString *_Nonnull)uid type:(AliRtcVideoStreamType)streamType;

  Parameters

  Name	Type	Description
  uid	NSString *_Nonnull	The remote user ID.
  streamType	AliRtcVideoStreamType	The camera stream type. The default value is AliRtcVideoStreamTypeHigh (high-quality stream).

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setRemoteDefaultVideoStreamType: Sets the default subscribed camera stream type to high-quality or low-quality.

  - (int)setRemoteDefaultVideoStreamType:(AliRtcVideoStreamType)streamType;

  Parameters

  Name	Type	Description
  streamType	AliRtcVideoStreamType	The camera stream type. The default value is AliRtcVideoStreamTypeHigh (high-quality stream).

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setDefaultSubscribeAllRemoteAudioStreams: Sets whether to subscribe to audio streams by default.

  - (int)setDefaultSubscribeAllRemoteAudioStreams:(BOOL)sub;

  Parameters

  Name	Type	Description
  sub	BOOL	`YES`: receives user audio streams. `NO`: stops receiving user audio streams. The default value is `YES`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Important

  • You can call this method before or after you join a channel. If you call `setDefaultSubscribeAllRemoteAudioStreams:NO` after you join a channel, you will not receive audio streams from users who join the channel after the setting is applied.
  • After you stop receiving audio streams, if you want to resume, call subscribeRemoteAudioStream:uid sub:YES and specify the UID of the remote user.
  • To resume receiving audio streams from multiple users, you must call subscribeRemoteAudioStream multiple times. `setDefaultSubscribeAllRemoteAudioStreams:YES` only resumes receiving audio streams from users who join the channel later.
• subscribeAllRemoteAudioStreams: Stops or resumes receiving all remote audio streams.

  - (int)subscribeAllRemoteAudioStreams:(BOOL)sub;

  Parameters

  Name	Type	Description
  sub	BOOL	`YES`: receives audio streams from all users. `NO`: stops receiving audio streams from all users. The default value is `YES`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note This method acts as a master switch for subscribing to remote audio streams. If you set this parameter to `NO`, you will unsubscribe from all remote audio streams in the current session. You will also not subscribe to new users who join later, even if setDefaultSubscribeAllRemoteAudioStreams:YES is set.
• subscribeRemoteAudioStream: Stops or resumes receiving the audio stream of a specific remote user.

  - (int)subscribeRemoteAudioStream:(NSString *_Nonnull)uid sub:(BOOL)sub;

  Parameters

  Name	Type	Description
  uid	NSString *_Nonnull	The remote user ID.
  sub	BOOL	`YES`: receives the audio stream of the specified user. `NO`: stops receiving the audio stream of the specified user. The default value is `YES`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note If you have previously called subscribeAllRemoteAudioStreams:NO to stop receiving all remote audio, you must call subscribeAllRemoteAudioStreams:YES before calling this method. The subscribeAllRemoteAudioStreams method provides global control, while the subscribeRemoteAudioStream method provides fine-grained control.
• setDefaultSubscribeAllRemoteVideoStreams: Sets whether to subscribe to video streams by default.

  - (int)setDefaultSubscribeAllRemoteVideoStreams:(BOOL)sub;

  Parameters

  Name	Type	Description
  sub	boolean	`YES`: receives user video streams. `NO`: does not receive user video streams. The default value is `YES`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note

  • You can call this method before or after you join a channel. If you call `setDefaultSubscribeAllRemoteVideoStreams:NO` after you join a channel, you will not receive video streams from users who join the channel after the setting is applied.
  • After you stop receiving video streams, if you want to resume, call subscribeRemoteVideoStream:uid track:track sub:YES and specify the UID of the remote user.
  • To resume receiving video streams from multiple users, you must call subscribeRemoteVideoStream multiple times. `setDefaultSubscribeAllRemoteVideoStreams:YES` only resumes receiving video streams from users who join the channel later.
• subscribeAllRemoteVideoStreams: Stops or resumes receiving all remote video streams.

  - (int)subscribeAllRemoteVideoStreams:(BOOL)sub;

  Parameters

  Name	Type	Description
  sub	BOOL	`YES`: receives video streams from all users. `NO`: stops receiving video streams from all users. The default value is `YES`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note This method acts as a master switch for subscribing to remote video streams. If you set this parameter to `NO`, you will unsubscribe from all remote video streams in the current session. You will also not subscribe to new users who join later, even if setDefaultSubscribeAllRemoteVideoStreams:YES is set.
• subscribeRemoteVideoStream: Stops or resumes receiving the video stream of a specific remote user.

  - (int)subscribeRemoteVideoStream:(NSString *_Nonnull)uid track:(AliRtcVideoTrack)track sub:(BOOL)sub;

  Parameters

  Name	Type	Description
  uid	NSString *_Nonnull	The remote user ID.
  track	AliRtcVideoTrack	The video stream type.
  sub	BOOL	`YES`: receives the video stream of the specified user. `NO`: stops receiving the video stream of the specified user. The default value is `YES`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note

  • If you have previously called subscribeAllRemoteVideoStreams:NO to stop receiving all remote video streams, you must call subscribeAllRemoteVideoStreams:YES before calling this method.
  • subscribeAllRemoteVideoStreams method provides global control, while the `subscribeRemoteVideoStream` method provides fine-grained control.
• setScreenShareEncoderConfiguration: Sets the encoding properties for screen sharing.

  - (void)setScreenShareEncoderConfiguration:(AliRtcScreenShareEncoderConfiguration* _Nonnull)config;

  Parameters

  Name	Type	Description
  config	AliRtcScreenShareEncoderConfiguration* _Nonnull	The predefined screen sharing encoding properties. Default values: dimensions: [0,0] frameRate: 5 bitrate: 0 rotation: 0

• setLocalViewConfig: Sets the rendering window and parameters for the local preview.

  - (int)setLocalViewConfig:(AliVideoCanvas *_Nullable)viewConfig forTrack:(AliRtcVideoTrack)track;

  Parameters

  Name	Type	Description
  viewConfig	AliVideoCanvas *_Nullable	The rendering parameters, including the rendering window and rendering mode.
  track	AliRtcVideoTrack	The video track type.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note

  • You can switch windows before and after you call joinChannel. If `canvas` or `AliVideoCanvas::view` is `nil`, rendering stops.
  • To reset the render mode during playback, keep the other member variables in the `canvas` object unchanged and modify only the `renderMode` member variable.
  • To reset the mirror mode during playback, keep the other member variables in the `canvas` object unchanged and modify only the `mirrorMode` member variable.
• setCameraCapturerConfiguration: Sets the preferred camera capture settings.

  - (int)setCameraCapturerConfiguration:(AliRtcCameraCapturerConfiguration* _Nonnull)config;

  Parameters

  Name	Type	Description
  config	AliRtcCameraCapturerConfiguration* _Nonnull	The preferred camera capture settings. Default values: preference: 0 cameraDirection: 0

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• enableLocalVideo: Disables or re-enables local video capture.

  - (int)enableLocalVideo:(BOOL)enable;

  Parameters

  Name	Type	Description
  enable	BOOL	`YES`: resumes normal operation. `NO`: stops video capture. The default value is `YES`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• muteLocalCamera: Stops or resumes sending local video data.

  - (int)muteLocalCamera:(BOOL)mute forTrack:(AliRtcVideoTrack)track;

  Parameters

  Name	Type	Description
  mute	BOOL	`YES`: sends black frames instead of video data. `NO`: resumes normal operation. The default value is `NO`.
  track	AliRtcVideoTrack	The video track type whose publishing state needs to be changed.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note This method controls only whether to send black frames on the specified video stream. It does not stop video capture or data sending. To turn off video capture, use the enableLocalVideo method. To stop sending video data, use the publishLocalVideoStream method.
• muteAllRemoteVideoRendering: Stops or resumes rendering all remote videos (iOS only).

  - (int)muteAllRemoteVideoRendering:(BOOL)mute;

  Parameters

  Name	Type	Description
  mute	BOOL	`YES`: stops rendering. `NO`: resumes rendering. The default value is `NO`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note Stream pulling and decoding are not affected. You can call this method before or after you call joinChannel.
• setRemoteViewConfig: Sets the rendering window and parameters for a remote video.

  - (int)setRemoteViewConfig:(AliVideoCanvas *_Nullable)canvas uid:(NSString *_Nonnull)uid forTrack:(AliRtcVideoTrack)track;

  Parameters

  Name	Type	Description
  canvas	AliVideoCanvas *_Nullable	The rendering parameters, including the rendering window and rendering mode.
  uid	NSString *_Nonnull	The user ID.
  track	AliRtcVideoTrack	The video track type to set.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note

  • You can switch windows before and after you call joinChannel. If `canvas` or `view` is `nil`, rendering of the corresponding stream stops.
  • To reset the render mode during playback, keep the other member variables in the `canvas` object unchanged and modify only the `renderMode` member variable.
  • To reset the mirror mode during playback, keep the other member variables in the `canvas` object unchanged and modify only the `mirrorMode` member variable.
• isCameraOn: Checks whether the camera is on.

  - (BOOL)isCameraOn;

  Return value

  `YES`: The camera is on. `NO`: The camera is not on.

• stopRecord: Stops recording.

  - (void)stopRecord;

• startRecord: Starts recording (non-layout recording).

  - (BOOL)startRecord:(AliRtcRecordType)recordType recordFormat:(AliRtcRecordFormat)recordFormat filePath:(NSString*_Nonnull)filePath audioConfig:(AliRtcRecordAudioConfig*_Nullable)audioConfig videoConfig:(AliRtcRecordVideoConfig*_Nullable)videoConfig;

  Parameters

  Name	Type	Description
  recordType	AliRtcRecordType	The record type.
  recordFormat	AliRtcRecordFormat	The record format.
  filePath	NSString*_Nonnull	The file path.
  audioConfig	AliRtcRecordAudioConfig*_Nullable	The audio recording settings.
  videoConfig	AliRtcRecordVideoConfig*_Nullable	The video settings. Mobile devices do not support video recording.

  Return value

  `YES` indicates that the method call is successful. `NO` indicates that the call failed.

• setBeautyEffect: Enables or disables basic retouching. This feature currently supports only whitening and smoothing.

  - (int)setBeautyEffect:(BOOL)enable config:(AliRtcBeautyConfig *_Nullable)config;

  Parameters

  Name	Type	Description
  enable	BOOL	`YES`: enables the feature. `NO`: disables the feature. The default value is `NO`.
  config	AliRtcBeautyConfig *_Nullable	The basic retouching parameters.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setVideoEncoderConfiguration: Sets the video encoding properties.

  - (void)setVideoEncoderConfiguration:(AliRtcVideoEncoderConfiguration* _Nonnull)config;

  Parameters

  Name	Type	Description
  config	AliRtcVideoEncoderConfiguration* _Nonnull	The predefined encoding properties. Default values: dimensions: [640,480] frameRate: 15 bitrate: 0 mirrorMode: 0 orientationMode: 0 rotation: 0

• addVideoWatermark: Adds a watermark.

  - (int)addVideoWatermark:(AliRtcVideoTrack)track image:(NSString*_Nonnull)imageUrl config:(AliRtcWatermarkConfig *_Nullable)config;

  Parameters

  Name	Type	Description
  track	AliRtcVideoTrack	The data stream type.
  imageUrl	NSString*_Nonnull	The path of the watermark image.
  config	AliRtcWatermarkConfig *_Nullable	The watermark configuration.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• clearVideoWatermark: Removes the watermark from the specified data stream.

  - (int)clearVideoWatermark:(AliRtcVideoTrack)track;

  Parameters

  Name	Type	Description
  track	AliRtcVideoTrack	The data stream type.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• snapshotVideo: Takes a snapshot. The result is returned through the OnSnapshotComplete callback.

  - (int)snapshotVideo:(NSString*_Nullable)userId type:(AliRtcVideoTrack)type;

  Parameters

  Name	Type	Description
  userId	NSString*_Nullable	The user ID. If empty, it refers to the local user.
  trackType	AliRtcVideoTrack	The stream type.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• switchCamera: Switches between the front and rear cameras. The front camera is used by default (iOS only).

  - (int)switchCamera;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getCurrentCameraDirection: Retrieves the current camera direction. The front camera is used by default (iOS only).

  - (AliRtcCameraDirection)getCurrentCameraDirection;

  Return value

  Returns the camera direction enumeration value.

• setCameraZoom: Sets the camera zoom factor (iOS only).

  - (int)setCameraZoom:(float)zoom;

  Parameters

  Name	Type	Description
  zoom	float	The zoom level. The default value is 1.0.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setCameraFlash: Turns the camera flash on or off (iOS only).

  - (int)setCameraFlash:(BOOL)flash;

  Parameters

  Name	Type	Description
  flash	BOOL	`YES`: turns on the flash. `NO`: turns off the flash. The default value is `NO`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• isCameraFocusPointSupported: Checks whether the camera supports manual focus (iOS only).

  - (BOOL)isCameraFocusPointSupported;

  Return value

  `YES`: supported. `NO`: not supported.

• isCameraExposurePointSupported: Checks whether the camera supports setting an exposure area (iOS only).

  - (BOOL)isCameraExposurePointSupported;

  Return value

  `YES`: supported. `NO`: not supported.

• setCameraFocusPoint: Sets the manual focus for the camera (iOS only).

  - (int)setCameraFocusPoint:(CGPoint)point;

  Parameters

  Name	Type	Description
  point	CGPoint	The coordinates of the focus point.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setCameraExposurePoint: Sets the camera exposure point (iOS only).

  - (int)setCameraExposurePoint:(CGPoint)point;

  Parameters

  Name	Type	Description
  point	CGPoint	The coordinates of the exposure point.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• isCameraAutoFocusFaceModeSupported: Checks whether the camera supports face-based auto focus (iOS only).

  - (BOOL)isCameraAutoFocusFaceModeSupported;

  Return value

  `YES`: supported. `NO`: not supported.

• setCameraAutoFocusFaceModeEnabled: Enables or disables face-based auto focus for the camera (iOS only).

  - (BOOL)setCameraAutoFocusFaceModeEnabled:(BOOL)enable;

  Parameters

  Name	Type	Description
  enable	BOOL	`YES`: enables face-based auto focus. `NO`: disables face-based auto focus. The default value is `NO`.

  Return value

  `YES` indicates that the method call is successful. `NO` indicates that the call failed.

• startScreenShare: Starts screen sharing (iOS only).

  - (int)startScreenShare;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• stopScreenShare: Stops screen sharing.

  - (int)stopScreenShare;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setAudioOnlyMode: Sets the mode to audio-only or audio and video.

  - (int)setAudioOnlyMode:(BOOL)audioOnly;

  Parameters

  Name	Type	Description
  audioOnly	BOOL	`YES`: only audio is ingested and pulled. `NO`: both audio and video are supported. The default value is `NO`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• isAudioOnly: Checks whether the current mode is audio-only.

  - (BOOL)isAudioOnly;

  Return value

  `YES`: audio-only mode. `NO`: audio and video mode.

• muteLocalMic: Stops or resumes sending local audio data.

  - (int)muteLocalMic:(BOOL)mute mode:(AliRtcMuteLocalAudioMode)mode;

  Parameters

  Name	Type	Description
  mute	BOOL	`YES`: sends empty frames instead of local audio. `NO`: resumes normal operation. The default value is `NO`.
  mode	AliRtcMuteLocalAudioMode	The mute mode. The default is microphone mute mode.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note Muting sends only silent audio frames. The capture and encoding modules continue to work.
• muteRemoteAudioPlaying: Stops or resumes playing a remote audio stream.

  - (int)muteRemoteAudioPlaying:(NSString *_Nonnull)uid mute:(BOOL)mute;

  Parameters

  Name	Type	Description
  uid	NSString *_Nonnull	The user ID.
  mute	BOOL	`YES`: stops playback. `NO`: resumes playback. The default value is `NO`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• muteAllRemoteAudioPlaying: Stops or resumes playing all remote audio streams.

  - (int)muteAllRemoteAudioPlaying:(BOOL)mute;

  Parameters

  Name	Type	Description
  mute	BOOL	`YES`: stops playback. `NO`: resumes playback. The default value is `NO`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note Stream pulling and decoding are not affected. You can call this method before or after you call joinChannel.
• startAudioCapture: Starts audio capture.

  - (void)startAudioCapture;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note This method lets you start audio capture in advance. If you do not call this method, the SDK starts audio capture at the appropriate time.
• stopAudioCapture: Stops audio capture.

  - (void)stopAudioCapture;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note This method stops audio capture and is the counterpart to `startAudioCapture`.
• startAudioPlayer: Starts the audio playback device.

  - (void)startAudioPlayer;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note This method lets you start audio playback in advance. If you do not call this method, the SDK starts audio playback at the appropriate time.
• stopAudioPlayer: Stops audio playback.

  - (void)stopAudioPlayer;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note This method stops audio playback and is the counterpart to `startAudioPlayer`.
• setRemoteAudioVolume: Sets the playback volume of a specified remote user.

  - (int)setRemoteAudioVolume:(NSString *_Nonnull)uid volume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  uid	NSString *_Nonnull	The user ID.
  volume	NSInteger	The playback volume. The range is [0, 100]. 0 means mute, and 100 means original volume. The default value is 100.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• enableSpeakerphone: Sets the audio output to the earpiece or speaker (iOS only).

  - (int)enableSpeakerphone:(BOOL)enable;

  Parameters

  Name	Type	Description
  enable	BOOL	`YES`: speaker mode. `NO`: earpiece mode. The default value is `YES`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• isEnableSpeakerphone: Checks whether the audio output device is the speaker or the earpiece (iOS only).

  - (BOOL)isEnableSpeakerphone;

  Return value

  `YES`: speaker mode. `NO`: earpiece mode.

• setRecordingVolume: Sets the recording volume.

  - (int)setRecordingVolume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  volume	NSInteger	The range is [0, 400]. 0 means mute. The default value is 100. A value greater than 100 increases the volume, and a value less than 100 decreases the volume.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setPlayoutVolume: Sets the playback volume.

  - (int)setPlayoutVolume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  volume	NSInteger	The range is [0, 400]. 0 means mute. The default value is 100. A value greater than 100 increases the volume, and a value less than 100 decreases the volume.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• enableAudioVolumeIndication: Sets the volume callback frequency and smoothing coefficient.

  - (int)enableAudioVolumeIndication:(NSInteger)interval smooth:(NSInteger)smooth reportVad:(NSInteger)reportVad;

  Parameters

  Name	Type	Description
  interval	NSInteger	The time interval in milliseconds. The minimum value is 10 ms. We recommend setting it to 300-500 ms. A value less than or equal to 0 disables the volume and speaker detection features.
  smooth	NSInteger	The smoothing coefficient. The range is [0, 9]. A larger value provides more smoothing but less real-time performance. We recommend setting it to 3.
  reportVad	NSInteger	The speaker detection switch. Valid values: 1: On. The status of each speaker is returned through the onAudioVolumeCallback method. 0: Off.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setAudioProfile: Sets the audio profile.

  - (int)setAudioProfile:(AliRtcAudioProfile)audio_profile audio_scene:(AliRtcAudioScenario)audio_scene;

  Parameters

  Name	Type	Description
  audio_profile	AliRtcAudioProfile	The audio capture or encoding mode parameter. The default value is AliEngineBasicQualityMode.
  audio_scene	AliRtcAudioScenario	The audio scenario mode parameter. The default value is AliEngineSceneDefaultMode.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setAudioSessionOperationRestriction: Sets the SDK's control permission over AVAudioSession (iOS only).

  - (int)setAudioSessionOperationRestriction:(AliRtcAudioSessionOperationRestriction)restriction;

  Parameters

  Name	Type	Description
  restriction	AliRtcAudioSessionOperationRestriction	The control permission. The default value is AliAudioSessionOperationRestrictionNone.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setDeviceVolumeType: Sets the SDK device volume type (iOS only).

  - (int)setDeviceVolumeType:(AliRtcDeviceVolumeType)type;

  Parameters

  Name	Type	Description
  type	AliRtcDeviceVolumeType	The volume type. The default value is AliRtcDeviceVolumeTypeAuto.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• enableAudioDTX: Enables local audio traffic shaping (voice).

  - (int)enableAudioDTX:(BOOL)enable;

  Parameters

  Name	Type	Description
  enable	BOOL	`YES`: enables the feature. `NO`: disables the feature. The default value is `NO`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note This method is effective when called before stream ingest. Enabling voice activity detection can reduce the number of bytes sent when no voice is detected, which saves user traffic.
• enableAudioAMD: Enables local audio traffic shaping (microphone).

  - (int)enableAudioAMD:(BOOL)enable;

  Parameters

  Name	Type	Description
  enable	BOOL	`YES`: enables the feature. `NO`: disables the feature. The default value is `NO`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note This method is effective when called before stream ingest. Enabling voice activity detection can stop the sending of audio packets when the microphone is muted or turned off.
• setAudioEffectVoiceChangerMode: Sets the voice changer effect mode.

  - (int)setAudioEffectVoiceChangerMode:(AliRtcAudioEffectVoiceChangerMode)mode;

  Parameters

  Name	Type	Description
  mode	AliRtcAudioEffectVoiceChangerMode	The mode value. The default value is AliRtcSdk_AudioEffect_Voice_Changer_OFF.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setAudioEffectPitchValue: Sets the pitch-shifting parameter.

  - (int)setAudioEffectPitchValue:(double)value;

  Parameters

  Name	Type	Description
  value	double	The range is [0.5, 2.0]. The default value is 1.0, which means no pitch change.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setAudioEffectReverbMode: Sets the reverb effect mode.

  - (int)setAudioEffectReverbMode:(AliRtcAudioEffectReverbMode)mode;

  Parameters

  Name	Type	Description
  mode	AliRtcAudioEffectReverbMode	The sound effect mode. The default value is AliRtcAudioEffectReverb_Off.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setAudioEffectReverbParamType: Sets the reverb effect type and specific parameters.

  - (int)setAudioEffectReverbParamType:(AliRtcAudioEffectReverbParamType)type value:(float)value;

  Parameters

  Name	Type	Description
  type	AliRtcAudioEffectReverbParamType	The reverb effect mode.
  value	float	The specific parameter value.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• startAudioAccompanyWithFile: Starts audio mixing.

  - (int)startAudioAccompanyWithFile:(NSString *_Nonnull)filePath onlyLocalPlay:(BOOL)onlyLocalPlay replaceMic:(BOOL)replaceMic loopCycles:(NSInteger)loopCycles;

  Parameters

  Name	Type	Description
  filePath	NSString *_Nonnull	The path of the audio mixing file.
  onlyLocalPlay	BOOL	Specifies whether to play locally only.
  replaceMic	BOOL	Specifies whether to replace the microphone.
  loopCycles	NSInteger	The number of loops (can be -1 or a positive integer).

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• stopAudioAccompany: Stops audio mixing.

  - (int)stopAudioAccompany;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setAudioAccompanyVolume: Sets the audio mixing volume. This method is effective only after you call startAudioAccompanyWithFile.

  - (int)setAudioAccompanyVolume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  volume	NSInteger	The audio mixing volume. The range is [0, 100]. The default value is 50.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setAudioAccompanyPublishVolume: Sets the stream ingest volume of the mixed audio. This method is effective only after you call startAudioAccompanyWithFile.

  - (int)setAudioAccompanyPublishVolume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  volume	NSInteger	The audio mixing volume. The range is [0, 100]. The default value is 50.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getAudioAccompanyPublishVolume: Retrieves the stream ingest volume of the mixed audio.

  - (int)getAudioAccompanyPublishVolume;

  Return value

  Returns the stream ingest volume of the mixed audio. A value from 0 to 100 indicates success. Other values are error codes.

• setAudioAccompanyPlayoutVolume: Sets the local playback volume of the mixed audio. This method is effective only after you call startAudioAccompanyWithFile.

  - (int)setAudioAccompanyPlayoutVolume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  volume	NSInteger	The audio mixing volume. The range is [0, 100]. The default value is 50.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getAudioAccompanyPlayoutVolume: Retrieves the local playback volume of the mixed audio.

  - (int)getAudioAccompanyPlayoutVolume;

  Return value

  Returns the local playback volume of the mixed audio. A value from 0 to 100 indicates success. Other values are error codes.

• pauseAudioAccompany: Pauses audio mixing.

  public abstract int pauseAudioAccompany();

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• resumeAudioAccompany: Resumes audio mixing.

  - (int)pauseAudioAccompany;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getAudioAccompanyDuration: Retrieves the duration of the audio mixing file.

  - (int)getAudioAccompanyDuration;

  Return value

  Returns the duration of the audio mixing file in milliseconds. A value less than 0 is an error code.

• getAudioAccompanyCurrentPosition: Retrieves the playback progress of the music file.

  - (int)getAudioAccompanyCurrentPosition;

  Return value

  Returns the playback progress of the music file in milliseconds. A value less than 0 is an error code.

• setAudioAccompanyPosition: Sets the playback position of the audio file.

  - (int)setAudioAccompanyPosition:(int)pos;

  Parameters

  Name	Type	Description
  pos	int	The progress bar position in milliseconds.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• preloadAudioEffectWithSoundId: Preloads a sound effect file.

  - (int)preloadAudioEffectWithSoundId:(NSInteger)soundId filePath:(NSString *_Nonnull)filePath;

  Parameters

  Name	Type	Description
  soundId	NSInteger	The ID assigned to the sound effect file by the user.
  filePath	NSString *_Nonnull	The path of the sound effect file.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• unloadAudioEffectWithSoundId: Unloads a preloaded sound effect file.

  - (int)unloadAudioEffectWithSoundId:(NSInteger)soundId;

  Parameters

  Name	Type	Description
  soundId	NSInteger	The ID assigned to the sound effect file by the user.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• playAudioEffectWithSoundId: Starts playing a sound effect.

  - (int)playAudioEffectWithSoundId:(NSInteger)soundId filePath:(NSString *_Nonnull)filePath cycles:(NSInteger)cycles publish:(BOOL)publish;

  Parameters

  Name	Type	Description
  soundId	NSInteger	The ID assigned to the sound effect file by the user.
  filePath	NSString *_Nonnull	The path of the sound effect file.
  cycles	NSInteger	The number of loops (can be -1 or a positive integer).
  publish	BOOL	Specifies whether to publish.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• stopAudioEffectWithSoundId: Stops playing a sound effect.

  - (int)stopAudioEffectWithSoundId:(NSInteger)soundId;

  Parameters

  Name	Type	Description
  soundId	NSInteger	The ID assigned to the sound effect file by the user.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• stopAllAudioEffects: Stops playing all sound effects.

  - (int)stopAllAudioEffects;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setAudioEffectPublishVolumeWithSoundId: Sets the stream ingest volume for a sound effect.

  - (int)setAudioEffectPublishVolumeWithSoundId:(NSInteger)soundId volume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  soundId	NSInteger	The ID assigned to the sound effect file by the user.
  volume	NSInteger	The audio mixing volume. The range is [0, 100]. The default value is 50.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getAudioEffectPublishVolumeWithSoundId: Retrieves the stream ingest volume for a sound effect.

  - (int)getAudioEffectPublishVolumeWithSoundId:(NSInteger)soundId;

  Parameters

  Name	Type	Description
  soundId	NSInteger	The ID assigned to the sound effect file by the user.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setAudioEffectPlayoutVolumeWithSoundId: Sets the local playback volume for a sound effect.

  - (int)setAudioEffectPlayoutVolumeWithSoundId:(NSInteger)soundId volume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  soundId	NSInteger	The ID assigned to the sound effect file by the user.
  volume	NSInteger	The audio mixing volume. The range is [0, 100]. The default value is 50.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getAudioEffectPlayoutVolumeWithSoundId: Retrieves the local playback volume for a sound effect.

  - (int)getAudioEffectPlayoutVolumeWithSoundId:(NSInteger)soundId;

  Parameters

  Name	Type	Description
  soundId	NSInteger	The ID assigned to the sound effect file by the user.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setAllAudioEffectsPublishVolume: Sets the stream ingest volume for all sound effects.

  - (int)setAllAudioEffectsPublishVolume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  volume	NSInteger	The audio mixing volume. The range is [0, 100]. The default value is 50.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setAllAudioEffectsPlayoutVolume: Sets the local playback volume for all sound effects.

  - (int)setAllAudioEffectsPlayoutVolume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  volume	NSInteger	The audio mixing volume. The range is [0, 100]. The default value is 50.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• pauseAudioEffectWithSoundId: Pauses a sound effect.

  - (int)pauseAudioEffectWithSoundId:(NSInteger)soundId;

  Parameters

  Name	Type	Description
  soundId	NSInteger	The ID assigned to the sound effect file by the user.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• pauseAllAudioEffects: Pauses all sound effects.

  - (int)pauseAllAudioEffects;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• resumeAudioEffectWithSoundId: Resumes playing a sound effect.

  - (int)resumeAudioEffectWithSoundId:(NSInteger)soundId;

  Parameters

  Name	Type	Description
  soundId	NSInteger	The ID assigned to the sound effect file by the user.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• resumeAllAudioEffects: Resumes playing all sound effects.

  - (int)resumeAllAudioEffects;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• enableEarBack: Enables in-ear monitoring (iOS only).

  - (int)enableEarBack:(BOOL)enable;

  Parameters

  Name	Type	Description
  enable	BOOL	`YES`: enables in-ear monitoring. `NO`: disables in-ear monitoring. The default value is `NO`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setEarBackVolume: Sets the in-ear monitoring volume (iOS only).

  - (int)setEarBackVolume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  volume	NSInteger	The range is [0, 100]. The default value is 100.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• registerVideoSampleObserver: Registers a video data observer.

  - (void)registerVideoSampleObserver;

• unRegisterVideoSampleObserver: Unregisters the video data observer.

  - (void)unregisterVideoSampleObserver;

• registerLocalVideoTexture: Registers an observer for local camera stream video OpenGL texture data (iOS only).

  - (void)registerLocalVideoTexture;

• unregisterLocalVideoTexture: Unregisters the observer for local camera stream video OpenGL texture data (iOS only).

  - (void)unregisterLocalVideoTexture;

• subscribeAudioData: Subscribes to audio data output.

  - (void)subscribeAudioData:(AliRtcAudioSource)audioSource;

  Parameters

  Name	Type	Description
  audioSource	AliRtcAudioSource	The data type.

• unSubscribeAudioData: Unsubscribes from audio data output.

  - (void)unSubscribeAudioData:(AliRtcAudioSource)audioSource;

  Parameters

  Name	Type	Description
  audioSource	AliRtcAudioSource	The data type.

• setSubscribeAudioNumChannel: Sets the number of output audio channels (not supported for pre-mixing data).

  - (void)setSubscribeAudioNumChannel:(AliRtcAudioNumChannel)audioNumChannel;

  Parameters

  Name	Type	Description
  audioNumChannel	AliRtcAudioNumChannel	The number of sound channels. The default is mono.

• setSubscribeAudioSampleRate: Sets the output audio sample rate (not supported for pre-mixing data).

  - (void)setSubscribeAudioSampleRate:(AliRtcAudioSampleRate)audioSampleRate;

  Parameters

  Name	Type	Description
  audioSampleRate	AliRtcAudioSampleRate	The sample rate. The default is 44.1 kHz.

• setExternalVideoSource: Enables an external video input source.

  - (int)setExternalVideoSource:(BOOL)enable sourceType:(AliRtcVideoSource)type renderMode:(AliRtcRenderMode)renderMode;

  Parameters

  Name	Type	Description
  enable	BOOL	`YES`: enables the feature. `NO`: disables the feature.
  type	AliRtcVideoSource	The stream type.
  renderMode	AliRtcRenderMode	The rendering mode.

• pushExternalVideoFrame: Inputs video data.

  - (int)pushExternalVideoFrame:(AliRtcVideoDataSample *_Nonnull)frame sourceType:(AliRtcVideoSource)type;

  Parameters

  Name	Type	Description
  frame	AliRtcVideoDataSample *_Nonnull	The frame data.
  type	AliRtcVideoSource	The stream type.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setExternalAudioSource: Sets whether to enable an external audio input source.

  - (int)setExternalAudioSource:(BOOL)enable withSampleRate:(NSUInteger)sampleRate channelsPerFrame:(NSUInteger)channelsPerFrame;

  Parameters

  Name	Type	Description
  enable	BOOL	`YES`: enables the feature. `NO`: disables the feature. The default value is `NO`.
  sampleRate	NSUInteger	The sample rate, such as 16000 Hz or 48000 Hz.
  channelsPerFrame	NSUInteger	The number of sound channels, such as 1 or 2.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• pushExternalAudioFrameRawData: Inputs audio data.

  - (int)pushExternalAudioFrameRawData:(void *_Nonnull)data samples:(NSUInteger)samples timestamp:(NSTimeInterval)timestamp;

  Parameters

  Name	Type	Description
  data	void *_Nonnull	The audio data. We recommend not exceeding 40 ms of data.
  samples	NSUInteger	The sample rate, such as 16 kHz or 48 kHz.
  timestamp	NSTimeInterval	The timestamp.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setExternalAudioVolume: Sets the audio mixing volume.

  - (int)setExternalAudioVolume:(int)vol;

  Parameters

  Name	Type	Description
  vol	int	The audio mixing volume. The range is [1, 100]. The default value is 50.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getExternalAudioVolume: Retrieves the audio mixing volume.

  - (int)getExternalAudioVolume;

  Return value

  Returns the current audio mixing volume.

• setMixedWithMic: Sets whether to mix with the audio captured by the microphone.

  - (int)setMixedWithMic:(BOOL)mixed;

  Parameters

  Name	Type	Description
  mixed	BOOL	`YES`: mixes the audio. `NO`: completely replaces the microphone-captured data. The default value is `NO`.

  Return value

  Retrieves the current audio mixing volume.

• setExteranlAudioRender: Sets whether to enable playback of external audio input.

  - (int)setExteranlAudioRender:(BOOL)enable sampleRate:(NSUInteger)sampleRate channelsPerFrame:(NSUInteger)channelsPerFrame;

  Parameters

  Name	Type	Description
  enable	BOOL	`YES`: enables the feature. `NO`: disables the feature. The default value is `NO`.
  sampleRate	NSUInteger	The sample rate, such as 16 kHz or 48 kHz.
  channelsPerFrame	NSUInteger	The number of sound channels, such as 1 or 2.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• pushExternalAudioRenderRawData: Inputs external audio playback data.

  - (int)pushExternalAudioRenderRawData:(const void* _Nullable)audioSamples sampleLength:(NSUInteger)sampleLength sampleRate:(NSUInteger)sampleRate channelsPerFrame:(NSUInteger)channelsPerFrame timestamp:(long long)timestamp;

  Parameters

  Name	Type	Description
  audioSamples	constvoid* _Nullable	The audio data.
  sampleLength	NSUInteger	The length of the audio data.
  sampleRate	NSUInteger	The audio sample rate.
  channelsPerFrame	NSUInteger	The number of audio channels.
  timestamp	long long	The timestamp.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• startPublishLiveStreamWithURL: Starts bypass live streaming.

  - (int)startPublishLiveStreamWithURL:(NSString *_Nonnull)streamURL liveTranscoding:(AliRtcLiveTranscodingParam *_Nonnull)trancoding;

  Parameters

  Name	Type	Description
  streamUrl	NSString *	The ingest URL.
  transcoding	AliRtcLiveTranscodingParam *	The parameters required for stream ingest.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• updatePublishLiveStreamWithURL: Updates bypass live streaming parameters.

  - (int)updatePublishLiveStreamWithURL:(NSString *_Nonnull)streamURL liveTranscoding:(AliRtcLiveTranscodingParam *_Nonnull)trancoding;

  Parameters

  Name	Type	Description
  streamUrl	NSString *	The ingest URL.
  transcoding	AliRtcLiveTranscodingParam *	The parameters required for stream ingest.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• stopPublishLiveStreamWithURL: Stops bypass live streaming.

  - (int)stopPublishLiveStreamWithURL:(NSString *_Nonnull)streamURL;

  Parameters

  Name	Type	Description
  streamUrl	NSString *_Nonnull	The ingest URL.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• startChannelRelay: Starts cross-channel co-hosting.

  - (int)startChannelRelay:(AliRtcChannelRelayConfiguration *_Nonnull)configuration;

  Parameters

  Name	Type	Description
  configuration	AliRtcChannelRelayConfiguration *_Nonnull	The configuration information.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• updateChannelRelay: Updates cross-channel co-hosting.

  - (int)updateChannelRelay:(AliRtcChannelRelayConfiguration *_Nonnull)configuration;

  Parameters

  Name	Type	Description
  configuration	AliRtcChannelRelayConfiguration *_Nonnull	The configuration information.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• stopChannelRelay: Stops cross-channel co-hosting.

  - (int)stopChannelRelay;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• startPreview: Starts the local preview. This method automatically turns on the camera.

  - (int)startPreview;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note If no view is set, the preview cannot be started. You can start the preview before you call joinChannel.
• stopPreview: Stops the local preview.

  - (int)stopPreview;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note `leaveChannel` automatically stops the local preview and turns off the camera. If the camera stream is being published, the camera is not turned off.
• getOnlineRemoteUsers: Retrieves the list of online remote users.

  - (NSArray<NSString *> *_Nullable)getOnlineRemoteUsers;

  Return value

  Returns a list of user IDs.

• getUserInfo: Queries remote user information.

  - (NSDictionary *_Nullable)getUserInfo:(NSString *_Nonnull)uid;

  Parameters

  Name	Type	Description
  uid	NSString *_Nonnull	The ID of the target user to query.

  Return value

  Returns a dictionary. The keys are described as follows:

  Key	Meaning
  userID	The ID of the remote user.
  displayName	The name of the remote user.
  sessionID	The session ID of the remote user.
  isOnline	Whether the remote user is online.
  isCameraMirror	Whether the remote user has enabled camera stream mirroring.
  isScreenMirror	Whether the remote user has enabled screen stream mirroring.
  muteAudioPlaying	Whether the local user has muted this remote user.
  preferCameraMaster	Whether the remote user has prioritized the high-quality stream.
  hasCameraView	Whether the local user has set a view for this remote user's camera stream.
  hasScreenView	Whether the local user has set a view for this remote user's screen stream.
  hasAudio	Whether the remote user has published an audio stream.
  hasCameraMaster	Whether the remote user has published a high-quality camera stream.
  hasCameraSlave	Whether the remote user has published a low-quality camera stream.
  hasScreenSharing	Whether the remote user has published a screen stream.
  requestAudio	Whether the local user has requested this remote user's audio stream.
  requestCameraMaster	Whether the local user has requested this remote user's high-quality camera stream.
  requestCameraSlave	Whether the local user has requested this remote user's low-quality camera stream.
  requestScreenSharing	Whether the local user has requested this remote user's screen stream.
  subScribedAudio	Whether the local user has pulled this remote user's audio stream.
  subScribedCameraMaster	Whether the local user has pulled this remote user's high-quality camera stream.
  subScribedCamearSlave	Whether the local user has pulled this remote user's low-quality camera stream.
  subScribedScreenSharing	Whether the local user has pulled this remote user's screen stream.

• isUserOnline: Queries whether a user is online.

  - (BOOL)isUserOnline:(NSString *_Nonnull)uid;

  Parameters

  Name	Type	Description
  uid	NSString *_Nonnull	The user ID. A unique identifier assigned by the app server.

  Return value

  `YES`: online. `NO`: offline.

• getSdkVersion: Retrieves the SDK version number.

  + (NSString *_Nonnull)getSdkVersion;

  Return value

  Returns the SDK version number.

• getErrorDescription: Retrieves the description of an error code.

  + (NSString *_Nullable)getErrorDescription:(NSInteger)errCode;

  Parameters

  Name	Type	Description
  errorCode	NSInteger	The error code.

  Return value

  Returns the description string of the error code.

• setClientRole: Sets the user role.

  - (int)setClientRole:(AliRtcClientRole)role;

  Parameters

  Name	Type	Description
  role	AliRtcClientRole	The user role type. The default value is AliRtcClientRolelive (viewer role). This is effective only in non-communication modes.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getCurrentClientRole: Retrieves the user role (iOS only).

  - (AliRtcClientRole)getCurrentClientRole;

  Return value

  Returns the current user role.

• startLastmileDetect: Starts the network quality probe.

  - (int)startLastmileDetect;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note Call this method before you call joinChannel. The probe result is returned in the onLastmileDetectResultWithQuality callback.
• stopLastmileDetect: Stops the network quality probe.

  - (int)stopLastmileDetect;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• postFeedbackWithUid: Provides SDK feedback.

  - (void)postFeedbackWithUid:(NSString *_Nullable)uid channleId:(NSString *_Nullable)channelId description:(NSString *_Nonnull)description type:(AliRtcFeedbackType)type timeStamp:(NSTimeInterval)timeStamp;

  Parameters

  Name	Type	Description
  uid	NSString *_Nullable	The current UID (can be empty).
  channelId	NSString *_Nullable	The current channel ID (can be empty).
  description	NSString *_Nullable	The problem description (supports Chinese and English, cannot be empty).
  type	AliRtcFeedbackType	The problem type.
  timeStamp	NSTimeInterval	The timestamp when the problem occurred (Unix timestamp, can be an approximate time, does not need to be precise, can also be 0).

• sendMediaExtensionMsg: Sends media extension messages.

  - (int)sendMediaExtensionMsg:(NSData *_Nonnull)data repeatCount:(int)repeatCount;

  Parameters

  Name	Type	Description
  data	NSData *_Nonnull	The extension message.
  repeatCount	int	The number of repetitions.

  Return value
  • 0: Success.
  • -1: No stream is being published.
  • -2: Invalid parameter.
  • -3: The message is sent too frequently. We recommend that you try again later.
• startIntelligentDenoise: Starts intelligent noise reduction.

  - (int)startIntelligentDenoise;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note

  • This method can be used to enable the intelligent noise reduction feature during a call.
  • This feature is disabled by default. Enabling it may increase power consumption. Intelligent noise reduction is suitable for voice-centric scenarios, such as meetings and education, but not for scenarios with background music.
• stopIntelligentDenoise: Stops intelligent noise reduction.

  - (void)stopIntelligentDenoise;

  Note This method can be used to disable the intelligent noise reduction feature during a call.
• refreshAuthInfo: Refreshes the authentication information.

  - (int)refreshAuthInfo:(AliRtcAuthInfo *_Nonnull)authInfo;

  Parameters

  Name	Type	Description
  authInfo	AliRtcAuthInfo *_Nonnull	The authentication information.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getCurrentConnectionStatus: Retrieves the current network connection status.

  - (AliRtcConnectionStatus)getCurrentConnectionStatus;

  Return value

  Returns the current network connection status. For more information about the status, see AliRtcConnectionStatus.

• enableDelegateMainQueue: Specifies whether to dispatch callbacks to the main thread (iOS only).

  - (int)enableDelegateMainQueue:(BOOL)enable;

  Parameters

  Name	Type	Description
  enable	BOOL	`YES`: dispatches callbacks to the main thread queue. `NO`: does not dispatch callbacks to the main thread queue. The default value is `YES`.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• setDelegateQueue: Specifies the thread queue for callbacks (iOS only).

  - (int)setDelegateQueue:(NSOperationQueue *_Nullable)queue;

  Parameters

  Name	Type	Description
  queue	NSOperationQueue *_Nullable	The callback queue. The default is the main thread queue.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

  Note

  • If you call enableDelegateMainQueue:YES, this method setting is invalid, and callbacks are dispatched to the main thread.
  • If you call enableDelegateMainQueue:NO, you can use this method to specify the callback thread. If you do not set a thread, the SDK's default subthread is used.
• startScreenShareWithDesktopId: Starts screen sharing based on the desktop ID (Mac only).

  - (int)startScreenShareWithDesktopId:(int)desktopId config:(AliRtcScreenShareConfig * _Nonnull)config;

  Parameters

  Name	Type	Description
  desktopId	int	The desktop ID, which can be obtained by calling the getScreenShareSourceInfoWithType method.
  config	AliRtcScreenShareConfig * _Nonnull	The screen sharing configuration.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• startScreenShareWithWindowId: Starts screen sharing based on the window ID (Mac only).

  - (int)startScreenShareWithWindowId:(int)windowId config:(AliRtcScreenShareConfig * _Nonnull)config;

  Parameters

  Name	Type	Description
  windowId	int	The window ID, which can be obtained by calling the getScreenShareSourceInfoWithType method.
  config	AliRtcScreenShareConfig * _Nonnull	The screen sharing configuration.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getScreenShareSourceInfoWithType: Retrieves the screen sharing source information (Mac only).

  - (NSArray<AliRtcScreenSourceInfo *> * _Nullable)getScreenShareSourceInfoWithType:(AliRtcScreenShareType)type;

  Parameters

  Name	Type	Description
  type	AliRtcScreenShareType	The screen sharing type.

  Return value

  Returns a list of AliRtcScreenSourceInfo objects that contain the screen sharing source information.

• updateScreenShareConfig: Updates the screen sharing configuration (Mac only).

  - (int)updateScreenShareConfig:(AliRtcScreenShareConfig * _Nonnull)config;

  Parameters

  Name	Type	Description
  config	AliRtcScreenShareConfig * _Nonnull	The screen sharing configuration.

  Return value

  Returns a list of screen sharing source information objects (AliRtcScreenSourceInfo).

• setRecordingDeviceVolume: Sets the audio capture device volume (Mac only).

  - (int)setRecordingDeviceVolume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  volume	NSInteger	The volume range is [0, 100]. The default value is the current microphone volume.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getRecordingDeviceVolume: Retrieves the audio capture device volume (Mac only).

  - (int)getRecordingDeviceVolume;

  Return value

  Returns the audio capture device volume. The value ranges from 0 to 100. A value of -1 indicates that the method call failed.

• setPlayoutDeviceVolume: Sets the audio playback device volume (Mac only).

  - (int)setPlayoutDeviceVolume:(NSInteger)volume;

  Parameters

  Name	Type	Description
  volume	NSInteger	The volume range is [0, 100]. The default value is the current speaker volume.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getPlayoutDeviceVolume: Retrieves the audio playback device volume (Mac only).

  - (int)getPlayoutDeviceVolume;

  Return value

  Returns the audio playback device volume. The value ranges from 0 to 100. A value of -1 indicates that the method call failed.

• setExternalAudioRenderVolume: Sets the playback volume of the external audio input (Mac only).

  - (int)setExternalAudioRenderVolume:(int)vol;

  Parameters

  Name	Type	Description
  vol	int	The volume range is [0, 100]. The default value is 50.

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• getExternalAudioRenderVolume: Retrieves the playback volume of the external audio input (Mac only).

  - (int)getExternalAudioRenderVolume;

  Return value

  Returns the audio playback volume. The value ranges from 0 to 100.

• getAudioCaptures: Retrieves a list of the recording devices in the system (Mac only).

  - (NSArray<AliRtcDeviceInfo *> *_Nullable)getAudioCaptures;

• getCurrentAudioCapture: Retrieves the name of the recording device in use (Mac only).

  - (NSString *_Nullable)getCurrentAudioCapture;

• getCurrentAudioCaptureID: Retrieves the ID of the recording device in use (Mac only).

  - (NSString *_Nullable)getCurrentAudioCaptureID;

• setCurrentAudioCapture: Sets the recording device by name (Mac only).

  - (void)setCurrentAudioCapture:(NSString *_Nonnull)capture;

  Parameters

  Name	Type	Description
  capture	NSString *_Nonnull	The name of the recording device to set.

• setCurrentAudioCaptureWithID: Sets the recording device by ID (Mac only).

  - (void)setCurrentAudioCaptureWithID:(NSString *_Nonnull)captureID;

  Parameters

  Name	Type	Description
  captureID	NSString *_Nonnull	The ID of the recording device to set.

• getAudioRenderers: Retrieves a list of the speakers in the system (Mac only).

  - (NSArray<AliRtcDeviceInfo *> *_Nullable)getAudioRenderers;

• getCurrentAudioRenderer: Retrieves the name of the speaker in use (Mac only).

  - (NSString *_Nullable)getCurrentAudioRenderer;

• getCurrentAudioRendererID: Retrieves the ID of the speaker in use (Mac only).

  - (NSString *_Nullable)getCurrentAudioRendererID;

• setCurrentAudioRenderer: Sets the speaker by name (Mac only).

  - (void)setCurrentAudioRenderer:(NSString *_Nonnull)renderer;

  Parameters

  Name	Type	Description
  renderer	NSString *_Nonnull	The name of the speaker device to set.

• setCurrentAudioRendererWithID: Sets the speaker by ID (Mac only).

  - (void)setCurrentAudioRendererWithID:(NSString *_Nonnull)rendererID;

  Parameters

  Name	Type	Description
  rendererID	NSString *_Nonnull	The ID of the speaker device to set.

• getCameraList: Retrieves the camera list (Mac only).

  - (NSArray<AliRtcDeviceInfo *> *_Nullable)getCameraList;

• getCurrentCamera: Retrieves the name of the camera in use (Mac only).

  - (NSString *_Nullable)getCurrentCamera;

• getCurrentCameraID: Retrieves the ID of the camera in use (Mac only).

  - (NSString *_Nullable)getCurrentCameraID;

• setCurrentCamera: Sets the camera by name (Mac only).

  - (void)setCurrentCamera:(NSString *_Nonnull)camera;

  Parameters

  Name	Type	Description
  camera	NSString *_Nonnull	The name of the camera device to set.

• setCurrentCameraWithID: Sets the camera by ID (Mac only).

  - (void)setCurrentCameraWithID:(NSString *_Nonnull)cameraID;

  Parameters

  Name	Type	Description
  cameraID	NSString *_Nonnull	The ID of the camera device to set.

• startTestAudioRecordWithName: Starts testing the audio capture device (Mac only).

  - (int)startTestAudioRecordWithName:(NSString *_Nonnull)deviceName;

  Parameters

  Name	Type	Description
  deviceName	NSString *_Nonnull	The audio capture device name.

• stopTestAudioRecord: Stops testing the audio capture device (Mac only).

  - (int)stopTestAudioRecord;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• startTestAudioPlayoutWithName: Starts testing the audio playback device (Mac only).

  - (int)startTestAudioPlayoutWithName:(NSString *_Nonnull)deviceName filePath:(NSString *_Nonnull)filePath loopCycles:(NSInteger)loopCycles;

  Parameters

  Name	Type	Description
  deviceName	NSString *_Nonnull	The audio playback device name.
  filePath	NSString *_Nonnull	The audio file path.
  loopCycles	NSInteger	The number of times to repeat playback. -1 means loop playback.

• stopTestAudioPlayout: Stops testing the audio playback device (Mac only).

  - (int)stopTestAudioPlayout;

  Return value

  A value of 0 indicates that the method call is successful. Other values indicate that the call failed.

• startRecord: Starts recording (Mac only).

  - (BOOL)startRecord:(NSString*_Nonnull)filePath recordLayout:(AliRtcRecordVideoLayout*_Nonnull)recordLayout;

  Parameters

  Name	Type	Description
  filePath	NSString*_Nonnull	The file path.
  recordLayout	AliRtcRecordVideoLayout*_Nonnull	The video window layout settings.

  Return value

  `YES` indicates that the method call is successful. `NO` indicates that the call failed.

• pauseRecord: Pauses recording (Mac only).

  - (BOOL)pauseRecord;

  Return value

  `YES` indicates that the method call is successful. `NO` indicates that the call failed.

• resumeRecord: Resumes recording (Mac only).

  - (BOOL)resumeRecord;

  Return value

  `YES` indicates that the method call is successful. `NO` indicates that the call failed.

• UpdateRecordLayout: Updates recording information (Mac only).

  - (BOOL)UpdateRecordLayout:(AliRtcRecordVideoLayout*_Nonnull)layout;

  Parameters

  Name	Type	Description
  layout	AliRtcRecordVideoLayout*_Nonnull	The video window layout settings.

  Return value

  `YES` indicates that the method call is successful. `NO` indicates that the call failed.

• addRecordTemplate: Adds a recording template (Mac only).

  - (BOOL)addRecordTemplate:(AliRtcRecordTemplate*_Nonnull)recordTemplate;

  Parameters

  Name	Type	Description
  recordTemplate	AliRtcRecordTemplate*_Nonnull	The recording template.

  Return value

  `YES` indicates that the method call is successful. `NO` indicates that the call failed.

• getClientRole: Retrieves the user role (Mac only).

  - (AliRtcClientRole)getClientRole;

  Return value

  Returns the current user role.

• showDebugView: Displays the dashboard.

  - (int)showDebugView:(UITextView * _Nonnull)view showType:(AliRtcShowDebugViewType)showType userId:(NSString * _Nullable)userId;

  Parameters

  Parameter	Type	Description
  view	UITextView *	The view to display externally.
  showType	AliRtcShowDebugViewType	The display type. Valid values: 0 (default): Do not show. 1: Audio. 2: Video. 3: Network. 4: All. Note For non-public data, you can set a special value.
  userId	NSString *	The corresponding user data.

  Return value

  A value of 0 indicates that the method call is successful. A non-zero value indicates that the call failed.

• getVideoCaptureData: Retrieves captured video data.

  - (BOOL)getVideoCaptureData:(AliRtcVideoTrack)videoTrack videoSample:(AliRtcVideoDataSample**)p_sample;

  Parameters

  Parameter	Type	Description
  videoTrack	AliRtcVideoTrack	The video stream type.
  p_sample	AliRtcVideoDataSample **	The video sample.

  Return value

  `YES` indicates that the method call is successful. `NO` indicates that the call failed.

• getVideoPreEncoderData: Retrieves pre-encoding video data.

  - (BOOL)getVideoPreEncoderData:(AliRtcVideoTrack)videoTrack videoSample:(AliRtcVideoDataSample**)p_sample;

  Parameters

  Parameter	Type	Description
  videoTrack	AliRtcVideoTrack	The video stream type.
  p_sample	AliRtcVideoDataSample **	The video sample.

  Return value

  `YES` indicates that the method call is successful. `NO` indicates that the call failed.

• getVideoRenderData: Retrieves stream pulling data.

  - (BOOL)getVideoRenderData:(NSString*)uid videoTrack:(AliRtcVideoTrack)videoTrack videoSample:(AliRtcVideoDataSample**)p_sample;

  Parameters

  Parameter	Type	Description
  uid	NSString *	The remote user ID.
  videoTrack	AliRtcVideoTrack	The video stream type.
  p_sample	AliRtcVideoDataSample **	The video sample.

  Return value

  `YES` indicates that the method call is successful. `NO` indicates that the call failed.

• GetPublishLiveStreamStateWithURL: Retrieves the bypass live streaming status.

  - (AliRtcLiveTranscodingState)GetPublishLiveStreamStateWithURL:(NSString *_Nonnull)streamURL;

  Parameters

  Parameter	Type	Description
  streamURL	NSString *	The ingest URL.

  Return value

  Returns the bypass live streaming status.

• setRecordingDeviceMute: Mutes the audio capture device (Mac only).

  - (int)setRecordingDeviceMute:(BOOL)mute;

  Parameters

  Parameter	Type	Description
  mute	BOOL	Specifies whether to mute the device. Valid values: TRUE: Mutes the device. FALSE: The device is unmuted.

  Return value

  A value of 0 indicates that the method call is successful. A non-zero value indicates that the call failed.

• getRecordingDeviceMute: Retrieves the mute status of the audio capture device (Mac only).

  - (BOOL)getRecordingDeviceMute;

  Return value

  `YES` indicates that the method call is successful. `NO` indicates that the call failed.

• setPlaybackDeviceMute: Mutes the audio playback device (Mac only).

  - (int)setPlaybackDeviceMute:(BOOL)mute;

  Parameters

  Parameter	Type	Description
  mute	BOOL	Specifies whether to mute the device. Valid values: TRUE: Mutes the device. FALSE: The device is unmuted.

  Return value

  A value of 0 indicates that the method call is successful. A non-zero value indicates that the call failed.

• getPlaybackDeviceMute: Retrieves the mute status of the audio playback device (Mac only).

  - (BOOL)getPlaybackDeviceMute;

  Return value

  `YES` indicates that the method call is successful. `NO` indicates that the call failed.

• enableBackgroundExchange: Enables or disables the virtual background replacement feature (Mac only).

  - (int)enableBackgroundExchange:(BOOL)enable imagePath:(NSString *_Nonnull)path scalMode:(AliRtcBokehScaleModel)mode;

  Parameters

  Parameter	Type	Description
  enable	BOOL	Specifies whether to enable the background replacement feature. Valid values: YES: Enable. NO: Disable.
  path	NSString	The local image path. Supports JPG and PNG formats.
  mode	AliRtcBokehScaleModel	The background image scaling mode. Valid values: AliRtcBokehScaleModelCrop: Proportional clipping. AliRtcBokehScaleModelFill: Fill with black bars.

  Return value

  A value of 0 indicates that the method call is successful. A non-zero value indicates that the call failed.

• enableBackgroundBlur: Enables or disables the virtual background blur feature (Mac only).

  - (int)enableBackgroundBlur:(BOOL)enable blurDegree:(uint32_t)blurDegree;

  Parameters

  Parameter	Type	Description
  enable	BOOL	Specifies whether to enable the background blur feature. Valid values: YES: Enable. NO: Disable.
  blurDegree	uint32_t	The degree of blur. The range is [0, 100].

  Return value

  A value of 0 indicates that the method call is successful. A non-zero value indicates that the call failed.