Class RtcEngine

This method injects an online media stream to a live broadcast.

This method add publish stream by option.

This method adds video watermark to the local video.

This method adjusts audio mixing playout by the volume parameter

This method adjusts audio mixing publish by the volume paraemter

This method adjusts audio mixing volume by the volume number parameter

This method adjusts playback signal by volume.

This method adjusts recording your signal by volume.

This method stops event subscribe and destroy the RtcEngine instance's. You should call it, when you want to destroy the engine.

This method disables audio

This method disable the network connection qualit test.

This method mutes the local audio stream by muted.

This method disables video.

This method enables audio

This method enables audio volume by interval and smooth

This method enables the dual stream by parameter mode.

This method enables in-ear monitoring by boolean parameter enabled

This method enables the network connection qualit test.

This method enables local audio by the boolean parameter.

This method enables the local video by the boolean parameter.

This method enables/disables stereo panning for remote users.

This method enables video.

This method used to enable websdk interoperability, so that it can connect with agora websdk apps.

This method gets audio mixing current position value.

This method gets the audio mixing duration

note: This method helps troubleshoot audio volume related issues.

note: This method helps troubleshoot audio volume related issues.

This method is used to get call id.

note: This method returns your current device camera support info.

     RtcEngine.getCameraInfo().then(info => {
        console.log("your currrent camera", info);
     })

This method gets the camera maximum zoom ratio.

notice

Android Only

This method gets agora native sdk connection state

This methods get audio mixing effects volume value.

This method gets the sdk version details and passed it into callback function

This method creates and start event observer. You should call this method once.

example

RtcEngine.init(option)

This method joins and begin rendering the video stream. when join succeeds. Otherwise, it will invoke error by the event

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.

This method checks the phone speaker is enabled

This method mutes all remote audio streams by muted

This method mutes all remote streams by the boolean parameter.

This method sends/stops sending the local audio.

This method mutes video stream by the boolean parameter.

This method mutes specified remote audio stream by number uid and boolean muted.

This method mutes remote video stream by the number of uid and boolean parameter.

deprecated

off

This method subscribes specified eventType and run listener. You should call this method at first.

events

---

name | description | usage | error | occurs when emit error | on("error", evt) | warning | occurs when emit warning | on("warning", evt) | messageReceived | occurs when message received | on("messageReceived", evt) | localInvitationReceivedByPeer | occurs when local inviation received by peer | on("localInvitationReceivedByPeer", evt) | localInvitationAccepted | occurs when local invitation accepted | on("localInvitationAccepted", evt) | localInvitationRefused | occurs when local invitation refused | on("localInvitationRefused", evt) | localInvitationCanceled | occurs when local invitation canceled | on("localInvitationCanceled", evt) | localInvitationFailure | occurs when local invitation failure | on("localInvitationFailure", evt) | remoteInvitationFailure | occurs when remote invitation failure | on("remoteInvitationFailure", evt) | remoteInvitationReceived | occurs when remote invitation received | on("remoteInvitationReceived", evt) | remoteInvitationAccepted | occurs when remote invitation accepted | on("remoteInvitationAccepted", evt) | remoteInvitationRefused | occurs when remote invitation refused | on("remoteInvitationRefused", evt) | remoteInvitationCanceled | occurs when remote invitation canceled | on("remoteInvitationCanceled", evt) | channelMessageReceived | occurs when received channel message | on("channelMessageReceived", evt) | channelMemberJoined | occurs when some one joined in the subscribed channel | on("channelMemberJoined", evt) | channelMemberLeft | occurs when sone one left from u subscribed channel | on("channelMemberLeft", evt) | tokenExpired | occurs when token has expired | on("tokenExpired", evt) | apiCallExecute | occurs when apiCallExecute emit, this event is api call monitor | on("apiCallExecute", evt) | joinChannelSuccess | occurs when joinChannel success | on("joinChannelSuccess", evt) | rejoinChannelSuccess | occurs when rejoinChannel success | on("rejoinChannelSuccess", evt) | leaveChannel | occurs when leaveChannel success | on("leaveChannel", evt) | clientRoleChanged | occurs when setClientRole changed | on("clientRoleChanged", evt) | userJoined | occurs when remote user joined | on("userJoined", evt) | userOffline | this event occurs when remote user offline in rtc mode, this events only occurs host user offline in live mode | on("userOffline", evt) | connectionStateChanged | occurs when sdk connection changed state | on("connectionStateChanged", evt) | connectionLost | occurs when sdk connection lost | on("connectionLost", evt) | tokenPrivilegeWillExpire | occurs when token will expire | on("tokenPrivilegeWillExpire", evt) | requestToken | occurs when token expired | on("requestToken") | microphoneEnabled | occurs when microphone enable state changed | on("microphoneEnabled", evt) | audioVolumeIndication | occurs when audio volume indication changed | on("audioVolumeIndication", evt) | activeSpeaker | occurs when detect active speaker | on("activeSpeaker", evt) | firstLocalAudioFrame | occurs when sent first audio frame on local | on("firstLocalAudioFrame", evt) | firstRemoteAudioFrame | occurs when received first audio frame from remote side | on("firstRemoteAudioFrame", evt) | firstRemoteAudioDecoded | occurs when first remote audio decoded | on("firstRemoteAudioDecoded", evt) | firstLocalVideoFrame | occurs when sent first video frame on local | on("firstLocalVideoFrame", evt) | firstRemoteVideoDecoded | occurs when received first video frame from remote side decoded | on("firstRemoteVideoDecoded", evt) | firstRemoteVideoFrame | occurs when received first video frame from remote side | on("firstRemoteVideoFrame", evt) | userMuteAudio | occurs when user mute audio | on("userMuteAudio", evt) | userMuteVideo | occurs when user mute video | on("userMuteVideo", evt) | userEnableVideo | occurs when remote side's user change video enable state | on("userEnableVideo", evt) | userEnableLocalVideo | occurs when user change video enable state on local | on("userEnableLocalVideo", evt) | videoSizeChanged | occurs when change local or remote side video size or rotation | on("videoSizeChanged", evt) | remoteVideoStateChanged | occurs when remote video state has any changed | on("remoteVideoStateChanged", evt) | localPublishFallbackToAudioOnly | occurs when published stream from local side fallback to audio stream | on("localPublishFallbackToAudioOnly", evt) | remoteSubscribeFallbackToAudioOnly | occurs when subscribed side's stream fallback to audio stream | on("remoteSubscribeFallbackToAudioOnly", evt) | audioRouteChanged | occurs when local audio route changed | on("audioRouteChanged", evt) | cameraFocusAreaChanged | occurs when a camera focus area changed | on("cameraFocusAreaChanged", evt) | cameraExposureAreaChanged | occurs when a camera exposure area changed | on("cameraExposureAreaChanged", evt) | rtcStats | occurs when reports the statistics of the current call session once every two seconds. | on("rtcStats", evt) | lastmileQuality | occurs when reports the last mile network quality of the local user once every two seconds before the user joins a channel.| on("lastmileQuality", evt) | networkQuality | occurs when reports the last mile network quality of each user in the channel once every two seconds.| on("networkQuality", evt) | localVideoStats | occurs when reports local video statistics | on("localVideoStats", evt) | remoteVideoStats | occurs when reports remote video statistics| on("remoteVideoStats", evt) | remoteAudioStats | occurs when reports remote audio statistics| on("remoteAudioStats", evt) | audioTransportStatsOfUid | occurs when reports transport-layer statistics of each remote audio stream. | on("audioTransportStatsOfUid", evt) | videoTransportStatsOfUid | occurs when reports transport-layer statistics of each remote video stream.| on("videoTransportStatsOfUid", evt) | audioEffectFinish | occurs when the local audio effect playback finishes. | on("audioEffectFinish", evt) | streamPublished | occurs when addPublishStreamUrl success| on("streamPublished", evt) | streamUnpublish | occurs when removePublishStreamUrl success| on("streamUnpublish", evt) | transcodingUpdate | occurs when the cdn live streaming settings are updated | on("transcodingUpdate", evt) | streamInjectedStatus | occurs when report the status of online injecting stream to a live broadcast | on("streamInjectedStatus", evt) | mediaEngineLoaded | occurs when the media engine loaded | on("mediaEngineLoaded", evt) | mediaEngineStartCall | occurs when the media engine call starts | on("mediaEngineStartCall", evt) | startEchoTestWithInterval | occurs when startEchoTestWithInterval success | on("startEchoTestWithInterval", evt) | audioMixingStateChanged | occurs when reports the local audio mixing state changed | on("audioMixingStateChanged", evt) | lastmileProbeTestResult | occurs when reports the last-mile network probe result.| on("lastmileProbeTestResult", evt) | rtmpStreamingStateChanged | occurs when reports the rtmp injecting stream state changed | on("rtmpStreamingStateChanged", evt) | localVideoChanged | occurs when the local video changed | on("localVideoChanged", evt) | networkTypeChanged | occurs when the device network type changed | on("networkTypeChanged", evt) |

mediaMetaDataReceived | occurs when you received media meta data from the remote side through sendMediaData | on("mediaMetaDataReceived", evt) |

This method pause all effects for audio mixing.

This method pauses for audio mixing.

This method pauses the specified effect for audio mixing by soundid.

This methos plays the specified effect of audio mixing file by option config.

This methods preloads the specified audio mixing file to memory by the soundid

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);
     })

This method removes the watermark image from the video stream added by addVideoWatermark.

deprecated

removeAllListeners

This method removes stream by addInjectsStreamUrl.

This method remove publish stream by options.

This method renews a new token.

This method resumes all audio mixing effects.

This method resumes for audio mixing.

This method resumes audio mixing effect by the specified soundid

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.

deprecated

sendMessage sendMessage

This method sets audio mixing position by the parameter pos

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

This method enables/disables image enhancement and sets the options.

This method enables auto-focus face mode function.

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.

This method sets the mannual exposure position.

This method sets the mannual focus position.

This method enables the camera flash function.

This method sets the camera zoom ratio.

This method changes the client of role.

This method set the default audio speaker enable or disable by pass boolean parameter.

This method set default mute all remote audio streams enable or not by pass boolean parameter.

This method mutes all remote video stream default by the boolean parameter.

This methods set audio mixing effects volume by float parameter.

This method set the speaker phone enable or disable by pass boolean parameter.

This method sets the in-ear-monitoring volume by number parameter volume

This method sets the video layout and audio settings for CDN live.

This method sets the fallback option for the locally published video stream based on the network conditions.

This method calls native sdk render mode for local video.

This method sets local video mirror mode

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." ]

This method set local video equalization of band frequency by enum band number and number of gain

This method sets the local voice pitch by float parameter pitch

This method sets local voice by reverb and value

This method sets the preset local voice reverberation effect.

This method sets the log file generated path and specified the log level.

This method Sets the audio frame format for the mixedAudioFrame callback.

This method Sets the audio frame format for the playbackFrame callback.

This method Sets the audio recording format for the audioFrame callback.

This method sets the default video stream type.

This method calls native sdk render mode for the specified remote video.

This method sets the fallback option for the remotely subscribed video stream based on the network conditions.

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.

This method sets the remote video stream type by uid and streamType.

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.

This methods set for playing audio mixing effects

This method will start audio mixing by option config

This method start audio recording by quality config

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.

This method start video preview for video.

This methods stops all effect audio mixing.

This methods stops for audio mixing.

This method stops audio recording.

This method stop launched an audio call test.

This methods stops the specified effect for audio mixing file by soundid.

This method stop the lastmile probe test.

This method stops video preview for video.

This method switches camera between front and rear.

This methods unload the already loaded audio mixing file from memory by the soundid.