AliRtcEngine API

Creates an AliRtcEngine instance.

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

Parameters

Parameter	Type	Description
delegate	id<AliRtcEngineDelegate>_Nullable	The delegate for receiving callbacks.
extras	NSString *_Nullable	A JSON string for configuring special SDK features. Pass an empty string ("") if no special features are required.

Releases the SDK instance.

+ (void)destroy;

Asynchronously destroys the engine.

+ (void)destroy:(id<AliRtcEngineDestroyDelegate>_Nullable)delegate;

Parameters

Parameter	Type	Description
delegate	id<AliRtcEngineDestroyDelegate> _Nullable	A delegate to receive the callback after the engine is destroyed.

Enables or disables H5 compatibility mode.

+ (void)setH5CompatibleMode:(BOOL)comp;

Parameters

Parameter	Type	Description
comp	BOOL	Set to YES to enable H5 compatibility mode. The default is NO.

Checks whether h5 compatible mode is enabled.

+ (BOOL)getH5CompatibleMode;

Return value

YES if h5 compatible mode is enabled; NO otherwise.

Sets the channel profile.

- (int)setChannelProfile:(AliRtcChannelProfile)profile;

Parameters

Parameter	Type	Description
profile	AliRtcChannelProfile	The channel profile. The default value is AliRtcCommunication. For RTC use cases, this parameter is typically set to AliRtcInteractivelive (interactive mode).

Returns

Returns 0 if the method call succeeds, or a non-zero value if it fails.

Call this method before you join a channel. You cannot change the profile while in a channel, but you can set it again after leaving the channel.

Sets the audio profile.

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

Parameters

Parameter	Type	Description
audio_profile	AliRtcAudioProfile	The audio profile for capturing or encoding audio. We recommend using the high-quality mode (AliRtcEngineHighQualityMode). Note For interoperability with the Web, the sample rate must be set to 48 kHz. AliRtcEngineLowQualityMode: The low-quality mode. Default: 8,000 Hz sample rate, mono, and a maximum encoding bitrate of 12 kbps. AliRtcEngineBasicQualityMode: The standard-quality mode. Default: 16,000 Hz sample rate, mono, and a maximum encoding bitrate of 24 kbps. AliRtcEngineHighQualityMode: The high-quality mode. Default: 48,000 Hz sample rate, mono, and a maximum encoding bitrate of 64 kbps. AliRtcEngineStereoHighQualityMode: The stereo high-quality mode. Default: 48,000 Hz sample rate, stereo, and a maximum encoding bitrate of 80 kbps. AliRtcEngineSuperHighQualityMode: The super-high-quality mode. Default: 48,000 Hz sample rate, mono, and a maximum encoding bitrate of 96 kbps. AliRtcEngineStereoSuperHighQualityMode: The stereo super-high-quality mode. Default: 48,000 Hz sample rate, stereo, and a maximum encoding bitrate of 128 kbps.
audio_scene	AliRtcAudioScenario	The audio scenario. Valid values: AliRtcSceneMusicMode (Recommended): The music scenario, which uses software 3A and captures audio from the mobile phone, providing higher audio quality. AliRtcSceneDefaultMode: The default scenario, which uses hardware 3A and allows capturing audio from a Bluetooth device. Note For ARTC SDK v6.21 and later, do not set the scenario to the chatroom scenario (AliRtcSceneChatroomMode).

Returns

A value of 0 indicates success; any other value indicates failure.

Checks if the current session is in audio-only mode.

- (BOOL)isAudioOnly;

Returns

YES if the session is in audio-only mode; NO if in audio and video mode.

Sets the session to audio-only mode or audio and video mode.

- (int)setAudioOnlyMode:(BOOL)audioOnly;

Parameters

Parameter	Type	Description
audioOnly	BOOL	Set to YES to enable audio-only mode for both stream publishing and stream subscribing. Set to NO to enable audio and video mode. The default is NO.

Returns

Returns 0 on success, or a non-zero error code if the call fails.

Joins a channel.

- (int)joinChannel:(NSString _Nonnull)token channelId:(NSString _Nullable)channelId userId:(NSString _Nullable)userId name:(NSString _Nullable)userName onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString _Nonnull channel, NSString _Nonnull userId, NSInteger elapsed))onResult;

After joining a channel, you must call leaveChannel before joining another. If a join attempt fails, you do not need to call leaveChannel before retrying.

Parameters

Parameter	Type	Description
token	String	The authentication token for joining the channel.
channelId	String	The ID of the channel to join. This value must match the channelId used to generate the token.
userId	String	The user ID. This value must match the userId used to generate the token.
userName	String	The user name to display. This is not the user ID.
onResultWithUserId	void(^_Nullable)(NSInteger errCode, NSString _Nonnull channel, NSString _Nonnull userId, NSInteger elapsed)	The callback invoked when the operation completes.

Returns

Returns 0 if the method call succeeds, or a non-zero value if it fails.

Joins a channel.

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

After joining a channel, you must call leaveChannel to exit before joining another. If a join attempt fails, you can retry without calling leaveChannel.

Parameters

Parameter	Type	Description
authInfo	AliRtcAuthInfo	Authentication information.
userName	String	The user's display name (not the user ID).
onResultWithUserId	void(^_Nullable)(NSInteger errCode, NSString _Nonnull channel, NSString _Nonnull userId, NSInteger elapsed)	The callback invoked when the API call is complete.

Joins a channel.

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

After joining a channel, you must call leaveChannel before joining another. If the join fails, you can retry without calling leaveChannel.

Parameters

Parameter	Type	Description
authInfo	AliRtcAuthInfo	Authentication credentials.
userName	String	The user's display name, not their user ID.
onResult	void(^_Nullable)(NSInteger errCode,NSString _Nonnull channel,NSInteger elapsed)	The callback invoked when the API call completes.

Joins a channel.

- (int)joinChannel:(NSString _Nonnull)token channelParam:(AliRtcChannelParam _Nonnull)channelParam onResultWithUserId:(void(^_Nullable)(NSInteger errCode, NSString _Nonnull channel, NSString _Nonnull userId, NSInteger elapsed))onResult;

After successfully joining a channel, you must call leaveChannel to leave it before joining another. If a join attempt fails, you do not need to call leaveChannel.

Parameters

Parameter	Type	Description
token	NSString	The authentication token. Obtain this from your app server.
channelParam	AliRtcChannelParam	The channel parameters.
onResult	void(^_Nullable)(NSInteger errCode,NSString _Nonnull channel,NSInteger elapsed)	The callback that is invoked when the API call is complete.

Leaves the channel.

- (int)leaveChannel;

Returns

Returns 0 on success, or a non-zero value if the method call fails.

Checks if the current user is in a channel.

- (BOOL)isInCall;

Return value

YES if in a channel; NO otherwise.

Sets the user role.

- (int)setClientRole:(AliRtcClientRole)role;

Parameters

Parameter	Type	Description
role	AliRtcClientRole	Specifies the user role. The default is AliRtcClientRoleLive (audience role). This setting applies only when the channel is not in communication mode.

Returns

Returns 0 on success or a non-zero value on failure.

Returns the client's role.

- (AliRtcClientRole)getClientRole;

Return value

The client's current role.

Refreshes the authentication information.

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

Parameters

Parameter	Type	Description
authInfo	AliRtcAuthInfo _Nonnull	The new authentication information.

Returns

0 on success; a non-zero value on failure.

Refreshes the authentication information.

- (int)refreshAuthInfoWithToken:(NSString _Nonnull)token;

Parameters

Parameter	Type	Description
token	NSString _Nonnull	The new authentication token.

Returns

0 indicates success, and any other value indicates failure.

Publishes or unpublishes the local audio stream.

- (int)publishLocalAudioStream:(BOOL)enabled;

Parameters

Parameter	Type	Description
enable	BOOL	Set to YES to publish the local audio stream, or NO to unpublish it. Defaults to YES.

Return value

Returns 0 on success, or a non-zero value on failure.

Checks if the local audio stream is published.

- (BOOL)isLocalAudioStreamPublished;

Returns

YES if the audio stream is published; NO otherwise.

Sets whether to subscribe to all remote audio streams by default.

- (int)setDefaultSubscribeAllRemoteAudioStreams:(BOOL)sub;

Parameters

Parameter	Type	Description
sub	BOOL	Specifies whether to subscribe to all remote audio streams by default. Set to YES to subscribe or NO to prevent automatic subscription. The default is YES.

Returns

0 if the method call is successful; a non-zero value if it fails.

Subscribes to or unsubscribes from all remote audio streams.

- (int)subscribeAllRemoteAudioStreams:(BOOL)sub;

Parameters

Parameter	Type	Description
sub	BOOL	Specifies whether to subscribe to all remote audio streams. The default is YES.

Return value

Returns 0 if the method call succeeds, or a non-zero value if it fails.

Subscribes to or unsubscribes from the audio stream of a remote user.

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

Parameters

Parameter	Type	Description
uid	NSString _Nonnull	The remote user ID.
sub	BOOL	Set to YES to subscribe to the user's audio stream (the default), or NO to unsubscribe.

Return value

Returns 0 on success or a non-zero value on failure.

Enables or disables publishing the local video stream.

- (int)publishLocalVideoStream:(BOOL)enabled;

Parameters

Parameter	Type	Description
enable	BOOL	Whether to publish the local video stream. YES to publish; NO to unpublish. Defaults to YES.

Returns

Returns 0 on success, or a non-zero value on failure.

Checks whether the local video stream is being published.

- (BOOL)isLocalVideoStreamPublished;

Returns

YES if the local video stream from the camera is being published; NO otherwise.

Sets whether to subscribe to all remote video streams by default.

- (int)setDefaultSubscribeAllRemoteVideoStreams:(BOOL)sub;

Parameters

Parameter	Type	Description
sub	BOOL	Set to YES to subscribe to remote video streams, or NO to not subscribe. The default value is YES.

Returns

Returns 0 on success and a non-zero value on failure.

Subscribes to or unsubscribes from all remote video streams.

- (int)subscribeAllRemoteVideoStreams:(BOOL)sub;

Parameters

Parameter	Type	Description
sub	BOOL	Specifies whether to subscribe to all remote video streams. Set this to YES to subscribe and NO to unsubscribe. The default is YES.

Returns

0 indicates a successful method call; a non-zero value indicates failure.

Subscribes to or unsubscribes from the media stream of a specified remote user.

- (int)subscribeRemoteMediaStream:(NSString _Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack subVideo:(BOOL)subVideo subAudio:(BOOL)subAudio;

Parameters

Parameter	Type	Description
uid	NSString	The remote user ID.
videoTrack	AliRtcVideoTrack	The video stream type.
subVideo	BOOL	Whether to subscribe to the remote user's video stream. true (default): Subscribes to the video stream. false: Unsubscribes from the video stream.
subAudio	BOOL	Whether to subscribe to the remote user's audio stream. true (default): Subscribes to the audio stream. false: Unsubscribes from the audio stream.

Returns

Returns 0 if the method call succeeds, or a non-zero value if it fails.

Subscribes to or unsubscribes from a specified remote user's media stream.

- (int)subscribeRemoteMediaStream:(NSString _Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack audioTrack:(AliRtcAudioTrack)audioTrack;

Parameters

Parameter	Type	Description
uid	NSString	The ID of the remote user.
videoTrack	AliRtcVideoTrack	The type of video track.
audioTrack	AliRtcAudioTrack	The type of audio track.

Returns

Returns 0 on success or a non-zero value on failure.

Subscribes to the stream of a specified user in another channel.

- (int)subscribeRemoteDestChannelStream:(NSString _Nonnull)channelId uid:(NSString _Nonnull)uid track:(AliRtcVideoTrack)track subAudio:(BOOL)subAudio sub:(BOOL)sub;

Parameters

Parameter	Type	Description
channelId	NSString	The remote channel ID.
uid	NSString	The remote user ID.
track	AliRtcVideoTrack	The video stream to subscribe to.
subAudio	BOOL	Controls the reception of the remote user's audio stream. true (default): Resumes receiving the audio stream. false: Stops receiving the audio stream.
sub	BOOL	Specifies whether to subscribe to or unsubscribe from the remote user's stream.

Returns

A return value of 0 indicates success. Any other value indicates failure.

Stops or resumes sending local audio data.

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

Parameters

Parameter	Type	Description
mute	BOOL	Set to YES to send null frames, or NO to resume normal sending. The default is NO.
mode	AliRtcMuteLocalAudioMode	Specifies the mute mode. The default is microphone mute mode.

Returns

Returns 0 if the method call is successful, and a non-zero value if it fails.

Mutes or unmutes the audio playback of a specified remote user.

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

Parameters

Parameter	Type	Description
uid	NSString _Nonnull	The user ID of the specified remote user.
mute	BOOL	Specifies whether to mute the audio playback. YES: Mute. NO: (Default) Unmute.

Return value

Returns 0 on success, or a non-zero value on failure.

Stops or resumes audio from all remote users.

- (int)muteAllRemoteAudioPlaying:(BOOL)mute;

Parameters

Parameter	Type	Description
mute	BOOL	YES stops playback; NO resumes playback. The default value is NO.

Returns

0 indicates success; any other value indicates failure.

Starts audio capture.

- (void)startAudioCapture;

Return value

A return value of 0 indicates success, while a non-zero value indicates failure.

Starts audio capture.

- (void)startAudioCapture:(BOOL)keepAlive;

Parameters

Parameter	Type	Description
keepAlive	BOOL	Specifies whether the capture device remains active after you leave the channel. true: The capture device remains active. false (default): The capture device is deactivated.

Returns

0: The method call was successful.
< 0: The method call failed.

Stops audio capture. This method is the counterpart to startAudioCapture.

- (void)stopAudioCapture;

Returns

Returns 0 on success or a non-zero value on failure.

Starts local audio and video recording.

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

Parameters

Parameter	Type	Description
recordType	AliRtcRecordType	The type of recording.
recordFormat	AliRtcRecordFormat	The format of the recording file.
filePath	NSString	The storage path for the recording file, including the file name.
audioConfig	AliRtcRecordAudioConfig	The audio configuration.
videoConfig	AliRtcRecordVideoConfig	The video configuration.

Return value

Returns TRUE if successful, or FALSE otherwise.

Stops the current recording.

- (void)stopRecord;

Returns

None.

Tests audio playback by playing an audio file from the specified path.

- (int)playAudioFileTest:(NSString _Nonnull)filePath;

Parameters

Parameter	Type	Description
filePath	NSString _Nonnull	The path to the audio file.

Return Value

Returns 0 on success and a non-zero value on failure.

Stops playing the current audio file.

- (int)stopAudioFileTest;

Return value

Returns 0 on success, or a non-zero error code on failure.

Enables or disables the audio volume indication and voice activity detection callbacks.

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

Parameters

Parameter	Type	Description
interval	NSInteger	The time interval, in milliseconds (ms). The minimum value is 10 ms. A value between 300 ms and 500 ms is recommended. Setting this parameter to 0 or less disables the callbacks.
smooth	NSInteger	The smoothing factor. The value ranges from 0 to 9. A higher value results in smoother but less responsive volume changes. The recommended value is 3.
reportVad	NSInteger	Specifies whether to enable voice activity detection. 1: Enables the feature, which reports the speaking status of each user via a callback. 0: Disables the feature.

Returns

0 indicates success; a non-zero value indicates failure.

Enables or disables the ear back function.

- (int)enableEarBack:(BOOL)enable;

Parameters

Parameter	Type	Description
enable	BOOL	Set to YES to enable ear back, or NO to disable it. The default is NO.

Returns

0 indicates success, and a non-zero value indicates failure.

Sets the in-ear monitoring volume.

- (int)setEarBackVolume:(NSInteger)volume;

Parameter

Parameter	Type	Description
volume	NSInteger	The value ranges from 0 to 100, with a default of 100.

Returns

Returns 0 on success or a non-zero value on failure.

Sets the audio effect voice changer mode.

- (int)setAudioEffectVoiceChangerMode:(AliRtcAudioEffectVoiceChangerMode)mode;

Parameters

Parameter	Type	Description
mode	AliRtcAudioEffectVoiceChangerMode	Specifies the audio effect voice changer mode. The default value is AliRtcSdk_AudioEffect_Voice_Changer_OFF.

Returns

Returns 0 on success or a non-zero value on failure.

- (int)setAudioEffectPitchValue:(double)value;

Parameters

Parameter	Type	Description
value	double	The range is [0.5, 2.0]. The default value is 1.0 (no change in pitch).

Return Value

A return value of 0 indicates success; any other value indicates failure.

Sets the audio effect reverb mode.

- (int)setAudioEffectReverbMode:(AliRtcAudioEffectReverbMode)mode;

Parameters

Parameter	Type	Description
mode	AliRtcAudioEffectReverbMode	The audio effect mode. The default value is AliRtcAudioEffectReverb_Off.

Return value

Returns 0 for success, or a non-zero value for failure.

Sets the value of a specific reverb audio effect parameter.

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

Parameters

Parameter	Type	Description
type	AliRtcAudioEffectReverbParamType	The reverb mode.
value	float	The parameter value.

Returns

A value of 0 indicates success, and any other value indicates failure.

Registers an external audio input stream.

- (int)addExternalAudioStream:(AliRtcExternalAudioStreamConfig _Nonnull)config;

Parameters

Parameter	Type	Description
config	AliRtcExternalAudioStreamConfig	The external audio stream configuration.

Returns

Returns the external audio stream ID as a positive integer on success. A return value of 0 or less indicates failure.

- (int)pushExternalAudioStream:(int)streamId rawData:(AliRtcAudioFrame _Nonnull)audioFrame;

Parameters

Parameter	Type	Description
streamId	int	The external audio stream ID.
audioFrame	AliRtcAudioFrame	The audio data.

Returns

0 indicates success. Any other value indicates failure.

Sets the publishing volume for a specific external audio stream.

- (int)setExternalAudioStream:(int)streamId publishVolume:(int)publishVolume;

Parameters

Parameter	Type	Description
streamId	int	The external audio stream ID.
publishVolume	int	The publishing volume.

Return value

A return value of 0 indicates success. Any other value indicates failure.

Retrieves the publishing volume of a specified external audio stream.

- (int)getExternalAudioStreamPublishVolume:(int)streamId;

Parameters

Parameter	Type	Description
streamId	int	The ID of the external audio stream.

Return Value

The publishing volume, ranging from 0 to 100. A value less than 0 indicates that the method call failed.

Sets the local playout volume of a specified external audio stream.

- (int)setExternalAudioStream:(int)streamId playoutVolume:(int)playoutVolume;

Parameters

Parameter	Type	Description
streamId	int	The external audio stream ID.
playoutVolume	int	The playout volume.

Return value

0 indicates that the method call succeeded; any other value indicates failure.

Gets the local playout volume for a specified external audio stream.

- (int)getExternalAudioStreamPlayoutVolume:(int)streamId;

Parameters

Parameter	Type	Description
streamId	int	The ID of the external audio stream.

Returns

The playout volume, an integer from 0 to 100. A negative value indicates failure.

Preloads an audio effect file into memory.

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

Parameters

Parameter	Type	Description
soundId	NSInteger	The ID you assign to the audio effect file.
filePath	NSString _Nonnull	The path to the audio effect file.

Returns

Returns 0 on success or a non-zero value on failure.

Unloads a specified audio effect from memory.

- (int)unloadAudioEffectWithSoundId:(NSInteger)soundId;

Parameters

Parameter	Type	Description
soundId	NSInteger	The ID of the audio effect to unload.

Return value

Returns 0 on success or a non-zero value on failure.

Plays the audio effect file with the specified ID.

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

Parameters

Parameter	Type	Description
soundId	NSInteger	The ID that you assign to the audio effect file.
filePath	NSString _Nonnull	The path to the audio effect file.
cycles	NSInteger	The number of times to play the audio effect. A value of -1 means the effect loops indefinitely.
publish	BOOL	Specifies whether to publish the audio effect.

Returns

Returns 0 on success, or a non-zero value on failure.

Stops playing the audio effect with the specified ID.

- (int)stopAudioEffectWithSoundId:(NSInteger)soundId;

Parameters

Parameter	Type	Description
soundId	NSInteger	The ID of the audio effect to stop.

Returns

Returns 0 on success and a non-zero value on failure.

Stops all audio effects.

- (int)stopAllAudioEffects;

Return value

Returns 0 on success. Any other value indicates failure.

Pauses the audio effect with the specified ID.

- (int)pauseAudioEffectWithSoundId:(NSInteger)soundId;

Parameters

Parameter	Type	Description
soundId	NSInteger	The ID you assign to the audio effect file.

Return value

0 indicates that the method call was successful; any other value indicates that it failed.

Pauses all playing audio effects.

- (int)pauseAllAudioEffects;

Returns

0 indicates success; a non-zero value indicates failure.

Resumes playing the specified audio effect.

- (int)resumeAudioEffectWithSoundId:(NSInteger)soundId;

Parameters

Parameter	Type	Description
soundId	NSInteger	The user-assigned ID of the audio effect.

Returns

Returns 0 on success, or a non-zero value on failure.

Resumes playback of all paused audio effects.

- (int)resumeAllAudioEffects;

Return value

Returns 0 on success. Any other value indicates failure.

Sets the mixing volume of a specified audio effect for the published stream.

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

Parameters

Parameter	Type	Description
soundId	NSInteger	The ID of the audio effect.
volume	NSInteger	The mixing volume. The value range is [0, 100]. The default value is 50.

Return value

Returns 0 on success, or a non-zero value on failure.

Gets the publish volume of a specific audio effect.

- (int)getAudioEffectPublishVolumeWithSoundId:(NSInteger)soundId;

Parameters

Parameter	Type	Description
soundId	NSInteger	The user-assigned ID for the audio effect.

Return Value

Returns 0 on success, or a non-zero value on failure.

Sets the publish volume for all audio effects.

- (int)setAllAudioEffectsPublishVolume:(NSInteger)volume;

Parameters

Parameter	Type	Description
volume	NSInteger	The publish volume. The value ranges from 0 to 100. The default value is 50.

Return value

Returns 0 for a successful method call and a non-zero value on failure.

Sets the local playout volume of a specified audio effect.

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

Parameters

Parameter	Type	Description
soundId	NSInteger	The ID of the audio effect.
volume	NSInteger	The local playout volume. Valid values: [0, 100]. Default: 50.

Returns

0: Success.
<0: Failure.

Gets the local playout volume for a specified audio effect.

- (int)getAudioEffectPlayoutVolumeWithSoundId:(NSInteger)soundId;

Parameters

Parameter	Type	Description
soundId	NSInteger	The ID of the audio effect file.

Return value

Returns the local playout volume (from 0 to 100) on success, or a negative value on failure.

Sets the local playout volume for all audio effects.

- (int)setAllAudioEffectsPlayoutVolume:(NSInteger)volume;

Parameters

Parameter	Type	Description
volume	NSInteger	The playout volume of all audio effects. Valid values: [0, 100]. Default value: 50.

Return value

Returns 0 on success, and a non-zero value on failure.

Sets the rendering window and rendering parameters for the local preview.

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

Parameters

Parameter	Type	Description
viewConfig	AliVideoCanvas _Nullable	The rendering parameters, including the rendering window and render mode.
track	AliRtcVideoTrack	Specifies the video track type.

Returns

Returns 0 on success, or a non-zero value on failure.

Sets the camera capture preferences.

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

Parameters

Parameter	Type	Description
config	AliRtcCameraCapturerConfiguration _Nonnull	The camera capture preferences. The default values are as follows: preference: 0 cameraDirection: 0 fps: 0 cameraCaptureProfile: 0 disableVideoCaptureReverse: -1 enableCameraMacroFocus: -1 captureObserverOriginal: -1 nativeBufferObserver: -1 captureCallbackCvpixelbufferToRaw: -1 A value of -1 indicates that the SDK's internal default settings are used.

Returns

Returns 0 on success, or a non-zero value on failure.

Enables or disables local video capture.

- (int)enableLocalVideo:(BOOL)enable;

Parameters

Parameter	Type	Description
enable	BOOL	Whether to enable local video capture.

Return value

Returns 0 on success, or a non-zero value on failure.

Stops or resumes sending local video data.

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

This method only controls whether to send black frames on a specified video stream. The local preview freezes on the last frame, but capture and data sending continue. To stop capture or video data transmission, use the AliRtcEngine API.

Parameters

Parameter	Type	Description
mute	BOOL	Specifies whether to send black frames. YES: Send black frames. NO: (Default) Resume sending normal local video data.
track	AliRtcVideoTrack	The video track whose publishing state you want to change.

Returns

Returns 0 on success and a non-zero value on failure.

Sets the render window and rendering parameters for a remote video stream.

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

You can call this method to switch the render window before or after calling other AliRtcEngine interface methods. If you set the canvas parameter or its view property to nil, the SDK stops rendering the corresponding stream. To change the render mode or mirror mode during playback, modify only the renderMode or mirrorMode property of the canvas object and keep all other properties unchanged.

Parameters

Parameter	Type	Description
canvas	AliVideoCanvas _Nullable	The video canvas, which includes the render window and render mode.
uid	NSString _Nonnull	The user ID.
track	AliRtcVideoTrack	The video track to configure.

Returns

A return value of 0 indicates a successful method call; any other value indicates a failure.

Checks whether the camera is on.

- (BOOL)isCameraOn;

Return value

Returns YES if the camera is on, or NO otherwise.

Sets the video encoder configuration.

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

Parameters

Parameter	Type	Description
config	AliRtcVideoEncoderConfiguration _Nonnull	The video encoder configuration. The default values are as follows: dimensions: [640,480] frameRate: 15 bitrate: 0 mirrorMode: 0 orientationMode: 0 rotation: 0 codecType: AliRtcVideoCodecTypeDefault encoderType: AliRtcVideoEncodeCodecTypeDefault seiForceFrontIFrame: -1 enableDynamicEncode: -1 disableDipenseResolutionChange: -1 enableDowngrade: -1 enableH264BFrame: -1 enableHevcBFrame: -1 backgroundHardwareToSoftware: -1 For the preceding parameters, a value of -1 indicates that the SDK's internal default setting will be used.

Sets the video decoder configuration.

- (void)setVideoDecoderConfiguration:(AliRtcVideoDecoderConfiguration _Nonnull)config;

Parameters

Parameter	Type	Description
config	AliRtcVideoDecoderConfiguration _Nonnull	The video decoder configuration. The default values are as follows: codecType: AliRtcVideoCodecTypeDefault enableDecoderBframe: -1 backgroundHardwareToSoftware: -1 The SDK uses its default settings for properties set to -1.

Starts the local preview and automatically turns on the camera.

- (int)startPreview;

You cannot start the local preview if a view has not been set. You can call this method before calling other AliRtcEngine methods.

Returns

Returns 0 on success and a non-zero value on failure.

Stops the local preview.

- (int)stopPreview;

Calling leaveChannel automatically stops the local preview and deactivates the camera. However, the camera remains active if you are currently publishing the camera stream.

Return value

Returns 0 on success, and a non-zero value otherwise.

Enables or disables an external video source.

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

Parameters

Parameter	Type	Description
enable	BOOL	Pass YES to enable the external video source, or NO to disable it.
type	AliRtcVideoSource	The stream type.
renderMode	AliRtcRenderMode	The render mode.

Pushes an external video frame to the SDK for encoding and transmission.

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

Parameters

Parameter	Type	Description
frame	AliRtcVideoDataSample _Nonnull	Specifies the frame data.
type	AliRtcVideoSource	Specifies the stream type.

Return value

Returns 0 on success; any other value indicates failure.

Starts sharing the screen of the specified desktop.

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

Parameters

Parameter	Type	Description
desktopId	int	The ID of the desktop to share.
config	AliRtcScreenShareConfig	Screen sharing configuration.

Return value

• 0 indicates success.

• A non-zero value indicates failure.

Shares the content of a window specified by its ID and publishes it as a video stream.

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

Parameters

Parameter	Type	Description
windowId	int	The window ID.
config	AliRtcScreenShareConfig	The screen sharing configuration.

Return value

• 0: Success.

• Non-zero: Failure.

Stops screen sharing.

- (int)stopScreenShare;

Parameters

None.

Returns

• 0: Success.

• A non-zero value: Failure.

Updates the screen share configuration.

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

Parameters

Parameter	Type	Description
config	AliRtcScreenShareConfig	The screen share configuration.

Returns

• 0: Success.

• Any other value: Failure.

Checks if screen share publishing is in progress.

- (BOOL)isScreenSharePublished;

Parameters

None.

Return value

• TRUE: Publishing is in progress.

• FALSE: Publishing is not in progress.

Starts CDN live streaming.

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

Parameters

Parameter	Type	Description
streamURL	NSString _Nonnull	The stream URL.
trancoding	AliRtcLiveTranscodingParam _Nonnull	The stream publishing parameters.

Return value

Returns 0 on success. Any other value indicates failure.

Updates live streaming parameters.

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

Parameters

Parameter	Type	Description
streamURL	NSString _Nonnull	The stream URL.
trancoding	AliRtcLiveTranscodingParam _Nonnull	Parameters for stream publishing.

Return value

Returns 0 on success, or a non-zero value on failure.

Stops CDN live streaming.

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

Parameters

Parameter	Type	Description
streamURL	NSString _Nonnull	The push URL.

Return value

A return value of 0 indicates success; any other value indicates failure.

Gets the state of the live stream transcoding.

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

Parameters

Parameter	Type	Description
streamURL	NSString _Nonnull	The publishing stream URL.

Returns

The current state of the live stream transcoding.

Starts a last-mile network quality probe.

- (int)startLastmileDetect:(AliRtcNetworkQualityProbeConfig _Nonnull)config;

Parameters

Parameter	Type	Description
config	AliRtcNetworkQualityProbeConfig _Nonnull	The probe configuration.

Return value

Returns 0 on success, a non-zero value otherwise.

Stops last-mile network detection.

- (int)stopLastmileDetect;

Return value

Returns 0 on success or a non-zero value on failure.

Sets a custom parameter.

- (int)setParameter:(NSString _Nonnull)param;

Parameters

Parameter	Type	Description
param	NSString _Nonnull	The custom parameter to set.

Gets a custom parameter.

- (NSString _Nonnull)getParameter:(NSString _Nonnull)param;

Parameters

Parameter	Type	Description
param	NSString _Nonnull	The custom parameter to retrieve.

Configures the audio callback parameters.

- (int)enableAudioFrameObserver:(bool)enable audioSource: (AliRtcAudioSource)audioSource config:(AliRtcAudioFrameObserverConfig_Nullable)config;

Parameters

Parameter	Type	Description
enable	bool	Whether to enable the data callback.
audioSource	AliRtcAudioSource	Specifies the type of audio source for the callback.
config	AliRtcAudioFrameObserverConfig _Nullable	Specifies the callback configuration.

Registers an audio frame observer.

- (int)registerAudioFrameObserver:(id<AliRtcAudioFrameDelegate> _Nullable)observer;

Parameters

Parameter	Type	Description
observer	id<AliRtcAudioFrameDelegate> _Nullable	The audio frame observer.

Registers a callback for video data output.

- (void)registerVideoSampleObserver;

Unregisters the video sample observer.

- (void)unregisterVideoSampleObserver;

Sets the storage path for SDK log files.

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

Parameters

Parameter	Type	Description
logDirPath	NSString _Nullable	The absolute path of the log storage directory. The default storage path is Library/Caches/Ali_RTC_Log on iOS and /Users/xxx/Documents/Ali_RTC_Log on macOS.

Sets the log level.

- (void)setLogLevel:(AliRtcLogLevel)logLevel;

Parameters

Parameter	Type	Description
logLevel	AliRtcLogLevel	The log level. The default is AliRtcLogLevelInfo.

Sets the video mirror mode.

- (int)setVideoMirrorMode:(AliRtcVideoPipelineMirrorMode)mirrorMode;

Parameters

Parameter	Type	Description
mirrorMode	AliRtcVideoPipelineMirrorMode	The mirror type.

Return value

Returns 0 on success, or a non-zero value on failure.

Sets the capture pipeline scale mode.

- (void)setCapturePipelineScaleMode:(AliRtcCapturePipelineScaleMode)mode;

Parameters

Parameter	Type	Description
mode	AliRtcCapturePipelineScaleMode	Specifies the scale mode for the capture pipeline.

Returns

Returns 0 on success, or a non-zero value on failure.

Gets the SDK version.

+ (NSString _Nonnull)getSdkVersion;

Returns

A string representing the current SDK version (e.g., "2.5.0.x"). This is a static method and can be called at any time.

Sets the encoder configuration for screen sharing.

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

Parameters

Parameter	Type	Description
config	AliRtcScreenShareEncoderConfiguration _Nonnull	The encoder configuration for the screen stream. It specifies parameters such as resolution, frame rate, bitrate, and video orientation. All these parameters have valid ranges.

Sets the playback volume of the remote audio.

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

Parameters

Parameter	Type	Description
uid	NSString _Nonnull	The unique identifier of the remote user, assigned by your application server.
volume	NSInteger	The playback volume. The value ranges from 0 (mute) to 100 (original volume).

Returns

A return value of 0 indicates a successful method call; any other value indicates failure.

Subscribes to or unsubscribes from the video stream of a specified remote user.

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

Parameters

Parameter	Type	Description
uid	NSString _Nonnull	The user ID, a unique identifier assigned by your app server.
track	AliRtcVideoTrack	The video stream type.
sub	BOOL	Set to YES to subscribe or NO to unsubscribe.

Returns

Returns 0 on success or a non-zero value on failure.

Subscribes to or unsubscribes from the stream of a specified user in the destination channel.

- (int)subscribeRemoteDestChannelStream:(NSString _Nonnull)channelId uid:(NSString _Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack audioTrack:(AliRtcAudioTrack)audioTrack sub:(BOOL)sub;

Parameters

Parameter	Type	Description
channelId	NSString _Nonnull	The destination channel.
uid	NSString _Nonnull	The unique user ID assigned by your app server.
videoTrack	AliRtcVideoTrack	The type of video track to subscribe to.
audioTrack	AliRtcAudioTrack	The type of audio track to subscribe to.
sub	BOOL	Set to true to subscribe to the stream, or false to unsubscribe.

Returns

Returns 0 on success, or a non-zero value on failure.

Subscribes to all user streams in the destination channel.

- (int)subscribeRemoteDestChannelAllStream:(NSString _Nonnull)channelId track:(AliRtcVideoTrack)track subAudio:(BOOL)subAudio sub:(BOOL)sub;

Parameters

Parameter	Type	Description
channelId	NSString _Nonnull	The ID of the destination channel.
track	AliRtcVideoTrack	The video track type.
subAudio	BOOL	Specifies whether to subscribe to the audio streams.
sub	BOOL	Specifies whether to subscribe to the video streams.

Returns

Returns 0 on success, or a non-zero value on failure.

Sets the recording volume.

- (int)setRecordingVolume:(NSInteger)volume;

Parameters

Parameter	Type	Description
volume	NSInteger	Value range: [0, 400]. The range [0, 100] represents the original volume, while the range [100, 400] is for volume amplification.

Return value

Returns 0 on success or a non-zero value on failure.

Sets the playout volume.

- (int)setPlayoutVolume:(NSInteger)volume;

Parameters

Parameter	Type	Description
volume	NSInteger	The playout volume. The value range is from 0 to 400. A value of 100 represents the original volume, and values above 100 amplify the volume.

Returns

Returns 0 on success, or a non-zero value on failure.

Starts a pre-call test of the audio capture device.

- (int)startAudioCaptureTest;

Stops the pre-call audio capture device test.

- (int)stopAudioCaptureTest;

Retrieves audio file information.

- (int)getAudioFileInfo:(NSString *_Nonnull)filePath;

Parameters

Parameter	Type	Description
filePath	NSString *	The path to the audio file.

Starts audio mixing.

- (int)startAudioAccompanyWithFile:(NSString *_Nonnull)filePath config:(AliRtcAudioAccompanyConfig *_Nonnull)config;

Parameters

Parameter	Type	Description
filePath	NSString *	The audio file path.
config	AliRtcAudioAccompanyConfig *	The audio mixing configuration.

Returns

0 indicates the method call was successful; a non-zero value indicates failure.

Stops audio accompaniment mixing.

- (int)stopAudioAccompany;

return value

0 indicates a successful call; any other value indicates failure.

Sets the accompaniment volume.

- (int)setAudioAccompanyVolume:(NSInteger)volume;

Parameters

Parameter	Type	Description
volume	NSInteger	The accompaniment volume. The value must be an integer between 0 and 100, inclusive.

Returns

Returns 0 if the method call succeeds, or a non-zero value if it fails.

Sets the volume of the audio accompaniment for publishing.

- (int)setAudioAccompanyPublishVolume:(NSInteger)volume;

Parameters

Parameter	Type	Description
volume	NSInteger	Audio accompaniment volume. Range: [0, 100].

Returns

Returns 0 on success or a non-zero value on failure.

Gets the audio accompaniment publish volume.

- (int)getAudioAccompanyPublishVolume;

Returns

A value in the range of [0, 100] is returned on success. Other values indicate failure.

Sets the audio accompaniment's local playback volume.

- (int)setAudioAccompanyPlayoutVolume:(NSInteger)volume;

Parameters

Parameter	Type	Description
volume	NSInteger	The volume of the audio accompaniment, in the range [0, 100].

Returns

Returns 0 on success, or a non-zero value on failure.

Gets the audio accompaniment playback volume.

- (int)getAudioAccompanyPlayoutVolume;

Return value

A value from 0 to 100 is returned on success; any other value indicates failure.

Pauses the audio accompaniment.

- (int)pauseAudioAccompany;

Return value

Returns 0 on success, or a non-zero value on failure.

Resumes the audio accompaniment.

- (int)resumeAudioAccompany;

Returns

0 indicates success, and a non-zero value indicates failure.

Returns the duration of the accompaniment file in milliseconds.

- (int)getAudioAccompanyDuration;

Return value

The duration of the accompaniment file in milliseconds. A negative value indicates failure.

Returns the current position of the audio accompaniment file in ms.

- (int)getAudioAccompanyCurrentPosition;

Return value

>=0: The current position; <0: Failure.

Sets the playback position of the accompaniment file.

- (int)setAudioAccompanyPosition:(int)pos;

Parameters

Parameter	Type	Description
pos	int	The playback position in milliseconds.

Returns

0 on success, or a non-zero value on failure.

Sets the in-ear monitoring volume.

- (int)setEarBackVolume:(NSInteger)volume;

Parameters

Parameter	Type	Description
volume	NSInteger	The volume level, ranging from 0 to 100. The default is 100.

Returns

Returns 0 if the method call succeeds, or a non-zero value if it fails.

Captures a video snapshot.

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

Parameters

Parameter	Type	Description
userId	NSString *	The ID of the user for whom to capture the snapshot. To capture a snapshot of the local user, set this parameter to nil or an empty string.
type	AliRtcVideoTrack	The type of the video stream to capture. Only AliRtcVideoTrackCamera and AliRtcVideoTrackScreen are supported.

Return value

Returns 0 if the call succeeds, or a non-zero value if it fails.

Sends a media extension message.

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

Parameters

Parameter	Type	Description
data	NSData *	The content of the media extension message. The maximum size is 4 KB.
repeatCount	int	The number of times the message is repeated. This setting controls message redundancy to mitigate packet loss. A value of -1 means the message is sent indefinitely until sendMediaExtensionMsg is called again.
delay	int	The delay in milliseconds (ms) before sending the SEI message. Because the SDK attaches the SEI message to the H.264/H.265 encoded stream, the actual delay may be slightly longer than this value.
isKeyFrame	bool	Specifies whether to attach the SEI message only to key frames.

Return value

Returns 0 on success, or a non-zero error code on failure.

Sends a media extension message. This method uses SEI.

- (int)sendMediaExtensionMsgEx:(NSData *_Nonnull)data repeatCount:(int)repeatCount delay:(int)delay isKeyFrame:(bool)isKeyFrame payloadType:(int)payloadType;

Parameters

Parameter	Type	Description
data	NSData *	The media extension message payload. The maximum size is 4 KB.
repeatCount	int	The number of times to repeat the message. This value specifies the message redundancy to prevent message loss due to network packet loss. A value of -1 repeats the message until sendMediaExtensionMsgEx is called again.
delay	int	The delay in milliseconds (ms) before sending the SEI message. The actual delay may be slightly longer than the specified value because the SEI message is attached to the encoded H.264/H.265 stream.
isKeyFrame	bool	Set to true to attach the SEI message only to keyframes.
payloadType	int	The payload type. Use 5 for payloads that include a UUID. The valid range is [5, 100..254].

Return value

Returns 0 on success, or a non-zero error code on failure.

Starts audio playback.

- (void)startAudioPlayer;

Stops audio playback.

- (void)stopAudioPlayer;

Removes an external audio stream.

- (int)removeExternalAudioStream:(int)streamId;

Parameters

Parameter	Type	Description
streamId	int	The external audio stream ID.

Return value

Returns 0 on success or a non-zero value on failure.

Returns the current time of the timeline.

-(long long)getNetworkTime;

Parameters

Parameter

Type

Description

Returns

The timeline's current timestamp.

Sends a data channel message.

-(int) sendDataChannelMessage:(AliRtcDataChannelMsg* _Nonnull)controlMsg;

The ARTC SDK enables you to send and receive custom messages through a dedicated data channel. You can call this method to transmit real-time data, such as control commands, state synchronization information, or other business messages, alongside audio and video streams. For more details, see Send and receive custom messages.

Related callbacks

• After the sender enables the data channel, they can call this method to send a custom message. The receiver receives the custom message through the onDataChannelMessage callback.

Usage limits

• Users with the broadcaster role can send and receive messages. Users with the audience role can only receive messages.

• You must call setParameter to enable the data channel.

• The following data sending limits apply:

  • The maximum bitrate is 30 KB/s.

  • The data channel is limited to 60 data packets per second, and each packet can be up to 1 KB.

Parameters

Parameter	Type	Description
controlMsg	AliRtcDataChannelMsg *	The control message.

Returns

Returns 0 for success and a non-zero value for failure.

Sets the device orientation.

- (int)setDeviceOrientationMode:(AliRtcOrientationMode)mode;

Parameters

Parameter	Type	Description
mode	AliRtcOrientationMode	The device orientation.

Return value

Returns 0 for success, or a non-zero value for failure.

Registers a video frame observer.

- (void)registerVideoFrameWithObserver:(id<AliRtcVideoFrameDelegate> _Nullable)observer;

Parameters

Parameter	Type	Description
observer	AliRtcVideoFrameDelegate	The video frame observer object.

Unregisters a video frame observer.

- (void)unregisterVideoSampleWithObserver:(id<AliRtcVideoFrameDelegate> _Nullable)observer;

Parameters

Parameter	Type	Description
observer	AliRtcVideoFrameDelegate	The video frame observer to unregister.

Triggered when the connection status changes.

- (void)onConnectionStatusChange:(AliRtcConnectionStatus)status reason:(AliRtcConnectionStatusChangeReason)reason;

Parameters

Parameter	Type	Description
status	AliRtcConnectionStatus	The current connection status.
reason	AliRtcConnectionStatusChangeReason	The reason for the status change.

A callback that triggers when an exception occurs on a local device. You should handle this callback.

- (void)onLocalDeviceException:(AliRtcLocalDeviceType)deviceType exceptionType:(AliRtcLocalDeviceExceptionType)exceptionType message:(NSString *_Nullable)msg;

Parameters

Parameter	Type	Description
deviceType	AliRtcLocalDeviceType	The device type.
exceptionType	AliRtcLocalDeviceExceptionType	The device exception type.
msg	NSString *	Information about the exception.

This required callback notifies you that your authentication information will expire in 30 seconds.

- (void)onAuthInfoWillExpire;

Occurs when a user calls an interface that requires authentication, and the server responds that the authentication information has expired.

- (void)onAuthInfoExpired;

Reports the result of joining a channel. This callback and the block in the joinChannel method serve the same purpose, so you only need to handle one.

- (void)onJoinChannelResult:(int)result channel:(NSString *_Nonnull)channel userId:(NSString *_Nonnull)userId elapsed:(int) elapsed;

Parameters

Parameter	Type	Description
result	int	A value of 0 indicates success, while any non-zero value is an error code.
channel	NSString *	The channel ID.
userId	NSString *	The user ID.
elapsed	int	The time elapsed, in milliseconds, from calling the joinChannel method until this callback is triggered.

Reports the result of joining a channel. This callback is equivalent to the completion block for the joinChannel method, so you only need to implement one of them.

- (void)onJoinChannelResult:(int)result channel:(NSString *_Nonnull)channel elapsed:(int) elapsed;

Parameters

Parameter	Type	Description
result	int	The result of joining the channel. A value of 0 indicates success, and a non-zero value indicates an error code.
channel	NSString *	The ID of the joined channel.
elapsed	int	The time elapsed (in milliseconds) to join the channel.

Reports the result of leaving a channel. This callback occurs after you call the leaveChannel method. If you call the destroy method immediately after leaveChannel, this callback is not triggered.

- (void)onLeaveChannelResult:(int)result stats:(AliRtcStats)stats;

Parameters

Parameter	Type	Description
result	int	The result of leaving the channel. 0: success. A non-zero value: an error code.
stats	AliRtcStats	Session statistics.

Triggered when a remote user goes offline.

- (void)onRemoteUserOffLineNotify:(NSString *_Nonnull)uid offlineReason:(AliRtcUserOfflineReason)reason;

Parameters

Parameter	Type	Description
uid	NSString *	The unique user ID assigned by your app server.
reason	AliRtcUserOfflineReason	The reason the remote user goes offline.

Occurs when a remote user joins the channel.

- (void)onRemoteUserOnLineNotify:(NSString *_Nonnull)uid elapsed:(int)elapsed;

Parameters

Parameter	Type	Description
uid	NSString *	The user ID, a unique identifier assigned by your app server.
elapsed	int	The time it took the remote user to join the channel.

Triggered when a remote user's track becomes available or unavailable.

- (void)onRemoteTrackAvailableNotify:(NSString *_Nonnull)uid audioTrack:(AliRtcAudioTrack)audioTrack videoTrack:(AliRtcVideoTrack)videoTrack;

Parameters

Parameter	Type	Description
uid	NSString *	The unique user ID assigned by your app server.
audioTrack	AliRtcAudioTrack	The remote user's updated audio track.
videoTrack	AliRtcVideoTrack	The remote user's updated video track.

Triggered when the server removes you from the channel or the channel closes.

- (void)onBye:(int)code;

Parameters

Parameter	Type	Description
code	int	Indicates the reason for the disconnection. Valid values: 1: You were removed by the server. 2: The channel was closed. 3: You logged in on another device with the same user ID.

Called when the audio publishing state changes.

- (void)onAudioPublishStateChanged:(AliRtcPublishState)oldState newState:(AliRtcPublishState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

Parameter	Type	Description
oldState	AliRtcPublishState	The previous audio publishing state.
newState	AliRtcPublishState	The current audio publishing state.
elapseSinceLastState	NSInteger	The time interval since the last state change, in milliseconds.
channel	NSString *	The current channel ID.

Called when the audio subscription state changes.

- (void)onAudioSubscribeStateChanged:(NSString *_Nonnull)uid oldState:(AliRtcSubscribeState)oldState newState:(AliRtcSubscribeState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

Parameter	Type	Description
uid	NSString *	The ID of the user whose subscription state changed.
oldState	AliRtcSubscribeState	The previous subscription state.
newState	AliRtcSubscribeState	The current subscription state.
elapseSinceLastState	NSInteger	The time elapsed since the last state change, in milliseconds.
channel	NSString *	The current channel ID.

Occurs when a remote user mutes or unmutes their audio.

- (void)onUserAudioMuted:(NSString *_Nonnull)uid audioMuted:(BOOL)isMute;

Parameters

Parameter	Type	Description
uid	NSString *	The user ID of the remote user.
isMute	BOOL	YES if the user's audio is muted; NO otherwise.

Occurs when a user's audio is interrupted. This typically happens when a system event, such as an incoming phone call, preempts the app's audio.

- (void)onUserAudioInterruptedBegin:(NSString *_Nonnull)uid;

Parameters

Parameter	Type	Description
uid	NSString *	The user ID of the interrupted user.

Triggered when a user's audio interruption ends.

- (void)onUserAudioInterruptedEnded:(NSString *_Nonnull)uid;

Parameters

Parameter	Type	Description
uid	NSString *	The ID of the user whose audio interruption ended.

Occurs when the video publishing state changes.

- (void)onVideoPublishStateChanged:(AliRtcPublishState)oldState newState:(AliRtcPublishState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

Parameter	Type	Description
oldState	AliRtcPublishState	The previous publish state.
newState	AliRtcPublishState	The current publish state.
elapseSinceLastState	NSInteger	The time elapsed since the last state change, in milliseconds.
channel	NSString *	The channel ID.

Occurs when the subscription state of a camera stream changes.

- (void)onVideoSubscribeStateChanged:(NSString *_Nonnull)uid oldState:(AliRtcSubscribeState)oldState newState:(AliRtcSubscribeState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

Parameter	Type	Description
uid	NSString *	The user ID of the stream publisher.
oldState	AliRtcSubscribeState	The previous subscription state.
newState	AliRtcSubscribeState	The current subscription state.
elapseSinceLastState	NSInteger	Time elapsed since the last state change, in milliseconds.
channel	NSString *	The channel ID.

Called when a user mutes or unmutes their video.

- (void)onUserVideoMuted:(NSString *_Nonnull)uid videoMuted:(BOOL)isMute;

Parameters

Parameter	Type	Description
uid	NSString *	The user ID of the user who muted or unmuted their video.
isMute	BOOL	YES means black frames are pushed; NO means a normal stream is pushed.

Occurs when a remote user enables or disables local video capture.

- (void)onUserVideoEnabled:(NSString *_Nullable)uid videoEnabled:(BOOL)isEnable;

Parameters

Parameter	Type	Description
uid	NSString *	The user ID of the remote user.
isEnable	BOOL	YES: Video capture is enabled. NO: Video capture is disabled.

Occurs when a remote user's application moves to the background.

- (void)onUserWillResignActive:(NSString *_Nonnull)uid;

Parameters

Parameter	Type	Description
uid	NSString *	The user ID of the remote user.

Occurs when a remote user's application returns to the foreground.

- (void)onUserWillBecomeActive:(NSString *_Nonnull)uid;

Parameters

Parameter	Type	Description
uid	NSString *	The ID of the user whose application returns to the foreground.

This callback reports real-time statistics every 2 seconds.

- (void)onRtcStats:(AliRtcStats)stats;

Parameters

Parameter	Type	Description
stats	AliRtcStats	The callback statistics.

Occurs when a local audio effect finishes playing.

- (void)onAudioEffectFinished:(int)soundId;

Parameters

Parameter	Type	Description
soundId	int	The ID of the audio effect that has finished playing.

Reports the audio volume, voice status, and UID of subscribed users.

- (void)onAudioVolumeCallback:(NSArray <AliRtcUserVolumeInfo *> *_Nullable)array totalVolume:(int)totalVolume;

Parameters

Parameter	Type	Description
array	NSArray <AliRtcUserVolumeInfo *> *	An array where each element specifies the UID, voice status, and audio volume of a user. A UID of 0 identifies the local speaker.
totalVolume	int	The total volume of all speakers after audio mixing. The value ranges from 0 to 255.

Reports the active speaker.

- (void)onActiveSpeaker:(NSString *_Nonnull)uid;

Parameters

Parameter	Type	Description
uid	NSString *	The user ID of the active speaker.

Reports a change in the live streaming state.

- (void)onPublishLiveStreamStateChanged:(NSString *_Nonnull)streamURL state:(AliRtcLiveTranscodingState)state errCode:(AliRtcTrascodingLiveStreamErrorCode)errCode;

Parameters

Parameter	Type	Description
streamURL	NSString *	The URL of the affected live stream.
state	AliRtcLiveTranscodingState	The new state of the live stream.
errCode	AliRtcTrascodingLiveStreamErrorCode	The associated error code.

Triggered when the state of a live streaming task changes.

- (void)onPublishTaskStateChanged:(NSString *_Nonnull)streamURL state:(AliRtcTrascodingLiveTaskStatus)state;

Parameters

Parameter	Type	Description
streamURL	NSString *	The stream URL.
state	AliRtcTrascodingLiveTaskStatus	The state of the live streaming task.

The SDK triggers this callback when the network quality changes.

- (void)onNetworkQualityChanged:(NSString *_Nonnull)uid upNetworkQuality:(AliRtcNetworkQuality)upQuality downNetworkQuality:(AliRtcNetworkQuality)downQuality;

Parameters

Parameter	Type	Description
uid	NSString *	The user ID. If this parameter is empty, the callback reports the network quality of the local user.
upQuality	AliRtcNetworkQuality	The uplink network quality.
downQuality	AliRtcNetworkQuality	The downlink network quality.

Reports the result of the last-mile network quality detection.

- (void)onLastmileDetectResultWithQuality:(AliRtcNetworkQuality)networkQuality;

Parameters

Parameter	Type	Description
networkQuality	AliRtcNetworkQuality	The detected last-mile network quality.

This callback reports the last-mile network quality probe result.

- (void)onLastmileDetectResultWithBandWidth:(int)code result:(AliRtcNetworkQualityProbeResult* _Nonnull)result;

Parameters

Parameter	Type	Description
code	int	The probe result code. 0: Success. -1: Failure caused by a poor network condition.
result	AliRtcNetworkQualityProbeResult *	The detailed network quality probe result.

Triggers when the audio publishing state changes.

- (void)onAudioPublishStateChanged:(AliRtcAudioTrack)track oldState:(AliRtcPublishState)oldState newState:(AliRtcPublishState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

Parameter	Type	Description
track	AliRtcAudioTrack	The track whose publish state changed.
oldState	AliRtcPublishState	The previous publish state.
newState	AliRtcPublishState	The current publish state.
elapseSinceLastState	NSInteger	The time elapsed since the last state change, in milliseconds.
channel	NSString *	The current channel ID.

Occurs when the publish state of the screen sharing stream changes.

- (void)onScreenSharePublishStateChanged:(AliRtcPublishState)oldState newState:(AliRtcPublishState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

Parameter	Type	Description
oldState	AliRtcPublishState	The previous publish state.
newState	AliRtcPublishState	The new publish state.
elapseSinceLastState	NSInteger	The time, in milliseconds, since the last state change.
channel	NSString *	The channel ID.

Occurs when the subscription state of an audio stream changes.

- (void)onAudioSubscribeStateChanged:(NSString *_Nonnull)uid track:(AliRtcAudioTrack)track oldState:(AliRtcSubscribeState)oldState newState:(AliRtcSubscribeState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

Parameter	Type	Description
uid	NSString *	The user ID.
track	AliRtcAudioTrack	The track whose subscription state changed.
oldState	AliRtcSubscribeState	The previous subscription state.
newState	AliRtcSubscribeState	The current subscription state.
elapseSinceLastState	NSInteger	The time elapsed since the last state change, in milliseconds.
channel	NSString *	The channel ID.

Occurs when the subscription state of a screen share stream changes.

- (void)onScreenShareSubscribeStateChanged:(NSString *_Nonnull)uid oldState:(AliRtcSubscribeState)oldState newState:(AliRtcSubscribeState)newState elapseSinceLastState:(NSInteger)elapseSinceLastState channel:(NSString *_Nonnull)channel;

Parameters

Parameter	Type	Description
uid	NSString *	The user ID.
oldState	AliRtcSubscribeState	The previous subscription state.
newState	AliRtcSubscribeState	The new subscription state.
elapseSinceLastState	NSInteger	Time elapsed since the last state change, in milliseconds.
channel	NSString *	The channel ID.

This callback fires when the user's role changes.

- (void)onUpdateRoleNotifyWithOldRole:(AliRtcClientRole)oldRole newRole:(AliRtcClientRole)newRole;

Parameters

Parameter	Type	Description
oldRole	AliRtcClientRole	The previous role.
newRole	AliRtcClientRole	The new role.

Called when an error occurs in the engine.

- (void)onOccurError:(int)error message:(NSString *_Nonnull)message;

Parameters

Parameter	Type	Description
error	int	The error code. For details, see {@link AliRtcErrorCode}.
message	NSString *	The error description.

Called when the first audio packet is sent.

- (void)onFirstAudioPacketSentWithTimecost:(AliRtcAudioTrack)track timeCost:(int)timeCost;

Parameters

Parameter	Type	Description
track	AliRtcAudioTrack	The audio track.
timeCost	int	The time elapsed to send the packet, in milliseconds (ms).

Triggered when the first video frame from a remote user is received.

- (void)onFirstVideoFrameReceivedWithUid:(NSString *_Nonnull)uid videoTrack:(AliRtcVideoTrack)videoTrack timeCost:(int)timeCost;

Parameters

Parameter	Type	Description
uid	NSString *	The user ID.
videoTrack	AliRtcVideoTrack	The video track.
timeCost	int	The time elapsed, in milliseconds.