AliRtcEngine class

Gets the current version number of the SDK.

public static getSDKVersion(): string

Returns

A string representing the current SDK version number. For example, "7.10.0".

Sets H5 compatible mode.

public static setH5CompatibleMode(enable: boolean): void

Parameters

Parameter	Type	Description
enable	boolean	true: enables H5 compatible mode; false: enables traditional mode, incompatible with H5.

Checks whether the H5 compatible mode is enabled.

public static getH5CompatibleMode(): boolean

Returns

A boolean value: true for H5 compatible mode, false for traditional mode.

Sets the event listener to receive callbacks for engine events.

public setRtcEngineEventListener(listener: AliRtcEngineEventListener | null) : void

Parameters

Parameter	Type	Description
listener	AliRtcEngineEventListener | null	The event listener that receives callbacks from the engine. Pass null to unregister the current listener.

Gets the native layer instance handle.

public getNativeHandle() : number

Returns

number - The native layer's instance handle.

Sets the channel profile.

public setChannelProfile(channelProfile: AliRtcChannelProfile): number

Parameters

Parameter	Type	Description
channelProfile	AliRtcChannelProfile	Specifies the channel profile. See AliRtcChannelProfile for details.

Returns

0 indicates success, while a negative value indicates failure.

Sets the user role in a live streaming scenario.

public setClientRole(clientRole: AliRtcClientRole): number

Parameters

Parameter	Type	Description
clientRole	AliRtcClientRole	The user role. For details, see AliRtcClientRole.

Returns

Returns 0 on success or a negative value on failure.

Gets the current user role.

public getCurrentClientRole(): AliRtcClientRole

Returns

The current user role. For details, see AliRtcClientRole.

Allows a user to join a channel. Users in the same channel can call each other.

public joinChannel(authInfo: AliRtcEngineAuthInfo, userName: string) : number

Parameters

Parameter	Type	Description
authInfo	AliRtcEngineAuthInfo	Authentication information obtained from your App Server.
userName	string	A display name for the user. This is not the user ID.

Returns

A number, where 0 indicates success and a negative value indicates failure.

Joins a channel.

public joinChannelWithToken(token: string, channelId: string, userId: string, userName: string): number

Parameters

Parameter	Type	Description
token	string	The authentication token obtained from your app server.
channelId	string	The ID of the channel to join. This must match the channelId used to generate the token. This parameter is optional. If omitted, the channelId from the token is used by default.
userId	string	The user ID of the joining user. This must match the userId used to generate the token. This parameter is optional. If omitted, the userId from the token is used by default.
userName	string	The user's display name. This is not the user ID. This parameter is optional. If omitted, no user name is specified.

Returns

A number where 0 indicates success and a negative value indicates failure.

Joins a channel.

public joinChannelWithChannelParam(token: string,  channelParam: AliRtcSDKChannelParam) : number

Parameters

Parameter	Type	Description
token	string	Authentication information from your application server.
channelParam	AliRtcSDKChannelParam	The channel parameters. For details, see AliRtcSDKChannelParam.

Returns

A number: 0 indicates success, and a negative value indicates failure.

Joins an AI channel.

public joinAIChannel(token: string, channelParam: AliRtcSDKChannelParam, agentParam: AliRtcSDKAIAgentParam) : number

Parameters

Parameter	Type	Description
token	string	Authentication information from your App Server.
channelParam	AliRtcSDKChannelParam	The channel parameters. See AliRtcSDKChannelParam for details.
agentParam	AliRtcSDKAIAgentParam	The parameters for the AI agent. See AliRtcSDKAIAgentParam for details.

Returns

Returns 0 on success, or a negative value on failure.

Leaves the channel, ending the call.

public leaveChannel(): number

Returns

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

Retrieves the current network connection status.

public getCurrentConnectionStatus(): AliRtcConnectionStatus

Returns

An AliRtcConnectionStatus enum value representing the current connection status.

Checks if the user is in a channel.

public isInCall(): boolean

Returns

true if the user is in a channel; false otherwise.

Refreshes the authentication information.

public refreshAuthInfo(authInfo: AliRtcEngineAuthInfo): number

Parameters

Parameter	Type	Description
authInfo	AliRtcEngineAuthInfo	The authentication information.

Return value

0: Success. A negative value: Failure.

Refreshes authentication information.

public refreshAuthInfoWithToken(token: string): number

Parameters

Parameter	Type	Description
token	string	The authentication token. The channelid and userid must match those used when joining the channel.

Returns

Returns 0 on success, or a value less than 0 on failure.

Checks if the session is in audio-only mode.

public isAudioOnlyMode(): boolean

Return value

true if the session is in audio-only mode; false otherwise.

Enables or disables local video stream publishing.

public publishLocalVideoStream(enabled: boolean): number

Parameters

Parameter	Type	Description
enabled	boolean	Specifies whether to publish the local video stream: true to publish, false to stop.

Returns

Returns 0 on success, or a negative error code on failure.

Checks if the local video stream is published.

public isLocalVideoStreamPublished(): boolean

Returns

true if the local video stream is published; false otherwise.

Publishes or unpublishes the secondary video stream.

public publishLocalDualVideoStream(enable: boolean): number

Parameters

Parameter	Type	Description
enable	boolean	Whether to publish the secondary video stream. true: Publishes the secondary video stream. false: Stops publishing the secondary video stream.

Return value

number - 0 indicates a successful call. A negative value indicates an error code.

Checks if the secondary video stream is published.

public isLocalDualVideoStreamPublished(): boolean

returns

boolean - true if the secondary video stream is published; false otherwise.

Publishes or unpublishes the local audio stream.

public publishLocalAudioStream(enabled: boolean): number

Parameters

Parameter	Type	Description
enabled	boolean	Set to true to publish the local audio stream, or false to unpublish it.

Returns

number - 0 indicates that the method call was successful. A negative value indicates a failure, where the value is the error code.

Checks whether the local audio stream is published.

public isLocalAudioStreamPublished(): boolean

Returns

boolean - true indicates that the local audio stream is published; false otherwise.

Publishes or unpublishes the secondary audio stream.

public publishLocalDualAudioStream(enabled: boolean): number

Parameters

Parameter	Type	Description
enabled	boolean	Whether to publish the secondary audio stream.

Returns

A number. 0 indicates the method call succeeded. A negative value is an error code.

Checks if the second audio stream is published.

public isLocalDualAudioStreamPublished(): boolean

Returns

boolean - true if the second audio stream is published; false otherwise.

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

public setDefaultSubscribeAllRemoteAudioStreams(sub: boolean): number

Parameters

Parameter	Type	Description
sub	boolean	true: Subscribes to all remote audio streams. false: Does not subscribe to any remote audio streams.

Returns

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

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

public setDefaultSubscribeAllRemoteVideoStreams(sub: boolean): number

Parameters

Parameter	Type	Description
sub	boolean	Specifies whether to subscribe to all remote video streams by default.

Returns

number - 0 on success; a value less than 0 on failure.

Sets the video stream type (high stream or low stream) to receive from a remote user.

public setRemoteVideoStreamType(uid: string, streamType: AliRtcVideoStreamType): number

Parameters

Parameter	Type	Description
uid	string	The ID of the remote user.
streamType	AliRtcVideoStreamType	The video stream type to receive. For details, see AliRtcVideoStreamType.

Return value

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

Sets the default video stream type for subscriptions to either the high stream or the low stream.

public setRemoteDefaultVideoStreamType(streamType: AliRtcVideoStreamType): number

Parameters

Parameter	Type	Description
streamType	AliRtcVideoStreamType	The default video stream type to subscribe to.

Returns

0 indicates success; any other value indicates failure.

Subscribes to or unsubscribes from all remote audio streams.

public subscribeAllRemoteAudioStreams(sub: boolean): number

Parameters

Parameter	Type	Description
sub	boolean	true: Subscribes to all remote audio streams. false: Unsubscribes from all remote audio streams.

Return value

A number where 0 indicates success and a non-zero value indicates failure.

Subscribes to or unsubscribes from all remote dual audio streams.

public subscribeAllRemoteDualAudioStreams(sub: boolean): number

Parameters

Parameter	Type	Description
sub	boolean	Whether to subscribe to all remote dual audio streams.

Returns

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

Subscribes to or unsubscribes from all remote video streams.

public subscribeAllRemoteVideoStreams(sub: boolean): number

Parameters

Parameter	Type	Description
sub	boolean	true: Subscribes to remote video streams from all users. false: Unsubscribes from remote video streams from all users.

Returns

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

Subscribes to or unsubscribes from a remote user's microphone audio stream.

public subscribeRemoteAudioStream(uid: string, sub: boolean): number

Parameters

Parameter	Type	Description
uid	string	The ID of the remote user.
sub	boolean	Sets the subscription state for the user's audio stream. Set to true to subscribe or false to unsubscribe.

Returns

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

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

public subscribeRemoteAudioStreamByTrack(uid: string, track: AliRtcAudioTrack, sub: boolean): number

Parameters

Parameter	Type	Description
uid	string	The remote user ID.
track	AliRtcAudioTrack	The audio stream type. AliRtcAudioTrackNo: An invalid parameter. This value is ignored. AliRtcAudioTrackMic: The microphone stream. AliRtcAudioTrackDual: The second audio stream. AliRtcAudioTrackBoth: Both the microphone stream and the second audio stream.
sub	boolean	Specifies whether to subscribe to the remote user's audio stream. true: Subscribe to the stream. false: Unsubscribe from the stream.

Returns

A number where 0 indicates success and a non-zero value indicates failure.

Subscribes to or unsubscribes from a remote video stream.

public subscribeRemoteVideoStream(uid: string, track: AliRtcVideoTrack, sub: boolean): number

Parameters

Parameter	Type	Description
uid	string	The ID of the remote user.
track	AliRtcVideoTrack	The video track to subscribe to.
sub	boolean	Sets whether to subscribe to the stream.

Returns

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

Stops or resumes a subscription to a remote audio/video stream.

public subscribeRemoteMediaStream(uid: string, videoTrack: AliRtcVideoTrack, subVideo: boolean, audioTrack: AliRtcAudioTrack, subAudio: boolean): number

Parameters

Parameter	Type	Description
uid	string	The remote user ID.
videoTrack	AliRtcVideoTrack	The type of the remote video stream.
subVideo	boolean	Set to true to subscribe to the video stream, or false to unsubscribe.
audioTrack	AliRtcAudioTrack	The type of the remote audio stream.
subAudio	boolean	Set to true to subscribe to the audio stream, or false to unsubscribe.

Returns

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

Subscribes to a stream from a specified remote user in the target channel.

public subscribeRemoteDestChannelStream(channelId: string, uid: string, videoTrack: AliRtcVideoTrack, audioTrack: AliRtcAudioTrack, sub: boolean): number

Parameters

Parameter	Type	Description
channelId	string	The ID of the target channel.
uid	string	The ID of the remote user.
videoTrack	AliRtcVideoTrack	The type of video track. Use AliRtcVideoTrackNo to unsubscribe from all video tracks; this action ignores the sub parameter. Other options are AliRtcVideoTrackCamera for the camera track, AliRtcVideoTrackScreen for the screen sharing track, and AliRtcVideoTrackBoth for both tracks.
audioTrack	AliRtcAudioTrack	The type of audio track. Use AliRtcAudioTrackNo to unsubscribe from all audio tracks; this action ignores the sub parameter. Other options are AliRtcAudioTrackMic for the microphone track, AliRtcAudioTrackDual for the dual audio track, and AliRtcAudioTrackBoth for both tracks.
sub	boolean	true: Subscribe to the specified track(s). false: Unsubscribe from the specified track(s).

Returns

A number. 0 indicates the call was successful, while a non-zero value indicates failure.

Sets the audio profile and audio scenario.

public setAudioProfile(profile: AliRtcAudioProfile, scenario: AliRtcAudioScenario): number

Parameters

Parameter	Type	Description
profile	AliRtcAudioProfile	The audio profile, which specifies the audio capture and encoding mode. For details, see AliRtcAudioProfile.
scenario	AliRtcAudioScenario	The audio scenario. For details, see AliRtcAudioScenario.

Returns

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

Sets the audio capability.

public SetAudioCapability(ability: AliRtcAudioCapability): number

Parameters

Parameter	Type	Description
ability	AliRtcAudioCapability	The audio capability to set.

Returns

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

Starts audio capture.

public startAudioCapture(): number

Returns

0 on success; a non-zero value indicates an error code.

Stops audio capture.

public stopAudioCapture(): number

Return value

Returns 0 on success or an error code on failure.

Starts the audio player.

public startAudioPlayer(): number

Return value

Returns 0 for success or a non-zero error code.

Stops audio playback.

public stopAudioPlayer(): number

Returns

0 indicates success; a non-zero value is an error code.

Mutes or unmutes the local audio stream.

public muteLocalMic(mute: boolean, mode:  AliRtcMuteLocalAudioMode): number

Parameters

Parameter	Type	Description
mute	boolean	Specifies whether to mute the local audio stream. true mutes the stream by sending silent frames; false unmutes it.
mode	AliRtcMuteLocalAudioMode	Specifies the mute mode. By default, the local microphone and all external audio inputs are muted.

Returns

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

Sets the recording volume.

public setRecordingVolume(volume: number): number

Parameters

Parameter	Type	Description
volume	number	The recording volume. The valid range is [0, 400]. A value of 0 mutes the audio. Values greater than 100 amplify the volume, while values less than 100 reduce it.

Returns

number: 0 for success; a non-zero value for failure.

Sets the playout volume.

public setPlayOutVolume(volume: number): number

Parameters

Parameter	Type	Description
volume	number	The playout volume. The valid range is [0, 400], where 100 represents the original volume. A value of 0 mutes the audio. Values greater than 100 amplify the volume, and values less than 100 attenuate it.

Returns

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

Sets whether to route audio to the speakerphone by default.

public setDefaultAudioRouteToSpeakerphone(defaultToSpeakerphone: boolean): number

Parameters

Parameter	Type	Description
defaultToSpeakerphone	boolean	true: speakerphone mode (default). false: earpiece mode.

Returns

number - 0 on success; a negative value on failure.

Switches the audio output between the earpiece and the speakerphone.

public enableSpeakerphone(enable: boolean): number

Parameters

Parameter	Type	Description
enable	boolean	true for speakerphone mode; false for earpiece mode (default).

Returns

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

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

public isSpeakerOn(): boolean

Returns

true if the audio output is the speaker; false otherwise.

Adjusts the playback volume of a specified remote user.

public setRemoteAudioVolume(uid: string, volume: number): number

Parameters

Parameter	Type	Description
uid	string	The remote user ID.
volume	number	The playback volume. The value ranges from 0 to 100, where 0 is mute and 100 is the original volume.

Returns

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

Stops or resumes playing a specified remote user's audio stream.

public muteRemoteAudioPlaying(uid: string, mute: boolean): number

Parameters

Parameter	Type	Description
uid	string	The remote user ID.
mute	boolean	Specifies whether to stop or resume playing the audio stream.

Returns

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

Mutes or unmutes all remote audio streams.

public muteAllRemoteAudioPlaying(mute: boolean): number

Parameters

Parameter	Type	Description
mute	boolean	Specifies whether to mute (true) or unmute (false) all remote audio streams.

Return value

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

Enables audio volume indication and sets the interval and smoothing factor for the volume callback.

public enableAudioVolumeIndication(interval: number, smooth: number, reportVad: number): number

Parameters

Parameter	Type	Description
interval	number	The time interval in milliseconds (ms) for the volume callback. The minimum value is 10 ms. The recommended range is 300–500 ms. A value of 0 or less disables both volume indication and speaker indication.
smooth	number	The smoothing factor. A larger value results in a smoother but less responsive volume indication. The value range is [0, 9]. The recommended value is 3.
reportVad	number	Specifies whether to enable voice activity detection. 1: Enable. 0: Disable.

Returns

0 indicates success, and a negative value indicates failure.

Enables in-ear monitoring.

public enableEarBack(enable: boolean): number

Parameters

Parameter	Type	Description
enable	boolean	Set to true to enable in-ear monitoring, or false (the default) to disable it.

Returns

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

Sets the ear back volume.

public setEarBackVolume(volume: number): number

Parameters

Parameter	Type	Description
volume	number	The volume level. The value must be within the range [0, 100], and the default is 100.

Returns

Returns a number, where 0 indicates success and any non-zero value indicates failure.

Tests the audio capture device before a call.

public startAudioCaptureTest(): number

Returns

A number is returned, where 0 indicates success and any non-zero value indicates failure.

Stops the audio capture test.

public stopAudioCaptureTest(): number

Returns

0 indicates success; a non-zero value indicates an error code.

Plays an audio file for testing.

public playAudioFileTest(filePath: string): number

Parameters

Parameter	Type	Description
filePath	string	The path to the audio file.

Returns

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

Stops the audio file playback test.

public stopAudioFileTest(): number

Returns

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

Sets the local preview view.

public setLocalViewConfig(canvas: AliRtcVideoCanvas, xComponentController: AliRtcXComponentController | null, track: AliRtcVideoTrack): number

Parameters

Parameter	Type	Description
canvas	AliRtcVideoCanvas	The properties for displaying the local video.
xComponentController	AliRtcXComponentController | null	The controller bound to the XComponent view.
track	AliRtcVideoTrack	The video track.

Starts the local video preview.

public startPreview(): number

Returns

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

Stops the local video preview.

public stopPreview(): number

Returns

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

Sets the camera capture configuration.

public setCameraCaptureConfiguration(cameraCaptureConfiguration: AliRtcCameraCaptureConfiguration): number

Parameters

Parameter	Type	Description
cameraCaptureConfiguration	AliRtcCameraCaptureConfiguration	The camera capture configuration includes the preference and cameraDirection properties. The preference property sets the capture preference: AliRtcCaptureOutputPreferencePreview enables high-definition preview and prioritizes preview quality; AliRtcCaptureOutputPreferencePerformance selects a capture resolution closest to the stream publishing resolution to prioritize device performance; AliRtcCaptureOutputPreferenceAuto automatically adjusts the capture resolution. The cameraDirection property sets the camera direction to either front or rear.

Returns

Returns a number where 0 indicates success and a non-zero value indicates failure.

Enables or disables local video capture.

public enableLocalVideo(enabled: boolean): number

Parameters

Parameter	Type	Description
enabled	boolean	Whether to enable local video capture. true: Enables local video capture. false: Disables local video capture.

Return value

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

Enables or disables local camera capture.

public enableVideoCapture(enabled: boolean): number

Parameters

Parameter	Type	Description
enabled	boolean	Set to true to enable local camera capture, or false to disable it.

Returns

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

Stops or resumes sending the local video stream.

public muteLocalCamera(mute: boolean, track: AliRtcVideoTrack): number

Parameters

Parameter	Type	Description
mute	boolean	Whether to mute the video stream. true: Mutes the stream by sending black frames. false: Unmutes the stream and resumes normal video transmission.
track	AliRtcVideoTrack	The video track to mute. Only AliRtcVideoTrackCamera is supported.

Return value

A number where 0 indicates success and a non-zero value indicates failure.

Checks if the camera is on.

public isCameraOn(): boolean

Return value

true if the camera is on; false if it is off.

Stops or resumes rendering all remote video tracks.

public muteAllRemoteVideoRendering(mute: boolean): number

Parameters

Parameter	Type	Description
mute	boolean	true: Stop rendering. Remote videos are displayed as a black frame. false: Resume rendering.

Returns

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

Sets the video encoder configuration for the camera stream.

public setVideoEncoderConfiguration(config: AliRtcVideoEncoderConfiguration): number

Parameters

Parameter	Type	Description
config	AliRtcVideoEncoderConfiguration	The predefined video encoder configuration. For details, see AliRtcVideoEncoderConfiguration.

Return value

0 indicates success; a negative value indicates failure.

Sets the video decoder configuration for the camera stream.

public setVideoDecoderConfiguration(config: AliRtcVideoDecoderConfiguration): void

Parameters

Parameter	Type	Description
config	AliRtcVideoDecoderConfiguration	The video decoder configuration. For details, see AliRtcVideoDecoderConfiguration.

Sets the mirror mode for the video preview and the published stream.

public setVideoMirrorMode(mirrorMode: AliRtcVideoPipelineMirrorMode): number

Parameters

Parameter	Type	Description
mirrorMode	AliRtcVideoPipelineMirrorMode	The mirror mode to apply.

Returns

number - 0 on success; a negative value on failure.

Sets whether to scale video data immediately after capture or during encoding.

public setCapturePipelineScaleMode(mode: AliRtcCapturePipelineScaleMode): void

Parameters

Parameter	Type	Description
mode	AliRtcCapturePipelineScaleMode	Specifies when scaling occurs in the capture pipeline. By default, scaling is applied immediately after capture.

Configures the remote video view.

public setRemoteViewConfig(canvas: AliRtcVideoCanvas, xComponentController: AliRtcXComponentController | null, uid: string, track: AliRtcVideoTrack): number

Parameters

Parameter	Type	Description
canvas	AliRtcVideoCanvas	The canvas object for rendering the remote video.
xComponentController	AliRtcXComponentController | null	The controller bound to the XComponent view.
uid	string	The remote user ID.
track	AliRtcVideoTrack	The video track type. Only AliRtcVideoTrackCamera and AliRtcVideoTrackScreen are supported.

Returns

Returns 0 for success or a negative value for failure.

Switches between the front and rear cameras.

public switchCamera(): number

Return value

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

Gets the current camera direction (front or back).

public getCurrentCameraDirection(): AliRtcCameraDirection

Return value

The camera direction as an AliRtcCameraDirection enum.

Sets the camera zoom ratio.

public setCameraZoom(zoom: number): number

Parameters

Parameter	Type	Description
zoom	number	The camera zoom ratio.

Returns

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

Gets the maximum zoom factor of the camera.

public getCameraMaxZoomFactor(): number

Return value

number - The maximum zoom factor of the camera.

Returns the camera zoom ratio.

public getCurrentZoom(): number

Returns

number - The camera zoom ratio.

Sets the camera exposure.

public setExposure(exposure: number): number

Parameters

Parameter	Type	Description
exposure	number	The exposure value.

Returns

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

Gets the current camera exposure.

public getCurrentExposure(): number

Returns

number - The current camera exposure.

Gets the minimum exposure of the camera.

public getMinExposure(): number

Returns

number - The minimum exposure.

Gets the maximum camera exposure.

public getMaxExposure(): number

Returns

number - The maximum exposure.

Enables or disables the camera flash.

public setCameraFlash(flash: boolean): number

Parameters

Parameter	Type	Description
flash	boolean	Whether to enable the camera flash. true: Enable the flash. false: Disable the flash.

Return value

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

Checks if the camera supports manual focus.

public isCameraFocusPointSupported(): boolean

Return value

A boolean value: true if the camera supports manual focus; false otherwise.

Checks whether the camera supports setting an exposure point.

public isCameraExposurePointSupported(): boolean

Returns

true if the camera supports setting an exposure point; false otherwise.

Sets the manual focus point for the camera.

public setCameraFocusPoint(x: number, y: number): number

Parameters

Parameter	Type	Description
x	number	The x-coordinate of the focus point.
y	number	The y-coordinate of the focus point.

Returns

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

Sets the camera exposure point.

public setCameraExposurePoint(x: number, y: number): number

Parameters

Parameter	Type	Description
x	number	The x-coordinate of the exposure point.
y	number	The y-coordinate of the exposure point.

Returns

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

Gets the video codec type.

public getVideoCodecType(codeKind: AliRtcVideoCodecKindType): AliRtcVideoFormat

Parameters

Parameter	Type	Description
codeKind	AliRtcVideoCodecKindType	Specifies whether the operation is for encoding or decoding.

Returns

An AliRtcVideoFormat enum representing the video codec type.

Gets the current encoder type. Returns an invalid type if stream publishing has not started.

public getCurrentEncoderManufacturer(track: AliRtcVideoTrack): AliRtcVideoCodecManufacturer

Parameters

Parameter	Type	Description
track	AliRtcVideoTrack	The video track.

Return value

An AliRtcVideoCodecManufacturer enum representing the encoder type.

Takes a snapshot of a video stream.

public snapshotVideo(userId: string, trackType: AliRtcVideoTrack): number

Parameters

Parameter	Type	Description
userId	string	The user ID. To specify the local user, pass an empty string ("").
trackType	AliRtcVideoTrack	The video stream type. Valid values are AliRtcVideoTrackCamera and AliRtcVideoTrackScreen.

Returns

Returns 0 if the method call is successful, or a value less than 0 if the call fails. A successful call only indicates that the request was initiated. The result of the snapshot operation is returned in the AliRtcEngineEventListener#onSnapshotCompleted callback.

Sets the encoder configuration for the screen share.

public setScreenShareEncoderConfiguration(config: AliRtcScreenShareEncoderConfiguration): number

Parameters

Parameter	Type	Description
config	AliRtcScreenShareEncoderConfiguration	The screen share encoder configuration.

Starts screen sharing.

public startScreenShare(mode: AliRtcScreenShareMode): number

Parameters

Parameter	Type	Description
mode	AliRtcScreenShareMode	Specifies the screen sharing mode.

Stops screen sharing.

public stopScreenShare(): number

Returns

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

Checks if the screen sharing stream is published.

public isScreenSharePublished(): boolean

Returns

boolean - true: Published; false: Not published.

Registers an audio data callback.

public registerAudioFrameObserver(observer: AliRtcEngineAudioFrameListener | null): void

Parameters

Parameter	Type	Description
observer	AliRtcEngineAudioFrameListener | null	The observer for audio data callbacks. Pass null to stop receiving callbacks.

Subscribes to raw audio data.

public enableAudioFrameObserver(enable: boolean, audioSource: AliRtcAudioSource, config: AliRtcAudioFrameObserverConfig | null): number

Parameters

Parameter	Type	Description
enable	boolean	Specifies whether to enable the data callback. true: Enable. false: Disable.
audioSource	AliRtcAudioSource	The raw audio data source. For details, see AliRtcAudioSource.
config	AliRtcAudioFrameObserverConfig | null	The configuration for the callback. For details, see AliRtcAudioFrameObserverConfig. If set to null, the SDK applies the default settings: a 48,000 Hz sample rate, a single channel, and read-only mode.

Returns

A number. 0 indicates success.

Adds an external audio stream.

public addExternalAudioStream(config: AliRtcExternalAudioStreamConfig): number

Parameters

Parameter	Type	Description
config	AliRtcExternalAudioStreamConfig	The external audio stream configuration. For details, see AliRtcExternalAudioStreamConfig.

Returns

A number. A value greater than 0 indicates success and is the external audio stream ID. A value less than 0 indicates failure.

Pushes external audio data.

public pushExternalAudioStreamRawData(streamId: number, audioFrame: AliRtcAudioFrame): number

Parameters

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

Returns

A number. 0 indicates success; a value less than 0 indicates failure. If the method returns AliRtcErrorCode.ERR_SDK_AUDIO_INPUT_BUFFER_FULL, you must wait for a period equal to the data submission interval before resubmitting the data frame.

Sets the playout volume for an external audio stream.

public setExternalAudioStreamPlayoutVolume(streamId: number, volume: number): number

Parameters

Parameter	Type	Description
streamId	number	The external audio stream ID.
volume	number	The playout volume. The valid range is [0, 100].

Returns

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

Gets the playout volume of the external audio stream.

public getExternalAudioStreamPlayoutVolume(streamId: number): number

Parameters

Parameter	Type	Description
streamId	number	The external audio stream ID.

Returns

The playout volume (0–100). A negative value indicates failure.

Sets the publish volume for an external audio stream.

public setExternalAudioStreamPublishVolume(streamId: number, volume: number): number

Parameters

Parameter	Type	Description
streamId	number	The external audio stream ID.
volume	number	The volume level, ranging from 0 to 100.

Returns

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

Gets the publish volume for an external audio stream.

public getExternalAudioStreamPublishVolume(streamId: number): number

Parameters

Parameter	Type	Description
streamId	number	The external audio stream ID.

Returns

The publish volume, a number in the range [0, 100]. A negative value indicates failure.

Removes an external audio stream.

public removeExternalAudioStream(streamId: number): number

Parameters

Parameter	Type	Description
streamId	number	The external audio stream ID.

Returns

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

Enables an external video source.

setExternalVideoSource(enable: boolean, streamType: AliRtcVideoTrack, renderMode: AliRtcRenderMode): void

Parameters

Parameter	Type	Description
enable	boolean	Controls whether to enable the external video source. Set this to true to enable it, or false to disable it.
streamType	AliRtcVideoTrack	AliRtcVideoTrackCamera: The external video is sent through the camera stream channel. If camera capture is active, setting enable to true replaces the camera stream with the external source. AliRtcVideoTrackScreen: The external video is sent through the screen stream channel. If screen sharing is active, setting enable to true replaces the screen stream with the external source.
renderMode	AliRtcRenderMode	The render mode to use when the source video's aspect ratio differs from that of the publishing profile. For details, see AliRtcRenderMode. AliRtcRenderModeAuto (Default): Maintains the source video's aspect ratio, scaling it to fit within the publishing dimensions. Note that to preserve the original aspect ratio and content integrity, the actual publishing resolution may differ from the configured resolution. AliRtcRenderModeStretch: Stretches the input video to match the publishing dimensions, which may cause image distortion. AliRtcRenderModeFill: Preserves the aspect ratio by scaling the video to fit the publishing dimensions and adding black bars (letterboxing). AliRtcRenderModeCrop: Crops the video to match the publishing aspect ratio, which may remove parts of the original content.

Return value

This method does not return a value.

Pushes an external video frame.

pushExternalVideoFrame(videoFrame: AliRtcVideoFrame, streamType: AliRtcVideoTrack): number

Parameters

Parameter	Type	Description
videoFrame	AliRtcVideoFrame	The video frame to push. For details, see AliRtcVideoFrame.
streamType	AliRtcVideoTrack	The stream type. For details, see AliRtcVideoTrack. Use AliRtcVideoTrackCamera for the camera stream or AliRtcVideoTrackScreen for the screen stream.

Returns

A number. 0 indicates success. A non-zero value indicates failure.

Inputs external video data.

setExternalImageData(rawData: AliRtcVideoFrame, streamType: AliRtcVideoTrack): number

Parameters

Parameter	Type	Description
rawData	AliRtcVideoFrame	The frame data. See AliRtcVideoFrame for details.
streamType	AliRtcVideoTrack	The stream type. For details, see AliRtcVideoTrack. Set this to AliRtcVideoTrackCamera to send data through the camera stream channel, or AliRtcVideoTrackScreen to send data through the screen stream channel.

Returns

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

Sets the pitch of the audio effect.

public setAudioEffectPitchValue(value: number): number

Parameters

Parameter	Type	Description
value	number	The pitch, ranging from 0.5 to 2.0. The default value is 1.0, which means no change to the pitch. Values less than 1.0 lower the pitch, and values greater than 1.0 raise the pitch.

Returns

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

Sets the voice changer mode.

public setAudioEffectVoiceChangerMode(mode: AliRtcAudioEffectVoiceChangerMode): number

Parameters

Parameter	Type	Description
mode	AliRtcAudioEffectVoiceChangerMode	Specifies the voice changer mode. For supported values, see AliRtcAudioEffectVoiceChangerMode.

Returns

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

Sets the audio effect reverb mode.

public setAudioEffectReverbMode(mode: AliRtcAudioEffectReverbMode): number

Parameters

Parameter	Type	Description
mode	AliRtcAudioEffectReverbMode	The reverb mode. See AliRtcAudioEffectReverbMode for available modes.

Returns

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

Sets the audio effect beautify mode.

public setAudioEffectBeautifyMode(mode: AliRtcAudioEffectBeautifyMode): number

Parameters

Parameter	Type	Description
mode	AliRtcAudioEffectBeautifyMode	The audio effect beautify mode. For supported values, see AliRtcAudioEffectBeautifyMode.

Returns

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

Sets the reverb effect type.

public setAudioEffectReverbParamType(type: AliRtcAudioEffectReverbParamType, value: number): number

Parameters

Parameter	Type	Description
type	AliRtcAudioEffectReverbParamType	The reverb effect type. See AliRtcAudioEffectReverbParamType for details.
value	number	The reverb parameter value. See AliRtcAudioEffectReverbParamType for the value range of each reverb effect type.

Returns

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

Sets the gain for a specific band of the audio equalizer.

public setAudioEffectEqualizationParam(bandIndex: AliRtcAudioEffectEqualizationBandFrequency, gain: number): number

Parameters

Parameter	Type	Description
bandIndex	AliRtcAudioEffectEqualizationBandFrequency	The band index. Value range: [0, 9]. Center frequencies: [31, 62, 125, 250, 500, 1000, 2000, 4000, 8000, 16000] Hz.
gain	number	The gain in decibels (dB). Value range: [-15, 15]. Default: 0.

Returns

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

Starts audio accompaniment mixing.

public startAudioAccompany(fileName: string, config: AliRtcAudioAccompanyConfig): number

Parameters

Parameter	Type	Description
fileName	string	Path to the accompaniment file.
config	AliRtcAudioAccompanyConfig	Configuration for accompaniment playback.

Return value

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

Stops accompaniment mixing.

public stopAudioAccompany(): number

Returns

0 indicates success; a non-zero value is an error code.

Sets the audio accompaniment volume.

public setAudioAccompanyVolume(volume: number): number

Parameters

Parameter	Type	Description
volume	number	The audio accompaniment volume. The value ranges from 0 to 100.

Return value

0 indicates success, and a non-zero value indicates an error code.

Sets the publish volume of the audio accompaniment.

public setAudioAccompanyPublishVolume(volume: number): number

Parameters

Parameter	Type	Description
volume	number	The publish volume of the audio accompaniment. The value range is [0, 100].

Returns

number - 0 indicates success; a non-zero value is an error code.

Gets the publishing volume of the audio accompaniment.

public getAudioAccompanyPublishVolume(): number

Returns

Returns the publishing volume (0-100) on success, or an error code on failure.

Sets the local playback volume of audio accompaniment.

public setAudioAccompanyPlayOutVolume(volume: number): number

Parameters

Parameter	Type	Description
volume	number	The local playback volume of audio accompaniment. The value range is [0, 100].

Returns

number, where 0 indicates success and a non-zero value is an error code.

Gets the local playback volume of the accompaniment.

public getAudioAccompanyPlayOutVolume(): number

Returns

A number indicating the local playback volume. A value in the range of [0, 100] indicates success; any other value is an error code.

Pauses the audio accompaniment.

public pauseAudioAccompany(): number

Return value

0 for success; a non-zero value indicates an error code.

Resumes the audio accompaniment.

public resumeAudioAccompany(): number

Return value

0 means success. Any other value is an error code.

Returns the duration of the accompaniment file in milliseconds.

public getAudioAccompanyDuration(): number

Return value

A non-negative value indicates the duration of the accompaniment file; a negative value is an error code.

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

public getAudioAccompanyCurrentPosition(): number

Returns

The return value is a number. ≥0: The current playback position. <0: An error code.

Sets the playback position of the accompaniment file.

public setAudioAccompanyPosition(pos: number): number

Parameters

Parameter	Type	Description
pos	number	Playback position in milliseconds.

Returns

Returns 0 for success; any non-zero value indicates an error code.

Preloads an audio effect file.

public preloadAudioEffect(soundId: number, filePath: string): number

Parameters

Parameter	Type	Description
soundId	number	The ID you assign to the audio effect file.
filePath	string	The path to the audio effect file. You can specify a local file path or a network URL.

Return value

A number. 0 indicates success, and any non-zero value indicates failure.

Unloads a preloaded audio effect file.

public unloadAudioEffect(soundId: number): number

Parameters

Parameter	Type	Description
soundId	number	The unique ID you assigned to the audio effect file.

Returns

A number: 0 for success, or a non-zero value for failure.

Plays an audio effect.

public playAudioEffect(soundId: number, filePath: string, config: AliRtcAudioEffectConfig): number

Parameters

Parameter	Type	Description
soundId	number	The unique ID of the audio effect file. This ID must be unique for each effect. If you preloaded the audio effect using preloadAudioEffect, this soundId must match the ID used in that call.
filePath	string	The audio effect file path. This can be a local file or a network URL.
config	AliRtcAudioEffectConfig	The audio effect playback configuration.

Returns

0 indicates success. Any other value indicates failure.

Pauses the specified audio effect.

public pauseAudioEffect(soundId: number):number

Parameters

Parameter	Type	Description
soundId	number	The ID of the audio effect.

Return value

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

Pauses all audio effects.

public pauseAllAudioEffects(): number

Return description

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

Resumes the specified audio effect.

public resumeAudioEffect(soundId: number): number

Parameters

Parameter	Type	Description
soundId	number	The ID of the audio effect.

Returns

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

Resumes all paused audio effects.

public resumeAllAudioEffects (): number

Returns

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

Stops playing an audio effect.

public stopAudioEffect(soundId: number): number

Parameters

Parameter	Type	Description
soundId	number	The unique ID of the audio effect file. If you preloaded the audio effect file using preloadAudioEffect, this soundId must match the one provided in that call.

Returns

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

Stops all audio effects.

public stopAllAudioEffects(): number

Returns

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

Sets the publishing volume of a specified audio effect.

public setAudioEffectPublishVolume(soundId: number, volume: number): number

Parameters

Parameter	Type	Description
soundId	number	The ID you assign to the audio effect.
volume	number	The publishing volume of the audio effect. The value ranges from 0 to 100, and the default is 50.

Returns

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

Gets the publishing volume of a specified sound effect.

public getAudioEffectPublishVolume(soundId: number): number

Parameters

Parameter	Type	Description
soundId	number	The ID you assign to the sound effect file.

Return value

A number representing the publishing volume for the sound effect. The valid range is [0, 100]. A value outside this range indicates an error.

Sets the local playout volume of an audio effect.

public setAudioEffectPlayOutVolume(soundId: number, volume: number): number

Parameters

Parameter	Type	Description
soundId	number	The ID of the audio effect.
volume	number	The local playout volume of the audio effect. The value ranges from 0 to 100. The default value is 50.

Returns

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

Retrieves the local playout volume of an audio effect.

public getAudioEffectPlayOutVolume(soundId: number): number

Parameters

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

Return value

number - The local playout volume, with a range of 0 to 100. Any other value indicates an error.

Sets the publish volume for all sound effects.

public setAllAudioEffectsPublishVolume(volume: number): number

Parameters

Parameter	Type	Description
volume	number	The publish volume for all sound effects. The value ranges from 0 to 100. The default value is 50.

Returns

Sets the local playout volume for all audio effects.

public setAllAudioEffectsPlayoutVolume(soundId: number): number

Parameters

Parameter	Type	Description
soundId	number	The local playout volume. The value ranges from 0 to 100, and the default is 50.

Returns

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

Enables or disables the SEI video stream. If enabled, the stream uses a 16x16 black frame at 20 fps.

public enableSEIVideoStream(enabled: boolean): number

Parameters

Parameter	Type	Description
enabled	boolean	Whether to enable the SEI video stream. true: Enable. false: Disable.

Return value

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

Sends a media extension message.

public sendMediaExtensionMsg(message: ArrayBuffer, repeatCount: number, delay: number, isKeyFrame: boolean): number

Parameters

Parameter	Type	Description
message	ArrayBuffer	The media extension message. The maximum size is 4 KB.
repeatCount	number	Specifies how many times to repeat the message. This provides redundancy to compensate for network packet loss. A value of -1 sends the message indefinitely.
delay	number	The minimum delay in milliseconds after the API call before the message is sent.
isKeyFrame	boolean	Specifies whether to attach the message only to keyframes. true: Attach the message only to keyframes. false: Attach the message to all frames.

Return value

number - 0: success; <0: failure

Sends a media extension message.

public sendMediaExtensionMsgEx(message: ArrayBuffer, repeatCount: number, delay: number, isKeyFrame: boolean, payloadType: number): number

Parameters

Parameter	Type	Description
message	ArrayBuffer	The media extension message. The maximum size is 4 KB.
repeatCount	number	The repeat count, which provides redundancy to prevent message loss due to packet loss. A value of -1 sends the message indefinitely.
delay	number	The minimum delay in milliseconds to wait after the API call before sending the message.
isKeyFrame	boolean	Whether to attach the message only to a key frame. true: Attach only to a key frame. false: Attach to all frames.
payloadType	number	The payload type. The valid values are 5 or any integer in the range [100, 254]. A value of 5 is equivalent to calling the sendMediaExtensionMsg method.

Returns

0 on success; a negative value on failure.

Sends a data message.

public sendDataChannelMsg(controlMsg: AliRtcDataChannelMsg): number

Parameters

Parameter	Type	Description
controlMsg	AliRtcDataChannelMsg	The message content.

Returns

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

Starts a file recording.

public startRecord(recordType: AliRtcRecordType,
    recordFormat: AliRtcRecordFormat,
    filePath: string,
    audioConfig: AliRtcRecordAudioConfig | undefined,
    videoConfig: AliRtcRecordVideoConfig | undefined): boolean

Parameters

Parameter	Type	Description
recordType	AliRtcRecordType	The recording type.
recordFormat	AliRtcRecordFormat	The recording file format. This parameter is ignored when recordType is AliRtcRecordTypeVideo.
filePath	string	The file path for the recording.
audioConfig	AliRtcRecordAudioConfig | undefined	The audio configuration.
videoConfig	AliRtcRecordVideoConfig | undefined	The video configuration.

Returns

Returns true if the method call is successful; false otherwise.

Stops recording to a file.

public stopRecord(): void

Starts server-side live streaming.

public startPublishLiveStream(streamURL: string, params: AliRtcLiveTranscodingParam) : number

Parameters

Parameter	Type	Description
streamURL	string	The destination stream URL.
params	AliRtcLiveTranscodingParam	The parameters for live transcoding.

Returns

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

Updates the parameters for an ongoing bypass live stream.

public updatePublishLiveStream(streamURL: string, params: AliRtcLiveTranscodingParam) : number

Parameters

Parameter	Type	Description
streamURL	string	The stream publishing URL.
params	AliRtcLiveTranscodingParam	The stream publishing parameters. For more information, see AliRtcLiveTranscodingParam.

Returns

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

Stops server-side live streaming.

public stopPublishLiveStream(streamURL: string) : number

Parameters

Parameter	Type	Description
streamURL	string	The publishing URL.

Returns

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

Gets the live transcoding state.

public getPublishLiveStreamState(streamURL: string): AliRtcLiveTranscodingState

Parameters

Parameter	Type	Description
streamURL	string	The stream URL.

Returns

An AliRtcLiveTranscodingState enum that indicates the live transcoding state.

Updates live stream publishing parameters.

public updatePublishLiveStreamWithTaskId(taskId: string, params: AliRtcLiveTranscodingParam): number

Parameters

Parameter	Type	Description
taskId	string	The task ID.
params	AliRtcLiveTranscodingParam	The stream publishing parameters.

Returns

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

Stops a live streaming task.

public stopPublishLiveStreamWithTaskId(taskId: string): number

Parameters

Parameter	Type	Description
taskId	string	The task ID.

Returns

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

Retrieves the state of a server-side streaming task.

public getPublishLiveStreamStateWithTaskId(taskId: string): AliRtcLiveTranscodingState

Parameters

Parameter	Type	Description
taskId	string	The task ID.

Returns

AliRtcLiveTranscodingState - An enumeration representing the state of live transcoding.

Publishes a stream to the specified RTS URL. You can only publish one stream at a time.

public publishStreamByRtsUrl(rtsUrl: string): number

Parameters

Parameter	Type	Description
rtsUrl	string	The URL for the RTS stream. Do not include room server information.

Returns

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

Stops publishing a stream to the specified RTS URL.

public stopPublishStreamByRtsUrl(rtsUrl: string): number

Parameters

Parameter	Type	Description
rtsUrl	string	The RTS URL. This URL must not contain roomserver information.

Returns

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

Subscribes to a stream using its RTS URL. You can only subscribe to one stream at a time.

public subscribeStreamByRtsUrl(rtsUrl: string, uid: string, preLoad: boolean = false): number

Parameters

Parameter	Type	Description
rtsUrl	string	The RTS URL. This URL should not include roomserver information.
uid	string	A unique identifier for the user, provided by the caller.
preLoad	boolean	Indicates whether to preload the stream. The default is false.

Returns

number - 0 for success; a non-zero value for failure.

Stops a stream subscription using the specified RTS user ID.

public stopSubscribeStreamByRtsUserId(uid: string): number

Parameters

Parameter	Type	Description
uid	string	The RTS user ID of the remote user.

Returns

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

Pauses a subscription to a server-side RTS stream.

public pauseRtsStreamByRtsUserId(uid: string): number

Parameters

Parameter	Type	Description
uid	string	The rts user id.

Returns

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

Resumes a subscription to a specific user's RTS stream.

public resumeRtsStreamByRtsUserId(uid: string): number

Parameters

Parameter	Type	Description
uid	string	The user ID for the RTS stream.

Returns

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

Starts last-mile detection.

public startLastmileDetect(config: AliRtcNetworkProbeConfig): number

Parameters

Parameter	Type	Description
config	AliRtcNetworkProbeConfig	The probe configuration.

Returns

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

Stops the last-mile network quality probe.

public stopLastmileDetect(): number

Returns

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

Sets the directory path for SDK log files.

public static setLogDirPath(logDirPath: string): number

Parameters

Parameter	Type	Description
logDirPath	string	The absolute path of the directory where log files are saved. This must be a directory path, not a file path.

Return value

number - Returns 0 for success or a non-zero value for failure. Possible error codes include: AliRtcError#ERR_LOG_ROOT_PATH_ERROR: The path already exists or is inaccessible due to insufficient permissions. AliRtcError#ERR_LOG_ALREADY_INIT: The log object has already been initialized.

Sets the log level.

public static setLogLevel(logLevel: AliRtcLogLevel): void

Parameters

Parameter	Type	Description
logLevel	AliRtcLogLevel	The log level. For available values, see the AliRtcLogLevel enum type.

Specifies whether to upload log files. This is enabled by default.

public static enableUploadLog(enable: boolean): void

Parameters

Parameter	Type	Description
enable	boolean	true: Uploads log files. false: Disables log file uploads.

Updates external input parameters with a JSON string.

public setExtras(extras: string): number

Parameters

Parameter	Type	Description
extras	string	A JSON string. An empty string is a valid value.

Returns

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

Sets a custom attribute using a JSON string.

public setParameter(param: string): number

Parameters

Parameter	Type	Description
param	string	The custom attribute to set, formatted as a JSON string.

Returns

A number where 0 indicates success and any other value indicates failure.

Gets the value of a custom property.

public getParameter(paramKey: string): string

Parameters

Parameter	Type	Description
paramKey	string	The custom property key.

Returns

string - The value of the specified property.

Controls the upload of analytics data. Enabled by default.

public enableStatsReport(enabled: boolean): void

Parameters

Parameter	Type	Description
enabled	boolean	true: Enables analytics data uploads. false: Disables analytics data uploads.

Gets the network time.

public getNetworkTime(): number

Returns

The timestamp as a number.

Occurs when a remote user in communication mode or a host in interactive live streaming mode leaves the channel.

onRemoteUserOffline : (func: OnRemoteUserOffLineNotify) => AliRtcEngineEventListener;

Callback parameters

Parameter	Type	Description
uid	string	The unique user ID assigned by your App server.
reason	AliRtcUserOfflineReason	The reason the user is offline.