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 io.agora.rtc2.internal.RtcEngineImpl

Public Member Functions

abstract int setProfile (String profile, boolean merge)
 
abstract int enableTransportQualityIndication (boolean enabled)
 
abstract int playRecap ()
 
abstract int enableRecap (int interval)
 
abstract String getParameters (String parameters)
 
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 muteRemoteAudioStreamEx (int uid, boolean muted, RtcConnection connection)
 
abstract int muteRemoteVideoStreamEx (int uid, boolean muted, RtcConnection connection)
 
abstract int setRemoteRenderModeEx (int uid, int renderMode, int mirrorMode, RtcConnection connection)
 
abstract int setupRemoteVideoEx (VideoCanvas remote, RtcConnection connection)
 
abstract int setVideoEncoderConfigurationEx (VideoEncoderConfiguration config, RtcConnection connection)
 
abstract int updateChannelMediaOptionsEx (ChannelMediaOptions options, RtcConnection connection)
 
abstract int joinChannelEx (String token, String channelId, int uid, ChannelMediaOptions options, IRtcEngineEventHandler eventHandler, RtcConnection connection)
 
abstract int leaveChannelEx (String channelId, RtcConnection connection)
 
abstract int pushExternalVideoFrameEx (VideoFrame frame, RtcConnection connection)
 
abstract int pushExternalVideoFrameEx (AgoraVideoFrame frame, RtcConnection connection)
 
abstract int pushExternalEncodedVideoFrameEx (ByteBuffer data, EncodedVideoFrameInfo frameInfo, RtcConnection connection)
 
abstract RtcConnection.CONNECTION_STATE_TYPE getConnectionStateEx (RtcConnection connection)
 
abstract int pushExternalAudioFrameEx (ByteBuffer data, long timestamp, int sourceId, RtcConnection connection)
 
abstract int sendCustomReportMessageEx (String id, String category, String event, String label, int value, RtcConnection connection)
 
abstract int sendStreamMessageEx (int streamId, byte[] message, RtcConnection connection)
 
abstract int createDataStreamEx (boolean reliable, boolean ordered, RtcConnection connection)
 
abstract int createDataStreamEx (DataStreamConfig config, RtcConnection connection)
 
abstract int joinChannelWithUserAccountEx (String token, String channelId, String userAccount, ChannelMediaOptions options, IRtcEngineEventHandler eventHandler, RtcConnection connection)
 
abstract UserInfo getUserInfoByUserAccount (String userAccount, RtcConnection connection)
 
abstract UserInfo getUserInfoByUid (int uid, RtcConnection connection)
 
- Public Member Functions inherited from io.agora.rtc2.RtcEngine
void addHandler (IRtcEngineEventHandler handler)
 
void removeHandler (IRtcEngineEventHandler handler)
 
abstract int joinChannel (String token, String channelName, String optionalInfo, int optionalUid)
 
abstract int joinChannel (String token, String channelId, int uid, ChannelMediaOptions options)
 
abstract int updateChannelMediaOptions (ChannelMediaOptions options)
 
abstract int leaveChannel ()
 
abstract int leaveChannel (LeaveChannelOptions options)
 
abstract boolean enableHighPerfWifiMode (boolean enable)
 
abstract int startLastmileProbeTest (LastmileProbeConfig config)
 
abstract int stopLastmileProbeTest ()
 
abstract int enableVideo ()
 
abstract int disableVideo ()
 
abstract int enableLocalVideo (boolean enabled)
 
abstract int startPreview ()
 
abstract int stopPreview ()
 
abstract int enableAudio ()
 
abstract int disableAudio ()
 
abstract int enableLocalAudio (boolean enabled)
 
abstract int pauseAudio ()
 
abstract int resumeAudio ()
 
abstract int setParameters (String parameters)
 
abstract String getParameter (String parameter, String args)
 
abstract int registerMediaMetadataObserver (IMetadataObserver observer, int type)
 
abstract int unregisterMediaMetadataObserver (IMetadataObserver observer, int type)
 
abstract String getCallId ()
 
abstract RtcConnection.CONNECTION_STATE_TYPE getConnectionState ()
 
abstract int rate (String callId, int rating, String description)
 
abstract int complain (String callId, String description)
 
abstract int setLogFile (String filePath)
 
abstract int setLogFilter (int filter)
 
abstract int setLogFileSize (long fileSizeInKBytes)
 
abstract int setupLocalVideo (VideoCanvas local)
 
abstract int setupRemoteVideo (VideoCanvas remote)
 
abstract int setLocalRenderMode (int renderMode)
 
abstract int setLocalRenderMode (int renderMode, int mirrorMode)
 
abstract int setRemoteRenderMode (int userId, int renderMode)
 
abstract int setRemoteRenderMode (int userId, int renderMode, int mirrorMode)
 
abstract int setLocalVideoMirrorMode (int mode)
 
abstract int addVideoWatermark (AgoraImage watermark)
 
abstract int clearVideoWatermarks ()
 
abstract int setRemoteUserPriority (int uid, int userPriority)
 
abstract int switchCamera ()
 
abstract boolean isCameraZoomSupported ()
 
abstract boolean isCameraTorchSupported ()
 
abstract boolean isCameraFocusSupported ()
 
abstract boolean isCameraAutoFocusFaceModeSupported ()
 
abstract int setCameraZoomFactor (float factor)
 
abstract float getCameraMaxZoomFactor ()
 
abstract int setCameraFocusPositionInPreview (float positionX, float positionY)
 
abstract int setCameraTorchOn (boolean isOn)
 
abstract int setCameraAutoFocusFaceModeEnabled (boolean enabled)
 
abstract int setCameraCapturerConfiguration (CameraCapturerConfiguration config)
 
abstract int setVideoProfile (int profile, boolean swapWidthAndHeight)
 
abstract int setVideoEncoderConfiguration (VideoEncoderConfiguration config)
 
abstract int setVideoProfile (int width, int height, int frameRate, int bitrate)
 
abstract int setAudioProfile (int profile, int scenario)
 
abstract int setAudioProfile (int profile)
 
abstract int muteLocalVideoStream (boolean muted)
 
abstract int muteAllRemoteVideoStreams (boolean muted)
 
abstract int setDefaultMuteAllRemoteVideoStreams (boolean muted)
 
abstract void monitorHeadsetEvent (boolean monitor)
 
abstract void monitorBluetoothHeadsetEvent (boolean monitor)
 
abstract int setEnableSpeakerphone (boolean enabled)
 
abstract int setDefaultAudioRoutetoSpeakerphone (boolean defaultToSpeaker)
 
abstract boolean isSpeakerphoneEnabled ()
 
abstract int enableAudioVolumeIndication (int interval, int smooth)
 
abstract int enableAudioQualityIndication (boolean enabled)
 
abstract int startAudioRecording (String filePath, int quality)
 
abstract int startAudioRecording (AudioFileRecordingConfig config)
 
abstract int stopAudioRecording ()
 
abstract int startEchoTest ()
 
abstract int startEchoTest (int intervalInSeconds)
 
abstract int stopEchoTest ()
 
abstract int muteLocalAudioStream (boolean muted)
 
abstract int muteAllRemoteAudioStreams (boolean muted)
 
abstract int setDefaultMuteAllRemoteAudioStreams (boolean muted)
 
abstract int muteRemoteAudioStream (int userId, boolean muted)
 
abstract int muteRemoteVideoStream (int userId, boolean muted)
 
abstract int setEncryptionMode (String encryptionMode)
 
abstract int setEncryptionSecret (String secret)
 
abstract int enableEncryption (boolean enabled, EncryptionConfig config)
 
abstract int renewToken (String token)
 
abstract int setChannelProfile (int profile)
 
abstract int setClientRole (int role)
 
abstract long getNativeHandle ()
 
abstract void setPreferHeadset (boolean enabled)
 
abstract int setRemoteVideoStreamType (int userId, int streamType)
 
abstract int setRemoteDefaultVideoStreamType (int streamType)
 
abstract int setLocalPublishFallbackOption (int option)
 
abstract int setRemoteSubscribeFallbackOption (int option)
 
abstract int startRecordingService (String recordingKey)
 
abstract int stopRecordingService (String recordingKey)
 
abstract int refreshRecordingServiceStatus ()
 
abstract int muteRecordingSignal (boolean muted)
 
abstract int startAudioMixing (String filePath, boolean loopback, boolean replace, int cycle)
 
abstract int stopAudioMixing ()
 
abstract int createDataStream (boolean reliable, boolean ordered)
 
abstract int createDataStream (DataStreamConfig config)
 
abstract int sendStreamMessage (int streamId, byte[] message)
 
abstract int startPlayingStream (String url)
 
abstract int stopPlayingStream ()
 
abstract int enableDualStreamMode (boolean enabled)
 
abstract int enableDualStreamMode (Constants.VideoSourceType sourceType, boolean enabled)
 
abstract int enableDualStreamMode (Constants.VideoSourceType sourceType, boolean enabled, SimulcastStreamConfig streamConfig)
 
abstract int setRecordingAudioFrameParameters (int sampleRate, int channel, int mode, int samplesPerCall)
 
abstract int setPlaybackAudioFrameParameters (int sampleRate, int channel, int mode, int samplesPerCall)
 
abstract int setMixedAudioFrameParameters (int sampleRate, int channel, int samplesPerCall)
 
abstract int setPlaybackAudioFrameBeforeMixingParameters (int sampleRate, int channel)
 
abstract int adjustRecordingSignalVolume (int volume)
 
abstract int adjustPlaybackSignalVolume (int volume)
 
abstract int adjustUserPlaybackSignalVolume (int uid, int volume)
 
abstract int setHighQualityAudioParameters (boolean fullband, boolean stereo, boolean fullBitrate)
 
abstract int pauseAudioMixing ()
 
abstract int resumeAudioMixing ()
 
abstract int adjustAudioMixingVolume (int volume)
 
abstract int adjustAudioMixingPublishVolume (int volume)
 
abstract int getAudioMixingPublishVolume ()
 
abstract int adjustAudioMixingPlayoutVolume (int volume)
 
abstract int getAudioMixingPlayoutVolume ()
 
abstract int getAudioMixingDuration ()
 
abstract int getAudioMixingCurrentPosition ()
 
abstract int setAudioMixingPosition (int pos)
 
abstract double getEffectsVolume ()
 
abstract int setEffectsVolume (double volume)
 
abstract int preloadEffect (int soundId, String filePath)
 
abstract int playEffect (int soundId, String filePath, int loopCount, double pitch, double pan, double gain, boolean publish)
 
abstract int playAllEffects (int loopCount, double pitch, double pan, double gain, boolean publish)
 
abstract int getVolumeOfEffect (int soundId)
 
abstract int setVolumeOfEffect (int soundId, double volume)
 
abstract int pauseEffect (int soundId)
 
abstract int pauseAllEffects ()
 
abstract int resumeEffect (int soundId)
 
abstract int resumeAllEffects ()
 
abstract int stopEffect (int soundId)
 
abstract int stopAllEffects ()
 
abstract int unloadEffect (int soundId)
 
abstract int unloadAllEffects ()
 
abstract int enableInEarMonitoring (boolean enabled)
 
abstract int enableInEarMonitoring (boolean enabled, int includeAudioFilters)
 
abstract int enableWebSdkInteroperability (boolean enabled)
 
abstract int setVideoQualityParameters (boolean preferFrameRateOverImageQuality)
 
abstract int configPublisher (PublisherConfiguration config)
 
abstract int setVideoCompositingLayout (VideoCompositingLayout layout)
 
abstract int clearVideoCompositingLayout ()
 
abstract int useExternalAudioDevice ()
 
abstract int registerAudioFrameObserver (IAudioFrameObserver observer)
 
abstract int setExternalAudioSource (boolean enabled, int sampleRate, int channels)
 
abstract int setExternalAudioSource (boolean enabled, int sampleRate, int channels, int sourceNumber, boolean localPlayback, boolean publish)
 
abstract int pushExternalAudioFrame (byte[] data, long timestamp)
 
abstract int pushExternalAudioFrame (ByteBuffer data, long timestamp, int sourceId)
 
abstract int setExternalAudioSink (int sampleRate, int channels)
 
abstract int pullPlaybackAudioFrame (byte[] data, int lengthInByte)
 
abstract int pullPlaybackAudioFrame (ByteBuffer data, int lengthInByte)
 
abstract IAudioEffectManager getAudioEffectManager ()
 
abstract int setLocalVoicePitch (double pitch)
 
abstract int setLocalVoiceEqualization (int bandFrequency, int bandGain)
 
abstract int setLocalVoiceReverb (int reverbKey, int value)
 
abstract int setLocalVoiceChanger (int voiceChanger)
 
abstract int setLocalVoiceReverbPreset (int reverbPreset)
 
abstract int setInEarMonitoringVolume (int volume)
 
abstract boolean isTextureEncodeSupported ()
 
abstract int setExternalVideoSource (boolean enable, boolean useTexture, boolean encodedFrame)
 
abstract boolean pushExternalVideoFrame (AgoraVideoFrame frame)
 
abstract boolean pushExternalVideoFrame (VideoFrame frame)
 
abstract int pushExternalEncodedVideoFrame (ByteBuffer data, EncodedVideoFrameInfo frameInfo)
 
abstract int registerVideoEncodedImageReceiver (IVideoEncodedImageReceiver receiver)
 
abstract int addPublishStreamUrl (String url, boolean transcodingEnabled)
 
abstract int removePublishStreamUrl (String url)
 
abstract int setLiveTranscoding (LiveTranscoding transcoding)
 
abstract int addInjectStreamUrl (String url, LiveInjectStreamConfig config)
 
abstract int removeInjectStreamUrl (String url)
 
abstract int setAudioOptionParams (String params)
 
abstract String getAudioOptionParams ()
 
abstract int setAudioSessionParams (String params)
 
abstract int startChannelMediaRelay (ChannelMediaRelayConfiguration channelMediaRelayConfiguration)
 
abstract int stopChannelMediaRelay ()
 
abstract int updateChannelMediaRelay (ChannelMediaRelayConfiguration channelMediaRelayConfiguration)
 
abstract String getAudioSessionParams ()
 
abstract boolean enableExtension (String vendor, boolean enable)
 
abstract boolean setExtensionProperty (String vendor, String key, String value)
 
abstract int startScreenCapture (Intent mediaProjectionPermissionResultData, ScreenCaptureParameters parameters)
 
abstract int stopScreenCapture ()
 
abstract int registerVideoFrameObserver (IVideoFrameObserver observer)
 
abstract int sendCustomReportMessage (String id, String category, String event, String label, int value)
 
abstract int setLogLevel (int level)
 
abstract IMediaPlayer createMediaPlayer ()
 
abstract int registerLocalUserAccount (String appId, String userAccount)
 
abstract int joinChannelWithUserAccount (String token, String channelId, String userAccount)
 
abstract int joinChannelWithUserAccount (String token, String channelId, String userAccount, ChannelMediaOptions options)
 
abstract UserInfo getUserInfoByUserAccount (String userAccount)
 
abstract UserInfo getUserInfoByUid (int uid)
 
abstract int enableExternalAudioSourceLocalPlayback (boolean enabled)
 

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
 
static synchronized RtcEngine create (RtcEngineConfig config) throws Exception
 
static synchronized boolean loadExtension (String name)
 
static synchronized void destroy ()
 
static String getSdkVersion ()
 
static String getMediaEngineVersion ()
 
static String getErrorDescription (int error)
 
static SurfaceView CreateRendererView (Context context)
 
static TextureView CreateTextureView (Context context)
 
static int getRecommendedEncoderType ()
 
- Static Protected Attributes inherited from io.agora.rtc2.RtcEngine
static RtcEngineImpl mInstance = null
 

Member Function Documentation

◆ getParameters()

abstract String io.agora.rtc2.RtcEngineInternal.getParameters ( String  parameters)
abstract

Queries internal states

Parameters
parametersJSON string, array type
Returns
A JSON string

Reimplemented in io.agora.rtc2.internal.RtcEngineImpl.

◆ 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

Reimplemented in io.agora.rtc2.internal.RtcEngineImpl.

◆ 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

Reimplemented in io.agora.rtc2.internal.RtcEngineImpl.

◆ 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

Reimplemented in io.agora.rtc2.internal.RtcEngineImpl.

◆ setApiCallMode()

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

Reimplemented in io.agora.rtc2.internal.RtcEngineImpl.