Intelligent Media Services:AliRtcEngine class

Creates an AliRtcEngine instance using the singleton pattern.

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

When to call

You must call this method to create an AliRtcEngine instance before calling any other ARTC SDK APIs.

Call restrictions

• This method is a synchronous call and can only be invoked on the main thread.

• The SDK supports only one AliRtcEngine instance per application.

Related callbacks

After creating an engine instance, implement the callbacks in AliRtcEngineDelegate based on your business scenario. If the SDK encounters an exception during operation, it first attempts automatic recovery using an internal retry mechanism. For errors that cannot be resolved internally, the SDK notifies your application through predefined callback interfaces. The following are key callbacks that the SDK cannot handle and must be monitored and responded to by the application layer:

Parameter description

Destroys the AliRtcEngine instance.

+ (void)destroy;

Destroys the AliRtcEngine singleton object and releases all internal resources. After this call, you can no longer use other methods of AliRtcEngine or receive any callbacks. To use the engine again, you must call <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#2db21d4f16s77" id="96631a9306wq8">sharedInstance</a> to create a new instance.

Both this method and destroy[2/2] can destroy the engine instance. The difference is that destroy[2/2] lets you pass a listener object to monitor the completion of the destruction process.

When to call

Call this method when Real-Time Communication ends and you no longer need AliRtcEngine features to release the instance and reduce unnecessary resource usage.

Call restrictions

To avoid deadlocks, do not call this method within any SDK callbacks.

Destroys an AliRtcEngine instance.

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

This method destroys the AliRtcEngine singleton object. After you call this method, all internal resources are released, and you can no longer use other methods of AliRtcEngine or receive any callbacks. To use the engine again, you must create a new instance by calling <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#2db21d4f16s77" id="115fd691743nx">sharedInstance</a>.

When to call

Call this method to release the instance after completing Real-Time Communication.

Call restrictions

To avoid deadlocks, do not call this method within any SDK callbacks.

Parameter description

Specifies whether to enable H5 compatibility mode.

+ (void)setH5CompatibleMode:(BOOL)comp;

Parameter description

Checks whether H5 compatibility mode is enabled.

+ (BOOL)getH5CompatibleMode;

Return description

YES indicates H5 compatibility is enabled. NO indicates it is disabled.

Gets the SDK version number.

+ (NSString *_Nonnull)getSdkVersion;

Return value

The current SDK version number in string format, such as "2.5.0.x".

Description

This is a static method and can be called at any time to retrieve the version number.

Sets the channel profile.

- (int)setChannelProfile:(AliRtcChannelProfile)profile;

This method sets the channel profile. It provides two main scenarios: video call and interactive stream.

• Video call profile: All users are streamers and can publish and subscribe to streams.

• Interactive live streaming mode: You must call <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#892915dd4edcy" id="d88dccff391by">setClientRole</a> to set the role. Users who ingest streams in the channel must set their role to streamer (AliRTCSdkInteractive). If a user only needs to pull streams and does not ingest streams, their role must be set to viewer (AliRTCSdkLive). This mode is recommended for RTC scenarios.

When to call

You can call this method only before joining a channel. You cannot change the profile while in the channel, but you can change it after leaving the channel.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the audio profile.

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

This method sets the audio encoding mode and audio scene mode. For more information, see Common audio operations and configurations. The ARTC SDK uses the high-quality mode (AliRtcEngineHighQualityMode) and music scene mode (AliRtcSceneMusicMode) by default. If the default settings do not meet your needs, call this method to configure them.

When to call

This method can only be called before joining a channel. It cannot be reconfigured after joining a channel, but it can be reconfigured after leaving the channel.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Checks whether the current mode is audio-only.

- (BOOL)isAudioOnly;

Return description

YES indicates audio-only mode. NO indicates audio and video mode.

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

- (int)setAudioOnlyMode:(BOOL)audioOnly;

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Joins a channel with a single parameter.

- (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;

This method joins a channel. ARTC organizes users by channels. Users must join a channel to publish or subscribe to audio and video streams. This method, along with joinChannel[2/3] and joinChannel[3/3], lets you join a channel. They differ in authentication method and user information passed:

• This method is for single-parameter entry. Pass the token generated for single-parameter entry using Token-based authentication to join the channel. We recommend this method for RTC scenarios.

• joinChannel[2/3] is for multi-parameter entry. It requires the token generated for multi-parameter entry using Token-based authentication, along with the user information used to generate the token.

• joinChannel[3/3] is for AI real-time interaction scenarios. Pass a single-parameter entry token and set the user attribute capabilityProfile based on the scenario.

When to call

Call this method after creating the engine.

Call restrictions

• After successfully joining a channel, to join another channel, you must first call <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="37299758eavvg">leaveChannel</a> to leave the current channel, and ensure you receive the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3721f1f2a3kpd" id="50039f328fdk7">onLeaveChannelResult</a> callback before calling this method again.

• This method supports joining only one channel at a time.

• Applications with different App IDs cannot communicate with each other.

• Do not call this method when retrying after a failed attempt to join a channel.

Related callbacks

After you successfully call this method, the following callbacks are triggered:

• The result of the local user joining the channel will be notified through the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#e6d2a213d7sl2" id="903005c54be4d">onJoinChannelResult</a> callback.

• After successfully joining the channel, the remote end will trigger the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#634626babfq9x" id="4b11b846b1f4t">onRemoteUserOnLineNotify</a> callback.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Joins a channel with multiple parameters.

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

This method joins a channel. ARTC organizes users by channels. Users must join a channel to publish or subscribe to audio and video streams. This method, along with joinChannel[1/3] and joinChannel[3/3], lets you join a channel. They differ in authentication method and user information passed:

• joinChannel[1/3] is for single-parameter entry. Pass the token generated for single-parameter entry using Token-based authentication to join the channel. We recommend this method for RTC scenarios.

• This method is for multi-parameter entry. It requires the token generated for multi-parameter entry using Token-based authentication, along with the user information used to generate the token.

• joinChannel[3/3] is for AI real-time interaction scenarios. Pass a single-parameter entry token and set the user attribute capabilityProfile based on the scenario.

Call restrictions

• After successfully joining a channel, you must first call <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="4283c6cc013bz">leaveChannel</a> to leave the current channel before joining another one. You can call the join method again only after you receive the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3721f1f2a3kpd" id="9e6478b2f0hen">onLeaveChannelResult</a> callback.

• This method only supports joining one channel at a time.

• Apps with different App IDs cannot communicate with each other.

Related callbacks

After successfully calling this method, the following callbacks will be triggered:

• The result of the local user joining the channel is returned in the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#e6d2a213d7sl2" id="df00346ea8928">onJoinChannelResult</a> callback.

• After successfully joining the channel, the remote end will trigger the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#634626babfq9x" id="c3832e71e8vck">onRemoteUserOnLineNotify</a> callback.

Parameter description

You can join the channel.

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

This method, along with joinChannel[1/3] and joinChannel[2/3], lets you join a channel. ARTC organizes users into channels, and you must join a channel to publish or subscribe to audio and video streams. These methods differ in the authentication method and the user information that is passed, as follows:

• joinChannel[1/3] is a single-parameter method for joining a channel in Real-Time Communication (RTC) scenarios. To use this method, pass the token generated by Token authentication. We recommend using this method for joining channels in RTC scenarios.

• joinChannel[2/3] is a multi-parameter method for joining a channel. To use this method, pass the multi-parameter token generated by Token authentication and the user information that was used to generate the token.

• This method is used for AI real-time interaction scenarios. To use this method, pass a single-parameter joining token and set the capabilityProfile user property according to the scenario. To communicate with an AI agent, set this property to AliRtcCapabilityProfileAiHuman.

Call restrictions

• After you successfully join a channel, you must call <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="923190466431o">leaveChannel</a> to leave the current channel and receive the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3721f1f2a3kpd" id="dfd794c32covq">onLeaveChannelResult</a> callback before you can join another channel.

• This method only supports joining one channel at a time.

• Apps with different App IDs cannot communicate with each other.

• Do not call this method again to retry a failed channel join.

Related Callbacks

A successful call to this method triggers the following callbacks:

• The result of joining the channel is returned in the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#e6d2a213d7sl2" id="f83d0aff9btwh">onJoinChannelResult</a> callback.

• After you successfully join the channel, the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#634626babfq9x" id="aeef817be3a0b">onRemoteUserOnLineNotify</a> callback is triggered.

Description

You can leave the channel.

- (int)leaveChannel;

After calling this method, the SDK will terminate audio and video interaction and leave the current channel.

Invocation Timing

• Call this method to leave a channel.

• If you are already in a channel, you must call this API to leave the current channel before joining another channel.

Related callbacks

• Local: After calling this method, the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3721f1f2a3kpd" id="ea2e36a41csu0">onLeaveChannelResult</a> callback will be triggered to notify you of the result of leaving the channel.

• Remote: After successfully calling this interface, remote users will receive the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#34876c27d7zv7" id="a50f534f21mew">onRemoteUserOffLineNotify</a> callback.

Return description

A value of 0 indicates that the call succeeded. A value other than 0 indicates failure.

Checks whether you are in a channel.

- (BOOL)isInCall;

Return description

YES indicates that you are in the channel. NO indicates that you are not in the channel.

Sets the user role.

- (int)setClientRole:(AliRtcClientRole)role;

This method sets the user role as streamer or viewer.

In interactive mode, before joining a channel:

• Set the user role to streamer: The SDK automatically publishes local audio and video streams and receives audio and video streams from other streamers by default.

• Set the user role to viewer: The SDK does not publish local audio and video streams, but receives audio and video streams from other streamers.

When to call

This method can be called both before and after joining a channel. You can set the user role before joining a meeting, or call it after joining to switch user roles.

Call restrictions

This method is only effective in interactive mode, that is, when the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#fc9626a99f5kj" id="cd8138c77fv4r">setChannelProfile</a> interface is set to AliRtcInteractivelive.

In interactive mode, we recommend explicitly setting the user role before joining the meeting.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Gets the user role (iOS only).

- (AliRtcClientRole)getCurrentClientRole;

Return description

Returns the current user role.

Refreshes the authentication information.

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

This method updates the authentication information. The token expires after a certain period, at which point the SDK can no longer connect to the server.

When to call

In the following situations:

• When you receive the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#6766cdfb40z1a" id="c1cc6cbddb22o">onAuthInfoWillExpire</a> callback indicating that the authentication information is about to expire, we recommend that you regenerate the Token on your server-side and then call this method to pass in the new Token.

• If you do not update the Token in time, the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#b04cd67880ptu" id="13c9ccb2b6ghh">onAuthInfoExpired</a> callback is triggered to notify you that the authentication has expired. In this case, you need to regenerate the Token and then call joinChannel to rejoin the channel.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Refreshes the authentication information.

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

This method updates the token. The token expires after a certain period, at which point the SDK can no longer connect to the server.

When to call

In the following situation, regenerate a token on your server and then call this method to pass in the new token:

When you receive the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#6766cdfb40z1a" id="b1dbfcb71d5ys">onAuthInfoWillExpire</a> callback reporting that the authentication information is about to expire.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Specifies whether to publish the audio stream.

- (int)publishLocalAudioStream:(BOOL)enable;

This method controls whether to publish the locally captured audio stream. The SDK publishes the audio stream by default. If you do not want to publish the audio stream by default, call publishLocalAudioStream(false) before joining the channel to disable audio stream publishing.

When to call

You can call this method before or after joining a channel. When called before joining a channel, it modifies the default configuration, which takes effect when you join the channel.

Related callbacks

When the local audio publishing status changes, the local client triggers the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#86b2d8735bm71" id="e5ef180ba6e2i">onAudioPublishStateChanged</a> callback to provide the latest audio publishing status, and the remote client triggers the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#6da9cf330aoer" id="299ef35806ttb">onRemoteTrackAvailableNotify</a> callback to notify that the remote user's audio and video streams have changed.

Parameter description

Return value

If the returned value is 0, the method call is successful. Otherwise, the method call failed.

Checks whether the local audio stream is published.

- (BOOL)isLocalAudioStreamPublished;

Return value

YES allows pushing. NO disallows pushing.

Determines whether to subscribe to remote audio streams by default.

- (int)setDefaultSubscribeAllRemoteAudioStreams:(BOOL)sub;

This method configures the default subscription setting for remote audio streams. This setting affects the audio stream subscription behavior for new users who join the channel. We recommend setting this parameter to true unless you have specific requirements.

When to call

You can call this method before or after joining a channel.

• Before joining a channel:

  • By default, the SDK subscribes to the audio streams of remote users when joining a channel. To change this behavior, you can call this method before joining the channel.

• After joining a channel:

  • You can call <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#8b515d9855osk" id="a467e60e4eyhk">setDefaultSubscribeAllRemoteAudioStreams</a>(false) to stop automatically subscribing to the audio streams of users who subsequently join the channel.

  • After stopping the default subscription, you can call the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#c8249fb568gms" id="9806dd9a750pf">subscribeRemoteAudioStream</a> method to resume subscribing to a specific user's audio stream. To resume subscribing to multiple users, call this method multiple times.

  • After you stop the default subscription, calling <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#8b515d9855osk" id="9507d6d3121uh">setDefaultSubscribeAllRemoteAudioStreams</a>(true) resumes the audio streams of only the users who subsequently join the channel. The SDK does not resume the audio streams of remote users who joined while the subscription was stopped.

Parameter descriptions

Return description

A return value of 0 indicates a successful method call. Any other value indicates that the call failed.

Stops or resumes pulling the audio stream of a specific remote user.

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

This method stops or resumes subscribing to the audio stream of a specific remote user. We recommend setting this to true unless you have specific requirements.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Stops or resumes receiving all remote audio streams.

- (int)subscribeAllRemoteAudioStreams:(BOOL)sub;

This method is the master switch for subscribing to remote audio streams. We recommend setting it to YES. If set to NO, it will result in:

• All remote audio in the current meeting will stop being subscribed to.

• New users who join later will not be subscribed to.

• You cannot use <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#c8249fb568gms" id="846b0dd501epf">subscribeRemoteAudioStream</a> to individually control the audio stream of a specific user.

To subscribe again, call this API again and set it to YES to resume the subscription.

Parameter description

Return description

A value of 0 indicates that the call succeeded. A value other than 0 indicates failure.

Specifies whether to publish the camera stream.

- (int)publishLocalVideoStream:(BOOL)enable;

This method controls whether to publish the locally captured video stream.

When to call

You can call this method before or after joining a channel.

Calling this method before joining a channel modifies the default configuration, which takes effect when you join the channel.

Related callbacks

When the local video stream ingest status changes, the local client triggers the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#bd67711e63tnk" id="f966292202q3d">onVideoPublishStateChanged</a> callback to report the latest status, and remote clients trigger the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#6da9cf330aoer" id="2fdc208ccczr1">onRemoteTrackAvailableNotify</a> callback to report that a remote user's audio and video streams have changed.

Parameter description

Queries whether a video stream is allowed to be published.

- (BOOL)isLocalVideoStreamPublished;

Return description

YES indicates that the camera stream is published. NO indicates that the camera stream is not published.

Specifies whether to subscribe to remote video streams by default.

- (int)setDefaultSubscribeAllRemoteVideoStreams:(BOOL)sub;

This method specifies whether to subscribe to video streams by default. The SDK subscribes by default.

When to call

You can call this method before or after joining a channel.

• Before joining a channel:

  • You can call this method to cancel the default subscription setting.

• After joining a channel:

  • To stop the default subscription, you can call setDefaultSubscribeAllRemoteVideoStreams(false). This prevents subscription to the video streams of users who join the channel later.

  • After stopping the default subscription, to resume subscribing to a specific user's video stream, call the subscribeRemoteVideoStream method. To resume for multiple users, call this method multiple times.

  • After you stop the default subscription, calling setDefaultSubscribeAllRemoteVideoStreams(false) resumes only the audio streams of users who subsequently join the channel.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Stops or resumes subscribing to the video stream of a remote user.

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

Performs subscription and unsubscription operations for the video stream of a specified user.

When to call

You can call this method before or after joining a channel.

Parameter description

Stops or resumes receiving all remote video streams.

- (int)subscribeAllRemoteVideoStreams:(BOOL)sub;

This method is a global switch for subscribing to remote video streams. If you set this parameter to false, the following occurs:

• All remote video streams in the current meeting stop being subscribed to.

• New users who join the meeting later will not be subscribed either (even if you have set <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#a975297480yoj" id="0464849a17dks">setDefaultSubscribeAllRemoteVideoStreams</a> to subscribe by default).

• You cannot control the audio stream of a specific user individually through <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#1cc7ef76fdawz" id="498e782f414zz">subscribeRemoteVideoStream</a>.

To resume subscription, call this method again and set it to true.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Stops or resumes the media stream of a specific remote user.

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

This method combines the subscription to remote audio and video streams.

Related methods

Compared to subscribeRemoteMediaStream[2/2], this method uses two boolean parameters, subVideo and subAudio, to determine whether to subscribe to remote audio and video streams. The videoTrack parameter controls which video stream to pull.

Note: In this method, AliRtcVideoTrackNo of AliRtcVideoTrack is invalid and has no effect.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Stops or resumes the media stream of a specific remote user.

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

This method combines the subscription to remote audio and video streams.

Related methods

Compared to subscribeRemoteMediaStream[1/2], this method uses the videoTrack and audioTrack parameters to inform the SDK about the desired subscription state in a single call. For example:

• To subscribe to both the camera stream and microphone stream, set videoTrack to AliRtcVideoTrackCamera and audioTrack to AliRtcAudioTrackMic when calling.

• To unsubscribe from the camera stream but keep the microphone, set videoTrack to AliRtcVideoTrackNo and audioTrack to AliRtcAudioTrackMic when calling again.

• To unsubscribe from both, set videoTrack to AliRtcVideoTrackNo and audioTrack to AliRtcAudioTrackNo when calling again.

• To subscribe to both the camera stream and screen sharing stream simultaneously, set videoTrack to AliRtcVideoTrackBoth. The same applies to audio.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Subscribes to the stream of a specific user across channels.

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

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Subscribes to the streams of all users in a target channel.

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

Parameter description

Return value

0 indicates success. Other values indicate failure.

Sets the volume of remote audio.

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

Parameter description

Return value

0 indicates success. Other values indicate failure.

Stops or resumes sending local audio data.

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

When to call

You can call this method before or after joining a channel.

Related callbacks

After a successful call, the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3189c59d9fipb" id="1579c3523779c">onUserAudioMuted</a> callback is triggered, indicating whether the remote user is muted.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Stops or resumes the playback of remote audio.

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

This method is only used to stop or resume the playback of audio from a specified remote user. It does not affect stream pulling or decoding of the remote audio. If you want to unsubscribe from a user's audio stream, call <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#c8249fb568gms" id="dd9dbbad0bkni">subscribeRemoteAudioStream</a>.

When to call

You can call this method before or after joining a channel.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Stops or resumes the playback of all remote audio.

- (int)muteAllRemoteAudioPlaying:(BOOL)mute;

This method stops or resumes the playback of all remote audio.

When to call

You can set this before or after joining a channel.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Starts audio collection.

- (void)startAudioCapture;

This method controls the start of audio collection. Calling it before joining a meeting can enable audio collection in advance. If not set, the SDK automatically controls the audio collection device. After calling stopAudioCapture to stop audio collection, call this method to start it again.

When to call

You can call this method before or after joining a meeting.

Related methods

The startAudioCapture[2/2] method can control whether the audio collection device remains on after leaving a meeting through parameters.

Related callbacks

After calling this method to modify the local audio collection status, you can get status changes through the onLocalAudioStateChanged callback.

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Starts audio collection.

- (void)startAudioCapture:(BOOL)keepAlive;

Turns off microphone collection when muted.

This method controls the start of audio collection. Calling it before joining a channel can enable audio collection in advance. If not set, the SDK automatically controls the audio collection device.

When to call

You can call this method before or after joining a channel.

Related methods

Compared to startAudioCapture[1/2], this method lets you control whether the collection device remains on after leaving a channel through the keepAlive parameter.

Related callbacks

After calling this method to modify the local audio collection status, you can get the status change through the onLocalAudioStateChanged callback.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Stops audio collection.

- (void)stopAudioCapture;

After calling <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#3103c368bexf8" id="ddef64f9b93zq">startAudioCapture</a> to start audio device capture, you can call this method to stop capturing.

Related callbacks

After calling this method to modify the local audio collection status, you can get the status change through the onLocalAudioStateChanged callback.

Return description

0 indicates that the method call succeeded. Other values indicate failure.

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

- (int)enableSpeakerphone:(BOOL)enable;

This method sets the current audio playback device after joining a meeting, allowing you to choose between the earpiece and speaker. If this feature is not set, the device configured by the default audio route is used for playback.

The priority of audio routing is defined within the SDK and automatically switches based on the current peripheral connection status. The priority is as follows: Wired headset > Bluetooth headset > User settings > Default settings. Therefore, when a peripheral is connected, calls to this method have no effect. For more details about audio routing settings, see Audio routing settings.

When to call

You can call this method before or after joining a channel.

Related methods

<a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#83be8cc066qqq" id="f8de149ef8so0">setDefaultAudioRoutetoSpeakerphone</a> is used to modify the default audio routing settings, while this interface is used to set the current routing device.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Gets the current audio output device, either earpiece or speaker (iOS only).

- (BOOL)isEnableSpeakerphone;

Return description

YES indicates speaker mode. NO indicates earpiece mode.

Sets the volume callback frequency and smoothing factor.

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

This method allows the SDK to regularly report volume-related information of the local streaming user and the remote user with the highest instantaneous volume to the application.

When to call

You can call this method before or after joining a channel.

Related callbacks

After you successfully call this method, if there are users streaming in the channel, the SDK triggers the following two callbacks at the specified time interval:

• The audio volume of speakers is reported through the onAudioVolumeCallback callback, with a frequency determined by the interval parameter.

• For voice activation, when an active user is detected, the speaker's UID is reported through the onActiveSpeaker callback.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Enables in-ear monitoring.

- (int)enableEarBack:(BOOL)enable;

This method enables or disables in-ear monitoring. We recommend enabling in-ear monitoring when wearing headphones (wired or Bluetooth) for better results.

When to call

You can call this method before or after joining a channel.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the in-ear monitoring volume.

- (int)setEarBackVolume:(NSInteger)volume;

This method is used to set the volume for in-ear monitoring. It takes effect only after in-ear monitoring is enabled through <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#bd665d0f894ux" id="b0fa866c9bcuq">enableEarBack</a>.

When to call

You can call this method before or after joining a channel.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Starts audio playback.

- (void)startAudioPlayer;

Stops audio playback.

- (void)stopAudioPlayer;

Sets the playback volume.

- (int)setPlayoutVolume:(NSInteger)volume;

Parameter description

Return value

0 indicates success. Other values indicate failure.

Sets the recording volume.

- (int)setRecordingVolume:(NSInteger)volume;

Parameter description

Return value

0 indicates success. Other values indicate failure.

Plays an audio file.

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

Parameter description

Return value

0 indicates success. Other values indicate failure.

Stops playing an audio file.

- (int)stopAudioFileTest;

Return value

0 indicates success. Other values indicate failure.

Starts audio collection device detection before a call.

- (void)startAudioCaptureTest;

Stops audio collection device detection before a call.

- (void)stopAudioCaptureTest;

Sets whether the default audio output is from the speaker. By default, audio comes from the speaker.

- (int)setDefaultAudioRouteToSpeakerphone:(BOOL)defaultToSpeakerphone;

This method sets the default audio routing device before joining a meeting. You can choose to output to the earpiece or speaker by default. The SDK defaults to the speaker. If you want to modify this default configuration, you can call this method before joining the meeting.

The priority of audio routing is predefined in the SDK and automatically switches based on the current peripheral connection status. The priority is as follows: Wired headset>Bluetooth headset>User settings>Default settings. Therefore, if no peripheral is connected and the route is not configured using <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#f7d0d8b64fzkz" id="30798b686b5qk">enableSpeakerphone</a>, the default settings are used.

For more details about audio routing settings, see Audio routing settings.

Mobile devices generally have two audio routing devices: earpiece and speaker.

• When audio is routed to the earpiece, the sound is quiet and can only be heard clearly when the ear is close, providing better privacy and is suitable for answering calls.

• When audio is routed to the speaker, the sound is louder and can be heard clearly without holding the phone to your face, thus enabling a "hands-free" feature.

Related methods

This interface is used to modify the default audio routing settings, while the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#f7d0d8b64fzkz" id="6001aa98ebapw">enableSpeakerphone</a> interface is used to set the current routing device.

When to call

This can be called both before and after joining a meeting.

Parameter description

Return value

0 indicates success. Other values indicate failure.

Sets the voice changer mode.

- (int)setAudioEffectVoiceChangerMode:(AliRtcAudioEffectVoiceChangerMode)mode;

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the pitch parameter.

- (int)setAudioEffectPitchValue:(double)value;

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the reverberation mode.

- (int)setAudioEffectReverbMode:(AliRtcAudioEffectReverbMode)mode;

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the reverberation type and specific parameters.

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

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Adds an external audio stream.

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

This method adds a new external audio stream. The following are the related steps:

1. Call the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#d71bbfd2f242b" id="c310321e9eu35">addExternalAudioStream</a> method to add an external audio stream and obtain the external audio stream ID.

2. Call pushExternalAudioStream to input audio data into the created audio stream.

3. When the call ends, you need to call <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#282d70095duaw" id="16f621608d94x">removeExternalAudioStream</a> to remove the external audio stream.

To publish custom captured audio in a channel, see Custom audio collection.

Parameter description

Return description

A value greater than 0 indicates that the call succeeded and is the ID of the external audio stream. Other values indicate failure.

Inputs external audio stream data.

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

This method inputs data into a specified audio stream. The following are the related steps:

1. Call the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#d71bbfd2f242b" id="0a353f7272shu">addExternalAudioStream</a> method to add an external audio stream and obtain the external audio stream ID.

2. Call this method to input audio data into the created audio stream.

3. When the call ends, you must invoke <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#282d70095duaw" id="a9ebc8d599dz4">removeExternalAudioStream</a> to remove the external audio stream.

To publish custom captured audio in a channel, see Custom audio collection.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the volume of an external audio stream for stream ingest.

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

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Gets the volume of an external audio stream for stream ingest.

- (int)getExternalAudioStreamPublishVolume:(int)streamId;

Parameter description

Return description

[0, 100]: The stream ingest volume. < 0: Failed.

Sets the playback volume of an external audio stream.

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

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Gets the playback volume of an external audio stream.

- (int)getExternalAudioStreamPlayoutVolume:(int)streamId;

Parameter description

Return description

[0, 100]: The playback volume. < 0: Failed.

Deletes an external audio stream.

- (int)removeExternalAudioStream:(int)streamId;

This method removes the corresponding external audio stream based on the input streamId, corresponding to the addExternalAudioStream method.

When to call

If you want to use the custom audio input feature, you need to call the addExternalAudioStream method to add an audio stream and get the external audio stream ID, then call the pushExternalAudioStream method to input your audio data to the SDK. When you want to stop custom audio input, call this method to remove the corresponding external audio stream and clean up resources.

Parameter description

Return value

0 indicates success. Other values indicate failure.

Gets audio file information.

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

Parameter description

Starts accompaniment mixing.

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

Parameter description

Return value

0 indicates success. Other values indicate failure.

Stops accompaniment mixing.

- (int)stopAudioAccompany;

Return value

0 indicates success. Other values indicate failure.

Sets the accompaniment volume.

- (int)setAudioAccompanyVolume:(NSInteger)volume;

Parameter description

Return value

0 indicates success. Other values indicate failure.

Sets the volume of the accompaniment file for stream ingest.

- (int)setAudioAccompanyPublishVolume:(NSInteger)volume;

Parameter description

Return value

0 indicates success. Other values indicate failure.

Gets the volume of the accompaniment file for stream ingest.

- (int)getAudioAccompanyPublishVolume;

Return value

Values between [0, 100] indicate success. Other values indicate failure.

Sets the accompaniment volume for local playback.

- (int)setAudioAccompanyPlayoutVolume:(NSInteger)volume;

Parameter description

Return value

0 indicates success. Other values indicate failure.

Gets the volume of the accompaniment for local playback.

- (int)getAudioAccompanyPlayoutVolume;

Return value

Values between [0, 100] indicate success. Other values indicate failure.

Pauses accompaniment mixing.

- (int)pauseAudioAccompany;

Return value

0 indicates success. Other values indicate failure.

Resumes accompaniment mixing.

- (int)resumeAudioAccompany;

Return value

0 indicates success. Other values indicate failure.

Gets the duration of the accompaniment file in milliseconds.

- (int)getAudioAccompanyDuration;

Return value

>=0: The duration of the accompaniment file in milliseconds. <0: Failed.

Gets the current playback position of the accompaniment file in milliseconds.

- (int)getAudioAccompanyCurrentPosition;

Return value

>=0: The current playback position of the accompaniment file. <0: Failed.

Sets the playback position of the accompaniment file.

- (int)setAudioAccompanyPosition:(int)pos;

Parameter description

Return value

0 indicates success. Other values indicate failure.

Preloads a sound effect file.

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

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Deletes a preloaded sound effect file.

- (int)unloadAudioEffectWithSoundId:(NSInteger)soundId;

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Starts playing a sound effect.

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

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Stops playing a sound effect.

- (int)stopAudioEffectWithSoundId:(NSInteger)soundId;

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Stops playing all sound effects.

- (int)stopAllAudioEffects;

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Pauses a sound effect.

- (int)pauseAudioEffectWithSoundId:(NSInteger)soundId;

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Pauses all sound effects.

- (int)pauseAllAudioEffects;

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Resumes playing a sound effect.

- (int)resumeAudioEffectWithSoundId:(NSInteger)soundId;

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Resumes playing all sound effects.

- (int)resumeAllAudioEffects;

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the stream ingest volume of a sound effect.

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

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Gets the stream ingest volume of a sound effect.

- (int)getAudioEffectPublishVolumeWithSoundId:(NSInteger)soundId;

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the stream ingest volume of all mixed sound effects.

- (int)setAllAudioEffectsPublishVolume:(NSInteger)volume;

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the local playback volume of a sound effect.

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

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Gets the local playback volume of a sound effect.

- (int)getAudioEffectPlayoutVolumeWithSoundId:(NSInteger)soundId;

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the local playback volume of all sound effects.

- (int)setAllAudioEffectsPlayoutVolume:(NSInteger)volume;

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Starts recording a media file.

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

Parameter description

Return description

TRUE indicates success. Other values indicate failure.

Stops recording a media file.

- (void)stopRecord 

Parameter description

None.

Sets the rendering window and drawing parameters for local preview.

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

This method sets the local preview view. Calling this method binds the display window (view) of the local video stream and sets the rendering mode, mirror mode, and rotation angle for the local user's view. It only affects the local user's preview display and does not affect the published video. To set the remote user interface view, call setRemoteViewConfig.

When to call

This method can be called both before and after joining a channel.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the camera capture preferences.

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

This method configures camera capture preferences, such as camera direction and capture frame rate.

When to call

You must set this before turning on the camera, for example, before the following operations:

• startPreview (start preview)

• joinChannel (join channel)

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Disables or re-enables local video collection.

- (int)enableLocalVideo:(BOOL)enable;

This method controls the enabling and disabling of local video collection. When local video collection is disabled, both local preview and stream ingest will not have video data, but it does not affect receiving remote video. If you call this method to turn off local camera collection, both the local preview and remote stream will remain on the last frame.

When to call

This method can be called both before and after joining a channel.

Related callbacks

• After you successfully call this method, remote users are notified through the onUserVideoEnabled callback.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Stops or resumes sending local video data.

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

When streaming, you can call this method to send black video frames. The local preview remains normal, and the collection, encoding, and sending modules continue to work, but the video content is black frames.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the rendering window and drawing parameters for a remote video.

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

This method binds the display view for a specified video stream of a remote user and sets the rendering mode, mirror mode, rotation angle, and other parameters for displaying the remote user's view locally. It only affects the video image seen by the local user. To set the local preview view, call <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#fea843803078q" id="b6f22fe87a2es">setLocalViewConfig</a>.

• If the view parameter in AliVideoCanvas: rendering canvas is empty, rendering stops.

• To reset the renderMode parameter of AliVideoCanvas: rendering canvas during playback, keep other parameters unchanged and only modify renderMode.

• To reset the mirrorMode parameter of AliVideoCanvas: rendering canvas during playback, keep other parameters unchanged and only modify mirrorMode.

When to call

We recommend that you call this method when you receive the onRemoteTrackAvailableNotify callback, which indicates that the remote user's video is available.

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Checks whether the camera is on.

- (BOOL)isCameraOn;

Return description

YES indicates that the camera is on. NO indicates that the camera is off.

Sets video encoding properties.

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

This method sets the video parameters for video stream encoding, such as resolution, frame rate, bitrate, and video orientation. We recommend calling this method for all video scenarios.

When to call

This method can be called both before and after joining a channel. If you only need to set the camera stream video encoding properties once per channel, we recommend calling this method before joining the channel.

Call restrictions

Both the mirrorMode parameter in this method and setVideoMirrorMode can set video stream mirroring. We recommend using only one method. Using multiple methods simultaneously can cause mirroring effects to stack, resulting in setting failures or errors.

Parameter description

Sets video decoding properties.

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

This method sets the video parameters for camera stream video decoding.

When to call

We recommend that you call this method before joining a channel.

Parameter description

Switches between the front and rear cameras. By default, the front camera is used (iOS only).

- (int)switchCamera;

This method controls the use of the front or rear camera. The front camera is used by default. You can dynamically switch cameras during application runtime based on the actual availability of cameras, without needing to restart the video stream or reconfigure the video source.

When to call

This method must be called after the camera has been successfully turned on.

Call restrictions

This method is available only on Android and iOS platforms.

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Gets the current camera direction. The front camera is used by default (iOS only).

- (AliRtcCameraDirection)getCurrentCameraDirection;

Return description

Returns the camera direction enumeration value.

Starts a local preview. The camera is automatically turned on.

- (int)startPreview;

This method starts a local video preview and automatically turns on the camera. To stop the local preview, call the stopPreview method.

When to call

• Before calling this method, you need to set a view for local preview through setLocalViewConfig. Otherwise, you cannot preview, but stream ingest is not affected.

• If needed, you can call this method before joining a channel to start the preview, which automatically turns on the camera.

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Stops a local preview.

- (int)stopPreview;

This method closes the local video preview and turns off the camera. After stopping the preview, the local end remains at the last frame, which does not affect stream ingest.

When to call

Call this method to stop the preview after it has been started.

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Sets the camera zoom.

 - (int)setCameraZoom:(float)zoom;

Parameter description

Return value

0 indicates success. Other values indicate failure.

Gets the maximum zoom factor of the camera.

 - (float)GetCameraMaxZoomFactor;

Return value

The maximum zoom factor of the camera.

Gets the current zoom factor of the camera.

- (float)GetCurrentZoom;

Return value

Gets the current zoom factor of the camera.

Sets the camera exposure.

- (int)SetExposure:(float)exposure;

Parameter description

Return value

0 indicates success. Other values indicate failure.

Gets the camera exposure.

- (float)GetCurrentExposure;

Return value

The camera exposure.

Gets the minimum camera exposure.

- (float)GetMinExposure;

Return value

The minimum camera exposure.

Gets the maximum camera exposure.

- (float)GetMaxExposure;

Return value

The maximum camera exposure.

Sets the camera flash on or off.

- (int)setCameraFlash:(BOOL)flash;

Parameter description

Return value

0 indicates success. Other values indicate failure.

Queries whether the camera supports manual focus.

- (BOOL)isCameraFocusPointSupported;

Return value

TRUE indicates that manual focus is supported. FALSE indicates that manual focus is not supported.

Queries whether the camera supports setting an exposure point.

- (BOOL)isCameraExposurePointSupported;

Return value

TRUE indicates that setting an exposure point is supported. FALSE indicates that setting an exposure point is not supported.

Sets the manual focus point for the camera.

- (int)setCameraFocusPoint:(CGPoint)point;

Parameter description

Return value

0 indicates success. Other values indicate failure.

Sets the exposure point and exposure value.

- (int)setCameraExposurePoint:(CGPoint)point;

Parameter description

Return value

0 indicates success. Other values indicate failure.

Queries whether the camera supports face-autofocus.

- (BOOL)isCameraAutoFocusFaceModeSupported;

Return value

TRUE indicates that face-autofocus is supported. FALSE indicates that face-autofocus is not supported.

Enables or disables face-autofocus for the camera.

- (BOOL)setCameraAutoFocusFaceModeEnabled:(BOOL)enable;

Parameter description

Return value

TRUE indicates success. FALSE indicates failure.

Sets the video mirror mode.

- (int)setVideoMirrorMode:(AliRtcVideoPipelineMirrorMode)mirrorMode;

Sets whether to enable mirror mode for local preview video and the published video stream.

When to call

This method can be dynamically set both before and after joining a channel. The SDK internally records the state and operates on the video when it can manipulate the preview and encoding (stream ingest).

Call restrictions

This method overlaps with the mirrorMode in setLocalViewConfig and setVideoEncoderConfiguration. We recommend using only this method.

Parameter description

Sets the video pipeline scaling mode.

-(void)setCapturePipelineScaleMode:(AliRtcCapturePipelineScaleMode)mode;

Sets whether video data scaling occurs immediately during capture or only during encoding. For example, when the capture resolution differs from the encoding resolution, you can decide whether preview data and streaming data are consistent by setting the timing of scaling.

When to call

This method needs to be set before the camera is turned on, for example, before startPreview begins preview or joinChannel joins the channel.

Parameter description

Return value

0 indicates success. Other values indicate failure.

Registers a video data output object.

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

This method registers an object that exports video data. To cancel the registration, call the unregisterVideoSampleWithObserver method.

When to call

To get raw video data, such as in YUV or RGBA format, you can call this method to register a video data monitor to get video data at various stages.

Related callbacks

After you successfully register a video data output monitor, the SDK triggers the callbacks that you implement when each video frame is captured. Implement the corresponding callbacks as needed:

• onCaptureVideoSample: The callback for local captured video data.

• onRemoteVideoSample: The callback for remote video data.

• onPreEncodeVideoSample: The callback for local video data before encoding.

Parameter description

Deregisters a video data output object.

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

This interface corresponds to the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#9a3437ab16j1w" id="f524bad30a6ys">registerVideoSampleObserver</a> interface and unregisters the video data output object.

Parameter description

Registers an observer for local camera stream video OpenGL texture data.

- (void)registerLocalVideoTextureObserver:(id<AliRtcTextureDelegate> _Nullable)observer;

If you want to get raw video data, call the registerVideoSampleObserver method to register the relevant callbacks. If you want to get internal texture data, call this method. To cancel the registration, call the unRegisterLocalVideoTextureObserver method.

Related callbacks

After you successfully register an observer for local camera stream video OpenGL texture data, the SDK triggers the callbacks that you implement in the AliRtcTextureObserver interface when each video frame is captured. Implement the corresponding callbacks as needed:

• onTextureCreate: This callback is triggered when the OpenGL context is created within the SDK.

• onTextureUpdate: This callback is triggered after each frame of video data is uploaded to the OpenGL texture. When an external OpenGL texture data observer is registered, you can process the texture in this callback and return the ID of the processed texture. The return value of this callback must be a valid texture ID. If no processing is performed, you must return the parameter textureId.

• onTextureDestroy: This callback is triggered when the OpenGL context within the SDK is destroyed.

Parameter description

Deregisters an observer for local camera stream video OpenGL texture data.

- (void)unregisterLocalVideoTextureObserver:(id<AliRtcTextureDelegate> _Nullable)observer;

This method corresponds to registerLocalVideoTextureObserver and is responsible for deregistration.

Parameter description

The video snapshot feature.

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

Parameter description

Return value

0 indicates success. Other values indicate failure.

Enables an external video input source.

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

Parameter description

Inputs video data.

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

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Starts bypass live streaming.

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

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Updates parameters for bypass live streaming.

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

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Stops bypass live streaming.

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

Parameter description

Return description

0 indicates that the method call succeeded. Other values indicate failure.

Gets the status of bypass live streaming.

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

Parameter description

Return description

Returns the status of bypass live streaming.

Starts network quality probing.

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

Parameter description

Return description

0 indicates success. Other values indicate failure.

Stops network quality probing.

- (int)stopLastmileDetect;

Return description

0 indicates success. Other values indicate failure.

Sends SEI information.

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

The SDK provides the ability to send and receive media extension information. This method sends media extension information using the SEI extension protocol. The receiver can get the information by listening to the onMediaExtensionMsgReceived callback.

Common use cases include the following:

• Using media extension information to transmit timestamps, calculate end-to-end network latency, or synchronize data with other business operations.

• Using media extension information to transmit descriptions. You can transmit up to 4 KB of data, which is suitable for small amounts of data. We recommend using JSON or plain strings.

When to call

Call this method after starting stream ingest.

Call restrictions

Using media extension information requires reusing the audio and video data channels. Therefore, you must control the frequency and length of custom messages. The limits are as follows:

• You can send a maximum of fps messages per second, as set in the profile, because SEI information is transmitted in the H.264/H.265 stream and requires video frame encoding to attach extension information.

• To avoid affecting the transmission quality of media data, the custom message body is limited to 4 KB, which is suitable for small amounts of information.

• The repeatCount parameter in the sendMediaExtensionMsg function represents the redundancy of custom messages. If it is greater than 1, the message is sent multiple times.

• To prevent message loss due to network packet loss, other users in the room will also receive the same message multiple times and need to deduplicate them.

• When you send custom messages, subscribers in the room will also receive them during bypass live streaming.

• Only one MediaExtensionMsg can be transmitted at a time. If you call sendMediaExtensionMsg multiple times, the data from the new call overwrites the data from the previous call.

Related callbacks

After the stream publisher sends media extension information, the stream subscriber can get the information by listening to the onMediaExtensionMsgReceived callback.

Parameter description

Return value

0 indicates success. Other values indicate failure.

Sends media extension information. This is implemented using SEI at the underlying level.

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

The SDK provides the ability to send and receive media extension information. This method sends media extension information using the SEI extension protocol. The receiver can get the information by listening to onMediaExtensionMsgReceived. When payloadType is 5, it is equivalent to using the sendMediaExtensionMsg method.

Common use cases include the following:

• Using media extension information to transmit timestamps, calculate end-to-end network latency, or synchronize data with other business operations.

• Using SEI to transmit descriptions. You can transmit up to 4 KB of data, which can be used to transmit small amounts of data. We recommend using JSON or plain strings.

When to call

Call this method after starting stream ingest.

Call restrictions

Using media extension information requires reusing the audio and video data channels. Therefore, you must control the frequency and length of custom messages. The limits are as follows:

• You can send a maximum of fps messages per second as set in the profile, because SEI information is transmitted in the H.264/H.265 stream, and video frame encoding is required to attach extension information.

• To avoid affecting the transmission quality of media data, the custom message body is limited to 4 KB, which can be used to transmit small amounts of information.

• The repeatCount parameter in the sendMediaExtensionMsg function is the redundancy of the custom message. If it is greater than 1, the message is sent multiple times.

• To prevent message loss due to network packet loss, others in the room will also receive the same message multiple times, requiring deduplication.

• For custom messages that are sent, subscribers in the room will also receive them during bypass live streaming.

• Only one MediaExtensionMsg can be transmitted at a time. When sendMediaExtensionMsg is called multiple times, the data from the new call overwrites the data from the previous call.

Parameter description

Return description

• 0: The call is successful.

• <0: The call failed, and an error code is returned.

  • ERR_INNER(-1): Internal SDK error, possibly because the SDK is not initialized or the method is called after the SDK is destroyed.

The callback that is invoked when the network connection status changes.

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

Parameter description

The callback that is invoked when a local device exception occurs. Pay attention to this callback.

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

Parameter description

The callback that is invoked when user authentication is about to expire. The authentication expires 30 seconds after you receive this callback. Pay attention to this callback.

- (void)onAuthInfoWillExpire;

This callback indicates that the user's authentication information is about to expire. The authentication expires 30 seconds after you receive this callback. You need to get a new token and update the authentication information using one of the following methods:

• Call the <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#e6a4495191bmd" id="918ba91977wi6">refreshAuthInfo</a> method to update the authentication information.

• Call <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="ad8235d30dprb">leaveChannel</a> to leave the current channel, and then call joinChannel to rejoin the channel.

When triggered

The SDK triggers this callback 30 seconds before the user authentication information expires. You should update the authentication information promptly after receiving this callback.

The callback for expired authentication. The expiration information is returned by the server when users call a method that requires authentication.

- (void)onAuthInfoExpired;

This callback indicates that the user's authentication information has expired. If you want to continue in the meeting, you need to generate a new token on the server side, and then update the authentication information through the following methods:

• Call <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#449873b819cz2" id="21390e77a1307">leaveChannel</a> to leave the current channel, and then call joinChannel to rejoin it.

When triggered

This callback is triggered when the user's authentication information expires.

The callback that is invoked to return the result of joining a channel. This callback is equivalent to the block operation of the joinChannel method, which handles events after joining a channel. You can choose either one.

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

Trigger condition

When the application calls the joinChannel method, this callback indicates a successful or failed channel join, and returns relevant information about the channel join along with the time consumed.

Parameter description

The callback that is invoked to return the result of leaving a channel. This callback is returned after you call the leaveChannel method. If you call destroy immediately after calling leaveChannel, you will not receive this callback.

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

Parameter description

The callback that is invoked when a remote user goes offline.

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

This callback notifies the local user that a remote user has left the channel for various reasons. This method is triggered when a remote user goes offline.

Trigger conditions

• When a remote user actively leaves the channel, this callback is triggered.

• This callback is triggered when a remote streamer calls <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#892915dd4edcy" id="78b1952ad5lwp">setClientRole</a> to switch to the viewer role (AliRtcClientRolelive).

• When no data is received from a remote streamer for a long time and they are considered disconnected, this callback is triggered.

Parameter description

The callback that is invoked when a remote user goes online.

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

This method notifies the local client when a remote user joins the channel.

Trigger conditions

• A remote user successfully joins the channel.

• When the current user joins the channel, they receive join callbacks for users who are already in the channel, to display previously joined users.

Parameter description

The callback that is invoked when the stream of a remote user changes.

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

This callback is triggered when the streaming status of a remote user changes. Through this callback, developers can monitor in real time whether remote users are publishing audio and video streams, and display or hide the remote users' audio and video information on the interface accordingly.

Trigger conditions

This callback is triggered in the following scenarios:

• When a remote user changes from not streaming to streaming (including audio and video).

• When a remote user changes from streaming to not streaming (including audio and video).

• In interactive mode, when a remote user calls setClientRole to switch from viewer to streamer role and sets up streaming, this callback is triggered.

Taking video as an example, if a remote user sets not to stream, this callback is not triggered:

• When a remote user starts publishing a camera stream (streaming status: not streaming video -> only streaming camera), the callback returns AliRtcVideoTrackCamera indicating that the remote user's camera stream is available.

• When the remote user also publishes a screen sharing stream (streaming status: only camera stream -> both camera and screen sharing streams), the callback returns AliRtcVideoTrackBoth indicating that both the remote user's camera stream and screen sharing stream are available.

• When the remote user stops publishing the camera stream and only keeps the screen sharing stream (streaming status: both camera and screen sharing streams -> only screen sharing stream), the callback returns AliRtcVideoTrackScreen indicating that only the screen sharing stream is currently available.

• When the remote user also stops publishing the screen sharing stream (streaming status: only screen sharing stream -> not streaming video), the callback returns AliRtcVideoTrackNo indicating that no video stream is currently available.

Parameter description

The callback that is invoked when a user is forced to leave a channel or the channel is closed.

- (void)onBye:(int)code;

When a user is disconnected for some reason or the meeting ends, this callback is triggered. Developers can determine the reason for disconnection from the callback parameter code and take appropriate action.

Trigger conditions

• The current user is kicked out by the server.

• The meeting ends (the server actively removes the channel).

• Passive departure, requiring the client to attempt to recover the session or reconnect.

Parameter description

The callback that is invoked when the status of the stream ingest for an audio track changes.

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

This callback is used to monitor changes in the stream ingest status of the local user's audio track.

Trigger conditions

When the audio stream ingest status of the user changes, for example:

• Stopping stream ingest.

• Call <a baseurl="t2309850_v9_0_0.xdita" data-node="4087266" data-root="16090" data-tag="xref" href="#892915dd4edcy" id="81771ef0798we">setClientRole</a> to switch to the viewer role.

Parameter description

The callback that is invoked when the status of subscription to an audio track changes.

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

This callback is triggered when the subscription state of a remote user's audio stream changes. It informs you of the new state and the time elapsed since the previous state.

Parameter description

A notification is sent when a user mutes their audio.

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

Parameter description

A notification is sent when the user's audio is interrupted. A common scenario is when a phone call preempts the audio.

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

Parameter description

A notification is sent when the user's audio interruption ends. It corresponds to onUserAudioInterruptedBegin.

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

Parameter description

Callback for video stream ingest changes.

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

This callback reports changes to the video stream ingest status of the local user.

Parameter description

A callback that indicates a change in the subscription status of a camera stream.

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

This callback notifies the local user of a change in the subscription status of a remote user's camera stream. The callback also provides the time elapsed since the previous state change.

Related callbacks

Video streams mainly include camera streams and screen sharing streams. This interface is for changes to the subscription status of camera streams. The related callback interface for screen sharing streams is onScreenShareSubscribeStateChanged.

Parameter description

Notification that a user has muted their video.

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

Parameter description

This notification is triggered when the local video capture is disabled or re-enabled.

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

Parameter description

Callback triggered when a remote user's application enters the background.

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

Parameter description

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

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

Parameter description

Real-time data callback (triggered every 2 s).

- (void)onRtcStats:(AliRtcStats)stats;

Parameter description

Reports local video statistics (triggered every 2 seconds).

- (void)onRtcLocalVideoStats:(AliRtcLocalVideoStats *_Nonnull)localVideoStats;

Parameter description

Remote video statistics information (triggered every 2 seconds).

- (void)onRtcRemoteVideoStats:(AliRtcRemoteVideoStats *_Nonnull)remoteVideoStats;

Parameter description