NERtc Android SDK 4.6.10
|
CommsEase NERTC SDK provides a comprehensive Real-time Communication (RTC) development platform that allows developers to implement Internet-based peer-to-peer audio and video calls, and group audio and video conferencing. The SDK enables users to manage audio and video devices and switch audio and video modes during calls. The SDK also implements capturing video data callbacks and offers additional features, such as personalized image enhancement.
channel.NERtcChannel
classes used to implement audio and video calling in a specified room. Users can join multiple rooms by creating multiple NERtcChannel objects.channel.NERtcChannelCallback
used to listen for and report events and data for a specified room.The SDK may return error codes or status codes when your app calls an API. You can learn about the status of the SDK or specific tasks based on the information provided by the error codes or status codes. If unknown errors are returned, you can contact our technical support for help.
The error codes of the current SDK APIs are as follows:
NERtcConstants.ErrorCode
NERtcConstants.AudioMixingError
NERtcConstants.LiveStreamState
NERtcConstants.AudioRecordingCode
NERtcConstants.NERtcLocalVideoWatermarkState
NERtcConstants.RuntimeError
Method | Description | Supported version |
---|---|---|
NERtc#getInstance() | Creates an RTC engine object. | V3.5.0 |
NERtc#init() | Initializes an RTC engine object. | V3.5.0 |
NERtc#release() | Destroys an NERtc instance and releases resources. | V3.5.0 |
NERtcEx#setChannelProfile() | Sets a room scene. | V3.6.0 |
NERtcEx#setClientRole() | Sets the role of a user. | V3.9.0 |
NERtc#joinChannel() | Joins a channel. | V3.5.0 |
NERtcEx#switchChannel() | Switches to another room in live streaming. | V4.1.0 |
NERtc#leaveChannel() | Leaves a channel. | V3.5.0 |
NERtc#setParameters() | Sets complex parameters. To set relevant parameters, you must call this method before calling the init method. | V3.5.0 |
NERtcEx#getConnectionState() | Gets the connection state of a channel. | V3.5.0 |
Event | Description | Supported version |
---|---|---|
NERtcCallback#onClientRoleChange() | Occurs when a user changes the role in live streaming. | V3.9.0 |
NERtcCallback#onJoinChannel() | Occurs when a user joins a channel. | V3.5.0 |
NERtcCallbackEx#onReJoinChannel() | Occurs when a user rejoins a room. | V3.5.0 |
NERtcCallback#onLeaveChannel() | Occurs when a user leaves a room. | V3.5.0 |
NERtcCallbackEx#onReconnectingStart() | Occurs when reconnection starts. | V3.7.0 |
NERtcCallback#onUserJoined() | Occurs when a remote user joins the current room. | V3.5.0 |
NERtcCallback#onUserLeave() | Occurs when a remote user leaves a room. | V3.5.0 |
NERtcCallback#onDisconnect() | Occurs when the server becomes disconnected. callback. | V3.5.0 |
NERtcCallbackEx#onConnectionTypeChanged() | Occurs when the type of the local network changes. | V3.5.0 |
NERtcCallbackEx#onConnectionStateChanged() | Occurs when the connection state changes | V3.8.0 |
Method | Description | Supported version |
---|---|---|
NERtc#setAudioProfile() | Sets the audio profile. | V3.5.0 |
NERtcEx#adjustRecordingSignalVolume() | Adjusts the recording volume. | V3.5.0 |
NERtcEx#adjustPlaybackSignalVolume() | Adjusts the playback volume. | V3.5.0 |
NERtcEx#adjustUserPlaybackSignalVolume() | Adjusts the local playback volume of the stream from a specified remote user. | V4.2.1 |
NERtc#enableLocalAudio() | Stops or resumes local audio capture. | V3.5.0 |
NERtcEx#muteLocalAudioStream() | Mutes or unmutes local audio. | V3.5.0 |
NERtc#subscribeRemoteAudioStream() | Subscribes to or unsubscribes from all remote audio streams. | V3.5.0 |
NERtc#subscribeAllRemoteAudioStreams() | Subscribes to or unsubscribes from all remote audio streams. | V3.5.0 |
NERtcEx#setAudioProcessObserver() | Registers the audio processing observer and set the audio processing callback | V3.9.0 |
NERtcEx#setRemoteHighPriorityAudioStream() | Sets high priority to a remote audio stream. | V4.6.0 |
NERtcEx#enableLoopbackRecording() | Enables or disables audio sharing. | V4.6.0 |
NERtcEx#adjustLoopBackRecordingSignalVolume() | Adjusts audio sharing volume | V4.6.0 |
NERtcEx#enableLocalSubStreamAudio() | Enables or disables the audio substream. | V4.6.10 |
NERtcEx#subscribeRemoteSubStreamAudio() | Subscribes to the audio substream from a specified remote user. | V4.6.10 |
NERtcEx#muteLocalSubStreamAudio() | Mutes the local audio substream. | V4.6.10 |
NERtcEx#setAudioSubscribeOnlyBy() | Allows the local audio stream to be subscribed only by specified users in the room. | V4.6.10 |
NERtcEx#enableMediaPub() | Publishes or unpublishes the local audio stream. | V4.6.10 |
Event | Description | Supported version |
---|---|---|
NERtcAudioProcessObserver#onAudioHasHowling() | Occurs when howling is detected. | V3.9.0 |
NERtcAudioFrameObserver#onRecordSubStreamAudioFrame() | Returns the audio substream data. | V4.6.10 |
NERtcAudioFrameObserver#onPlaybackSubStreamAudioFrameBeforeMixingWithUserID() | Gets the substream data of a remote user publishing the audio substream. | V4.6.10 |
Method | Description | Supported version |
---|---|---|
NERtc#enableLocalVideo() | Enables or disables the local video stream. | V3.5.0 |
NERtc#setCameraCaptureConfig() | Sets the configuration for capturing the camera data. | V4.5.0 |
NERtc#setLocalVideoConfig() | Sets the local video configuration. | V3.5.0 |
NERtc#setupLocalVideoCanvas() | Sets the local video canvas. | V3.5.0 |
NERtc#setupRemoteVideoCanvas() | Sets the remote video canvas. | V3.5.0 |
NERtc#startVideoPreview() | Starts video preview. | V3.5.0 |
NERtc#stopVideoPreview() | Stops video preview | V3.5.0 |
NERtcEx#muteLocalVideoStream() | Mutes or unmutes local video stream. | V3.5.0 |
NERtc#subscribeRemoteVideoStream() | Subscribes to or unsubscribes from video streams from specified remote users. | V3.5.0 |
NERtcVideoView#setScalingType() | Sets the rendering mode. | V3.5.0 |
NERtcEx#postOnGLThread() | Integrates a specific operation in a thread that contains GLContext. For example, destroying third-party filter assets. | V3.5.0 |
NERtcEx#enableSuperResolution() | Enables or disables AI-powered super resolution. | V4.4.0 |
NERtcEx#enableVideoCorrection() | Enables or disables video correction. | V4.6.0 |
NERtcEx#setVideoCorrectionConfig() | Sets the parameters of video correction configuration. | V4.6.0 |
NERtcEx#enableVirtualBackground() | Enables the virtual background. | V4.6.10 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onFirstAudioFrameDecoded() | Occurs when the first audio frame from a remote user is decoded. | V3.9.0 |
NERtcCallbackEx#onFirstVideoFrameDecoded() | Occurs when the first video frame from a remote user is decoded. | V3.9.0 |
NERtcCallbackEx#onFirstVideoDataReceived() | Occurs when the first video frame from a remote user is received. | V3.9.0 |
NERtcCallbackEx#onFirstAudioDataReceived() | Occurs when the first audio frame from a remote user is received. | V3.9.0 |
NERtcCallbackEx#onMediaRightChange() | Occurs when audio and video permissions are revoked on the server side. | V3.9.0 |
NERtcCallbackEx#onVirtualBackgroundSourceEnabled() | Callback that returns the result of enabling the virtual background | V4.6.10 |
Method | Description | Supported version |
---|---|---|
NERtcCallbackEx#onUserVideoProfileUpdate() | Occurs when a remote user changes the video resolution type. | V3.5.0 |
NERtcCallbackEx#onUserVideoMute() | Occurs when a remote user closes the video. | V3.5.0 |
NERtcCallbackEx#onUserAudioMute() | Occurs when a remote user mutes the audio. | V3.5.0 |
NERtcCallbackEx#onUserSubStreamAudioMute() | Occurs when a remote user unpublishes the audio substream. | V4.6.10 |
NERtcCallback#onUserAudioStart() | Occurs when a remote user enables the audio. | V3.5.0 |
NERtcCallbackEx#onUserSubStreamAudioStart() | Occurs when a remote user publishes the audio substream. | V4.6.10 |
NERtcCallback#onUserAudioStop() | Occurs when a remote user stops the audio stream. | V3.5.0 |
NERtcCallbackEx#onUserSubStreamAudioStop() | Occurs when a remote user unpublishes the audio substream. | V4.6.10 |
NERtcCallback#onUserVideoStart() | Occurs when a remote user enables the video. | V3.5.0 |
NERtcCallback#onUserVideoStop() | Occurs when a remote user stops sending the video stream. | V3.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcStatsObserver#onRtcStats() | Occurs when the stats for the current call is collected. The callback is triggered every 2 seconds. | V3.5.0 |
NERtcStatsObserver#onNetworkQuality() | Occurs when the stats of uplink and downlink network quality for each user are reported during the call | V3.5.0 |
NERtcStatsObserver#onLocalAudioStats() | Occurs when the stats of the local audio stream are collected. | V3.5.0 |
NERtcStatsObserver#onLocalVideoStats() | Occurs when the stats of the local video stream are collected. | V3.5.0 |
NERtcStatsObserver#onRemoteAudioStats() | Occurs when the stats of the remote audio stream in the call are collected. | V3.5.0 |
NERtcStatsObserver#onRemoteVideoStats() | Occurs when the stats of the video stream in the call are collected. | V3.5.0 |
NERtcEx#setStatsObserver() | Gets notified when the stats are collected. | V3.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#createChannel() | Creates and gets an NERtcChannel object. Users can join multiple rooms by creating multiple NERtcChannel objects. | V4.5.0 |
channel.NERtcChannel | The classes provide methods to implement audio and video calling in a specified room. | V4.5.0 |
channel.NERtcChannelCallback | The classes provide callbacks for listening to events and returning data in a specified room. | V4.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#setupLocalSubStreamVideoCanvas() | Sets a playback canvas for local video substream. | V3.9.0 |
NERtcEx#setupRemoteSubStreamVideoCanvas() | Sets a playback canvas for remote video substream. | V3.9.0 |
NERtcEx#startScreenCapture() | Starts screen sharing. | V3.5.0 |
NERtcEx#stopScreenCapture() | Stops screen sharing | V3.5.0 |
NERtcEx#subscribeRemoteSubStreamVideo() | Subscribes to or unsubscribes from the remote video substream for screen sharing. You can receive the video substream data only after you subscribe to the remote video substream. | V3.9.0 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onUserSubStreamVideoStart() | Occurs when a remote user starts screen sharing through the substream. | V3.9.0 |
NERtcCallbackEx#onUserSubStreamVideoStop() | Occurs when a remote user stops screen sharing through the substream. | V3.9.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#startBeauty() | Enables the beauty module. | V4.6.10 |
NERtcEx#stopBeauty() | Stops the beauty module. | V4.6.10 |
NERtcEx#enableBeauty() | Pauses or resumes beauty effects | V4.6.10 |
NERtcEx#setBeautyEffect() | Sets a beauty effect. | V4.6.10 |
NERtcEx#addBeautyFilter() | Adds a filter effect | V4.6.10 |
NERtcEx#removeBeautyFilter() | Removes a filter | V4.6.10 |
NERtcEx#setBeautyFilterLevel() | Sets the filter intensity | V4.6.10 |
Method | Description | Supported version |
---|---|---|
NERtcEx#enableDualStreamMode() | Enables or disables the video dual stream mode. | V3.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#setLocalPublishFallbackOption() | Sets the fallback option for the published local video stream for unreliable network conditions. | V4.3.0 |
NERtcEx#setRemoteSubscribeFallbackOption() | Sets the fallback option for the subscribed remote audio and video stream for unreliable network conditions. | V4.3.0 |
NERtcEx#setLocalMediaPriority() | Sets the priority of local media streams. | V4.2.0 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onLocalPublishFallbackToAudioOnly() | Occurs when the published local media stream falls back to an audio-only stream or switches back to an audio and video stream. | V4.3.0 |
NERtcCallbackEx#onRemoteSubscribeFallbackToAudioOnly() | Occurs when the subscribed remote media stream falls back to an audio-only stream or switches back to an audio and video stream. | V4.3.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#startLastmileProbeTest() | Performs a probe test before starting a call. | V4.5.0 |
NERtcEx#stopLastmileProbeTest() | Performs a probe test before stopping a call. | V4.5.0 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onLastmileQuality() | Reports the network quality of the current user. | V4.5.0 |
NERtcCallbackEx#onLastmileProbeResult() | Reports the upstream and downstream network quality of the last mile before starting a call. | V4.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#startAudioMixing() | Starts to play a music file. | V3.5.0 |
NERtcEx#stopAudioMixing() | Stops playing a music file. | V3.5.0 |
NERtcEx#pauseAudioMixing() | Pauses playing a music file. | V3.5.0 |
NERtcEx#resumeAudioMixing() | Resumes playing a music file. | V3.5.0 |
NERtcEx#setAudioMixingPlaybackVolume() | Sets the playback volume of a music file. | V3.5.0 |
NERtcEx#setAudioMixingSendVolume() | Sets the publishing volume of a music file. | V3.5.0 |
NERtcEx#getAudioMixingPlaybackVolume() | Gets the playback volume of a music file. | V3.5.0 |
NERtcEx#getAudioMixingSendVolume() | Get the publishing volume of a music file. | V3.5.0 |
NERtcEx#getAudioMixingDuration() | Gets the total duration of a music file | V3.5.0 |
NERtcEx#setAudioMixingPosition() | Sets the playback position of a music file. | V3.5.0 |
NERtcEx#getAudioMixingCurrentPosition() | Gets the current playback position of a music file. | V3.5.0 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onAudioMixingStateChanged() | Occurs when the playback status of a local music file changes. | V3.5.0 |
NERtcCallbackEx#onAudioMixingTimestampUpdate() | Occurs when the timestamp of a music file is updated. | V3.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#getEffectPlaybackVolume() | Gets the playback volume of an audio effect file. | V3.5.0 |
NERtcEx#setEffectPlaybackVolume() | Sets the playback volume of an audio effect file. | V3.5.0 |
NERtcEx#playEffect() | Plays back a specified audio effect file | V3.5.0 |
NERtcEx#stopEffect() | Stops playing a specified audio effect file. | V3.5.0 |
NERtcEx#stopAllEffects() | Stops playing all audio effect files. | V3.5.0 |
NERtcEx#pauseEffect() | Pauses the playback of an audio effect file. | V3.5.0 |
NERtcEx#pauseAllEffects() | Pauses all audio file playback | V3.5.0 |
NERtcEx#resumeEffect() | Resumes playing back a specified audio effect file. | V3.5.0 |
NERtcEx#resumeAllEffects() | Resumes playing back all audio effect files. | V3.5.0 |
NERtcEx#setEffectSendVolume() | Adjusts the publishing volume of a effect file. | V3.5.0 |
NERtcEx#getEffectSendVolume() | Gets the publishing volume of an effect file. | V3.5.0 |
NERtcEx#getEffectDuration() | Gets the duration of of an audio effect file. | V4.4.0 |
NERtcEx#getEffectCurrentPosition() | Gets the playback position of an audio effect file. | V4.4.0 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onAudioEffectFinished() | Occurs when the playback of an audio effect file ends | V3.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#setAudioEffectPreset() | Sets a voice change effect preset by the SDK. | 4.1.0 |
NERtcEx#setVoiceBeautifierPreset() | Sets an voice beautifier effect preset by the SDK. | 4.0.0 |
NERtcEx#setLocalVoiceEqualization() | Sets the local voice equalization effect. You can customize the center frequencies of the local voice effects. | 4.0.0 |
NERtcEx#setLocalVoicePitch() | Sets the voice pitch of a local voice. | 4.1.0 |
NERtcEx#setLocalVoiceReverbParam() | Enables the local reverb effect. | 4.6.10 |
Method | Description | Supported version |
---|---|---|
NERtcEx#sendSEIMsg() | Sends supplemental enhancement information (SEI) messages through the bigtream. | V4.0.0 |
NERtcEx#sendSEIMsg() | Sends SEI messages. You can use the bigstream or substream to send SEI messages by calling this method. | V4.0.0 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onRecvSEIMsg() | Occurs when the message that contains the SEI of the remote stream. | V4.0.0 |
Note: This methods are applicable only to Interactive Live Streaming v2.0.
Method | Description | Supported version |
---|---|---|
NERtcEx#addLiveStreamTask() | Adds a streaming task in a room. | V3.5.0 |
NERtcEx#updateLiveStreamTask() | Updates a streaming task in a room. | V3.5.0 |
NERtcEx#removeLiveStreamTask() | Deletes a streaming task in a room. | V3.5.0 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onLiveStreamState() | Live streaming status callbacks | V3.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#startChannelMediaRelay() | Starts relaying media streams across channels. | V4.2.1 |
NERtcEx#updateChannelMediaRelay() | Updates the information about the destination room to which the media stream is relayed. | V4.2.1 |
NERtcEx#stopChannelMediaRelay() | Stops media stream relay across rooms. | V4.2.1 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onMediaRelayStatesChange() | Occurs when the status of media stream relay changes. | V4.2.1 |
NERtcCallbackEx#onMediaRelayReceiveEvent() | Occurs when events about media stream relay are triggered. | V4.2.1 |
Method | Description | Supported version |
---|---|---|
NERtcEx#enableAudioVolumeIndication(boolean enable,int interval) | Enables volume indication for the current speaker. | V3.5.0 |
NERtcEx#enableAudioVolumeIndication(boolean enable,int interval,boolean enableVad) | Enables volume indication for the current speaker and voice detection. | V4.6.10 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onRemoteAudioVolumeIndication() | Occurs when the system indicates the active speaker and the audio volume. | V3.5.0 |
NERtcCallbackEx#onLocalAudioVolumeIndication(int volume) | Occurs when the system indicates current local audio volume in the room. | V3.5.0 |
NERtcCallbackEx#onLocalAudioVolumeIndication(int volume, boolean vadFlag) | Occurs when the system indicates current local audio volume in the room and detects voice activities. | V4.6.10 |
Method | Description | Supported version |
---|---|---|
NERtcEx#enableEarback() | enables the in-ear monitoring feature. | V3.5.0 |
NERtcEx#setEarbackVolume() | Sets the volume for in-ear monitoring. | V3.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#setSpeakerphoneOn() | Turns on or off the speaker | V3.5.0 |
NERtcEx#isSpeakerphoneOn() | Checks if the speaker is turned on | V3.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#enableDualStreamMode() | Enables or disables the video dual stream mode. | V3.7.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#setExternalAudioSource() | Enables external source for the audio mainstream and sets the capture parameters. | V3.9.0 |
NERtcEx#setExternalSubStreamAudioSource() | Enables external source for the audio substream and sets the capture parameters. | V4.6.10 |
NERtcEx#pushExternalAudioFrame() | Pushes the mainstream audio data captured from the external audio source to the internal audio engine. | V3.9.0 |
NERtcEx#pushExternalSubStreamAudioFrame() | Pushes the substream audio data captured from the external audio source to the internal audio engine. | V4.6.10 |
NERtcEx#setExternalAudioRender() | Sets external audio rendering. | V4.0.0 |
NERtcEx#pullExternalAudioFrame() | Pulls the external audio data | V4.0.0 |
NERtcEx#setStreamAlignmentProperty() | Syncs the local system time with the server time. | V4.6.10 |
NERtcEx#getNtpTimeOffset() | Gets the difference between the local system time and the server time. | V4.6.10 |
Method | Description | Supported version |
---|---|---|
NERtcEx#setExternalVideoSource() | Configures external video source. | V3.5.0 |
NERtcEx#pushExternalVideoFrame() | Pushes the external video frame data captured from the external video source. | V3.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#setRecordingAudioFrameParameters() | Sets the audio recording format. | V3.5.0 |
NERtcEx#setPlaybackAudioFrameParameters() | Sets the audio playback format. | V3.5.0 |
NERtcEx#setAudioFrameObserver() | Registers the audio frame observer. | V3.5.0 |
NERtcEx#setMixedAudioFrameParameters() | Sets the sample rate of the mixed stream after the audio is captured and playback. You must call this method before you join a room. | V3.9.0 |
Event | Description | Supported version |
---|---|---|
NERtcAudioFrameObserver#onRecordFrame() | Retrieves the audio data captured. | V3.5.0 |
NERtcAudioFrameObserver#onPlaybackFrame() | Retrieves the audio playback data. | V3.5.0 |
NERtcAudioFrameObserver#onMixedAudioFrame() | Retrieves the mixed recorded and playback audio frame. | V3.5.0 |
NERtcAudioFrameObserver#onPlaybackAudioFrameBeforeMixingWithUserID(long, NERtcAudioFrame) | Returns the raw audio frames of a remote user. The API is deprecated. Use NERtcAudioFrameObserver#onPlaybackAudioFrameBeforeMixingWithUserID(long, NERtcAudioFrame, long) instead. | V3.5.0 |
NERtcAudioFrameObserver#onPlaybackAudioFrameBeforeMixingWithUserID(long, NERtcAudioFrame, long) | Returns the raw audio frames of a remote user. | V4.5.0 |
Event | Description | Supported version |
---|---|---|
NERtcEx#setVideoCallback() | Retrieves the video data captured. | V3.5.0 |
Event | Description | Supported version |
---|---|---|
NERtcVideoCallback#onVideoCallback() | Returns the local video data captured. | V3.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#takeLocalSnapshot() | Takes a local video snapshot. | V4.2.0 |
NERtcEx#takeRemoteSnapshot() | Takes a snapshot of a remote video screen. | V4.2.0 |
Event | Description | Supported version |
---|---|---|
NERtcTakeSnapshotCallback#onTakeSnapshotResult() | Returns the screenshot result. | V4.2.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#setLocalCanvasWatermarkConfigs() | Adds a watermark to the local video canvas (deprecated). | V4.2.0 |
NERtcEx#setLocalVideoWatermarkConfigs() | Adds a watermark to the local video. | V4.6.10 |
NERtcEx#setRemoteCanvasWatermarkConfigs() | Adds a watermark to the remote video canvas (deprecated). | V4.2.0 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onLocalVideoWatermarkState() | Returns the watermark result. | V4.6.10 |
Method | Description | Supported version |
---|---|---|
NERtcEx#enableEncryption() | Enables or disables media stream encryption. | V4.4.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#startAudioRecording() | Starts an audio recording on a client. | V4.2.0 |
NERtcEx#startAudioRecordingWithConfig() | Starts an audio recording on a client. | V4.6.0 |
NERtcEx#stopAudioRecording() | Stops an audio recording on the client. | V4.2.0 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onAudioRecording() | Returns the audio recording status. | V4.2.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#setCloudProxy() | Enables and sets the cloud proxy service. | V4.6.0 |
Method | Description | Supported version |
---|---|---|
NERtc#checkPermission() | Checks the device permissions, for example, microphone and camera permissions. | V3.5.0 |
NERtcEx#switchCamera() | Switches between front and rear cameras. | V3.5.0 |
NERtcEx#switchCameraWithPosition() | Specifies the front or rear camera. | V4.6.10 |
NERtcEx#getCurrentCamera() | Check the direction of the current camera. | V4.5.0 |
NERtcEx#isCameraZoomSupported() | Checks whether the camera zoom function is supported. | V3.5.0 |
NERtcEx#setCameraZoomFactor() | Sets the camera zoom ratio. | V3.5.0 |
NERtcEx#getCameraCurrentZoom() | Gets the scale of the current camera | V3.5.0 |
NERtcEx#getCameraMaxZoom() | Gets the maximum zoom ratio supported by the camera. | V3.5.0 |
NERtcEx#isCameraTorchSupported() | Checks whether the camera flash is supported. | V3.5.0 |
NERtcEx#isCameraFocusSupported() | Checks whether the camera manual focus function is supported. | V3.5.0 |
NERtcEx#setCameraFocusPosition() | Sets the current camera focus position | V3.5.0 |
NERtcEx#isCameraExposurePositionSupported() | Checks whether the camera exposure function is supported. | V3.5.0 |
NERtcEx#setCameraExposurePosition() | Sets the camera manual exposure position. | V3.5.0 |
NERtcEx#setCameraTorchOn() | Sets the camera flash function. | V3.5.0 |
NERtcEx#setPlayoutDeviceMute() | Mutes or unmutes the audio playback device. | V3.5.0 |
NERtcEx#isPlayoutDeviceMute() | Gets whether the audio playback device is muted. | V3.5.0 |
NERtcEx#setRecordDeviceMute() | Sets the status of the recording device | V3.5.0 |
NERtcEx#isRecordDeviceMute() | Gets whether the audio capture device is muted. | V3.5.0 |
NERtc#version() | NERtc SDK version number | V3.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcCallbackEx#onAudioDeviceChanged() | Occurs when the status of the audio playback device changes. | V3.5.0 |
NERtcCallbackEx#onAudioDeviceStateChange() | Occurs when the status of the video playback device. | V3.5.0 |
NERtcCallbackEx#onVideoDeviceStageChange() | Occurs when video devices change | V3.5.0 |
NERtcCallbackEx#onCameraFocusChanged() | Occurs when the camera focus position changes. | V3.5.0 |
NERtcCallbackEx#onCameraExposureChanged() | Occurs when the camera exposure position changes. | V3.5.0 |
Method | Description | Supported version |
---|---|---|
NERtcEx#uploadSdkInfo() | Uploads the log records collected by the SDK. | V3.5.0 |
NERtcEx#startAudioDump() | Starts recording an audio dump file. | V3.5.0 |
NERtcEx#stopAudioDump() | Stops recording an audio dump file. | V3.5.0 |
Event | Description | Supported version |
---|---|---|
NERtcCallbackEx#onWarning() | Occurs when a warning is triggered. | V3.5.0 |
NERtcCallbackEx#onError() | Occurs when a runtime error occurred in the engine and manual troubleshooting is required. | V3.5.0 |