Agora Java API Reference for Android
Public Member Functions | List of all members
io.agora.rtc2.RtcEngineInternal Class Referenceabstract
Inheritance diagram for io.agora.rtc2.RtcEngineInternal:
io.agora.rtc2.RtcEngineEx io.agora.rtc2.RtcEngine

Public Member Functions

abstract int setProfile (String profile, boolean merge)
 
abstract int enableTransportQualityIndication (boolean enabled)
 
abstract String makeQualityReportUrl (String channel, String listenerUid, String speakerUid, int format)
 
abstract int updateSharedContext (EGLContext sharedContext)
 
abstract int updateSharedContext (android.opengl.EGLContext sharedContext)
 
abstract int setTextureId (int id, EGLContext eglContext, int width, int height, long ts)
 
abstract int setTextureId (int id, android.opengl.EGLContext eglContext, int width, int height, long ts)
 
abstract int monitorAudioRouteChange (boolean isMonitoring)
 
abstract int setApiCallMode (int syncCallTimeout)
 
- Public Member Functions inherited from io.agora.rtc2.RtcEngineEx
abstract int muteLocalAudioStreamEx (boolean muted, RtcConnection connection)
 Stops or resumes publishing the local audio stream. More...
 
abstract int muteLocalVideoStreamEx (boolean muted, RtcConnection connection)
 Stops or resumes publishing the local video stream. More...
 
abstract int muteAllRemoteAudioStreamsEx (boolean muted, RtcConnection connection)
 Stops or resumes subscribing to the audio streams of all remote users. More...
 
abstract int muteAllRemoteVideoStreamsEx (boolean muted, RtcConnection connection)
 Stops or resumes subscribing to the video streams of all remote users. More...
 
abstract int muteRemoteAudioStreamEx (int uid, boolean muted, RtcConnection connection)
 Stops or resumes receiving the audio stream of a specified user. More...
 
abstract int muteRemoteVideoStreamEx (int uid, boolean muted, RtcConnection connection)
 Stops or resumes receiving the video stream of a specified user. More...
 
abstract int setRemoteVideoStreamTypeEx (int uid, Constants.VideoStreamType streamType, RtcConnection connection)
 Sets the video stream type to subscribe to. More...
 
abstract int setRemoteVideoStreamTypeEx (int uid, int streamType, RtcConnection connection)
 Sets the video stream type to subscribe to. More...
 
abstract int setHighPriorityUserListEx (int[] uidList, int option, RtcConnection connection)
 
abstract int setSubscribeAudioBlocklistEx (int[] uidList, RtcConnection connection)
 Sets the blocklist of subscriptions for audio streams. More...
 
abstract int setSubscribeAudioAllowlistEx (int[] uidList, RtcConnection connection)
 Sets the allowlist of subscriptions for audio streams. More...
 
abstract int setSubscribeVideoBlocklistEx (int[] uidList, RtcConnection connection)
 Sets the blocklist of subscriptions for video streams. More...
 
abstract int setSubscribeVideoAllowlistEx (int[] uidList, RtcConnection connection)
 Sets the allowlist of subscriptions for video streams. More...
 
abstract int setRemoteRenderModeEx (int uid, int renderMode, int mirrorMode, RtcConnection connection)
 Sets the video display mode of a specified remote user. More...
 
abstract int setupRemoteVideoEx (VideoCanvas remote, RtcConnection connection)
 Initializes the video view of a remote user. More...
 
abstract int setVideoEncoderConfigurationEx (VideoEncoderConfiguration config, RtcConnection connection)
 Sets the video encoder configuration. More...
 
abstract int updateChannelMediaOptionsEx (ChannelMediaOptions options, RtcConnection connection)
 Updates the channel media options after joining the channel. More...
 
abstract int joinChannelEx (String token, RtcConnection connection, ChannelMediaOptions options, IRtcEngineEventHandler eventHandler)
 Joins a channel. More...
 
abstract int leaveChannelEx (RtcConnection connection)
 Leaves a channel. More...
 
abstract int leaveChannelEx (RtcConnection connection, LeaveChannelOptions options)
 Sets channel options and leaves the channel. More...
 
abstract int leaveChannelWithUserAccountEx (String channelId, String userAccount)
 
abstract int leaveChannelWithUserAccountEx (String channelId, String userAccount, LeaveChannelOptions options)
 
abstract int enableDualStreamModeEx (boolean enabled, SimulcastStreamConfig streamConfig, RtcConnection connection)
 Enables or disables dual-stream mode on the sender side. More...
 
abstract int setDualStreamModeEx (Constants.SimulcastStreamMode mode, SimulcastStreamConfig streamConfig, RtcConnection connection)
 Sets the dual-stream mode on the sender side. More...
 
abstract int setSimulcastConfigEx (SimulcastConfig simulcastConfig, RtcConnection connection)
 Sets the simulcast video stream configuration. More...
 
abstract int getConnectionStateEx (RtcConnection connection)
 Gets the current connection state of the SDK. More...
 
abstract int sendCustomReportMessageEx (String id, String category, String event, String label, int value, RtcConnection connection)
 Agora supports reporting and analyzing customized messages. More...
 
abstract int sendStreamMessageEx (int streamId, byte[] message, RtcConnection connection)
 Sends data stream messages. More...
 
abstract int sendRdtMessageEx (int uid, int type, byte[] message, RtcConnection connection)
 Send Reliable message to remote uid in channel. More...
 
abstract int sendMediaControlMessageEx (int uid, byte[] message, RtcConnection connection)
 Send media control message. More...
 
abstract int createDataStreamEx (boolean reliable, boolean ordered, RtcConnection connection)
 Creates a data stream. More...
 
abstract int createDataStreamEx (DataStreamConfig config, RtcConnection connection)
 Creates a data stream. More...
 
abstract int joinChannelWithUserAccountEx (String token, String channelId, String userAccount, ChannelMediaOptions options, IRtcEngineEventHandler eventHandler)
 Join a channel using a user account and token, and set the media options. More...
 
abstract int getUserInfoByUserAccountEx (String userAccount, UserInfo userInfo, RtcConnection connection)
 Gets the user information by passing in the user account. More...
 
abstract int getUserInfoByUidEx (int uid, UserInfo userInfo, RtcConnection connection)
 Gets the user information by passing in the user ID. More...
 
abstract int adjustRecordingSignalVolumeEx (int volume, RtcConnection connection)
 
abstract int muteRecordingSignalEx (boolean muted, RtcConnection connection)
 
abstract int adjustUserPlaybackSignalVolumeEx (int uid, int volume, RtcConnection connection)
 Adjusts the playback signal volume of a specified remote user. More...
 
abstract int setRemoteVoicePositionEx (int uid, double pan, double gain, RtcConnection connection)
 Sets the 2D position (the position on the horizontal plane) of the remote user's voice. More...
 
abstract int setRemoteVideoSubscriptionOptionsEx (int uid, VideoSubscriptionOptions options, RtcConnection rtcConnection)
 Sets options for subscribing to remote video streams. More...
 
abstract int setRemoteUserSpatialAudioParamsEx (int uid, SpatialAudioParams params, RtcConnection connection)
 
abstract int addVideoWatermarkEx (String watermarkUrl, WatermarkOptions options, RtcConnection connection)
 Adds a watermark image to the local video. More...
 
abstract int addVideoWatermarkEx (WatermarkConfig config, RtcConnection connection)
 Adds a watermark image to the local video. More...
 
abstract int removeVideoWatermarkEx (String id, RtcConnection connection)
 Removes the specified watermark image from the local or remote video stream. More...
 
abstract int clearVideoWatermarkEx (RtcConnection connection)
 Removes the watermark image from the video stream. More...
 
abstract int enableAudioVolumeIndicationEx (int interval, int smooth, boolean reportVad, RtcConnection connection)
 Enables the reporting of users' volume indication. More...
 
abstract int takeSnapshotEx (RtcConnection connection, int uid, String filePath)
 Takes a snapshot of a video stream using connection ID. More...
 
abstract int takeSnapshotEx (RtcConnection connection, int uid, SnapshotConfig config)
 Gets a video screenshot of the specified observation point using the connection ID. More...
 
abstract int enableContentInspectEx (boolean enabled, ContentInspectConfig config, RtcConnection connection)
 Enables or disables video screenshot and upload. More...
 
abstract int startRtmpStreamWithoutTranscodingEx (String url, RtcConnection connection)
 Starts pushing media streams to a CDN without transcoding. More...
 
abstract int startRtmpStreamWithTranscodingEx (String url, LiveTranscoding transcoding, RtcConnection connection)
 Starts Media Push and sets the transcoding configuration. More...
 
abstract int updateRtmpTranscodingEx (LiveTranscoding transcoding, RtcConnection connection)
 Updates the transcoding configuration. More...
 
abstract int stopRtmpStreamEx (String url, RtcConnection connection)
 Stops pushing media streams to a CDN. More...
 
abstract int startOrUpdateChannelMediaRelayEx (ChannelMediaRelayConfiguration channelMediaRelayConfiguration, RtcConnection connection)
 Starts relaying media streams across channels or updates channels for media relay. More...
 
abstract int stopChannelMediaRelayEx (RtcConnection connection)
 Stops the media stream relay. Once the relay stops, the host quits all the target channels. More...
 
abstract int pauseAllChannelMediaRelayEx (RtcConnection connection)
 Pauses the media stream relay to all target channels. More...
 
abstract int resumeAllChannelMediaRelayEx (RtcConnection connection)
 Resumes the media stream relay to all target channels. More...
 
abstract int startMediaRenderingTracingEx (RtcConnection connection)
 Enables tracing the video frame rendering process. More...
 
abstract int setParametersEx (String parameters, RtcConnection connection)
 
abstract String getCallIdEx (RtcConnection connection)
 Gets the call ID with the connection ID. More...
 
abstract void addHandlerEx (IRtcEngineEventHandler handler, RtcConnection connection)
 
abstract void removeHandlerEx (IRtcEngineEventHandler handler, RtcConnection connection)
 
abstract int enableEncryptionEx (boolean enabled, EncryptionConfig config, RtcConnection connection)
 Enables or disables the built-in encryption. More...
 
abstract int sendAudioMetadataEx (byte[] metadata, RtcConnection connection)
 
abstract int preloadEffectEx (RtcConnection connection, int soundId, String filePath)
 Preloads a specified sound effect to the channel. More...
 
abstract int preloadEffectEx (RtcConnection connection, int soundId, String filePath, int startPos)
 Preloads a specified sound effect to a channel. More...
 
abstract int playEffectEx (RtcConnection connection, int soundId, String filePath, int loopCount, double pitch, double pan, double gain, boolean publish)
 Plays a specified sound effect in the channel. More...
 
abstract int playEffectEx (RtcConnection connection, int soundId, String filePath, int loopCount, double pitch, double pan, double gain, boolean publish, int startPos)
 Plays a specified sound effect in a channel. More...
 
- Public Member Functions inherited from io.agora.rtc2.RtcEngine
abstract int setChannelProfile (int profile)
 Sets the channel profile. More...
 
abstract int setClientRole (int role)
 Sets the client role. More...
 
abstract int setClientRole (int role, ClientRoleOptions options)
 Sets the user role and the audience latency level in a live streaming scenario. More...
 
abstract int sendCustomReportMessage (String id, String category, String event, String label, int value)
 Reports customized messages. More...
 
abstract int preloadChannel (String token, String channelName, int optionalUid)
 Preloads a channel with token, channelName, and optionalUid. More...
 
abstract int preloadChannelWithUserAccount (String token, String channelName, String userAccount)
 Preloads a channel with token, channelName, and userAccount. More...
 
abstract int updatePreloadChannelToken (String token)
 Updates the wildcard token for preloading channels. More...
 
abstract int joinChannel (String token, String channelId, String optionalInfo, int uid)
 Joins a channel. More...
 
abstract int joinChannel (String token, String channelId, int uid, ChannelMediaOptions options)
 Joins a channel with media options. More...
 
abstract int registerLocalUserAccount (String appId, String userAccount)
 Registers a user account. More...
 
abstract int joinChannelWithUserAccount (String token, String channelName, String userAccount)
 Joins a channel with a User Account and Token. More...
 
abstract int joinChannelWithUserAccount (String token, String channelName, String userAccount, ChannelMediaOptions options)
 Join a channel using a user account and token, and set the media options. More...
 
abstract int getUserInfoByUserAccount (String userAccount, UserInfo userInfo)
 Gets the user information by passing in the user account. More...
 
abstract int getUserInfoByUid (int uid, UserInfo userInfo)
 Gets the user information by passing in the user ID. More...
 
abstract int leaveChannel ()
 Leaves a channel. More...
 
abstract int leaveChannel (LeaveChannelOptions options)
 Sets channel options and leaves the channel. More...
 
abstract int renewToken (String token)
 Renews the token. More...
 
abstract DeviceInfo getAudioDeviceInfo ()
 Gets the audio device information. More...
 
abstract int enableWebSdkInteroperability (boolean enabled)
 Enables interoperability with the Agora Web SDK (applicable only in the live streaming scenarios). More...
 
abstract int getConnectionState ()
 Gets the current connection state of the SDK. More...
 
abstract int enableAudio ()
 Enables the audio module. More...
 
abstract int disableAudio ()
 Disables the audio module. More...
 
abstract int pauseAudio ()
 
abstract int resumeAudio ()
 
abstract int setAudioProfile (int profile)
 Sets the audio profile. More...
 
abstract int setAudioProfile (int profile, int scenario)
 Sets the audio profile and audio scenario. More...
 
abstract int setAudioScenario (int scenario)
 Sets the audio scenario. More...
 
abstract int setHighQualityAudioParameters (boolean fullband, boolean stereo, boolean fullBitrate)
 
abstract int adjustRecordingSignalVolume (int volume)
 Adjusts the capturing signal volume. More...
 
abstract int adjustPlaybackSignalVolume (int volume)
 Adjusts the playback signal volume of all remote users. More...
 
abstract int enableAudioVolumeIndication (int interval, int smooth, boolean reportVad)
 Enables the reporting of users' volume indication. More...
 
abstract int enableLocalAudio (boolean enabled)
 Enables or disables the local audio capture. More...
 
abstract int muteLocalAudioStream (boolean muted)
 Stops or resumes publishing the local audio stream. More...
 
abstract int muteRemoteAudioStream (int uid, boolean muted)
 Stops or resumes subscribing to the audio stream of a specified user. More...
 
abstract int adjustUserPlaybackSignalVolume (int uid, int volume)
 Adjusts the playback signal volume of a specified remote user. More...
 
abstract int muteAllRemoteAudioStreams (boolean muted)
 Stops or resumes subscribing to the audio streams of all remote users. More...
 
abstract int enableVideo ()
 Enables the video module. More...
 
abstract int disableVideo ()
 Disables the video module. More...
 
abstract int setVideoEncoderConfiguration (VideoEncoderConfiguration config)
 Sets the video encoder configuration. More...
 
abstract CodecCapInfo[] queryCodecCapability ()
 Queries the video codec capabilities of the SDK. More...
 
abstract int queryDeviceScore ()
 Queries device score. More...
 
abstract AgoraFocalLengthInfo[] queryCameraFocalLengthCapability ()
 Queries the focal length capability supported by the camera. More...
 
abstract int setCameraCapturerConfiguration (CameraCapturerConfiguration config)
 Sets the camera capture configuration. More...
 
abstract int setupLocalVideo (VideoCanvas local)
 Initializes the local video view. More...
 
abstract int setupRemoteVideo (VideoCanvas remote)
 Initializes the video view of a remote user. More...
 
abstract int setRemoteRenderMode (int uid, int renderMode)
 
abstract int setLocalRenderMode (int renderMode)
 Sets the local video display mode. More...
 
abstract int setRemoteRenderMode (int uid, int renderMode, int mirrorMode)
 Updates the display mode of the video view of a remote user. More...
 
abstract int setLocalRenderMode (int renderMode, int mirrorMode)
 Updates the display mode of the local video view. More...
 
abstract int startPreview ()
 Enables the local video preview. More...
 
abstract int startPreview (Constants.VideoSourceType sourceType)
 Enables the local video preview and specifies the video source for the preview. More...
 
abstract int stopPreview ()
 Stops the local video preview. More...
 
abstract int stopPreview (Constants.VideoSourceType sourceType)
 Stops the local video preview. More...
 
abstract int enableLocalVideo (boolean enabled)
 Enables/Disables the local video capture. More...
 
abstract int startCameraCapture (Constants.VideoSourceType sourceType, CameraCapturerConfiguration config)
 Starts camera capture. More...
 
abstract int stopCameraCapture (Constants.VideoSourceType sourceType)
 Stops camera capture. More...
 
abstract int startLocalVideoTranscoder (LocalTranscoderConfiguration config)
 Starts the local video mixing. More...
 
abstract int stopLocalVideoTranscoder ()
 Stops the local video mixing. More...
 
abstract int updateLocalTranscoderConfiguration (LocalTranscoderConfiguration config)
 Updates the local video mixing configuration. More...
 
abstract int startLocalAudioMixer (LocalAudioMixerConfiguration config)
 Starts local audio mixing. More...
 
abstract int updateLocalAudioMixerConfiguration (LocalAudioMixerConfiguration config)
 Updates the configurations for mixing audio streams locally. More...
 
abstract int stopLocalAudioMixer ()
 Stops the local audio mixing. More...
 
abstract int muteLocalVideoStream (boolean muted)
 Stops or resumes publishing the local video stream. More...
 
abstract int muteRemoteVideoStream (int uid, boolean muted)
 Stops or resumes subscribing to the video stream of a specified user. More...
 
abstract int muteAllRemoteVideoStreams (boolean muted)
 Stops or resumes subscribing to the video streams of all remote users. More...
 
abstract int setBeautyEffectOptions (boolean enabled, BeautyOptions options)
 Sets the image enhancement options. More...
 
abstract int setBeautyEffectOptions (boolean enabled, BeautyOptions options, Constants.MediaSourceType sourceType)
 Sets the image enhancement options and specifies the media source. More...
 
abstract int setFaceShapeBeautyOptions (boolean enabled, FaceShapeBeautyOptions options)
 Sets the face shape beauty options. More...
 
abstract int setFaceShapeBeautyOptions (boolean enabled, FaceShapeBeautyOptions options, Constants.MediaSourceType sourceType)
 Sets the face shape options and specifies the media source. More...
 
abstract FaceShapeBeautyOptions getFaceShapeBeautyOptions ()
 Gets the beauty effect options. More...
 
abstract FaceShapeBeautyOptions getFaceShapeBeautyOptions (Constants.MediaSourceType sourceType)
 Gets the beauty effect options. More...
 
abstract int setFaceShapeAreaOptions (FaceShapeAreaOptions options)
 Sets the options for beauty enhancement facial areas. More...
 
abstract int setFaceShapeAreaOptions (FaceShapeAreaOptions options, Constants.MediaSourceType sourceType)
 Sets the image enhancement options for facial areas and specifies the media source. More...
 
abstract FaceShapeAreaOptions getFaceShapeAreaOptions (int shapeArea)
 Gets the facial beauty area options. More...
 
abstract FaceShapeAreaOptions getFaceShapeAreaOptions (int shapeArea, Constants.MediaSourceType sourceType)
 Gets the facial beauty area options. More...
 
abstract int setFilterEffectOptions (boolean enabled, FilterEffectOptions options)
 Sets the filter effect options. More...
 
abstract int setFilterEffectOptions (boolean enabled, FilterEffectOptions options, Constants.MediaSourceType sourceType)
 Sets the filter effect options and specifies the media source. More...
 
abstract int setLowlightEnhanceOptions (boolean enabled, LowLightEnhanceOptions options)
 Sets low-light enhancement. More...
 
abstract int setLowlightEnhanceOptions (boolean enabled, LowLightEnhanceOptions options, Constants.MediaSourceType sourceType)
 Sets low light enhance options and specifies the media source. More...
 
abstract int setVideoDenoiserOptions (boolean enabled, VideoDenoiserOptions options)
 Sets video noise reduction. More...
 
abstract int setVideoDenoiserOptions (boolean enabled, VideoDenoiserOptions options, Constants.MediaSourceType sourceType)
 Sets video noise reduction and specifies the media source. More...
 
abstract int setColorEnhanceOptions (boolean enabled, ColorEnhanceOptions options)
 Sets color enhancement. More...
 
abstract int setColorEnhanceOptions (boolean enabled, ColorEnhanceOptions options, Constants.MediaSourceType sourceType)
 Sets color enhance options and specifies the media source. More...
 
abstract IVideoEffectObject createVideoEffectObject (String bundlePath, Constants.MediaSourceType sourceType)
 Creates a video effect object. More...
 
abstract int destroyVideoEffectObject (IVideoEffectObject videoEffectObject)
 Destroys a video effect object. More...
 
abstract int enableVirtualBackground (boolean enabled, VirtualBackgroundSource backgroundSource, SegmentationProperty segproperty)
 Enables/Disables the virtual background. More...
 
abstract int enableVirtualBackground (boolean enabled, VirtualBackgroundSource backgroundSource, SegmentationProperty segproperty, Constants.MediaSourceType sourceType)
 Enables virtual background and specify the media source, or disables virtual background. More...
 
abstract int setDefaultAudioRoutetoSpeakerphone (boolean defaultToSpeaker)
 Sets the default audio playback route. More...
 
abstract int setEnableSpeakerphone (boolean enabled)
 Enables/Disables the audio route to the speakerphone. More...
 
abstract int setRouteInCommunicationMode (int route)
 Selects the audio playback route in communication audio mode. More...
 
abstract boolean isSpeakerphoneEnabled ()
 Checks whether the speakerphone is enabled. More...
 
abstract int enableInEarMonitoring (boolean enabled)
 Enables in-ear monitoring. More...
 
abstract int enableInEarMonitoring (boolean enabled, int includeAudioFilters)
 Enables in-ear monitoring. More...
 
abstract int setInEarMonitoringVolume (int volume)
 Sets the volume of the in-ear monitor. More...
 
abstract int setLocalVoicePitch (double pitch)
 Changes the voice pitch of the local speaker. More...
 
abstract int setLocalVoiceFormant (double formantRatio)
 Sets the formant ratio to change the timbre of human voice. More...
 
abstract int setLocalVoiceEqualization (Constants.AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain)
 Sets the local voice equalization effect. More...
 
abstract int setLocalVoiceReverb (Constants.AUDIO_REVERB_TYPE reverbKey, int value)
 Sets the local voice reverberation. More...
 
abstract int setHeadphoneEQPreset (int preset)
 Sets the preset headphone equalization effect. More...
 
abstract int setHeadphoneEQParameters (int lowGain, int highGain)
 Sets the low- and high-frequency parameters of the headphone equalizer. More...
 
abstract int setAudioEffectPreset (int preset)
 Sets an SDK preset audio effect. More...
 
abstract int setVoiceBeautifierPreset (int preset)
 Sets a preset voice beautifier effect. More...
 
abstract int setVoiceConversionPreset (int preset)
 Sets a preset voice beautifier effect. More...
 
abstract int setAudioEffectParameters (int preset, int param1, int param2)
 Sets parameters for SDK preset audio effects. More...
 
abstract int setVoiceBeautifierParameters (int preset, int param1, int param2)
 Sets parameters for the preset voice beautifier effects. More...
 
abstract int setVoiceConversionParameters (int preset, int param1, int param2)
 
abstract int enableSoundPositionIndication (boolean enabled)
 Enables or disables stereo panning for remote users. More...
 
abstract int setRemoteVoicePosition (int uid, double pan, double gain)
 Sets the 2D position (the position on the horizontal plane) of the remote user's voice. More...
 
abstract int enableVoiceAITuner (boolean enabled, Constants.VOICE_AI_TUNER_TYPE type)
 Enables or disables the voice AI tuner. More...
 
abstract int startAudioMixing (String filePath, boolean loopback, int cycle)
 Starts playing the music file. More...
 
abstract int enableSpatialAudio (boolean enabled)
 Enables or disables the spatial audio effect. More...
 
abstract int setRemoteUserSpatialAudioParams (int uid, SpatialAudioParams params)
 Sets the spatial audio effect parameters of the remote user. More...
 
abstract int setRemoteVideoSubscriptionOptions (int uid, VideoSubscriptionOptions options)
 Options for subscribing to remote video streams. More...
 
abstract int setAINSMode (boolean enabled, int mode)
 Sets whether to enable the AI ​​noise suppression function and set the noise suppression mode. More...
 
abstract int startAudioMixing (String filePath, boolean loopback, int cycle, int startPos)
 Starts playing the music file. More...
 
abstract int stopAudioMixing ()
 Stops playing the music file. More...
 
abstract int pauseAudioMixing ()
 Pauses playing and mixing the music file. More...
 
abstract int resumeAudioMixing ()
 Resumes playing and mixing the music file. More...
 
abstract int adjustAudioMixingVolume (int volume)
 Adjusts the volume during audio mixing. More...
 
abstract int adjustAudioMixingPlayoutVolume (int volume)
 Adjusts the volume of audio mixing for local playback. More...
 
abstract int adjustAudioMixingPublishVolume (int volume)
 Adjusts the volume of audio mixing for publishing. More...
 
abstract int getAudioMixingPlayoutVolume ()
 Retrieves the audio mixing volume for local playback. More...
 
abstract int getAudioMixingPublishVolume ()
 Retrieves the audio mixing volume for publishing. More...
 
abstract int getAudioMixingDuration ()
 Retrieves the duration (ms) of the music file. More...
 
abstract int getAudioMixingCurrentPosition ()
 Retrieves the playback position (ms) of the music file. More...
 
abstract int setAudioMixingPosition (int pos)
 Sets the audio mixing position. More...
 
abstract int setAudioMixingDualMonoMode (Constants.AudioMixingDualMonoMode mode)
 Sets the channel mode of the current audio file. More...
 
abstract int setAudioMixingPitch (int pitch)
 Sets the pitch of the local music file. More...
 
abstract int setAudioMixingPlaybackSpeed (int speed)
 Sets the playback speed of the current audio file. More...
 
abstract int selectAudioTrack (int audioIndex)
 Selects the audio track used during playback. More...
 
abstract int getAudioTrackCount ()
 Gets the index of audio tracks of the current music file. More...
 
abstract IAudioEffectManager getAudioEffectManager ()
 Gets the IAudioEffectManager class to manage the audio effect files. More...
 
abstract int startAudioRecording (String filePath, int quality)
 Starts client-side recording. More...
 
abstract int startAudioRecording (AudioRecordingConfiguration config)
 Starts client-side recording and applies recording configurations. More...
 
abstract int stopAudioRecording ()
 Stops client-side recording. More...
 
abstract int startEchoTest (EchoTestConfiguration config)
 Starts an audio device loopback test. More...
 
abstract int stopEchoTest ()
 Stops the audio call test. More...
 
abstract int startLastmileProbeTest (LastmileProbeConfig config)
 Starts the last mile network probe test. More...
 
abstract int stopLastmileProbeTest ()
 Stops the last mile network probe test. More...
 
abstract int setExternalAudioSource (boolean enabled, int sampleRate, int channels)
 Sets the external audio source. More...
 
abstract int setExternalAudioSink (boolean enabled, int sampleRate, int channels)
 Sets the external audio sink. More...
 
abstract int setExternalRemoteEglContext (Object eglContext)
 Sets the EGL context for rendering remote video streams. More...
 
abstract int pullPlaybackAudioFrame (byte[] data, int lengthInByte)
 Pulls the remote audio data. More...
 
abstract int pullPlaybackAudioFrame (ByteBuffer data, int lengthInByte)
 Pulls the remote audio data. More...
 
abstract int startRecordingDeviceTest (int indicationInterval)
 Starts the audio capturing device test. More...
 
abstract int stopRecordingDeviceTest ()
 Stops the audio capturing device test. More...
 
abstract int startPlaybackDeviceTest (String audioFileName)
 Starts the audio playback device test. More...
 
abstract int stopPlaybackDeviceTest ()
 Stops the audio playback device test. More...
 
abstract int createCustomAudioTrack (Constants.AudioTrackType trackType, AudioTrackConfig config)
 Creates a custom audio track. More...
 
abstract int destroyCustomAudioTrack (int trackId)
 Destroys the specified audio track. More...
 
abstract int setExternalAudioSource (boolean enabled, int sampleRate, int channels, boolean localPlayback, boolean publish)
 Sets the external audio source parameters. More...
 
abstract int pushExternalAudioFrame (byte[] data, long timestamp)
 
abstract int pushExternalAudioFrame (ByteBuffer data, long timestamp, int trackId)
 
abstract int pushExternalAudioFrame (byte[] data, long timestamp, int sampleRate, int channels, Constants.BytesPerSample bytesPerSample, int trackId)
 Pushes the external audio frame to the SDK. More...
 
abstract int pushExternalAudioFrame (ByteBuffer data, long timestamp, int sampleRate, int channels, Constants.BytesPerSample bytesPerSample, int trackId)
 
abstract int setExternalVideoSource (boolean enable, boolean useTexture, Constants.ExternalVideoSourceType sourceType)
 Configures the external video source. More...
 
abstract int setExternalVideoSource (boolean enable, boolean useTexture, Constants.ExternalVideoSourceType sourceType, EncodedVideoTrackOptions encodedOpt)
 
abstract boolean pushExternalVideoFrame (VideoFrame frame)
 Pushes the external raw video frame to the SDK. More...
 
abstract int pushExternalVideoFrameById (VideoFrame frame, int videoTrackId)
 Pushes the external raw video frame to the SDK through video tracks. More...
 
abstract int pushExternalVideoFrameById (AgoraVideoFrame frame, int videoTrackId)
 Pushes the external raw video frame to the SDK through video tracks. More...
 
abstract int pushExternalEncodedVideoFrame (ByteBuffer data, EncodedVideoFrameInfo frameInfo)
 
abstract int pushExternalEncodedVideoFrameById (ByteBuffer data, EncodedVideoFrameInfo frameInfo, int videoTrackId)
 
abstract boolean pushExternalVideoFrame (AgoraVideoFrame frame)
 Pushes the external raw video frame to the SDK. More...
 
abstract boolean isTextureEncodeSupported ()
 Check whether the video supports the Texture encoding. More...
 
abstract int registerAudioFrameObserver (IAudioFrameObserver observer)
 Registers an audio frame observer object. More...
 
abstract int registerAudioEncodedFrameObserver (AudioEncodedFrameObserverConfig config, IAudioEncodedFrameObserver observer)
 Registers an encoded audio observer. More...
 
abstract int setRecordingAudioFrameParameters (int sampleRate, int channel, int mode, int samplesPerCall)
 Sets the format of the captured raw audio data. More...
 
abstract int setPlaybackAudioFrameParameters (int sampleRate, int channel, int mode, int samplesPerCall)
 Sets the format of the raw audio playback data. More...
 
abstract int setMixedAudioFrameParameters (int sampleRate, int channel, int samplesPerCall)
 Sets the format of the raw audio data after mixing for audio capture and playback. More...
 
abstract int setEarMonitoringAudioFrameParameters (int sampleRate, int channel, int mode, int samplesPerCall)
 Sets the format of the in-ear monitoring raw audio data. More...
 
abstract int addVideoWatermark (AgoraImage watermark)
 Adds a watermark image to the local video. More...
 
abstract int addVideoWatermark (String watermarkUrl, WatermarkOptions options)
 Adds a watermark image to the local video. More...
 
abstract int addVideoWatermark (WatermarkConfig config)
 Adds a watermark image to the local video. More...
 
abstract int removeVideoWatermark (String id)
 Removes the watermark image from the local video. More...
 
abstract int clearVideoWatermarks ()
 Removes the watermark image from the video stream. More...
 
abstract int setRemoteUserPriority (int uid, int userPriority)
 
abstract int setRemoteSubscribeFallbackOption (Constants.StreamFallbackOptions option)
 Sets the fallback option for the subscribed video stream based on the network conditions. More...
 
abstract int setRemoteSubscribeFallbackOption (int option)
 Sets the fallback option for the subscribed video stream based on the network conditions. More...
 
abstract int setHighPriorityUserList (int[] uidList, int option)
 
abstract int enableDualStreamMode (boolean enabled)
 Enables or disables dual-stream mode on the sender side. More...
 
abstract int enableDualStreamMode (boolean enabled, SimulcastStreamConfig streamConfig)
 Sets the dual-stream mode on the sender side and the low-quality video stream. More...
 
abstract int setDualStreamMode (Constants.SimulcastStreamMode mode)
 Sets the dual-stream mode on the sender side. More...
 
abstract int setDualStreamMode (Constants.SimulcastStreamMode mode, SimulcastStreamConfig streamConfig)
 Sets dual-stream mode configuration on the sender side. More...
 
abstract int setSimulcastConfig (SimulcastConfig simulcastConfig)
 Sets the simulcast video stream configuration. More...
 
abstract int setLocalRenderTargetFps (Constants.VideoSourceType sourceType, int targetFps)
 Sets the maximum frame rate for rendering local video. More...
 
abstract int setRemoteRenderTargetFps (int targetFps)
 Sets the maximum frame rate for rendering remote video. More...
 
abstract int setRemoteVideoStreamType (int uid, Constants.VideoStreamType streamType)
 Sets the video stream type to subscribe to. More...
 
abstract int setRemoteVideoStreamType (int uid, int streamType)
 Sets the video stream type to subscribe to. More...
 
abstract int setRemoteDefaultVideoStreamType (Constants.VideoStreamType streamType)
 Sets the default video stream type to subscribe to. More...
 
abstract int setRemoteDefaultVideoStreamType (int streamType)
 Sets the default video stream type to subscribe to. More...
 
abstract int setSubscribeAudioBlocklist (int[] uidList)
 Sets the blocklist of subscriptions for audio streams. More...
 
abstract int setSubscribeAudioAllowlist (int[] uidList)
 Sets the allowlist of subscriptions for audio streams. More...
 
abstract int setSubscribeVideoBlocklist (int[] uidList)
 Sets the blocklist of subscriptions for video streams. More...
 
abstract int setSubscribeVideoAllowlist (int[] uidList)
 Sets the allowlist of subscriptions for video streams. More...
 
abstract int enableEncryption (boolean enabled, EncryptionConfig config)
 Enables or disables the built-in encryption. More...
 
abstract int startRtmpStreamWithoutTranscoding (String url)
 Starts pushing media streams to a CDN without transcoding. More...
 
abstract int startRtmpStreamWithTranscoding (String url, LiveTranscoding transcoding)
 Starts Media Push and sets the transcoding configuration. More...
 
abstract int updateRtmpTranscoding (LiveTranscoding transcoding)
 Updates the transcoding configuration. More...
 
abstract int stopRtmpStream (String url)
 Stops pushing media streams to a CDN. More...
 
abstract int createDataStream (boolean reliable, boolean ordered)
 Creates a data stream. More...
 
abstract int createDataStream (DataStreamConfig config)
 Creates a data stream. More...
 
abstract int sendStreamMessage (int streamId, byte[] message)
 Sends data stream messages. More...
 
abstract int sendRdtMessage (int uid, int type, byte[] message)
 Send Reliable message to remote uid in channel. More...
 
abstract int sendMediaControlMessage (int uid, byte[] message)
 Send media control message. More...
 
abstract int setVideoQualityParameters (boolean preferFrameRateOverImageQuality)
 
abstract int setLocalVideoMirrorMode (int mode)
 Sets the local video mirror mode. More...
 
abstract int switchCamera ()
 Switches between front and rear cameras. More...
 
abstract int switchCamera (String cameraId)
 Switches cameras by camera ID. More...
 
abstract boolean isCameraZoomSupported ()
 Checks whether the device supports camera zoom. More...
 
abstract boolean isCameraTorchSupported ()
 Checks whether the device supports camera flash. More...
 
abstract boolean isCameraFocusSupported ()
 Check whether the device supports the manual focus function. More...
 
abstract boolean isCameraExposurePositionSupported ()
 Checks whether the device supports manual exposure. More...
 
abstract boolean isCameraAutoFocusFaceModeSupported ()
 Checks whether the device supports the face auto-focus function. More...
 
abstract boolean isCameraFaceDetectSupported ()
 Checks whether the device camera supports face detection. More...
 
abstract boolean isCameraExposureSupported ()
 Queries whether the current camera supports adjusting exposure value. More...
 
abstract int setCameraZoomFactor (float factor)
 Sets the camera zoom factor. More...
 
abstract float getCameraMaxZoomFactor ()
 Gets the maximum zoom ratio supported by the camera. More...
 
abstract int setCameraFocusPositionInPreview (float positionX, float positionY)
 Sets the camera manual focus position. More...
 
abstract int setCameraExposurePosition (float positionXinView, float positionYinView)
 Sets the camera exposure position. More...
 
abstract int enableFaceDetection (boolean enabled)
 Enables or disables face detection for the local user. More...
 
abstract int setCameraTorchOn (boolean isOn)
 Enables the camera flash. More...
 
abstract int setCameraAutoFocusFaceModeEnabled (boolean enabled)
 Enables the camera auto-face focus function. More...
 
abstract int setCameraExposureFactor (int factor)
 Sets the camera exposure value. More...
 
abstract String getCallId ()
 Retrieves the call ID. More...
 
abstract int rate (String callId, int rating, String description)
 Allows a user to rate a call after the call ends. More...
 
abstract int complain (String callId, String description)
 Allows a user to complain about the call quality after a call ends. More...
 
abstract int setLogFile (String filePath)
 Sets the log file. More...
 
abstract int setLogFilter (int filter)
 Sets the log output level of the SDK. More...
 
abstract int setLogLevel (int level)
 Sets the output log level of the SDK. More...
 
abstract int setLogFileSize (long fileSizeInKBytes)
 Sets the log file size. More...
 
abstract String uploadLogFile ()
 
abstract int writeLog (int level, String format, Object... args)
 
abstract long getNativeHandle ()
 Gets the C++ handle of the Native SDK. More...
 
void addHandler (IRtcEngineEventHandler handler)
 Adds event handlers. More...
 
void removeHandler (IRtcEngineEventHandler handler)
 Removes the specified IRtcEngineEventHandler instance. More...
 
abstract boolean enableHighPerfWifiMode (boolean enable)
 
abstract long getNativeMediaPlayer (int sourceId)
 
abstract int queryHDRCapability (Constants.VIDEO_MODULE_TYPE moduleType)
 
abstract int queryScreenCaptureCapability ()
 Queries the highest frame rate supported by the device during screen sharing. More...
 
abstract void monitorHeadsetEvent (boolean monitor)
 
abstract void monitorBluetoothHeadsetEvent (boolean monitor)
 
abstract void setPreferHeadset (boolean enabled)
 
abstract int setParameters (String parameters)
 Provides technical preview functionalities or special customizations by configuring the SDK with JSON options. More...
 
abstract String getParameters (String parameters)
 
abstract String getParameter (String parameter, String args)
 
abstract int registerMediaMetadataObserver (IMetadataObserver observer, int type)
 Registers the metadata observer. More...
 
abstract int unregisterMediaMetadataObserver (IMetadataObserver observer, int type)
 Unregisters the specified metadata observer. More...
 
abstract int startOrUpdateChannelMediaRelay (ChannelMediaRelayConfiguration channelMediaRelayConfiguration)
 Starts relaying media streams across channels or updates channels for media relay. More...
 
abstract int stopChannelMediaRelay ()
 Stops the media stream relay. Once the relay stops, the host quits all the target channels. More...
 
abstract int pauseAllChannelMediaRelay ()
 Pauses the media stream relay to all target channels. More...
 
abstract int resumeAllChannelMediaRelay ()
 Resumes the media stream relay to all target channels. More...
 
abstract int updateChannelMediaOptions (ChannelMediaOptions options)
 Updates the channel media options after joining the channel. More...
 
abstract int muteRecordingSignal (boolean muted)
 Whether to mute the recording signal. More...
 
abstract int setPlaybackAudioFrameBeforeMixingParameters (int sampleRate, int channel)
 Sets the format of the raw audio playback data before mixing. More...
 
abstract int setPlaybackAudioFrameBeforeMixingParameters (int sampleRate, int channel, int samplesPerCall)
 Sets the format of audio data in the onPlaybackAudioFrameBeforeMixing callback. More...
 
abstract int enableAudioSpectrumMonitor (int intervalInMS)
 Turns on audio spectrum monitoring. More...
 
abstract int disableAudioSpectrumMonitor ()
 Disables audio spectrum monitoring. More...
 
abstract int registerAudioSpectrumObserver (IAudioSpectrumObserver observer)
 Registers an audio spectrum observer. More...
 
abstract int unRegisterAudioSpectrumObserver (IAudioSpectrumObserver observer)
 Unregisters the audio spectrum observer. More...
 
abstract double getEffectsVolume ()
 Retrieves the volume of the audio effects. More...
 
abstract int setEffectsVolume (double volume)
 Sets the volume of the audio effects. More...
 
abstract int preloadEffect (int soundId, String filePath)
 Preloads a specified audio effect file into the memory. More...
 
abstract int preloadEffect (int soundId, String filePath, int startPos)
 
abstract int playEffect (int soundId, String filePath, int loopCount, double pitch, double pan, double gain, boolean publish)
 Plays the specified local or online audio effect file. More...
 
abstract int playEffect (int soundId, String filePath, int loopCount, double pitch, double pan, double gain, boolean publish, int startPos)
 Plays the specified local or online audio effect file. More...
 
abstract int playAllEffects (int loopCount, double pitch, double pan, double gain, boolean publish)
 
abstract int getVolumeOfEffect (int soundId)
 Gets the volume of a specified audio effect file. More...
 
abstract int setVolumeOfEffect (int soundId, double volume)
 Gets the volume of a specified audio effect file. More...
 
abstract int pauseEffect (int soundId)
 Pauses a specified audio effect file. More...
 
abstract int pauseAllEffects ()
 Pauses all audio effects. More...
 
abstract int resumeEffect (int soundId)
 Resumes playing a specified audio effect. More...
 
abstract int resumeAllEffects ()
 Resumes playing all audio effect files. More...
 
abstract int stopEffect (int soundId)
 Stops playing a specified audio effect. More...
 
abstract int stopAllEffects ()
 Stops playing all audio effects. More...
 
abstract int unloadEffect (int soundId)
 Releases a specified preloaded audio effect from the memory. More...
 
abstract int unloadAllEffects ()
 
abstract int getEffectDuration (String filePath)
 Retrieves the duration of the audio effect file. More...
 
abstract int setEffectPosition (int soundId, int pos)
 Sets the playback position of an audio effect file. More...
 
abstract int getEffectCurrentPosition (int soundId)
 Retrieves the playback position of the audio effect file. More...
 
abstract int registerVideoEncodedFrameObserver (IVideoEncodedFrameObserver receiver)
 Registers a receiver object for the encoded video image. More...
 
abstract int registerFaceInfoObserver (IFaceInfoObserver receiver)
 Registers or unregisters a facial information observer. More...
 
abstract int takeSnapshot (int uid, String filePath)
 Takes a snapshot of a video stream. More...
 
abstract int takeSnapshot (int uid, SnapshotConfig config)
 Takes a screenshot of the video at the specified observation point. More...
 
abstract int enableContentInspect (boolean enabled, ContentInspectConfig config)
 Enables or disables video screenshot and upload. More...
 
abstract int loadExtensionProvider (String path)
 
abstract int registerExtension (String provider, String extension, Constants.MediaSourceType sourceType)
 Registers an extension. More...
 
abstract int enableExtension (String provider, String extension, boolean enable)
 
abstract int enableExtension (String provider, String extension, boolean enable, Constants.MediaSourceType sourceType)
 Enables or disables extensions. More...
 
abstract int setExtensionProperty (String provider, String extension, String key, String value)
 Sets the properties of the extension. More...
 
abstract int setExtensionProperty (String provider, String extension, String key, String value, Constants.MediaSourceType sourceType)
 
abstract String getExtensionProperty (String provider, String extension, String key)
 Gets detailed information on the extensions. More...
 
abstract String getExtensionProperty (String provider, String extension, String key, Constants.MediaSourceType sourceType)
 Gets detailed information on the extensions. More...
 
abstract int setExtensionProviderProperty (String provider, String key, String value)
 Sets the properties of the extension provider. More...
 
abstract int enableExtension (String provider, String extension, ExtensionInfo extensionInfo, boolean enable)
 
abstract int setExtensionProperty (String provider, String extension, ExtensionInfo extensionInfo, String key, String value)
 
abstract String getExtensionProperty (String provider, String extension, ExtensionInfo extensionInfo, String key)
 
abstract int startScreenCapture (ScreenCaptureParameters screenCaptureParameters)
 Starts screen capture. More...
 
abstract int setExternalMediaProjection (MediaProjection mediaProjection)
 Configures MediaProjection outside of the SDK to capture screen video streams. More...
 
abstract int setScreenCaptureScenario (Constants.ScreenScenarioType screenScenario)
 Sets the screen sharing scenario. More...
 
abstract int stopScreenCapture ()
 Stops screen capture. More...
 
abstract int setVideoScenario (Constants.VideoScenario scenarioType)
 Sets video application scenarios. More...
 
abstract int setVideoQoEPreference (Constants.QoEPreference qoePreference)
 
abstract int updateScreenCaptureParameters (ScreenCaptureParameters screenCaptureParameters)
 Updates the screen capturing parameters. More...
 
abstract int registerVideoFrameObserver (IVideoFrameObserver observer)
 Registers a raw video frame observer object. More...
 
abstract IMediaPlayer createMediaPlayer ()
 Creates a media player object. More...
 
abstract AgoraMediaRecorder createMediaRecorder (RecorderStreamInfo info)
 Creates a recorder for audio and video. More...
 
abstract void destroyMediaRecorder (AgoraMediaRecorder mediaRecorder)
 Destroys the audio and video recording object. More...
 
abstract IMediaPlayerCacheManager getMediaPlayerCacheManager ()
 Gets one IMediaPlayerCacheManager instance. More...
 
abstract IH265Transcoder getH265Transcoder ()
 
abstract int enableExternalAudioSourceLocalPlayback (boolean enabled)
 
abstract int adjustCustomAudioPublishVolume (int trackId, int volume)
 Adjusts the volume of the custom audio track played remotely. More...
 
abstract int adjustCustomAudioPlayoutVolume (int trackId, int volume)
 Adjusts the volume of the custom audio track played locally. More...
 
abstract int startRhythmPlayer (String sound1, String sound2, AgoraRhythmPlayerConfig config)
 Enables the virtual metronome. More...
 
abstract int stopRhythmPlayer ()
 Disables the virtual metronome. More...
 
abstract int configRhythmPlayer (AgoraRhythmPlayerConfig config)
 Configures the virtual metronome. More...
 
abstract int setDirectCdnStreamingAudioConfiguration (int profile)
 Sets the audio profile of the audio streams directly pushed to the CDN by the host. More...
 
abstract int setDirectCdnStreamingVideoConfiguration (VideoEncoderConfiguration config)
 Sets the video profile of the media streams directly pushed to the CDN by the host. More...
 
abstract long getCurrentMonotonicTimeInMs ()
 Gets the current Monotonic Time of the SDK. More...
 
abstract int startDirectCdnStreaming (IDirectCdnStreamingEventHandler eventHandler, String publishUrl, DirectCdnStreamingMediaOptions options)
 Starts pushing media streams to the CDN directly. More...
 
abstract int stopDirectCdnStreaming ()
 Stops pushing media streams to the CDN directly. More...
 
abstract int updateDirectCdnStreamingMediaOptions (DirectCdnStreamingMediaOptions options)
 
abstract int createCustomVideoTrack ()
 Creates a custom video track. More...
 
abstract int createCustomEncodedVideoTrack (EncodedVideoTrackOptions encodedOpt)
 
abstract int destroyCustomVideoTrack (int video_track_id)
 Destroys the specified video track. More...
 
abstract int destroyCustomEncodedVideoTrack (int video_track_id)
 
abstract int setCloudProxy (int proxyType)
 Sets up cloud proxy service. More...
 
abstract int setLocalAccessPoint (LocalAccessPointConfiguration config)
 Configures the connection to the Agora private media server access module. More...
 
abstract int enableCustomAudioLocalPlayback (int trackId, boolean enabled)
 Sets whether to enable the local playback of external audio source. More...
 
abstract int setAdvancedAudioOptions (AdvancedAudioOptions options)
 Sets audio advanced options. More...
 
abstract int setAVSyncSource (String channelId, int uid)
 Sets audio-video synchronization on the publishing side. More...
 
abstract int enableVideoImageSource (boolean enabled, ImageTrackOptions options)
 Sets whether to replace the current video feeds with images when publishing video streams. More...
 
abstract int getNetworkType ()
 Gets the type of the local network connection. More...
 
abstract long getNtpWallTimeInMs ()
 Gets the current NTP (Network Time Protocol) time. More...
 
abstract int startMediaRenderingTracing ()
 Enables tracing the video frame rendering process. More...
 
abstract int enableInstantMediaRendering ()
 Enables audio and video frame instant rendering. More...
 
abstract int setupAudioAttributes (AudioAttributes attr)
 
abstract boolean isFeatureAvailableOnDevice (int type)
 Checks whether the device supports the specified advanced feature. More...
 
abstract int sendAudioMetadata (byte[] metadata)
 Send audio metadata. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from io.agora.rtc2.RtcEngine
static synchronized RtcEngine create (Context context, String appId, IRtcEngineEventHandler handler) throws Exception
 Creates and initializes RtcEngine. More...
 
static synchronized RtcEngine create (RtcEngineConfig config) throws Exception
 Creates and initializes RtcEngine. More...
 
static synchronized void destroy ()
 Releases the RtcEngine instance. More...
 
static synchronized void destroy (@Nullable IRtcEngineReleaseCallback callback)
 Destroys the RtcEngine instance and releases related resources. More...
 
static int getRecommendedEncoderType ()
 
static String getSdkVersion ()
 Gets the SDK version. More...
 
static String getMediaEngineVersion ()
 
static String getErrorDescription (int error)
 Gets the warning or error description. More...
 
- Static Protected Attributes inherited from io.agora.rtc2.RtcEngine
static RtcEngineImpl mInstance = null
 

Member Function Documentation

◆ updateSharedContext()

abstract int io.agora.rtc2.RtcEngineInternal.updateSharedContext ( EGLContext  sharedContext)
abstract

Shared context of MediaCodec. Only takes effect when using the hardware encoder and texture as the input source.

Parameters
sharedContextShared context
Returns
int

◆ setTextureId()

abstract int io.agora.rtc2.RtcEngineInternal.setTextureId ( int  id,
EGLContext  eglContext,
int  width,
int  height,
long  ts 
)
abstract

Sets the texture ID to MediaCodec.

Parameters
idTexture ID
eglContexteglContext which the texture belongs to
widthTexture's original width
heightTexture's original height
tsTimestamp of the captured frame (ms)
Returns
Texture ID

◆ monitorAudioRouteChange()

abstract int io.agora.rtc2.RtcEngineInternal.monitorAudioRouteChange ( boolean  isMonitoring)
abstract

Enables the audio routing monitoring by the SDK.

Call before joining a channel.

Parameters
isMonitoringDefault value is true
Returns

◆ setApiCallMode()

abstract int io.agora.rtc2.RtcEngineInternal.setApiCallMode ( int  syncCallTimeout)
abstract
Parameters
syncCallTimeoutSynchronous or asynchronous mode -1: Asynchronous mode >=0: Synchronous mode, timeout (ms)