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).
LastmileProbeConfig {@link LastmileProbeConfig}
Promise<{success, value}>
add inject stream url
This method injects an online media stream to a live broadcast.
Promise<{success, value}>
add publish stream url
This method add publish stream by option.
Promise<{success, value}>
add video watermark
This method adds video watermark to the local video.
Promise<{success, value}>
adjust audio mixing playout volume
This method adjusts audio mixing playout by the volume parameter
adjust audio mixing publish volume
This method adjusts audio mixing publish by the volume paraemter
adjust audio mixing volume
This method adjusts audio mixing volume by the volume number parameter
adjust playback signal volume
This method adjusts playback signal by volume.
adjust recording signal volume
This method adjusts recording your signal by volume.
create data stream
This method creates data stream with options
destroy
This method stops event subscribe and destroy the RtcEngine instance's. You should call it, when you want to destroy the engine.
Promise<{success, value}>
disable audio
This method disables audio
disable lastmile test
This method disable the network connection qualit test.
Promise<{success, value}>
mute local audio stream
This method mutes the local audio stream by muted.
disable video
This method disables video.
enable audio
This method enables audio
enable audio volume indication
This method enables audio volume by interval and smooth
enable dual stream mode
This method enables the dual stream by parameter mode.
Promise<{success, value}>
enable in-ear monitor
This method enables in-ear monitoring by boolean parameter enabled
enable lastmile test
This method enables the network connection qualit test.
Promise<{success, value}>
enable local audio
This method enables local audio by the boolean parameter.
enable local video
This method enables the local video by the boolean parameter.
control stereo panning for remote users
This method enables/disables stereo panning for remote users.
boolean
Promise<{success, value}>
enable video
This method enables video.
enable websdk interoperability
This method used to enable websdk interoperability, so that it can connect with agora websdk apps.
Promise<{success, value}>
get audio mixing current position
This method gets audio mixing current position value.
Promise<{success, value}>
get audio mixing duration
This method gets the audio mixing duration
Promise<{success, value}>
get call id
This method is used to get call id.
Promise<{success, value}>
get camera max zoom ratio
This method gets the camera maximum zoom ratio.
Promise<{success, value}>
get agora native sdk connection state
This method gets agora native sdk connection state
Promise<{success: true, state: (connection state)}>
get effects of volume
This methods get audio mixing effects volume value.
Promise<{success, value}>
get sdk version
This method gets the sdk version details and passed it into callback function
to handle resolve from getSdkVersion
to handle reject error from getSdkVersion
Creates a RtcEngine Object internal.
This method creates and start event observer. You should call this method once.
Defines the property of the client, see {@link Option} for details.
is camera auto focus face mode supported
This method checks whether the camera mannual auto-face focus function is supported.
Promise<{success, value}>
is camera exposure position supported
This method checks whether the camera mannual exposure function is supported.
Promise<{success, value}>
is camera focus supported
This method checks whether the camera mannual focus function is supported.
Promise<{success, value}>
is camera torch supported
This method checks whether the camera flash function is supported.
Promise<{success, value}>
is camera zoom supported
This method checks whether the camera zoom function is supported.
Promise<{success, value}>
join specified channel
This method joins and begin rendering the video stream. when join succeeds. Otherwise, it will invoke error by the event
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.
Promise<{success, value}>
check for mobile phone speaker enabled
This method checks the phone speaker is enabled
mute all remote audio streams
This method mutes all remote audio streams by muted
mute all remote video streams
This method mutes all remote streams by the boolean parameter.
mute local audio stream
This method sends/stops sending the local audio.
mute local video stream
This method mutes video stream by the boolean parameter.
mute specified remote audio stream by muted
This method mutes specified remote audio stream by number uid and boolean muted.
mute specified remote video stream.
This method mutes remote video stream by the number of uid and boolean parameter.
remove event listeners
This method unsubscribes specified eventType related all listeners. You should call this method when you want to unsubscribe some eventType.
add event listener
This method subscribes specified eventType and run listener. You should call this method at first.
pause all effects for audio mixing
This method pause all effects for audio mixing.
Promise<{success, value}>
pause audio mixing
This method pauses for audio mixing.
pause the specified effect for audio mixing by soundid
This method pauses the specified effect for audio mixing by soundid.
Promise<{success, value}>
play specified effect for audio mixing
This methos plays the specified effect of audio mixing file by option config.
Promise<{success, value}>
preload effect for audio mixing file.
This methods preloads the specified audio mixing file to memory by the soundid
Promise<{success, value}>
clear video watermarks
This method removes the watermark image from the video stream added by addVideoWatermark.
Promise<{success, value}>
remove all events listeners
This method unsubscribes all eventTypes related listeners.
remove inject stream url
This method removes stream by addInjectsStreamUrl.
Promise<{success, value}>
remove publish stream url
This method remove publish stream by options.
Promise<{success, value}>
renew token
This method renews a new token.
resume all audio mixing effects.
This method resumes all audio mixing effects.
Promise<{success, value}>
resume audio mixing
This method resumes for audio mixing.
resume audio mixing effect by the specified soundid
This method resumes audio mixing effect by the specified soundid
Promise<{success, value}>
send stream message
This method sends stream message by specified uid
Promise<{success, value}>
set audio mixing position
This method sets audio mixing position by the parameter pos
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.
video pre-process/post-process
This method enables/disables image enhancement and sets the options.
Promise<{success, value}>
set enable auto focus face mode
This method enables auto-focus face mode function.
boolean
Promise<{success, value}>
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.
Promise<{success, value}>
set camera exposure position
This method sets the mannual exposure position.
Promise<{success, value}>
set camera focus position in preview
This method sets the mannual focus position.
Promise<{success, value}>
set camera torch on
This method enables the camera flash function.
Promise<{success, value}>
set camera zoom ratio
This method sets the camera zoom ratio.
Promise<{success, value}>
change the client role
This method changes the client of role.
(audience: 0, host: 1)
set default audio speaker
This method set the default audio speaker enable or disable by pass boolean parameter.
set default mute all remote audio streams
This method set default mute all remote audio streams enable or not by pass boolean parameter.
set default mute all remote video stream
This method mutes all remote video stream default by the boolean parameter.
set effects volume
This methods set audio mixing effects volume by float parameter.
Promise<{success, value}>
set enable speaker phone
This method set the speaker phone enable or disable by pass boolean parameter.
set in-ear monitoring volume
This method sets the in-ear-monitoring volume by number parameter volume
set live transcoding
This method sets the video layout and audio settings for CDN live.
Promise<{success, value}>
set local publish fallback
This method sets the fallback option for the locally published video stream based on the network conditions.
Promise<{success, value}>
set local video render mode
This method calls native sdk render mode for local video.
set local video mirror mode
This method sets local video mirror mode
Promise<{success, value}>
set local voice change
This method changes local speaker voice with voiceChanger
integer
Promise<{success, value}>
set local voice equalization
This method set local video equalization of band frequency by enum band number and number of gain
set local voice pitch
This method sets the local voice pitch by float parameter pitch
set local voice reverb
This method sets local voice by reverb and value
set the preset local voice reverberation effect.
This method sets the preset local voice reverberation effect.
integer
Promise<{success, value}>
set log file and log filter
This method sets the log file generated path and specified the log level.
string
enum
integer (KB)
Promise<{success, value}>
set mixed audio frame parameters
This method Sets the audio frame format for the mixedAudioFrame callback.
Promise<{success, value}>
set playback audio frame parameters
This method Sets the audio frame format for the playbackFrame callback.
Promise<{success, value}>
set recording audio frame parameters
This method Sets the audio recording format for the audioFrame callback.
Promise<{success, value}>
set remote default video stream type
This method sets the default video stream type.
Promise<{success, value}>
set the specified remote video render mode
This method calls native sdk render mode for the specified remote video.
set remote publish fallback
This method sets the fallback option for the remotely subscribed video stream based on the network conditions.
Promise<{success, value}>
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.
number
Promise<{success, value}>
set remote video stream type
This method sets the remote video stream type by uid and streamType.
Promise<{success, value}>
set the sound position of a remote user
This method sets the sound position of a remote user by uid
number | The ID of the remote user
float | The sound position of the remote user. The value ranges from -1.0 to 1.0
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.
Promise<{success, value}>
set volume for playing effects.
This methods set for playing audio mixing effects
Promise<{success, value}>
show local video
This method calls native sdk render canvas for local video.
show remote video
This method calls native sdk render canvas for remote video.
start audio mixing
This method will start audio mixing by option config
start audio recording by quality
This method start audio recording by quality config
Promise<{success, value}>
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.
number
Promise<{success, value}>
start video preview
This method start video preview for video.
stop play all for effect audio mixing.
This methods stops all effect audio mixing.
Promise<{success, value}>
stop audio mixing
This methods stops for audio mixing.
stop audio recording
This method stops audio recording.
Promise<{success, value}>
stop echo test
This method stop launched an audio call test.
Promise<{success, value}>
stop play effect for audio mixing
This methods stops the specified effect for audio mixing file by soundid.
Promise<{success, value}>
stop the lastmile probe test
This method stop the lastmile probe test.
Promise<{success, value}>
stop video preview
This method stops video preview for video.
switch camera
This method switches camera between front and rear.
Promise<{success, value}>
unload effect
This methods unload the already loaded audio mixing file from memory by the soundid.
Promise<{success, value}>
Generated using TypeDoc
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.