Agora Java API Reference for Android
Public Member Functions | List of all members
agora::rtc::IRtcEngineInternal Class Referenceabstract
Inheritance diagram for agora::rtc::IRtcEngineInternal:
agora::rtc::IRtcEngineEx agora::base::IParameterEngine agora::rtc::IRtcEngine agora::base::IEngineBase

Public Member Functions

virtual int initializeEx (const RtcEngineContextInternal &context)=0
 
virtual int muteRemoteAudioStream (uid_t userId, bool mute, conn_id_t connectionId=DEFAULT_CONNECTION_ID)=0
 
virtual int muteRemoteVideoStream (uid_t userId, bool mute, conn_id_t connectionId=DEFAULT_CONNECTION_ID)=0
 
virtual int setProfile (const char *profile, bool merge)=0
 
virtual int getProfile (any_document_t &result)=0
 
virtual int notifyNetworkChange (agora::commons::network::network_info_t &&networkInfo)=0
 
virtual int getOptionsByVideoProfile (int profile, VideoNetOptions &options)=0
 
virtual int setAudioOptionParams (const char *params)=0
 
virtual int getAudioOptionParams (char *params)=0
 
virtual int setAudioSessionParams (const char *params)=0
 
virtual int getAudioSessionParams (char *params)=0
 
virtual bool isMicrophoneOn ()=0
 
virtual int reportWebAgentVideoStats (const WebAgentVideoStats &stats)=0
 
virtual int printLog (int level, const char *message)=0
 
virtual int runOnWorkerThread (std::function< void(void)> &&f)=0
 
virtual int reportArgusCounters (int *counterId, int *value, int count, user_id_t userId)=0
 
virtual int reportRecordingArgusEvent (uint32_t *eventIds, int64_t *value, int count, RecordingEventType eventType)=0
 
virtual int addInjectStreamUrl2 (const char *url, protocol::CmdInjectStreamConfig &config)=0
 
virtual int enableYuvDumper (bool enable)=0
 
virtual int setVideoConfigParam (const char *params)=0
 
virtual int getVideoConfigParam (char *params, size_t size)=0
 
virtual int setExternalVideoConfigEx (const VideoEncoderConfiguration &config, conn_id_t connectionId)=0
 
virtual int setLogLevelEx (unsigned int filter)=0
 
virtual int simulateOnSetParameters (const std::string &parameters)=0
 
virtual int setCameraDevice (const char dev_id[MAX_DEVICE_ID_LENGTH])=0
 
virtual agora_refptr< IMediaPlayer > getMediaPlayer (int sourceId)=0
 
- Public Member Functions inherited from agora::rtc::IRtcEngineEx
virtual int initialize (const RtcEngineContextEx &context)=0
 
virtual int setVideoProfileEx (int width, int height, int frameRate, int bitrate)=0
 
virtual int initialize (const RtcEngineContext &context)=0
 
- Public Member Functions inherited from agora::rtc::IRtcEngine
virtual void release (bool sync=false)=0
 
virtual int initialize (const RtcEngineContext &context)=0
 
virtual int queryInterface (INTERFACE_ID_TYPE iid, void **inter)=0
 
virtual const char * getVersion (int *build)=0
 
virtual const char * getErrorDescription (int code)=0
 
virtual int joinChannel (const char *token, const char *channelId, const char *info, uid_t uid)=0
 
virtual int joinChannel (const char *token, const char *channelId, uid_t uid, const ChannelMediaOptions &options)=0
 
virtual int joinChannelEx (const char *token, const char *channelId, uid_t uid, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler, conn_id_t *connectionId)=0
 
virtual int updateChannelMediaOptions (const ChannelMediaOptions &options, conn_id_t connectionId=agora::rtc::DEFAULT_CONNECTION_ID)=0
 
virtual int leaveChannelEx (const char *channelId, conn_id_t connectionId)=0
 
virtual int leaveChannel ()=0
 
virtual int leaveChannel (const LeaveChannelOptions &options)=0
 
virtual int renewToken (const char *token)=0
 
virtual int setChannelProfile (CHANNEL_PROFILE_TYPE profile)=0
 
virtual int setClientRole (CLIENT_ROLE_TYPE role)=0
 
virtual int startEchoTest ()=0
 
virtual int startEchoTest (int intervalInSeconds)=0
 
virtual int stopEchoTest ()=0
 
virtual int enableVideo ()=0
 
virtual int disableVideo ()=0
 
virtual int startPreview ()=0
 
virtual int stopPreview ()=0
 
virtual int startLastmileProbeTest (const LastmileProbeConfig &config)=0
 
virtual int stopLastmileProbeTest ()=0
 
virtual int setVideoEncoderConfiguration (const VideoEncoderConfiguration &config, conn_id_t connectionId=DEFAULT_CONNECTION_ID)=0
 
virtual int setupRemoteVideo (const VideoCanvas &canvas, conn_id_t connectionId=DEFAULT_CONNECTION_ID)=0
 
virtual int setupLocalVideo (const VideoCanvas &canvas)=0
 
virtual int enableAudio ()=0
 
virtual int disableAudio ()=0
 
virtual int setAudioProfile (AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario)=0
 
virtual int setAudioProfile (AUDIO_PROFILE_TYPE profile)=0
 
virtual int enableLocalAudio (bool enabled)=0
 
virtual int muteLocalAudioStream (bool mute)=0
 
virtual int muteAllRemoteAudioStreams (bool mute)=0
 
virtual int setDefaultMuteAllRemoteAudioStreams (bool mute)=0
 
virtual int muteLocalVideoStream (bool mute)=0
 
virtual int enableLocalVideo (bool enabled)=0
 
virtual int muteAllRemoteVideoStreams (bool mute)=0
 
virtual int setDefaultMuteAllRemoteVideoStreams (bool mute)=0
 
virtual int setRemoteVideoStreamType (uid_t uid, VIDEO_STREAM_TYPE streamType)=0
 
virtual int setRemoteDefaultVideoStreamType (VIDEO_STREAM_TYPE streamType)=0
 
virtual int enableAudioVolumeIndication (int interval, int smooth)=0
 
virtual int startAudioRecording (const char *filePath, AUDIO_RECORDING_QUALITY_TYPE quality)=0
 
virtual int startAudioRecording (const char *filePath, int sampleRate, AUDIO_RECORDING_QUALITY_TYPE quality)=0
 
virtual int startAudioRecording (const AudioFileRecordingConfig &config)=0
 
virtual int stopAudioRecording ()=0
 
virtual int destroyMediaPlayer (agora_refptr< IMediaPlayer > media_player)=0
 
virtual int startAudioMixing (const char *filePath, bool loopback, bool replace, int cycle)=0
 
virtual int stopAudioMixing ()=0
 
virtual int pauseAudioMixing ()=0
 
virtual int resumeAudioMixing ()=0
 
virtual int adjustAudioMixingVolume (int volume)=0
 
virtual int adjustAudioMixingPublishVolume (int volume)=0
 
virtual int getAudioMixingPublishVolume ()=0
 
virtual int adjustAudioMixingPlayoutVolume (int volume)=0
 
virtual int getAudioMixingPlayoutVolume ()=0
 
virtual int getAudioMixingDuration ()=0
 
virtual int getAudioMixingCurrentPosition ()=0
 
virtual int setAudioMixingPosition (int pos)=0
 
virtual int getEffectsVolume ()=0
 
virtual int setEffectsVolume (int volume)=0
 
virtual int preloadEffect (int soundId, const char *filePath)=0
 
virtual int playEffect (int soundId, const char *filePath, int loopCount, double pitch, double pan, int gain, bool publish=false)=0
 
virtual int playAllEffects (int loopCount, double pitch, double pan, int gain, bool publish=false)=0
 
virtual int getVolumeOfEffect (int soundId)=0
 
virtual int setVolumeOfEffect (int soundId, int volume)=0
 
virtual int pauseEffect (int soundId)=0
 
virtual int pauseAllEffects ()=0
 
virtual int resumeEffect (int soundId)=0
 
virtual int resumeAllEffects ()=0
 
virtual int stopEffect (int soundId)=0
 
virtual int stopAllEffects ()=0
 
virtual int unloadEffect (int soundId)=0
 
virtual int unloadAllEffects ()=0
 
virtual int setLocalVoicePitch (double pitch)=0
 
virtual int setLocalVoiceEqualization (AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain)=0
 
virtual int setLocalVoiceReverb (AUDIO_REVERB_TYPE reverbKey, int value)=0
 
virtual int setLocalVoiceReverbPreset (AUDIO_REVERB_PRESET reverbPreset)=0
 
virtual int setLocalVoiceChanger (VOICE_CHANGER_PRESET voiceChanger)=0
 
virtual int setLogFile (const char *filePath)=0
 
virtual int setLogFilter (unsigned int filter)=0
 
virtual int setLogLevel (commons::LOG_LEVEL level)=0
 
virtual int setLogFileSize (unsigned int fileSizeInKBytes)=0
 
virtual int setLocalRenderMode (media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
 
virtual int setRemoteRenderMode (uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode, conn_id_t connectionId=DEFAULT_CONNECTION_ID)=0
 
virtual int setLocalRenderMode (media::base::RENDER_MODE_TYPE renderMode)=0
 
virtual int setRemoteRenderMode (uid_t uid, media::base::RENDER_MODE_TYPE renderMode, conn_id_t connectionId=DEFAULT_CONNECTION_ID)=0
 
virtual int setLocalVideoMirrorMode (VIDEO_MIRROR_MODE_TYPE mirrorMode)=0
 
virtual int enableDualStreamMode (bool enabled)=0
 
virtual int enableDualStreamMode (VIDEO_SOURCE_TYPE sourceType, bool enabled)=0
 
virtual int enableDualStreamMode (VIDEO_SOURCE_TYPE sourceType, bool enabled, const SimulcastStreamConfig &streamConfig)=0
 
virtual int setExternalAudioSource (bool enabled, int sampleRate, int channels, int sourceNumber=1, bool localPlayback=false, bool publish=true)=0
 
virtual int setExternalAudioSink (int sampleRate, int channels)=0
 
virtual int pullAudioFrame (media::IAudioFrameObserver::AudioFrame *frame)=0
 
virtual int startPrimaryCustomAudioTrack (const AudioTrackConfig &config)=0
 
virtual int stopPrimaryCustomAudioTrack ()=0
 
virtual int startSecondaryCustomAudioTrack (const AudioTrackConfig &config)=0
 
virtual int stopSecondaryCustomAudioTrack ()=0
 
virtual int setRecordingAudioFrameParameters (int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
 
virtual int setPlaybackAudioFrameParameters (int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
 
virtual int setMixedAudioFrameParameters (int sampleRate, int channel, int samplesPerCall)=0
 
virtual int setPlaybackAudioFrameBeforeMixingParameters (int sampleRate, int channel)=0
 
virtual int adjustRecordingSignalVolume (int volume)=0
 
virtual int muteRecordingSignal (bool mute)=0
 
virtual int adjustPlaybackSignalVolume (int volume)=0
 
virtual int adjustUserPlaybackSignalVolume (unsigned int uid, int volume)=0
 
virtual int enableLoopbackRecording (bool enabled)=0
 
virtual int enableLoopbackRecording (conn_id_t connectionId, bool enabled)=0
 
virtual int adjustLoopbackRecordingVolume (int volume)=0
 
virtual int getLoopbackRecordingVolume ()=0
 
virtual int enableInEarMonitoring (bool enabled, int includeAudioFilters)=0
 
virtual int setInEarMonitoringVolume (int volume)=0
 
virtual int enableExtension (const char *id, bool enable=true)=0
 
virtual int setExtensionProperty (const char *id, const char *key, const char *json_value)=0
 
virtual int getCallId (agora::util::AString &callId)=0
 
virtual int rate (const char *callId, int rating, const char *description)=0
 
virtual int complain (const char *callId, const char *description)=0
 
virtual int addPublishStreamUrl (const char *url, bool transcodingEnabled)=0
 
virtual int removePublishStreamUrl (const char *url)=0
 
virtual int setLiveTranscoding (const LiveTranscoding &transcoding)=0
 
virtual int startLocalVideoTranscoder (const LocalTranscoderConfiguration &config)=0
 
virtual int updateLocalTranscoderConfiguration (const LocalTranscoderConfiguration &config)=0
 
virtual int stopLocalVideoTranscoder ()=0
 
virtual int startPrimaryCameraCapture (const CameraCapturerConfiguration &config)=0
 
virtual int startSecondaryCameraCapture (const CameraCapturerConfiguration &config)=0
 
virtual int stopPrimaryCameraCapture ()=0
 
virtual int stopSecondaryCameraCapture ()=0
 
virtual int setCameraDeviceOrientation (VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation)=0
 
virtual int startPrimaryScreenCapture (const ScreenCaptureConfiguration &config)=0
 
virtual int startSecondaryScreenCapture (const ScreenCaptureConfiguration &config)=0
 
virtual int stopPrimaryScreenCapture ()=0
 
virtual int stopSecondaryScreenCapture ()=0
 
virtual CONNECTION_STATE_TYPE getConnectionState (conn_id_t connectionId=0)=0
 
virtual bool registerEventHandler (IRtcEngineEventHandler *eventHandler)=0
 
virtual bool unregisterEventHandler (IRtcEngineEventHandler *eventHandler)=0
 
virtual int setRemoteUserPriority (uid_t uid, PRIORITY_TYPE userPriority)=0
 
virtual int registerPacketObserver (IPacketObserver *observer)=0
 
virtual int setEncryptionMode (const char *encryptionMode)=0
 
virtual int setEncryptionSecret (const char *secret)=0
 
virtual int enableEncryption (bool enabled, const EncryptionConfig &config)=0
 
virtual int createDataStream (int *streamId, bool reliable, bool ordered, conn_id_t connectionId=agora::rtc::DEFAULT_CONNECTION_ID)=0
 
virtual int createDataStream (int *streamId, DataStreamConfig &config, conn_id_t connectionId=agora::rtc::DEFAULT_CONNECTION_ID)=0
 
virtual int sendStreamMessage (int streamId, const char *data, size_t length, conn_id_t connectionId=agora::rtc::DEFAULT_CONNECTION_ID)=0
 
virtual int addVideoWatermark (const RtcImage &watermark)=0
 
virtual int addVideoWatermark (const char *watermarkUrl, const WatermarkOptions &options, conn_id_t connectionId=agora::rtc::DEFAULT_CONNECTION_ID)=0
 
virtual int clearVideoWatermark (conn_id_t connectionId=agora::rtc::DEFAULT_CONNECTION_ID)=0
 
virtual int clearVideoWatermarks ()=0
 
virtual int addInjectStreamUrl (const char *url, const InjectStreamConfig &config)=0
 
virtual int removeInjectStreamUrl (const char *url)=0
 
virtual int pauseAudio ()=0
 
virtual int resumeAudio ()=0
 
virtual int enableWebSdkInteroperability (bool enabled)=0
 
virtual int sendCustomReportMessage (const char *id, const char *category, const char *event, const char *label, int value, conn_id_t connectionId=agora::rtc::DEFAULT_CONNECTION_ID)=0
 
virtual int registerMediaMetadataObserver (IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0
 
virtual int unregisterMediaMetadataObserver (IMetadataObserver *observer, IMetadataObserver::METADATA_TYPE type)=0
 
virtual int startAudioFrameDump (const char *channel_id, uid_t user_id, const char *location, const char *uuid, const char *passwd, long duration_ms, bool auto_upload)=0
 
virtual int stopAudioFrameDump (const char *channel_id, uid_t user_id, const char *location)=0
 
virtual int registerLocalUserAccount (const char *appId, const char *userAccount)=0
 
virtual int joinChannelWithUserAccount (const char *token, const char *channelId, const char *userAccount)=0
 
virtual int joinChannelWithUserAccount (const char *token, const char *channelId, const char *userAccount, const ChannelMediaOptions &options)=0
 
virtual int joinChannelWithUserAccountEx (const char *token, const char *channelId, const char *userAccount, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler, conn_id_t *connectionId=0)=0
 
virtual int getUserInfoByUserAccount (const char *userAccount, rtc::UserInfo *userInfo, conn_id_t connectionId=agora::rtc::DEFAULT_CONNECTION_ID)=0
 
virtual int getUserInfoByUid (uid_t uid, rtc::UserInfo *userInfo, conn_id_t connectionId=agora::rtc::DEFAULT_CONNECTION_ID)=0
 
virtual int startChannelMediaRelay (const ChannelMediaRelayConfiguration &configuration)=0
 
virtual int updateChannelMediaRelay (const ChannelMediaRelayConfiguration &configuration)=0
 
virtual int stopChannelMediaRelay ()=0
 
- Public Member Functions inherited from agora::base::IParameterEngine
virtual int setParameters (const char *parameters)=0
 
virtual int getParameters (const char *key, any_document_t &result)=0
 

Member Function Documentation

◆ muteRemoteAudioStream()

virtual int agora::rtc::IRtcEngineInternal::muteRemoteAudioStream ( uid_t  uid,
bool  mute,
conn_id_t  connectionId = DEFAULT_CONNECTION_ID 
)
pure virtual

Stops or resumes receiving the audio stream of a specified user.

Note
You can call this method before or after joining a channel. If a user leaves a channel, the settings in this method become invalid.
Parameters
uidThe ID of the specified user.
muteWhether to stop receiving the audio stream of the specified user:
  • true: Stop receiving the audio stream of the specified user.
  • false: (Default) Resume receiving the audio stream of the specified user.
connectionIdThe connection ID.
Returns
  • 0: Success.
  • < 0: Failure.

Implements agora::rtc::IRtcEngine.

◆ muteRemoteVideoStream()

virtual int agora::rtc::IRtcEngineInternal::muteRemoteVideoStream ( uid_t  uid,
bool  mute,
conn_id_t  connectionId = DEFAULT_CONNECTION_ID 
)
pure virtual

Stops or resumes receiving the video stream of a specified user.

Note
You can call this method before or after joining a channel. If a user leaves a channel, the settings in this method become invalid.
Parameters
uidThe ID of the specified user.
muteWhether to stop receiving the video stream of the specified user:
  • true: Stop receiving the video stream of the specified user.
  • false: (Default) Resume receiving the video stream of the specified user.
connectionIdThe connection ID.
Returns
  • 0: Success.
  • < 0: Failure.

Implements agora::rtc::IRtcEngine.

◆ reportWebAgentVideoStats()

virtual int agora::rtc::IRtcEngineInternal::reportWebAgentVideoStats ( const WebAgentVideoStats stats)
pure virtual

get SHA1 values of source files for building the binaries being used, for bug tracking.