RtcEngine
rn-agora-docs › "RtcEngine.native" › RtcEngine
RtcEngine is the javascript object for control agora native sdk through react native bridge.
You can use the RtcEngine methods to create init
Other methods of the RtcEngine object serve for agora native sdk and set up error logging.
Hierarchy
- RtcEngine
Index
Events
Methods
- addInjectStreamUrl
- addPublishStreamUrl
- addVideoWatermark
- adjustAudioMixingPlayoutVolume
- adjustAudioMixingPublishVolume
- adjustAudioMixingVolume
- adjustPlaybackSignalVolume
- adjustRecordingSignalVolume
- clearVideoWatermarks
- destroy
- disableAudio
- disableLastmileTest
- disableLocalAudio
- disableVideo
- enableAudio
- enableAudioVolumeIndication
- enableDualStreamMode
- enableInEarMonitoring
- enableLastmileTest
- enableLocalAudio
- enableLocalVideo
- enableSoundPositionIndication
- enableVideo
- enableWebSdkInteroperability
- getAudioMixingCurrentPosition
- getAudioMixingDuration
- getAudioMixingPlayoutVolume
- getAudioMixingPublishVolume
- getCallId
- getCameraInfo
- getCameraMaxZoomFactor
- getConnectionState
- getEffectsVolume
- getParameter
- getParameters
- getSdkVersion
- getUserInfoByUid
- getUserInfoByUserAccount
- init
- isSpeakerphoneEnabled
- joinChannel
- joinChannelWithUserAccount
- leaveChannel
- muteAllRemoteAudioStreams
- muteAllRemoteVideoStreams
- muteLocalAudioStream
- muteLocalVideoStream
- muteRemoteAudioStream
- muteRemoteVideoStream
- off
- pauseAllEffects
- pauseAudioMixing
- pauseEffect
- playEffect
- preloadEffect
- registerLocalUserAccount
- registerMediaMetadataObserver
- removeAllListeners
- removeChannelMediaRelay
- removeInjectStreamUrl
- removePublishStreamUrl
- renewToken
- resumeAllEffects
- resumeAudioMixing
- resumeEffect
- sendMediaData
- sendMessage
- setAudioMixingPosition
- setAudioSessionOperationRestriction
- setBeautyEffectOptions
- setCameraAutoFocusFaceModeEnabled
- setCameraCapturerConfiguration
- setCameraExposurePosition
- setCameraFocusPositionInPreview
- setCameraTorchOn
- setCameraZoomFactor
- setClientRole
- setDefaultAudioRouteToSpeakerphone
- setDefaultMuteAllRemoteAudioStreams
- setDefaultMuteAllRemoteVideoStreams
- setEffectsVolume
- setEnableSpeakerphone
- setInEarMonitoringVolume
- setLiveTranscoding
- setLocalPublishFallbackOption
- setLocalRenderMode
- setLocalVideoMirrorMode
- setLocalVoiceChanger
- setLocalVoiceEqualization
- setLocalVoicePitch
- setLocalVoiceReverb
- setLocalVoiceReverbPreset
- setLog
- setMixedAudioFrameParameters
- setParameters
- setPlaybackAudioFrameParameters
- setRecordingAudioFrameParameters
- setRemoteDefaultVideoStreamType
- setRemoteRenderMode
- setRemoteSubscribeFallbackOption
- setRemoteUserPriority
- setRemoteVideoStreamType
- setRemoteVoicePosition
- setVolumeOfEffect
- startAudioMixing
- startAudioRecording
- startChannelMediaRelay
- startEchoTestWithInterval
- startLastmileProbeTest
- startPreview
- stopAllEffects
- stopAudioMixing
- stopAudioRecording
- stopChannelMediaRelay
- stopEchoTest
- stopEffect
- stopLastmileProbeTest
- stopPreview
- switchCamera
- switchChannel
- unloadEffect
- updateChannelMediaRelay
Events
Static on
• on(eventType: string, listener: function): any
Defined in RtcEngine.native.ts:305
add event listener
This method subscribes specified eventType and run listener. You should call this method at first.
Parameters:
▪ eventType: string
▪ listener: function
▸ (...args: any[]): any
Parameters:
| Name | Type |
|---|---|
...args | any[] |
Returns: any
any
Methods
Static addInjectStreamUrl
▸ addInjectStreamUrl(options: InjectStreamOption): Promise‹any›
Defined in RtcEngine.native.ts:1240
add inject stream url
This method injects an online media stream to a live broadcast.
Parameters:
| Name | Type | Description |
|---|---|---|
options | InjectStreamOption | InjectStreamOption |
Returns: Promise‹any›
Promise<{success, value}>
Static addPublishStreamUrl
▸ addPublishStreamUrl(options: PublishStreamOption): Promise‹any›
Defined in RtcEngine.native.ts:1413
add publish stream url
This method add publish stream by option.
Parameters:
| Name | Type | Description |
|---|---|---|
options | PublishStreamOption | PublishStreamOption |
Returns: Promise‹any›
Promise<{success, value}>
Static addVideoWatermark
▸ addVideoWatermark(url: string, options: ImageOption): Promise‹any›
Defined in RtcEngine.native.ts:1157
add video watermark
This method adds video watermark to the local video.
Parameters:
| Name | Type | Description |
|---|---|---|
url | string | - |
options | ImageOption | ImageOption |
Returns: Promise‹any›
Promise<{success, value}>
Static adjustAudioMixingPlayoutVolume
▸ adjustAudioMixingPlayoutVolume(volume: number): void
Defined in RtcEngine.native.ts:860
adjust audio mixing playout volume
This method adjusts audio mixing playout by the volume parameter
Parameters:
| Name | Type | Description |
|---|---|---|
volume | number |
Returns: void
Static adjustAudioMixingPublishVolume
▸ adjustAudioMixingPublishVolume(volume: number): void
Defined in RtcEngine.native.ts:870
adjust audio mixing publish volume
This method adjusts audio mixing publish by the volume paraemter
Parameters:
| Name | Type | Description |
|---|---|---|
volume | number |
Returns: void
Static adjustAudioMixingVolume
▸ adjustAudioMixingVolume(volume: number): void
Defined in RtcEngine.native.ts:850
adjust audio mixing volume
This method adjusts audio mixing volume by the volume number parameter
Parameters:
| Name | Type | Description |
|---|---|---|
volume | number |
Returns: void
Static adjustPlaybackSignalVolume
▸ adjustPlaybackSignalVolume(volume: number): Promise‹any›
Defined in RtcEngine.native.ts:719
adjust playback signal volume
This method adjusts playback signal by volume.
Parameters:
| Name | Type |
|---|---|
volume | number |
Returns: Promise‹any›
Promise
Static adjustRecordingSignalVolume
▸ adjustRecordingSignalVolume(volume: number): Promise‹any›
Defined in RtcEngine.native.ts:708
adjust recording signal volume
This method adjusts recording your signal by volume.
Parameters:
| Name | Type |
|---|---|
volume | number |
Returns: Promise‹any›
Promise
Static clearVideoWatermarks
▸ clearVideoWatermarks(): Promise‹any›
Defined in RtcEngine.native.ts:1168
clear video watermarks
This method removes the watermark image from the video stream added by addVideoWatermark.
Returns: Promise‹any›
Promise<{success, value}>
Static destroy
▸ destroy(): any
Defined in RtcEngine.native.ts:451
destroy
This method stops event subscribe and destroy the RtcEngine instance's. You should call it, when you want to destroy the engine.
Returns: any
void
Static disableAudio
▸ disableAudio(): Promise‹any›
Defined in RtcEngine.native.ts:651
disable audio
This method disables audio
Returns: Promise‹any›
Promise
Static disableLastmileTest
▸ disableLastmileTest(): Promise‹any›
Defined in RtcEngine.native.ts:1109
disable lastmile test
This method disable the network connection qualit test.
Returns: Promise‹any›
Promise<{success, value}>
Static disableLocalAudio
▸ disableLocalAudio(muted: boolean): Promise‹any›
Defined in RtcEngine.native.ts:673
mute local audio stream
This method mutes the local audio stream by muted.
Parameters:
| Name | Type |
|---|---|
muted | boolean |
Returns: Promise‹any›
Promise
Static disableVideo
▸ disableVideo(): Promise‹any›
Defined in RtcEngine.native.ts:556
disable video
This method disables video.
Returns: Promise‹any›
Promise
Static enableAudio
▸ enableAudio(): Promise‹any›
Defined in RtcEngine.native.ts:641
enable audio
This method enables audio
Returns: Promise‹any›
Promise
Static enableAudioVolumeIndication
▸ enableAudioVolumeIndication(interval: number, smooth: number, vad: boolean): Promise‹any›
Defined in RtcEngine.native.ts:731
enable audio volume indication
This method enables audio volume by interval and smooth
Parameters:
| Name | Type |
|---|---|
interval | number |
smooth | number |
vad | boolean |
Returns: Promise‹any›
Promise
Static enableDualStreamMode
▸ enableDualStreamMode(enabled: boolean): Promise‹any›
Defined in RtcEngine.native.ts:1204
enable dual stream mode
This method enables the dual stream by parameter mode.
Parameters:
| Name | Type |
|---|---|
enabled | boolean |
Returns: Promise‹any›
Promise<{success, value}>
Static enableInEarMonitoring
▸ enableInEarMonitoring(enabled: boolean): Promise‹any›
Defined in RtcEngine.native.ts:754
enable in-ear monitor
This method enables in-ear monitoring by boolean parameter enabled
Parameters:
| Name | Type |
|---|---|
enabled | boolean |
Returns: Promise‹any›
Promise
Static enableLastmileTest
▸ enableLastmileTest(): Promise‹any›
Defined in RtcEngine.native.ts:1098
enable lastmile test
This method enables the network connection qualit test.
Returns: Promise‹any›
Promise<{success, value}>
Static enableLocalAudio
▸ enableLocalAudio(enabled: boolean): Promise‹any›
Defined in RtcEngine.native.ts:662
enable local audio
This method enables local audio by the boolean parameter.
Parameters:
| Name | Type |
|---|---|
enabled | boolean |
Returns: Promise‹any›
Promise
Static enableLocalVideo
▸ enableLocalVideo(enabled: boolean): Promise‹any›
Defined in RtcEngine.native.ts:567
enable local video
This method enables the local video by the boolean parameter.
Parameters:
| Name | Type |
|---|---|
enabled | boolean |
Returns: Promise‹any›
Promise
Static enableSoundPositionIndication
▸ enableSoundPositionIndication(enabled: boolean): Promise‹any›
Defined in RtcEngine.native.ts:1521
control stereo panning for remote users
This method enables/disables stereo panning for remote users.
Parameters:
| Name | Type | Description |
|---|---|---|
enabled | boolean | boolean |
Returns: Promise‹any›
Promise
Static enableVideo
▸ enableVideo(): Promise‹any›
Defined in RtcEngine.native.ts:546
enable video
This method enables video.
Returns: Promise‹any›
Promise
Static enableWebSdkInteroperability
▸ enableWebSdkInteroperability(enabled: boolean): Promise‹any›
Defined in RtcEngine.native.ts:407
enable websdk interoperability
This method used to enable websdk interoperability, so that it can connect with agora websdk apps.
Parameters:
| Name | Type |
|---|---|
enabled | boolean |
Returns: Promise‹any›
Promise<{success, value}>
Static getAudioMixingCurrentPosition
▸ getAudioMixingCurrentPosition(): Promise‹any›
Defined in RtcEngine.native.ts:890
get audio mixing current position
This method gets audio mixing current position value.
Returns: Promise‹any›
Promise<{success, value}>
Static getAudioMixingDuration
▸ getAudioMixingDuration(): Promise‹any›
Defined in RtcEngine.native.ts:880
get audio mixing duration
This method gets the audio mixing duration
Returns: Promise‹any›
Promise<{success, value}>
Static getAudioMixingPlayoutVolume
▸ getAudioMixingPlayoutVolume(): Promise‹any›
Defined in RtcEngine.native.ts:1631
Gets the audio mixing volume for local playback.
note: This method helps troubleshoot audio volume related issues.
Returns: Promise‹any›
Promise
Static getAudioMixingPublishVolume
▸ getAudioMixingPublishVolume(): Promise‹any›
Defined in RtcEngine.native.ts:1643
Gets the audio mixing volume for publishing.
note: This method helps troubleshoot audio volume related issues.
Returns: Promise‹any›
Promise
Static getCallId
▸ getCallId(): Promise‹any›
Defined in RtcEngine.native.ts:1387
get call id
This method is used to get call id.
Returns: Promise‹any›
Promise<{success, value}>
Static getCameraInfo
▸ getCameraInfo(): Promise‹any›
Defined in RtcEngine.native.ts:1690
Get local device camera support info
note: This method returns your current device camera support info.
RtcEngine.getCameraInfo().then(info => {
console.log("your currrent camera", info);
})
Returns: Promise‹any›
Promise<{cameraSupportInfo}>
Static getCameraMaxZoomFactor
▸ getCameraMaxZoomFactor(): Promise‹any›
Defined in RtcEngine.native.ts:1328
get camera max zoom ratio
This method gets the camera maximum zoom ratio.
notice Android Only
Returns: Promise‹any›
Promise<{success, value}>
Static getConnectionState
▸ getConnectionState(): Promise‹any›
Defined in RtcEngine.native.ts:417
get agora native sdk connection state
This method gets agora native sdk connection state
Returns: Promise‹any›
Promise<{state: (connection state)}>
Static getEffectsVolume
▸ getEffectsVolume(): Promise‹any›
Defined in RtcEngine.native.ts:910
get effects of volume
This methods get audio mixing effects volume value.
Returns: Promise‹any›
Promise<{success, value}>
Static getParameter
▸ getParameter(paramsStr: string, args: string): Promise‹string›
Defined in RtcEngine.native.ts:1709
Get Private Parameter
Parameters:
| Name | Type |
|---|---|
paramsStr | string |
args | string |
Returns: Promise‹string›
Promise
Static getParameters
▸ getParameters(paramsStr: string): Promise‹string›
Defined in RtcEngine.native.ts:1719
Get Private Parameters
Parameters:
| Name | Type |
|---|---|
paramsStr | string |
Returns: Promise‹string›
Promise
Static getSdkVersion
▸ getSdkVersion(callback: Callback‹any›, errorHandler?: Callback‹any›): any
Defined in RtcEngine.native.ts:1450
get sdk version
This method gets the sdk version details and passed it into callback function
Parameters:
| Name | Type | Description |
|---|---|---|
callback | Callback‹any› | to handle resolve from getSdkVersion |
errorHandler? | Callback‹any› | to handle reject error from getSdkVersion |
Returns: any
any
Static getUserInfoByUid
▸ getUserInfoByUid(uid: number): Promise‹AgoraUserInfo›
Defined in RtcEngine.native.ts:194
Gets the user information by passing in the user account.
After receiving the "userInfoUpdated" callback, you can call this method to get the user ID of the remote user from the AgoraUserInfo object by passing in the userAccount.
Parameters:
| Name | Type |
|---|---|
uid | number |
Returns: Promise‹AgoraUserInfo›
Promise<AgoraUserInfo>
Static getUserInfoByUserAccount
▸ getUserInfoByUserAccount(userAccount: string): Promise‹AgoraUserInfo›
Defined in RtcEngine.native.ts:211
Gets the user information by passing in the user account.
After receiving the "userInfoUpdated" callback, you can call this method to get the user ID of the remote user from the AgoraUserInfo object by passing in the userAccount.
Parameters:
| Name | Type |
|---|---|
userAccount | string |
Returns: Promise‹AgoraUserInfo›
Promise<AgoraUserInfo>
Static init
▸ init(options: Option): void
Defined in RtcEngine.native.ts:63
Creates a RtcEngine Object internal.
This method creates and start event observer. You should call this method once.
example RtcEngine.init(option)
Parameters:
| Name | Type | Description |
|---|---|---|
options | Option | Defines the property of the client, see Option for details. |
Returns: void
any
Static isSpeakerphoneEnabled
▸ isSpeakerphoneEnabled(callback: Callback‹any›): any
Defined in RtcEngine.native.ts:742
check for mobile phone speaker enabled
This method checks the phone speaker is enabled
Parameters:
| Name | Type |
|---|---|
callback | Callback‹any› |
Returns: any
any
Static joinChannel
▸ joinChannel(channelName: string, uid?: number, token?: string, info?: Object): Promise‹any›
Defined in RtcEngine.native.ts:78
join specified channel
This method joins and begin rendering the video stream. when join succeeds. Otherwise, it will invoke error by the event
Parameters:
| Name | Type |
|---|---|
channelName | string |
uid? | number |
token? | string |
info? | Object |
Returns: Promise‹any›
Promise
Static joinChannelWithUserAccount
▸ joinChannelWithUserAccount(channelName: string, userAccount: string, token: string): Promise‹any›
Defined in RtcEngine.native.ts:183
Joins the channel with a user account.
After the user successfully joins the channel, the SDK triggers the following callbacks:
The local client: on("localUserRegistered", callback) and on("joinChannelSuccess", callback).
The remote client: on("userJoined", callback) and on("userInfoUpdated", callback), if the user joining the channel is in the Communication profile, or is a BROADCASTER in the Live Broadcast profile.
note To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the uid of the user is set to the same parameter type.
Parameters:
| Name | Type |
|---|---|
channelName | string |
userAccount | string |
token | string |
Returns: Promise‹any›
Promise
Static leaveChannel
▸ leaveChannel(): Promise‹any›
Defined in RtcEngine.native.ts:439
leave channel
This method leaves the joined channel, then your video view will not render ever. You should call it, when you dont need render video stream.
Returns: Promise‹any›
Promise
Static muteAllRemoteAudioStreams
▸ muteAllRemoteAudioStreams(muted: boolean): Promise‹any›
Defined in RtcEngine.native.ts:684
mute all remote audio streams
This method mutes all remote audio streams by muted
Parameters:
| Name | Type | Description |
|---|---|---|
muted | boolean | boolean |
Returns: Promise‹any›
Promise
Static muteAllRemoteVideoStreams
▸ muteAllRemoteVideoStreams(muted: boolean): Promise‹any›
Defined in RtcEngine.native.ts:589
mute all remote video streams
This method mutes all remote streams by the boolean parameter.
Parameters:
| Name | Type |
|---|---|
muted | boolean |
Returns: Promise‹any›
Promise
Static muteLocalAudioStream
▸ muteLocalAudioStream(enabled: boolean): Promise‹any›
Defined in RtcEngine.native.ts:1463
mute local audio stream
This method sends/stops sending the local audio.
Parameters:
| Name | Type |
|---|---|
enabled | boolean |
Returns: Promise‹any›
Promise
Static muteLocalVideoStream
▸ muteLocalVideoStream(muted: boolean): Promise‹any›
Defined in RtcEngine.native.ts:578
mute local video stream
This method mutes video stream by the boolean parameter.
Parameters:
| Name | Type |
|---|---|
muted | boolean |
Returns: Promise‹any›
Promise
Static muteRemoteAudioStream
▸ muteRemoteAudioStream(uid: number, muted: boolean): Promise‹any›
Defined in RtcEngine.native.ts:696
mute specified remote audio stream by muted
This method mutes specified remote audio stream by number uid and boolean muted.
Parameters:
| Name | Type |
|---|---|
uid | number |
muted | boolean |
Returns: Promise‹any›
Promise
Static muteRemoteVideoStream
▸ muteRemoteVideoStream(uid: number, muted: boolean): Promise‹any›
Defined in RtcEngine.native.ts:619
mute specified remote video stream.
This method mutes remote video stream by the number of uid and boolean parameter.
Parameters:
| Name | Type |
|---|---|
uid | number |
muted | boolean |
Returns: Promise‹any›
Promise
Static off
▸ off(evt: any): void
Defined in RtcEngine.native.ts:385
deprecated off
Parameters:
| Name | Type |
|---|---|
evt | any |
Returns: void
Static pauseAllEffects
▸ pauseAllEffects(): Promise‹any›
Defined in RtcEngine.native.ts:1008
pause all effects for audio mixing
This method pause all effects for audio mixing.
Returns: Promise‹any›
Promise<{success, value}>
Static pauseAudioMixing
▸ pauseAudioMixing(): void
Defined in RtcEngine.native.ts:831
pause audio mixing
This method pauses for audio mixing.
Returns: void
Static pauseEffect
▸ pauseEffect(soundId: number): Promise‹any›
Defined in RtcEngine.native.ts:997
pause the specified effect for audio mixing by soundId
This method pauses the specified effect for audio mixing by soundId.
Parameters:
| Name | Type |
|---|---|
soundId | number |
Returns: Promise‹any›
Promise<{success, value}>
Static playEffect
▸ playEffect(options: PlayEffectOption): Promise‹any›
Defined in RtcEngine.native.ts:942
play specified effect for audio mixing
This methos plays the specified effect of audio mixing file by option config.
Parameters:
| Name | Type | Description |
|---|---|---|
options | PlayEffectOption | PlayEffectOption |
Returns: Promise‹any›
Promise<{success, value}>
Static preloadEffect
▸ preloadEffect(soundId: number, filePath: string): Promise‹any›
Defined in RtcEngine.native.ts:975
preload effect for audio mixing file.
This methods preloads the specified audio mixing file to memory by the soundId
Parameters:
| Name | Type |
|---|---|
soundId | number |
filePath | string |
Returns: Promise‹any›
Promise<{success, value}>
Static registerLocalUserAccount
▸ registerLocalUserAccount(userAccount: string): Promise‹any›
Defined in RtcEngine.native.ts:164
Registers a user account.
Once registered, the user account can be used to identify the local user when the user joins the channel. After the user successfully registers a user account, the SDK triggers the on("localUserRegistered", callback) on the local client, reporting the user ID and user account of the local user.
To join a channel with a user account, you can choose either of the following:
Call the registerLocalUserAccount method to create a user account, and then the joinChannelWithUserAccount method to join the channel.
Call the joinChannelWithUserAccount method to join the channel.
note To ensure smooth communication, use the same parameter type to identify the user. For example, if a user joins the channel with a user ID, then ensure all the other users use the user ID too. The same applies to the user account. If a user joins the channel with the Agora Web SDK, ensure that the uid of the user is set to the same parameter type.
Parameters:
| Name | Type |
|---|---|
userAccount | string |
Returns: Promise‹any›
Promise
Static registerMediaMetadataObserver
▸ registerMediaMetadataObserver(): Promise‹any›
Defined in RtcEngine.native.ts:1674
Registers the metadata observer.
note: This method only work in live mode This method enables you to add synchronized metadata in the video stream for more diversified live broadcast interactions, such as sending shopping links, digital coupons, and online quizzes. This method trigger 'mediaMetaDataReceived' event, here is example:
RtcEngine.on("mediaMetaDataReceived", (data) => {
console.log("mediaMetaDataReceived", data);
})
Returns: Promise‹any›
Promise
Static removeAllListeners
▸ removeAllListeners(): void
Defined in RtcEngine.native.ts:377
deprecated removeAllListeners
Returns: void
Static removeChannelMediaRelay
▸ removeChannelMediaRelay(config: ChannelMediaConfiguration): Promise‹any›
Defined in RtcEngine.native.ts:121
Remove to relay media streams across channels.
This method will remove & update relay media stream across specified channels. (maximum support relay 4 channels) It will occurs event: Occurs mediaRelayStateChanged
Parameters:
| Name | Type | Description |
|---|---|---|
config | ChannelMediaConfiguration | ChannelMediaConfiguration |
Returns: Promise‹any›
Promise
Static removeInjectStreamUrl
▸ removeInjectStreamUrl(options: RemoveInjectStreamOption): Promise‹any›
Defined in RtcEngine.native.ts:1252
remove inject stream url
This method removes stream by addInjectsStreamUrl.
Parameters:
| Name | Type | Description |
|---|---|---|
options | RemoveInjectStreamOption | RemoveInjectStreamOption |
Returns: Promise‹any›
Promise<{success, value}>
Static removePublishStreamUrl
▸ removePublishStreamUrl(options: RemovePublishStreamOption): Promise‹any›
Defined in RtcEngine.native.ts:1425
remove publish stream url
This method remove publish stream by options.
Parameters:
| Name | Type | Description |
|---|---|---|
options | RemovePublishStreamOption | RemovePublishStreamOption |
Returns: Promise‹any›
Promise<{success, value}>
Static renewToken
▸ renewToken(token: string): any
Defined in RtcEngine.native.ts:395
renew token
This method renews a new token.
Parameters:
| Name | Type | Description |
|---|---|---|
token | string |
Returns: any
Static resumeAllEffects
▸ resumeAllEffects(): Promise‹any›
Defined in RtcEngine.native.ts:1029
resume all audio mixing effects.
This method resumes all audio mixing effects.
Returns: Promise‹any›
Promise<{success, value}>
Static resumeAudioMixing
▸ resumeAudioMixing(): void
Defined in RtcEngine.native.ts:840
resume audio mixing
This method resumes for audio mixing.
Returns: void
Static resumeEffect
▸ resumeEffect(soundId: number): Promise‹any›
Defined in RtcEngine.native.ts:1019
resume audio mixing effect by the specified soundId
This method resumes audio mixing effect by the specified soundId
Parameters:
| Name | Type |
|---|---|
soundId | number |
Returns: Promise‹any›
Promise<{success, value}>
Static sendMediaData
▸ sendMediaData(data: String): Promise‹any›
Defined in RtcEngine.native.ts:1656
sendMediaData for media observer.
note: This method needs you invoke registerMediaMetadataObserver success first and you could send media data through interval media observer feature. The data have limit length is 1024 bytes, if you pass data length bigger than limit it will failed.
Parameters:
| Name | Type | Description |
|---|---|---|
data | String | String: 1024 bytes limit |
Returns: Promise‹any›
Promise
Static sendMessage
▸ sendMessage(): Promise‹any›
Defined in RtcEngine.native.ts:1260
deprecated sendMessage
sendMessage
Returns: Promise‹any›
Static setAudioMixingPosition
▸ setAudioMixingPosition(pos: number): Promise‹any›
Defined in RtcEngine.native.ts:900
set audio mixing position
This method sets audio mixing position by the parameter pos
Parameters:
| Name | Type | Description |
|---|---|---|
pos | number |
Returns: Promise‹any›
Static setAudioSessionOperationRestriction
▸ setAudioSessionOperationRestriction(): void
Defined in RtcEngine.native.ts:1062
set audio session operation restriction
The SDK and the app can both configure the audio session by default. The app may occasionally use other apps or third-party components to manipulate the audio session and restrict the SDK from doing so. This method allows the app to restrict the SDK’s manipulation of the audio session. You can call this method at any time to return the control of the audio sessions to the SDK. This method restricts the SDK’s manipulation of the audio session. Any operation to the audio session relies solely on the app, other apps, or third-party components.
notice iOS support only
Returns: void
Static setBeautyEffectOptions
▸ setBeautyEffectOptions(enabled: boolean, options: BeautyOption): Promise‹any›
Defined in RtcEngine.native.ts:1476
video pre-process/post-process
This method enables/disables image enhancement and sets the options.
Parameters:
| Name | Type | Description |
|---|---|---|
enabled | boolean | - |
options | BeautyOption | {@link BeautyOptions} |
Returns: Promise‹any›
Promise
Static setCameraAutoFocusFaceModeEnabled
▸ setCameraAutoFocusFaceModeEnabled(enabled: boolean): Promise‹any›
Defined in RtcEngine.native.ts:1376
set enable auto focus face mode
This method enables auto-focus face mode function.
Parameters:
| Name | Type | Description |
|---|---|---|
enabled | boolean | boolean |
Returns: Promise‹any›
Promise<{success, value}>
Static setCameraCapturerConfiguration
▸ setCameraCapturerConfiguration(config: CameraCapturerConfiguration): Promise‹any›
Defined in RtcEngine.native.ts:1619
set the camera capture preference.
note: For a video call or live broadcast, generally the SDK controls the camera output parameters. When the default camera capture settings do not meet special requirements or cause performance problems, we recommend using this method to set the camera capture preference: If the resolution or frame rate of the captured raw video data are higher than those set by setVideoEncoderConfiguration, processing video frames requires extra CPU and RAM usage and degrades performance. We recommend setting config as CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE(1) to avoid such problems. If you do not need local video preview or are willing to sacrifice preview quality, we recommend setting config as CAPTURER_OUTPUT_PREFERENCE_PERFORMANCE(1) to optimize CPU and RAM usage. If you want better quality for the local video preview, we recommend setting config as CAPTURER_OUTPUT_PREFERENCE_PREVIEW(2).
This method will set the camera capture preference.
Parameters:
| Name | Type | Description |
|---|---|---|
config | CameraCapturerConfiguration | CameraCapturerConfiguration |
Returns: Promise‹any›
Promise
Static setCameraExposurePosition
▸ setCameraExposurePosition(options: PositionOption): Promise‹any›
Defined in RtcEngine.native.ts:1352
set camera exposure position
This method sets the mannual exposure position.
Parameters:
| Name | Type | Description |
|---|---|---|
options | PositionOption | PositionOption |
Returns: Promise‹any›
Promise<{success, value}>
Static setCameraFocusPositionInPreview
▸ setCameraFocusPositionInPreview(options: PositionOption): Promise‹any›
Defined in RtcEngine.native.ts:1340
set camera focus position in preview
This method sets the mannual focus position.
Parameters:
| Name | Type | Description |
|---|---|---|
options | PositionOption | PositionOption |
Returns: Promise‹any›
Promise<{success, value}>
Static setCameraTorchOn
▸ setCameraTorchOn(enabled: boolean): Promise‹any›
Defined in RtcEngine.native.ts:1364
set camera torch on
This method enables the camera flash function.
Parameters:
| Name | Type |
|---|---|
enabled | boolean |
Returns: Promise‹any›
Promise<{success, value}>
Static setCameraZoomFactor
▸ setCameraZoomFactor(zoomFactor: number): Promise‹any›
Defined in RtcEngine.native.ts:1316
set camera zoom ratio
This method sets the camera zoom ratio.
Parameters:
| Name | Type |
|---|---|
zoomFactor | number |
Returns: Promise‹any›
Promise<{success, value}>
Static setClientRole
▸ setClientRole(role: number): Promise‹any›
Defined in RtcEngine.native.ts:427
change the client role
This method changes the client of role.
Parameters:
| Name | Type | Description |
|---|---|---|
role | number | (audience: 0, host: 1) |
Returns: Promise‹any›
Static setDefaultAudioRouteToSpeakerphone
▸ setDefaultAudioRouteToSpeakerphone(enabled: boolean): Promise‹any›
Defined in RtcEngine.native.ts:525
set default audio speaker
This method set the default audio speaker enable or disable by pass boolean parameter.
Parameters:
| Name | Type |
|---|---|
enabled | boolean |
Returns: Promise‹any›
Promise
Static setDefaultMuteAllRemoteAudioStreams
▸ setDefaultMuteAllRemoteAudioStreams(enabled: boolean): Promise‹any›
Defined in RtcEngine.native.ts:536
set default mute all remote audio streams
This method set default mute all remote audio streams enable or not by pass boolean parameter.
Parameters:
| Name | Type |
|---|---|
enabled | boolean |
Returns: Promise‹any›
Promise
Static setDefaultMuteAllRemoteVideoStreams
▸ setDefaultMuteAllRemoteVideoStreams(muted: boolean): Promise‹any›
Defined in RtcEngine.native.ts:631
set default mute all remote video stream
This method mutes all remote video stream default by the boolean parameter.
Parameters:
| Name | Type |
|---|---|
muted | boolean |
Returns: Promise‹any›
Promise
Static setEffectsVolume
▸ setEffectsVolume(volume: number): Promise‹any›
Defined in RtcEngine.native.ts:921
set effects volume
This methods set audio mixing effects volume by float parameter.
Parameters:
| Name | Type |
|---|---|
volume | number |
Returns: Promise‹any›
Promise<{success, value}>
Static setEnableSpeakerphone
▸ setEnableSpeakerphone(enabled: boolean): Promise‹any›
Defined in RtcEngine.native.ts:514
set enable speaker phone
This method set the speaker phone enable or disable by pass boolean parameter.
Parameters:
| Name | Type |
|---|---|
enabled | boolean |
Returns: Promise‹any›
Promise
Static setInEarMonitoringVolume
▸ setInEarMonitoringVolume(volume: number): Promise‹any›
Defined in RtcEngine.native.ts:766
set in-ear monitoring volume
This method sets the in-ear-monitoring volume by number parameter volume
Parameters:
| Name | Type |
|---|---|
volume | number |
Returns: Promise‹any›
Promise
Static setLiveTranscoding
▸ setLiveTranscoding(options: LiveTranscodingOption): Promise‹any›
Defined in RtcEngine.native.ts:1437
set live transcoding
This method sets the video layout and audio settings for CDN live.
Parameters:
| Name | Type | Description |
|---|---|---|
options | LiveTranscodingOption | {@link LiveTranscoding} |
Returns: Promise‹any›
Promise<{success, value}>
Static setLocalPublishFallbackOption
▸ setLocalPublishFallbackOption(option: number): Promise‹any›
Defined in RtcEngine.native.ts:1180
set local publish fallback
This method sets the fallback option for the locally published video stream based on the network conditions.
Parameters:
| Name | Type | Description |
|---|---|---|
option | number | more details |
Returns: Promise‹any›
Promise<{success, value}>
Static setLocalRenderMode
▸ setLocalRenderMode(mode: number): Promise‹any›
Defined in RtcEngine.native.ts:468
set local video render mode
This method calls native sdk render mode for local video.
Parameters:
| Name | Type |
|---|---|
mode | number |
Returns: Promise‹any›
Promise
Static setLocalVideoMirrorMode
▸ setLocalVideoMirrorMode(mode: number): Promise‹any›
Defined in RtcEngine.native.ts:1293
set local video mirror mode
This method sets local video mirror mode
Parameters:
| Name | Type |
|---|---|
mode | number |
Returns: Promise‹any›
Promise<{success, value}>
Static setLocalVoiceChanger
▸ setLocalVoiceChanger(voiceChanger: number): Promise‹any›
Defined in RtcEngine.native.ts:1497
set local voice change
This method changes local speaker voice with voiceChanger
voicechanger value ranges [
0: "The original voice",
1: "An old man’s voice",
2: "A little boy’s voice.",
3: "A little girl’s voice.",
4: "TBD",
5: "Ethereal vocal effects.",
6: "Hulk’s voice."
]
Parameters:
| Name | Type | Description |
|---|---|---|
voiceChanger | number | integer |
Returns: Promise‹any›
Promise
Static setLocalVoiceEqualization
▸ setLocalVoiceEqualization(band: number, gain: number): void
Defined in RtcEngine.native.ts:791
set local voice equalization
This method set local video equalization of band frequency by enum band number and number of gain
Parameters:
| Name | Type |
|---|---|
band | number |
gain | number |
Returns: void
Promise
Static setLocalVoicePitch
▸ setLocalVoicePitch(pitch: number): Promise‹any›
Defined in RtcEngine.native.ts:778
set local voice pitch
This method sets the local voice pitch by float parameter pitch
Parameters:
| Name | Type |
|---|---|
pitch | number |
Returns: Promise‹any›
Promise
Static setLocalVoiceReverb
▸ setLocalVoiceReverb(reverb: number, value: number): void
Defined in RtcEngine.native.ts:802
set local voice reverb
This method sets local voice by reverb and value
Parameters:
| Name | Type | Description |
|---|---|---|
reverb | number | - |
value | number |
Returns: void
Static setLocalVoiceReverbPreset
▸ setLocalVoiceReverbPreset(preset: number): Promise‹any›
Defined in RtcEngine.native.ts:1509
set the preset local voice reverberation effect.
This method sets the preset local voice reverberation effect.
Parameters:
| Name | Type | Description |
|---|---|---|
preset | number | integer |
Returns: Promise‹any›
Promise
Static setLog
▸ setLog(filePath: string, level: number, maxfileSize: number): Promise‹any›
Defined in RtcEngine.native.ts:1401
set log file and log filter
This method sets the log file generated path and specified the log level.
Parameters:
| Name | Type | Description |
|---|---|---|
filePath | string | string |
level | number | enum |
maxfileSize | number | integer (KB) |
Returns: Promise‹any›
Promise<{success, value}>
Static setMixedAudioFrameParameters
▸ setMixedAudioFrameParameters(options: MixedAudioFrameOption): Promise‹any›
Defined in RtcEngine.native.ts:1145
set mixed audio frame parameters
This method Sets the audio frame format for the mixedAudioFrame callback.
Parameters:
| Name | Type | Description |
|---|---|---|
options | MixedAudioFrameOption | MixedAudioFrameOption |
Returns: Promise‹any›
Promise<{success, value}>
Static setParameters
▸ setParameters(paramsStr: string): Promise‹any›
Defined in RtcEngine.native.ts:1699
Set Private Parameters
Parameters:
| Name | Type |
|---|---|
paramsStr | string |
Returns: Promise‹any›
Promise
Static setPlaybackAudioFrameParameters
▸ setPlaybackAudioFrameParameters(options: AudioFrameOption): Promise‹any›
Defined in RtcEngine.native.ts:1133
set playback audio frame parameters
This method Sets the audio frame format for the playbackFrame callback.
Parameters:
| Name | Type | Description |
|---|---|---|
options | AudioFrameOption | AudioFrameOption |
Returns: Promise‹any›
Promise<{success, value}>
Static setRecordingAudioFrameParameters
▸ setRecordingAudioFrameParameters(options: AudioFrameOption): Promise‹any›
Defined in RtcEngine.native.ts:1121
set recording audio frame parameters
This method Sets the audio recording format for the audioFrame callback.
Parameters:
| Name | Type | Description |
|---|---|---|
options | AudioFrameOption | {@link RecordingAudioFrameOption} |
Returns: Promise‹any›
Promise<{success, value}>
Static setRemoteDefaultVideoStreamType
▸ setRemoteDefaultVideoStreamType(options: DefaultVideoStreamOption): Promise‹any›
Defined in RtcEngine.native.ts:1228
set remote default video stream type
This method sets the default video stream type.
Parameters:
| Name | Type | Description |
|---|---|---|
options | DefaultVideoStreamOption | DefaultVideoStreamOption |
Returns: Promise‹any›
Promise<{success, value}>
Static setRemoteRenderMode
▸ setRemoteRenderMode(uid: number, mode: number): Promise‹any›
Defined in RtcEngine.native.ts:481
set the specified remote video render mode
This method calls native sdk render mode for the specified remote video.
Parameters:
| Name | Type |
|---|---|
uid | number |
mode | number |
Returns: Promise‹any›
Promise
Static setRemoteSubscribeFallbackOption
▸ setRemoteSubscribeFallbackOption(option: number): Promise‹any›
Defined in RtcEngine.native.ts:1192
set remote publish fallback
This method sets the fallback option for the remotely subscribed video stream based on the network conditions.
Parameters:
| Name | Type | Description |
|---|---|---|
option | number | more details |
Returns: Promise‹any›
Promise<{success, value}>
Static setRemoteUserPriority
▸ setRemoteUserPriority(uid: number, userPriority: number): Promise‹any›
Defined in RtcEngine.native.ts:1581
sets the priority of a remote user's media stream.
note: Use this method with the setRemoteSubscribeFallbackOption method. If the fallback function is enabled for a subscribed stream, the SDK ensures the high-priority user gets the best possible stream quality.
This method sets the priority of a remote user's media stream.
Parameters:
| Name | Type | Description | |
|---|---|---|---|
uid | number | number | |
userPriority | number | number | The value range is [50 is "user's priority is high", 100 is "the default user's priority is normal"] |
Returns: Promise‹any›
Promise
Static setRemoteVideoStreamType
▸ setRemoteVideoStreamType(options: VideoStreamOption): Promise‹any›
Defined in RtcEngine.native.ts:1216
set remote video stream type
This method sets the remote video stream type by uid and streamType.
Parameters:
| Name | Type | Description |
|---|---|---|
options | VideoStreamOption | VideoStreamOption |
Returns: Promise‹any›
Promise<{success, value}>
Static setRemoteVoicePosition
▸ setRemoteVoicePosition(uid: number, pan: number, gain: number): Promise‹any›
Defined in RtcEngine.native.ts:1539
set the sound position of a remote user
This method sets the sound position of a remote user by uid
pan
0.0: the remote sound comes from the front.
-1.0: the remote sound comes from the left.
1.0: the remote sound comes from the right.
Parameters:
| Name | Type | Description | |
|---|---|---|---|
uid | number | number | The ID of the remote user |
pan | number | float | The sound position of the remote user. The value ranges from -1.0 to 1.0 |
gain | number | float | Gain of the remote user. The value ranges from 0.0 to 100.0. The default value is 100.0 (the original gain of the remote user). The smaller the value, the less the gain. |
Returns: Promise‹any›
Promise
Static setVolumeOfEffect
▸ setVolumeOfEffect(volume: number): Promise‹any›
Defined in RtcEngine.native.ts:931
set volume for playing effects.
This methods set for playing audio mixing effects
Parameters:
| Name | Type |
|---|---|
volume | number |
Returns: Promise‹any›
Promise<{success, value}>
Static startAudioMixing
▸ startAudioMixing(options: AudioMixingOption): void
Defined in RtcEngine.native.ts:813
start audio mixing
This method will start audio mixing by option config
Parameters:
| Name | Type | Description |
|---|---|---|
options | AudioMixingOption | AudioMixingOption |
Returns: void
Static startAudioRecording
▸ startAudioRecording(options: AudioRecordingOption): Promise‹any›
Defined in RtcEngine.native.ts:1040
start audio recording by quality
This method start audio recording by quality config
Parameters:
| Name | Type | Description |
|---|---|---|
options | AudioRecordingOption | AudioRecordingOption |
Returns: Promise‹any›
Promise<{success, value}>
Static startChannelMediaRelay
▸ startChannelMediaRelay(config: ChannelMediaConfiguration): Promise‹any›
Defined in RtcEngine.native.ts:108
Starts to relay media streams across channels.
This method will start relay media stream across specified channels. (maximum support 4 channels) It will occurs event: Occurs mediaRelayStateChanged Occurs receivedChannelMediaRelay when peer channel received this message
Parameters:
| Name | Type | Description |
|---|---|---|
config | ChannelMediaConfiguration | ChannelMediaConfiguration |
Returns: Promise‹any›
Promise
Static startEchoTestWithInterval
▸ startEchoTestWithInterval(interval: number): Promise‹any›
Defined in RtcEngine.native.ts:1600
start an audio call test.
note: Call this method before joining a channel. After calling this method, call the stopEchoTest method to end the test. Otherwise, the app cannot run the next echo test, or call the joinChannel method. In the Live-broadcast profile, only a host can call this method. This method will start an audio call test with interval parameter. In the audio call test, you record your voice. If the recording plays back within the set time interval, the audio devices and the network connection are working properly.
Parameters:
| Name | Type | Description |
|---|---|---|
interval | number | number |
Returns: Promise‹any›
Promise
Static startLastmileProbeTest
▸ startLastmileProbeTest(config: LastmileProbeConfig): Promise‹any›
Defined in RtcEngine.native.ts:1555
start the lastmile probe test
This method start the last-mile network probe test before joining a channel to get the uplink and downlink last-mile network statistics, including the bandwidth, packet loss, jitter, and round-trip time (RTT).
Parameters:
| Name | Type | Description |
|---|---|---|
config | LastmileProbeConfig | LastmileProbeConfig LastmileProbeConfig event onLastmileQuality: the SDK triggers this callback within two seconds depending on the network conditions. This callback rates the network conditions with a score and is more closely linked to the user experience. event onLastmileProbeResult: the SDK triggers this callback within 30 seconds depending on the network conditions. This callback returns the real-time statistics of the network conditions and is more objective. |
Returns: Promise‹any›
Promise
Static startPreview
▸ startPreview(): Promise‹any›
Defined in RtcEngine.native.ts:492
start video preview
This method start video preview for video.
Returns: Promise‹any›
Promise
Static stopAllEffects
▸ stopAllEffects(): Promise‹any›
Defined in RtcEngine.native.ts:963
stop play all for effect audio mixing.
This methods stops all effect audio mixing.
Returns: Promise‹any›
Promise<{success, value}>
Static stopAudioMixing
▸ stopAudioMixing(): void
Defined in RtcEngine.native.ts:822
stop audio mixing
This methods stops for audio mixing.
Returns: void
Static stopAudioRecording
▸ stopAudioRecording(): Promise‹any›
Defined in RtcEngine.native.ts:1050
stop audio recording
This method stops audio recording.
Returns: Promise‹any›
Promise<{success, value}>
Static stopChannelMediaRelay
▸ stopChannelMediaRelay(): Promise‹any›
Defined in RtcEngine.native.ts:147
Stop to relay media streams across channels.
This method will stop relay media stream across specified channels. It will occurs event: Occurs mediaRelayStateChanged
Returns: Promise‹any›
Promise
Static stopEchoTest
▸ stopEchoTest(): Promise‹any›
Defined in RtcEngine.native.ts:1087
stop echo test
This method stop launched an audio call test.
Returns: Promise‹any›
Promise<{success, value}>
Static stopEffect
▸ stopEffect(soundId: number): Promise‹any›
Defined in RtcEngine.native.ts:953
stop play effect for audio mixing
This methods stops the specified effect for audio mixing file by soundId.
Parameters:
| Name | Type |
|---|---|
soundId | number |
Returns: Promise‹any›
Promise<{success, value}>
Static stopLastmileProbeTest
▸ stopLastmileProbeTest(): Promise‹any›
Defined in RtcEngine.native.ts:1566
stop the lastmile probe test
This method stop the lastmile probe test.
Returns: Promise‹any›
Promise
Static stopPreview
▸ stopPreview(): Promise‹any›
Defined in RtcEngine.native.ts:503
stop video preview
This method stops video preview for video.
Returns: Promise‹any›
Promise
Static switchCamera
▸ switchCamera(): Promise‹any›
Defined in RtcEngine.native.ts:1304
switch camera
This method switches camera between front and rear.
Returns: Promise‹any›
Promise<{success, value}>
Static switchChannel
▸ switchChannel(channelName: string, token?: string): Promise‹any›
Defined in RtcEngine.native.ts:94
switch to specified channel
This method will switch channel smoothly than you invoke leaveChannel & joinChannel. Otherwise, it will invoke error by the event It will occurs two events: Occurs leaveChannel when achieve leaving stage Occurs joinChannelSuccess when achieve joining stage
Parameters:
| Name | Type | Description |
|---|---|---|
channelName | string | {@link string} |
token? | string | {@link string} |
Returns: Promise‹any›
Promise
Static unloadEffect
▸ unloadEffect(soundId: number): Promise‹any›
Defined in RtcEngine.native.ts:986
unload effect
This methods unload the already loaded audio mixing file from memory by the soundId.
Parameters:
| Name | Type |
|---|---|
soundId | number |
Returns: Promise‹any›
Promise<{success, value}>
Static updateChannelMediaRelay
▸ updateChannelMediaRelay(config: ChannelMediaConfiguration): Promise‹any›
Defined in RtcEngine.native.ts:134
Updates to relay media streams across channels.
This method will update relay media stream across specified channels. (maximum support 4 channels) It will occurs event: Occurs mediaRelayStateChanged
Parameters:
| Name | Type | Description |
|---|---|---|
config | ChannelMediaConfiguration | ChannelMediaConfiguration |
Returns: Promise‹any›
Promise