AliRtcEngine interface

Joins a channel (multi-parameter join).

public abstract int joinChannel(AliRtcAuthInfo authInfo, String userName);

This operation is used to join a channel. ARTC uses channels to organize users, and a user must join a channel to publish or subscribe to audio and video streams. This operation, along with joinChannel[1/3] and joinChannel[3/3], can be used to join a channel. The differences lie in the authentication method and the user information that is passed, as detailed below:

• joinChannel[1/3] is the single-parameter API for joining a channel. Pass a token generated for a single-parameter join via Token authentication to join the channel. This API is recommended for joining a channel in RTC scenarios.

• This API is a multi-parameter join interface. You must pass a multi-parameter join token generated using Token-based authentication and the user information that was used to generate the token.

• joinChannel[3/3] is used for Real-time Conversational AI scenarios and requires you to pass a single-parameter join token and set the user property capabilityProfile based on the scenario.

Limits

• If you need to switch to another channel after joining one, you must first call <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="e2525ba6a0k3s">leaveChannel</a> to leave the current channel and wait for the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8c189be470bsp" id="6aefdfedb0op3">onLeaveChannelResult</a> callback from AliRtcEngineEventListener before you can join another channel.

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

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

Related callbacks

Calling this method successfully triggers the following callbacks:

• The result of the local user joining a channel is notified through the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#89f5ad2d0bnd1" id="fb41cdcfc6acj">onJoinChannelResult</a> callback in AliRtcEngineEventListener.

• After you successfully join the channel, the remote user triggers the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7298cad465wnd" id="8e9d69ebe54sr">onRemoteUserOnLineNotify</a> callback.

Parameters

Return value

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

Joins a channel (single-parameter join).

public abstract int joinChannel(String token, AliRTCSdkChannelParam channelParam);

This interface is used to join a channel. Alibaba Real-Time Communication (ARTC) uses channels to organize users. You must join a channel to publish or subscribe to audio and video streams. This interface, joinChannel[1/3], and joinChannel[2/3] can all be used to join a channel. The differences are the authentication method and the user information that is passed, as follows:

• joinChannel[1/3] is the recommended API for joining a channel with a single parameter in RTC scenarios. You can join a channel by passing a token generated using Token authentication.

• joinChannel[2/3] is the API for joining a channel with multiple parameters. To use this API, you must use Token authentication to generate a token for joining with multiple parameters, and then pass the generated token along with the user information that was used to create it.

• This API is used for the Real-time Conversational AI scenario, where you pass in the token to join a session as a single parameter and set the capabilityProfile user property based on the scenario. To talk with an AI agent, set this property to AliCapabilityProfileAiHuman.

Limits

• If you need to join another channel after successfully joining one, you must first call <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="719d580348a95">leaveChannel</a> to leave the current channel and ensure that you receive the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8c189be470bsp" id="d128acfee2fpd">onLeaveChannelResult</a> callback from AliRtcEngineEventListener before you can join a channel again.

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

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

• You do not need to call this method again if the SDK is retrying to join the channel after a failure.

Related callbacks

Calling this method successfully triggers the following callbacks:

• The result of the local client joining a channel is notified through the AliRtcEngineEventListener's <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#89f5ad2d0bnd1" id="879ae2fa04zjd">onJoinChannelResult</a> callback.

• After you successfully join a channel, the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7298cad465wnd" id="9b5662c5a0nvf">onRemoteUserOnLineNotify</a> callback is triggered.

Parameters

Return value

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

Leaves a channel. After you call this method, the SDK terminates real-time audio and video interaction and leaves the current channel.

public abstract int leaveChannel();

When to call

• Call this method when you need to leave the channel after joining it.

• If you have already joined a channel and need to join another channel, call this method first to exit the current channel.

Related callbacks

• Local client: After you call this method, the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8c189be470bsp" id="80f5e30245vfn">onLeaveChannelResult</a> callback is triggered to notify you of the result of leaving the channel.

• Remote side: After this API is called successfully, remote users receive the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#75c700a2376c1" id="69bf5ff199oda">onRemoteUserOffLineNotify</a> callback.

Return value

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

Checks whether the user is in a channel.

public abstract boolean isInCall();

Return value

true: The user is in a channel. false: The user is not in a channel.

Sets the user role.

public abstract int setClientRole(AliRTCSdkClientRole clientRole);

This method sets the user role to streamer or viewer.

In interactive mode, before joining a channel:

• If you set the user role to streamer, the SDK automatically publishes the local audio and video streams by default and receives the audio and video streams from other streamers.

• If you set the user role to viewer, the SDK does not publish the local audio and video streams but receives the audio and video streams from other streamers.

When to call

You can call this method before or after joining a channel. You can call it before joining to set the user role or after joining to switch the user role.

Limits

This method is effective only in interactive mode, which means you must call the setChannelProfile method to set the channel profile to AliRTCSdkInteractiveLive.

In interactive mode, we recommend that you explicitly set the user role before you join a session.

Parameters

Gets the user role.

public abstract AliRTCSdkClientRole getCurrentClientRole();

Return value

Returns the current user role.

Refreshes the authentication information.

public abstract int refreshAuthInfo(AliRtcAuthInfo authInfo);

This method updates the authentication information. Tokens expire after a certain period, and the SDK cannot establish a connection with the server after expiration.

When to call

In the following situations:

• When the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e9acb46a25uym" id="7e1510bec7s3s">onAuthInfoWillExpire</a> callback reports that the authentication information is about to expire, we recommend that you regenerate a 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="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8fa7e60f9f5qq" id="97664f9e46fhp">onAuthInfoExpired</a> callback is triggered, which indicates that the authentication has expired. In this case, you must regenerate the token and then call joinChannel to rejoin the channel.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Refreshes the authentication information.

public abstract int refreshAuthInfo(String token);

This method updates the token. Tokens expire after a certain period, and the SDK cannot establish a connection with the server after expiration.

When to call

In the following situations, we recommend that you generate a new token on your server and then call this method to pass the new token:

• When the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e9acb46a25uym" id="d708af68eevs9">onAuthInfoWillExpire</a> callback reports that the authentication information is about to expire.

• If the Token is not updated in time, this triggers <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#8fa7e60f9f5qq" id="3fd674e985gl8">onAuthInfoExpired</a>, indicating that authentication has expired, and you must then call joinChannel to rejoin the channel.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Stops or resumes publishing the local video stream.

public abstract int publishLocalAudioStream(boolean enable);

This method is used to control whether to publish the local audio stream. By default, the SDK publishes the audio stream. To disable this behavior, call publishLocalAudioStream(false) before you join a meeting.

When to call

You can call this method before or after joining a channel. If you call it before joining, the setting takes effect when you join the channel.

Related callbacks

When the state of local audio stream ingest changes, the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b7e3bb51c2ga9" id="4ced92c3f5hmj">onAudioPublishStateChanged</a> callback is triggered on the local client to report the latest audio stream ingest state, and the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7078e15087a0z" id="2b5460d448ga9">onRemoteTrackAvailableNotify</a> callback is triggered on the remote client to report that the remote user's audio and video streams have changed.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Queries whether the audio stream is being published.

public abstract boolean isLocalAudioStreamPublished();

Return value

true: The audio stream is being published. false: The audio stream is not being published.

Sets whether to subscribe to remote audio streams by default.

public abstract int setDefaultSubscribeAllRemoteAudioStreams(boolean sub);

This method configures whether the system subscribes to remote users' audio streams by default. This setting affects the audio stream subscription behavior of users who join the channel later. We recommend setting this 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 remote users' audio streams when joining a channel. If you want to change this behavior, call this method before joining the channel.

• After joining a channel:

  • If you want to stop the default subscription, you can call setDefaultSubscribeAllRemoteAudioStreams(false). You will not subscribe to the audio streams of users who subsequently join the channel.

  • After stopping the default subscription, if you want to resume subscribing to a specific user's audio stream, call the subscribeRemoteAudioStream method. To resume subscribing to multiple users, call this method multiple times.

  • After you stop the default subscription, calling setDefaultSubscribeAllRemoteAudioStreams(true) resumes the audio streams of only the users who join the channel afterward. The audio streams of remote users who joined the channel while the subscription was stopped are not subscribed.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

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

public abstract int subscribeRemoteAudioStream(String uid, boolean sub);

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

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets whether to subscribe to all remote audio streams.

public abstract int subscribeAllRemoteAudioStreams(boolean sub);

This method is the master switch for subscribing to remote audio streams. We recommend setting it to true. If you set it to false, the following occurs:

• All remote audio streams in the current session stop being subscribed to.

• New users who join the channel later are not subscribed to.

• You cannot use <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e09342eeb0z4k" id="a56b5f2a3f56k">subscribeRemoteAudioStream</a> to individually control a specific user's audio stream.

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

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets whether to publish the camera stream.

public abstract int publishLocalVideoStream(boolean enable);

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

When to call

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

If you call it before joining, the setting takes effect when you join the channel.

Related callbacks

When the local audio stream ingest result changes, the local client triggers the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#afe6d3c4b1rvg" id="8b70bc353aj68">onVideoPublishStateChanged</a> callback to notify of the latest audio stream ingest status, and the remote client triggers the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#7078e15087a0z" id="176ee94b46lb7">onRemoteTrackAvailableNotify</a> callback to notify of changes to the remote user's audio and video stream.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Queries whether the camera stream is being published.

public abstract boolean isLocalVideoStreamPublished();

Return value

true: The camera stream is being published. false: The camera stream is not being published.

Sets whether to subscribe to remote video streams by default.

public abstract int setDefaultSubscribeAllRemoteVideoStreams(boolean sub);

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

When to call

You can call this method before or after joining a channel. If you call setDefaultSubscribeAllRemoteVideoStreams(false) after joining a channel, you will not receive the video streams of users who join the channel later.

After you stop receiving video streams, if you want to resume receiving, call subscribeRemoteVideoStream and specify the remote user ID you want to receive. If you want to resume receiving video streams from multiple users, call subscribeRemoteVideoStream multiple times. setDefaultSubscribeAllRemoteVideoStreams(true) only resumes receiving the video streams of users who join the channel later.

This method sets whether to subscribe to remote users' video streams by default.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Stops or resumes subscribing to a specified remote video stream.

public abstract int subscribeRemoteVideoStream(String uid, AliRtcVideoTrack track, boolean sub);

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

When to call

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

Parameters

Return value

• 0: The method call succeeded.

• Non-zero: The method call failed.

Stops or resumes receiving all remote video streams.

public abstract int subscribeAllRemoteVideoStreams(boolean sub);

This method is the master switch for subscribing to remote video streams. If you set it to false, the following occurs:

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

• New users who join the meeting later will also no longer subscribe (even if you set <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#c90127d90d22o" id="8661e30c89dum">setDefaultSubscribeAllRemoteVideoStreams</a>(true) to subscribe by default).

• You cannot use <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b738a1b498bc1" id="19b0cea8593i5">subscribeRemoteVideoStream</a> to individually control the video stream of a specific user.

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

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

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

public abstract int subscribeRemoteMediaStream(String uid, AliRtcVideoTrack videoTrack, boolean subVideo, boolean subAudio);

This method merges the subscription of remote audio and video streams.

Related interfaces

Unlike <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#4cec275051vr6" id="faff82a053mev">subscribeRemoteMediaStream[2/2]</a>, this API uses the two Boolean parameters subVideo and subAudio to determine whether to subscribe to remote audio and video streams, while the videoTrack parameter controls which video stream to pull.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Stops/resumes subscribing to a remote user's audio and video streams.

public abstract int subscribeRemoteMediaStream(String uid, AliRtcVideoTrack videoTrack, AliRtcAudioTrack audioTrack) ;

This method merges the subscription of remote audio and video streams.

Related interfaces

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

• If you want to subscribe to the camera and microphone streams, set videoTrack to AliRtcVideoTrackCamera and audioTrack to AliRtcAudioTrackMic when you make the call.

• If you want to unsubscribe from the camera stream but keep the microphone, set videoTrack to AliRtcVideoTrackNo and audioTrack to AliRtcAudioTrackMic when you call the method again.

• To cancel both, set videoTrack and audioTrack to AliRtcVideoTrackNo and AliRtcAudioTrackNo respectively in a subsequent call.

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

Parameters

Return value

• 0: Success.

• <0: Failure.

Subscribes to a specific user's stream across channels.

public abstract int subscribeRemoteDestChannelStream(String channelId, String uid, AliRtcVideoTrack track, boolean sub_audio, boolean sub);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Stops or resumes subscribing to all users' streams across channels.

public abstract int subscribeRemoteDestChannelAllStream(String channelId, AliRtcVideoTrack track, boolean sub_audio, boolean sub);

Parameters

Return value

• 0: The method call succeeded.

• Non-zero: The method call failed.

Adjusts the playback volume of a pulled stream.

public abstract int setRemoteAudioVolume(String uid, int volume);

With this interface, the local user can adjust the playbackvolume of a specified user's audio stream on the local device.

Parameters

Return value

• 0: The method call succeeded.

• Non-zero: The method call failed. For example, the volume value is invalid.

Stops or resumes sending local audio data.

public abstract int muteLocalMic(boolean mute, AliRtcMuteLocalAudioMode mode);

When to call

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

Related callbacks

After the call succeeds, the remote user triggers the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#ea457055e4izi" id="cce3d390a3xud">onUserAudioMuted</a> notification to indicate whether that user is muted.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure. Muting only sends silent frames for audio data. The collection and encoding modules continue to work.

Stops or resumes remote audio playback.

public abstract int muteRemoteAudioPlaying(String uid, boolean mute);

This API is used only to stop or resume the playback of audio from a specified remote user. It does not affect the stream pulling or decoding of the remote audio. To unsubscribe from a user's audio stream, call <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#e09342eeb0z4k" id="66a2ef0919jjg">subscribeRemoteAudioStream</a>.

When to call

You can set this before or after joining a channel.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Stops or resumes all remote audio playback.

public abstract int muteAllRemoteAudioPlaying(boolean mute);

This method stops or resumes all remote audio playback.

When to call

You can set this before or after joining a channel.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Enables audio collection.

public abstract int startAudioCapture();

This interface is used to start audio capture. You can call this interface before you join a meeting to start audio capture in advance. If you do not call this interface, the SDK automatically controls the audio capture device. To start audio capture again after you stop it by calling stopAudioCapture, call this interface.

When to call

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

Related interfaces

<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#b71a48f4b84n0" id="4565abdceeq8i">startAudioCapture[2/2]</a> uses parameters to control whether the audio capture device remains enabled after you leave a meeting.

Related callbacks

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

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Enables audio collection.

public abstract int startAudioCapture(boolean keepAlive);

Muting disables microphone capture.

This method controls enabling audio collection. You can also call it before joining a channel to enable audio collection in advance. If you do not set this, the SDK automatically controls the audio collection device.

When to call

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

Related interfaces

Compared to startAudioCapture[1/2], this API lets you use the keepAlive parameter to control whether the capture device remains on after you leave the session.

Related callbacks

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

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Disables audio collection.

public abstract int stopAudioCapture();

The SDK enables audio collection by default. Without special configuration, actions such as starting a preview or joining a channel automatically start audio collection. To stop audio device collection, call this method.

Related callbacks

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

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets whether the default audio output is the speaker.

public abstract int setDefaultAudioRoutetoSpeakerphone(boolean defaultToSpeakerphone);

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

The audio routing priority is predefined in the SDK and automatically switches based on the connection status of peripherals. The priority order is as follows: Wired headset > Bluetooth headset > User settings > Default settings. Therefore, if no peripherals are connected and the audio route is not set using enableSpeakerphone, the default settings are used.

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

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

• When the audio route is the earpiece, the sound is quieter and can only be heard clearly when the ear is close. It offers better privacy and is suitable for answering calls.

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

Related interfaces

This API is used to modify the default audio routing settings. The enableSpeakerphone API is used to set the current routing device.

When to call

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

Parameters

Return value

• 0: The method call succeeded.

• <0: The method call failed.

Sets the audio output to the earpiece or speaker.

public abstract int enableSpeakerphone(boolean enable);

This method sets the current audio playback device after joining a channel, choosing between the earpiece and the speaker. If this feature is not set, the device set by the default audio routing is used for playback.

The audio routing priority is predefined in the SDK and switches automatically based on the connection status of peripherals. The priority is as follows: Wired headset > Bluetooth headset > User settings > Default settings. Therefore, when a peripheral is connected, this API call has no effect. For more information about audio routing settings, see Audio Routing Settings.

When to call

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

Related interfaces

<a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#d4dab00b21ebx" id="944fb5797e773">setDefaultAudioRoutetoSpeakerphone</a> modifies the default audio routing settings. This API sets the current routing device.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Gets whether the current audio output is the earpiece or speaker.

public abstract boolean isSpeakerOn();

Return value

true: Speaker. false: Earpiece.

Enables user volume indication.

public abstract int enableAudioVolumeIndication(int interval, int smooth, int reportVad);

This interface allows the SDK to periodically report volume-related information to your app about the local user who is publishing a stream and the remote user with the highest instantaneous volume. To use this feature, implement the AliRtcAudioVolumeObserver class and call the registerAudioVolumeObserver interface to register the receiving object.

When to call

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

Related callbacks

After this method is called successfully, if there are publishing users in the channel, the SDK triggers the following two callbacks at the set time interval:

• The speaker's audio volume is notified through the AliRtcAudioVolumeObserver#onAudioVolume callback. The callback frequency is determined by the interval.

• Voice activity detection. When an active user is detected, the speaker's uid is returned through the AliRtcAudioVolumeObserver#onActiveSpeaker callback.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Enables in-ear monitoring.

public abstract int enableEarBack(boolean enable);

This method enables or disables the in-ear monitoring feature. 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.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets the in-ear monitoring volume.

public abstract int setEarBackVolume(int volume) ;

This method sets the volume for in-ear monitoring. It takes effect only after you enable the in-ear monitoring feature by calling enableEarBack.

When to call

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

Parameters

Return value

• 0: The method call succeeded.

• <0: The method call failed.

Turns on the audio playback device.

public abstract int startAudioPlayer();

This method can control enabling audio playback in advance. If you do not set this, the SDK automatically enables audio playback after subscribing to an audio stream.

Return value

• 0: Success.

• Non-zero: Failure. An error code is returned.

Turns off the audio playback device.

 public abstract int stopAudioPlayer();

This method stops audio playback and corresponds to startAudioPlayer.

Return value

• 0: Success.

• Non-zero: Failure. An error code is returned.

Sets the local playback volume.

public abstract int setPlayoutVolume(int volume);

Parameters

Return value

• 0: Success.

• Non-zero: Failure.

Sets the recording volume.

public abstract int setRecordingVolume(int volume);

Parameters

Return value

• 0: Success.

• Non-zero: Failure.

Plays an audio file.

public abstract int playAudioFileTest(String filePath) ;

This method plays an audio file before joining a channel to test audio playback.

When to call

You can only call this method before joining a channel.

Limits

Multiple calls will overwrite each other. A new call stops any file that is currently playing.

Parameters

Return value

• 0: Success.

• Non-zero: Failure.

Stops playing the audio file.

public abstract int stopAudioFileTest();

This method corresponds to playAudioFileTest and stops playing the audio file.

Limits

You can only call this method before joining a channel.

Return value

• 0: Success.

• Non-zero: Failure.

Enables audio collection device detection before a call.

public abstract int startAudioCaptureTest();

You can use this method to start an audio capture test to check if your local audio capture device is working properly before a call. After you call this method, the SDK reports the volume information of the capture device to you through the AliRtcAudioVolumeObserver::OnTestAudioVolume callback.

When to call

Call this method before you join a channel. After the test is complete, make sure that you call stopAudioCaptureTest to stop the device detection and prevent issues that are caused by device occupation.

Return value

• 0: Success.

• Non-zero: Failure. An error code is returned.

Disables audio collection detection.

public abstract int stopAudioCaptureTest();

This method stops audio capture device detection. You must call this method to stop the test after calling startAudioCaptureTest.

When to call

Call this before joining a channel.

Return value

• 0: Success.

• Non-zero: Failure. An error code is returned.

Sets the voice changer effect mode.

public abstract int setAudioEffectVoiceChangerMode(AliRtcAudioEffectVoiceChangerMode mode);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets the pitch shifting parameter.

public abstract int setAudioEffectPitchValue(double value);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets the reverberation effect mode.

public abstract int setAudioEffectReverbMode(AliRtcAudioEffectReverbMode mode);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets the reverberation effect type and specific parameters.

public abstract int setAudioEffectReverbParamType(AliRtcAudioEffectReverbParamType type, float value);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets the preset voice beautification effect mode.

public abstract int setAudioEffectBeautifyMode(AliRtcAudioEffectBeautifyMode mode);

This method sets some preset voice beautification modes within the SDK. It is suitable for scenarios with voice beautification needs, such as voice live streaming, karaoke, and voice social networking. By selecting different beautification modes, you can change the auditory effect of the human voice, such as enhancing magnetism or improving clarity, thereby improving the listening experience for remote users.

When to call

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

Parameters

Return value

• 0: Success.

• Non-zero: Failure.

Sets the audio equalizer (EQ) parameters to adjust the gain of a specified frequency band.

public abstract int setAudioEffectEqualizationParam(AliRtcAudioEffectEqualizationBandFrequency bandIndex, float gain);

This method adjusts the graphic equalizer for locally collected human voice or audio signals. By adjusting the gain (in dB) of one of the 10 fixed frequency bands, you can customize the timbre. It is suitable for scenarios such as voice clarity optimization, human voice enhancement, and noise reduction assistance.

The equalizer supports adjusting the full audio spectrum from 31 Hz to 16 kHz, with a total of 10 standard frequency bands. The gain for each band can be set independently, ranging from -15 to 15 dB, with a default of 0 dB (no enhancement or attenuation).

Limits

• You cannot use the equalizer before the beautify mode is enabled. You must call this interface after calling setAudioEffectBeautifyMode.

Parameters

Return value

0: Success.

Non-zero: Failure.

Adds an external audio stream.

public abstract int addExternalAudioStream(AliRtcExternalAudioStreamConfig config);

This method adds a new external audio stream. The steps are as follows:

1. Call the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#42b363024fich" id="20c33a9acb0ui">addExternalAudioStream</a> API to add an external audio stream and obtain the external audio stream ID.

2. Call <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#930f22d3dcdco" id="d3deb62b2fl0f">pushExternalAudioStreamRawData</a> to push audio data to the created audio stream.

3. When the call ends, you need to call <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#0333f86114078" id="16d826dedcli6">removeExternalAudioStream</a> to remove the external audio stream.

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

Parameters

Return value

A value greater than 0 indicates the method call was successful and is the external audio stream ID. Any other value indicates a failure.

Inputs external audio stream data.

public abstract int pushExternalAudioStreamRawData(int streamId, AliRtcAudioFrame rawData);

This method inputs data into a specified audio stream. The steps are as follows:

1. Call the <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#42b363024fich" id="8822f2932e9ep">addExternalAudioStream</a> API to add an external audio stream and obtain the external audio stream ID.

2. Call <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#930f22d3dcdco" id="880fe8cd02j10">pushExternalAudioStreamRawData</a> to push audio data into the created audio stream.

3. When the call ends, you need to call <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#0333f86114078" id="106c7aefa27c0">removeExternalAudioStream</a> to remove the external audio stream.

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

When to call

Call this after joining a channel.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets the external audio stream ingest volume.

public abstract int setExternalAudioStreamPublishVolume(int streamId, int publishVolume);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Gets the external audio stream ingest volume.

public abstract int getExternalAudioStreamPublishVolume(int streamId);

Parameters

Return value

[0, 100] Ingest volume. < 0: Failure.

Sets the external audio stream playback volume.

public abstract int setExternalAudioStreamPlayoutVolume(int streamId, int playoutVolume);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Gets the external audio stream playback volume.

public abstract int getExternalAudioStreamPlayoutVolume(int streamId);

Parameters

Return value

[0, 100] Playback volume. < 0 indicates a failure.

Deletes an external audio stream.

public abstract int removeExternalAudioStream(int streamId);

This method removes the corresponding external audio stream based on the provided streamId. It corresponds 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 pushExternalAudioStreamRawData method to input your audio data into the SDK. When you want to stop custom audio input, call this method to remove the corresponding external audio stream and clean up resources.

Parameters

Return value

• 0: Success.

• <0: Failure. An error code is returned.

Gets audio file information.

public abstract int getAudioFileInfo(String fileName);

You can call this asynchronous API to obtain the duration information of a file. You can obtain the audio file information through onAudioFileInfo.

Parameters

Return value

• 0: Success.

• Non-zero: An error code is returned.

Starts accompaniment mixing.

public abstract int startAudioAccompany(String fileName, AliRtcAudioAccompanyConfig config) ;

This method plays a local or online accompaniment file. It is an asynchronous method. After you call this method, you can listen to the accompaniment playback status through AliRtcEngineNotify#onAudioAccompanyStateChanged.

When to call

You can call this method after joining a channel.

Limits

Unlike sound effects, only one accompaniment can be played at a time. Repeated calls will overwrite the playback of the previous accompaniment.

Parameters

Return value

• 0: Success.

• Non-zero: Failure. An error code is returned.

Stops accompaniment mixing.

public abstract int stopAudioAccompany() ;

This method corresponds to startAudioAccompany and stops accompaniment playback.

When to call

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

Return value

• 0: Success.

• Non-zero: Failure. An error code is returned.

Sets the accompaniment volume, including local playback volume and ingest volume.

public abstract int setAudioAccompanyVolume( int volume) ;

This method sets the accompaniment volume for both local playback and stream ingest. In addition, setAudioAccompanyPlayoutVolume and setAudioAccompanyPublishVolume set only the local playback volume and the accompaniment stream ingest volume, respectively.

Parameters

Return value

• 0: Success.

• Non-zero: Failure. An error code is returned.

Sets the accompaniment ingest volume.

public abstract int setAudioAccompanyPublishVolume(int volume) ;

Parameters

Return value

• 0: Success.

• Non-zero: Failure. An error code is returned.

Gets the accompaniment ingest volume.

public abstract int getAudioAccompanyPublishVolume() ;

Return value

The ingest volume of the accompaniment music.

• [0-100]: Success.

• Other: Error code.

Sets the accompaniment local playback volume.

public abstract int setAudioAccompanyPlayoutVolume(int volume) ;

Parameters

Return value

• 0: Success.

• Non-zero: Failure. An error code is returned.

Gets the accompaniment local playback volume.

public abstract int getAudioAccompanyPlayoutVolume() ;

Return value

The local playback volume of the accompaniment music.

• [0-100]: Success.

• Other: Error code.

Pauses accompaniment mixing.

public abstract int pauseAudioAccompany();

Return value

• 0: Success.

• Non-zero: Failure. An error code is returned.

Resumes accompaniment mixing.

public abstract int resumeAudioAccompany();

Return value

• 0: Success.

• Non-zero: Failure. An error code is returned.

Gets the duration of the accompaniment file, in milliseconds.

public abstract int getAudioAccompanyDuration();

This method gets the duration of the current accompaniment file.

Return value

• >=0: Duration of the accompaniment file.

• <0: Failure. An error code is returned.

Gets the playback progress of the accompaniment file, in milliseconds.

public abstract int getAudioAccompanyCurrentPosition();

This method gets the playback progress of the current accompaniment file, in milliseconds.

Return value

• >=0: Playback progress of the accompaniment file.

• <0: Failure. An error code is returned.

Sets the playback position of the accompaniment file.

public abstract int setAudioAccompanyPosition(int posMs);

This method actively sets the playback progress of the accompaniment, for features such as dragging a progress bar. After this method is called successfully, the accompaniment file will play from the corresponding posMs position.

Parameters

Return value

• 0: Success.

• Non-zero: Failure. An error code is returned.

Preloads a sound effect file.

public abstract int preloadAudioEffect(int soundId, String filePath);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Deletes a preloaded sound effect file.

public abstract int unloadAudioEffect(int soundId);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Starts playing a sound effect.

public abstract int playAudioEffect(int soundId, String filePath, int cycles, boolean publish);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Stops playing a sound effect.

public abstract int stopAudioEffect(int soundId);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Stops playing all sound effects.

public abstract int stopAllAudioEffects();

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets the sound effect ingest mixing volume.

public abstract int setAudioEffectPublishVolume(int soundId, int volume);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Gets the ingest sound effect volume.

public abstract int getAudioEffectPublishVolume(int soundId);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets the local playback volume for a sound effect.

public abstract int setAudioEffectPlayoutVolume(int soundId, int volume);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Gets the local playback volume for a sound effect (Android and iOS).

public abstract int getAudioEffectPlayoutVolume(int soundId);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets the ingest mixing volume for all sound effects.

public abstract int setAllAudioEffectsPublishVolume(int volume);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets the local playback volume for all sound effects (Android and iOS).

public abstract int setAllAudioEffectsPlayoutVolume(int volume);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Starts recording a media file.

public abstract boolean startRecord(AliRtcRecordType recordType, AliRtcRecordFormat recordFormat, String filePath, AliRtcRecordAudioConfig audioConfig, AliRtcRecordVideoConfig videoConfig, long maxSize, long maxDuration);

Parameters

Return value

TRUE: Success. Other: Failure.

Stops recording a media file.

  public abstract void stopRecord();

Parameters

None.

Pauses a sound effect.

public abstract int pauseAudioEffect(int soundId);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Pauses all sound effects.

public abstract int pauseAllAudioEffects();

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Resumes playing a sound effect.

public abstract int resumeAudioEffect(int soundId);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Resumes playing all sound effects.

public abstract int resumeAllAudioEffects();

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Creates a SurfaceView rendering view.

public abstract SophonSurfaceView createRenderSurfaceView(Context context);

You must call this method to display the video view, instead of creating a SurfaceView directly. The calling method is as follows:

• Assign the return value to AliRtcVideoCanvas#view.

• Call setLocalViewConfig to set the local preview display view or call setRemoteViewConfig to set the remote preview display view.

When to call

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

Limits

Call this method in the main thread.

Parameters

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

public abstract int setLocalViewConfig(AliRtcVideoCanvas viewConfig, AliRtcVideoTrack track);

This method is used to set the local preview view. Calling this method attaches the display window (view) for the local video stream and sets parameters for the local user view, such as the rendering mode, mirror mode, and rotation angle. It only affects the local user's preview screen and does not affect the ingested video stream. To set the remote user interface view, call setRemoteViewConfig.

When to call

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

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

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

public abstract int setRemoteViewConfig(AliVideoCanvas canvas, String uid,AliRtcVideoTrack track);

This method attaches a display view to a specified video stream from a remote user and sets display settings for the remote view, such as the rendering mode, mirror mode, and rotation angle. This affects only the video image that the local user sees. To set the local preview view, call setLocalViewConfig.

• If the view parameter in AliRtcVideoCanvas is empty, rendering stops.

• To reset the renderMode parameter of AliRtcVideoCanvas during playback, keep the other parameters unchanged and only modify renderMode.

• To reset the mirrorMode parameter of AliRtcVideoCanvas during playback, keep the other parameters unchanged and only modify mirrorMode.

When to call

We recommend calling this when you receive the onRemoteTrackAvailableNotify callback, which is when the remote user's video is available.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets the camera capture preferences.

public abstract int setCameraCapturerConfiguration(AliEngineCameraCapturerConfiguration cameraCapturerConfiguration);

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

When to call

You must set this before you turn on the camera. For example, call it before the following operations:

• startPreview (start preview)

• joinChannel (join channel)

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Disables or re-enables local video collection.

public abstract int enableLocalVideo(boolean enable);

This method controls enabling and disabling local video collection. When local video collection is disabled, both the local preview and the published stream have no video data, but this does not affect receiving remote video. If you call this method to disable local camera collection, both the local preview and the remote published stream will freeze on the last frame.

When to call

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

Related callbacks

After this method is called successfully, the remote user is notified through the onUserVideoEnabled callback.

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Stops or resumes sending local video data.

public abstract int muteLocalCamera(boolean mute, AliRtcVideoTrack track);

When publishing a stream, you can call this method to publish all-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.

Parameters

Return value

0 indicates the method call was successful.

Checks whether the camera is on.

public abstract boolean isCameraOn();

Return value

true: The camera is on. false: The camera is not on.

Sets the video encoding properties.

public abstract void setVideoEncoderConfiguration(AliRtcVideoEncoderConfiguration config);

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

When to call

You can call this method before or after joining a channel. If you only need to set the camera stream video encoding properties once per session, we recommend calling it before joining the channel.

Limits

Both the mirrorMode of this method and setVideoMirrorMode can set the video publishing mirror. We recommend using only one. Using multiple methods at the same time can cause the mirror effects to stack, leading to a failed or incorrect mirror setting.

Parameters

Sets the video decoding properties.

    public abstract void setVideoDecoderConfiguration(AliRtcVideoDecoderConfiguration config);

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

When to call

We recommend calling this method before joining a channel.

Parameters

Switches between the front and rear cameras. The front camera is used by default.

public abstract int switchCamera();

This method switches between the front and rear cameras. The front camera is used by default. You can dynamically switch cameras during the application's runtime based on the available cameras, without restarting the video stream or reconfiguring the video source.

When to call

Call this method after the camera has been successfully turned on.

Limits

This is available only on Android and iOS.

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Gets the current camera direction.

public abstract AliRTCCameraDirection getCurrentCameraDirection();

Return value

• Returns CAMERA_REAR(0) for the rear camera.

• Returns CAMERA_FRONT(1) for the front camera.

• Returns CAMERA_INVALID(-1) for invalid.

Starts the local preview.

public abstract int startPreview();

This method starts the 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 the view for the local preview by calling setLocalViewConfig. Otherwise, the preview will not be displayed, but this will not affect publishing.

• If needed, you can call this method to start the preview before joining a channel with joinChannel. The camera will be turned on automatically.

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Stops the local preview.

public abstract int stopPreview();

This method closes the local video preview and turns off the camera. After stopping the preview, the local end will remain on the last frame, which does not affect publishing.

When to call

To close the preview after starting it, you can call this method.

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Sets the camera zoom ratio.

public abstract int setCameraZoom(float zoom);

Sets the zoom ratio of the camera.

Limits

Only iOS and Android provide this interface.

When to call

This setting is effective only after the camera is turned on. The zoom is reset each time the camera is restarted.

Parameters

Return value

• 0: The method call succeeded.

• Non-zero: The method call failed.

Gets the maximum zoom ratio supported by the camera.

public abstract float GetCameraMaxZoomFactor();

Return value

The maximum zoom ratio supported by the device's camera.

Gets the current camera zoom ratio setting.

public abstract float GetCurrentZoom();

Return value

The current zoom ratio of the device's camera.

Sets the camera exposure.

public abstract int SetExposure(float exposure);

When the ambient light is insufficient or too bright, it affects the quality of the video capture. To achieve better video quality, you can use this method to adjust the exposure of the camera in use. You can obtain the exposure range supported by the current device by calling GetMinExposure and GetMaxExposure.

Parameters

Return value

• 0: The method call succeeded.

• Non-zero: The method call failed.

Gets the camera exposure.

public abstract float GetCurrentExposure();

Gets the exposure setting of the currently used camera.

Return value

The current camera exposure.

Gets the minimum exposure supported by the camera.

public abstract float GetMinExposure();

Return value

The minimum camera exposure.

Gets the maximum exposure supported by the camera.

public abstract float GetMaxExposure();

Return value

The maximum camera exposure.

Sets the camera flash on or off.

public abstract int setCameraFlash(boolean flash);

Turns the flash on or off.

Limits

Only iOS and Android provide this interface.

Parameters

Return value

• 0: Success.

• Non-zero: Failure.

Checks whether the current device supports manual focus.

public abstract boolean isCameraFocusPointSupported();

Checks whether the current camera can set a focus point to support the manual focus feature.

Limits

Only iOS and Android provide this interface.

Return value

• true: The device supports the manual focus feature.

• false: The device does not support the manual focus feature.

Checks whether setting the camera exposure point is supported.

public abstract boolean isCameraExposurePointSupported();

Checks whether the current device supports setting an exposure point.

Limits

Only iOS and Android provide this interface.

Return value

• true: Setting the camera exposure point is supported.

• false: Setting the camera exposure point is not supported.

Sets the manual focus point for the camera.

public abstract int setCameraFocusPoint(float x, float y);

Sets the focus point of the current camera. After you call this method, the camera performs a one-time exposure adjustment on the set point and then maintains this focus value. Before you call this method, we recommend that you call isCameraFocusPointSupported to check whether the device supports the manual focus feature.

Limits

Only iOS and Android provide this interface.

Parameters

Return value

• 0: The method call succeeded.

• Non-zero: The method call failed.

Sets the camera exposure point.

public abstract int setCameraExposurePoint(float x, float y);

Sets the camera exposure point. After this method is called, the camera performs a one-time exposure adjustment on the set point and maintains this exposure value. Before calling this method, we recommend calling isCameraExposurePointSupported to check if the device supports the manual focus feature.

Limits

Only iOS and Android provide this interface.

Parameters

Return value

• 0: The method call succeeded.

• Non-zero: The method call failed.

Checks whether camera auto face focus is supported.

public abstract boolean isCameraAutoFocusFaceModeSupported();

Checks whether camera auto face focus is supported.

When to call

This is effective only after the camera is turned on. If the camera is not on when you call this, it returns false by default. If the camera is on and supports both facial recognition and focus functions, it returns true.

Limits

Only iOS and Android provide this interface.

Return value

• true: Auto face focus is supported.

• false: Auto face focus is not supported.

Sets camera face focus.

public abstract boolean setCameraAutoFocusFaceModeEnabled(boolean enable);

Call this method to set the camera to focus on faces in real time. Before calling this method, call isCameraAutoFocusFaceModeSupported to verify that the device supports this feature.

Limits

Only iOS and Android provide this interface.

Parameters

Return value

• true: The call succeeded.

• false: The call failed.

Sets the video mirroring capability for preview and ingest.

public abstract int setVideoMirrorMode(AliRtcVideoPipelineMirrorMode mirrorMode);

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

When to call

You can dynamically set this method before and after joining a channel. The SDK records the status and performs the video operation when it can operate on the preview and encoding (publishing).

Limits

This method overlaps with the mirrorMode in setLocalViewConfig&setVideoEncoderConfiguration. We recommend using only one method.

Parameters

Return value

• 0: Success.

• <0: Failure.

  • AliRtcErrInner: Internal SDK error. Check if the SDK instance was created successfully.

Sets the video capture scaling time.

public abstract void setCapturePipelineScaleMode(AliRtcCapturePipelineScaleMode mode);

Sets whether video data capture scaling occurs immediately upon capture or only during encoding. For example, when the capture resolution and encoding resolution are inconsistent, you can set the scaling time to determine whether the preview data and the published data are consistent.

When to call

Call this method before you turn on the camera, for example, before you start a preview with startPreview or join a channel with joinChannel.

Parameters

Return value

None.

Enables an external video input source.

public abstract void setExternalVideoSource(boolean enable,boolean useTexture,
 AliRtcVideoTrack streamType,AliRtcRenderMode renderMode);

Parameters

Inputs video data.

public abstract int pushExternalVideoFrame(AliRtcRawDataFrame aliRawDataFrame,AliRtcVideoTrack streameType);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Starts bypass live streaming.

public abstract int startPublishLiveStream(String streamUrl,AliRtcLiveTranscodingParam transcodingParam);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Updates bypass live streaming parameters.

public abstract int updatePublishLiveStream(String streamUrl,AliRtcLiveTranscodingParam transcodingParam);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Stops bypass live streaming.

public abstract int stopPublishLiveStream(String streamUrl);

Parameters

Return value

0 indicates the method call was successful. Any other value indicates a failure.

Gets the bypass live streaming status.

public abstract AliRtcEngine.AliRtcLiveTranscodingState getPublishLiveStreamState(String streamUrl);

Parameters

Return value

Returns the bypass live streaming status.

Starts a network quality probe.

public abstract int startNetworkQualityProbeTest(AlirtcNetworkQualityProbeConfig config);

Parameters

Return value

0: Success. Other: Failure.

Stops a network quality probe.

public abstract int stopNetworkQualityProbeTest();

Return value

0: Success. Other: Failure.

Sends a media extension message.

public abstract int sendMediaExtensionMsg(byte[]message, int repeatCount, int delay, boolean isKeyFrame);

The SDK provides the functionality to send and receive media extension messages. This method sends media extension messages using the SEI extension protocol. Receivers can obtain the messages by listening to onMediaExtensionMsgReceived.

Common scenarios include the following:

• Using media extension messages to transmit timestamps to calculate end-to-end network latency or to synchronize data with other business services.

• Using media extension messages to transmit descriptive information. Currently, up to 4 KB of data can be transmitted, which can be used to transfer small amounts of data. We recommend using JSON or plain strings.

When to call

Call this after you start publishing a stream.

Limits

When using media extension messages, the audio and video data channels are reused. Therefore, you must control the sending frequency and message data length. The limits are as follows:

• You can send a maximum of fps messages per second, as set in the profile. SEI information is transmitted in the H.264/H.265 stream, and extension information can only be attached when there is video frame encoding.

• To avoid affecting the quality of media data transmission, the custom message body is limited to 4 KB. It 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 will be sent multiple times.

• To prevent message loss due to network packet loss, other people in the channel will also receive the same message multiple times and need to remove duplicates.

• When custom messages are sent, subscribers in the channel will also receive them during bypass live streaming.

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

Related callbacks

After the publishing end sends a media extension message, the pulling end can get the message by listening to the onMediaExtensionMsgReceived callback.

Parameters

Return value

• 0: Success.

• <0: Failure. An error code is returned.

  • ERR_INNER(-1): Internal SDK error. The SDK may not have been initialized or was called after being destroyed.

Sends a media extension message.

public abstract int sendMediaExtensionMsgEx(byte[]message, int repeatCount, int delay, boolean isKeyFrame, int payloadType);

The SDK provides features to send and receive media extension messages. This method sends a media extension message using the SEI extension protocol. The receiver can obtain the message by listening to onMediaExtensionMsgReceived. When payloadType is 5, this is equivalent to using the sendMediaExtensionMsg method.

Common scenarios include the following:

• Using media extension messages to transmit timestamps to calculate end-to-end network latency or to synchronize data with other business services.

• Using media extension messages to transmit descriptive information. Currently, up to 4 KB of data can be transmitted, which can be used to transfer small amounts of data. We recommend using JSON or plain strings.

When to call

Call this after you start publishing a stream.

Limits

When using media extension messages, the audio and video data channels are reused. Therefore, you must control the sending frequency and message data length. The limits are as follows:

• You can send a maximum of fps messages per second, as set in the profile. SEI information is transmitted in the H.264/H.265 stream, and extension information can only be attached when there is video frame encoding.

• To avoid affecting the quality of media data transmission, the custom message body is limited to 4 KB. It 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 will be sent multiple times.

• To prevent message loss due to network packet loss, other people in the channel will also receive the same message multiple times and need to remove duplicates.

• When custom messages are sent, subscribers in the channel will also receive them during bypass live streaming.

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

Parameters

Return value

• 0: Success.

• <0: Failure. An error code is returned.

  • ERR_INNER(-1): Internal SDK error. The SDK may not have been initialized or was called after being destroyed.

Callback for network connection status changes. You need to handle this callback.

public void onConnectionStatusChange(AliRtcEngine.AliRtcConnectionStatus status,
 AliRtcEngine.AliRtcConnectionStatusChangeReason reason);

Parameters

Callback for local device exceptions. You need to handle this callback.

public void OnLocalDeviceException(AliRtcEngine.AliRtcEngineLocalDeviceType deviceType, AliRtcEngine.AliRtcEngineLocalDeviceExceptionType exceptionType, String msg)

Parameters

Notification that user authentication information is about to expire. Authentication expires 30 seconds after this callback is received. You need to handle this callback.

public void onAuthInfoWillExpire();

This callback indicates that the user's authentication information is about to expire. Authentication expires 30 seconds after this callback is received. You need to get a new token and then update the authentication information in one of the following ways:

• Call <a baseurl="t2309760_v6_4_1.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#975b9af9ecq1a" id="8099ac5a509hn">refreshAuthInfo</a> to update the authentication information.

• Call <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="fe88be037dy4g">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's authentication information expires. You should update the authentication information promptly after receiving this callback.

The server returns that the information has expired when the user calls an interface that requires authentication.

public void onAuthInfoExpired();

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

• Call <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="c3b0cf2f19dgm">leaveChannel</a> to leave the current channel, and then call joinChannel to rejoin the channel.

When triggered

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

Callback for the result of joining a channel.

public void onJoinChannelResult(int result, String channel, String userId, int elapsed);

Parameters

Callback for the result of leaving a channel.

public void onLeaveChannelResult(int result, AliRtcEngine.AliRtcStats stats);

Trigger condition

When the application successfully calls <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#fef395c4beqdt" id="7f3d2133c81tx">leaveChannel</a> to leave the channel, this callback is triggered and returns the result of leaving the channel and the statistics of this channel session.

Parameters

Callback for when a remote user goes offline.

public void onRemoteUserOffLineNotify(String uid, 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 condition

• The callback is triggered when a remote user actively leaves the channel.

• When a remote streamer calls <a baseurl="t2309760_v6_0_0.xdita" data-node="4086566" data-root="16090" data-tag="xref" href="#84f350f904s98" id="4c0adbe948tif">setClientRole</a> to switch to the viewer role (by calling AliRtcEngine#setClientRole to set the role to AliRTCSdkLive), a callback is triggered.

• The callback is triggered when no data is received from the remote streamer for a long time and the user is considered to have dropped.

Parameters

Callback for when a remote user comes online.

public void onRemoteUserOnLineNotify(String uid, int elapsed);

This method notifies the local client that a remote user has joined the channel.

Trigger condition

• A remote user successfully joins the channel.

• After the current user joins the channel, they receive a join callback for users already in the channel, which is used to display previously joined users.

Parameters