Agora C++ API Reference for All Platforms
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
agora::rtc::IRtcEngineInternal Class Referenceabstract

Inherits agora::rtc::IRtcEngineEx, and agora::base::IParameterEngine.

Public Member Functions

virtual aosl_ref_t ref ()=0
 
virtual int initializeEx (const RtcEngineContextInternal &context)=0
 
virtual const char * getSid (const RtcConnection &connection={})=0
 
virtual int setProfile (const char *profile, bool merge)=0
 
virtual int getProfile (std::string &result)=0
 
virtual int initializeInternal (const RtcEngineContextInternal &context)=0
 
virtual int setAudioOptionParams (const char *params)=0
 
virtual int getAudioOptionParams (char *params)=0
 
virtual bool isMicrophoneOn ()=0
 
virtual int reportWebAgentVideoStats (const WebAgentVideoStats &stats)=0
 
virtual int monitorDeviceChange (bool enabled)=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, uid_t uid)=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)=0
 
virtual int setExternalVideoConfigEx (const VideoEncoderConfiguration &config, const RtcConnection &connection)=0
 
virtual int getParametersEx (const RtcConnection &connection, const char *key, std::string &results)=0
 
virtual int GetScreenCaptureType ()=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 aosl_ref_t getMediaPlayer (int sourceId)=0
 
virtual int putMediaPlayer (int sourceId)=0
 
virtual agora_refptr< IRtcConnectiongetConnection (const RtcConnection &connection={}) const =0
 
virtual int soundPositionChannel (uid_t uid)=0
 
virtual int soundPositionChannel (uid_t uid, const RtcConnection &connection)=0
 
virtual int32_t setAppType (APP_TYPE appType)=0
 
virtual int32_t enableVosUserInfoHidden (bool enabled)=0
 
virtual int setMediaRecorderObserver (const char *channelId, uid_t uid, bool isLocal, media::IMediaRecorderObserverEx *observer, int sys_version=0)=0
 
virtual int startRecording (const char *channelId, uid_t uid, bool isLocal, const media::MediaRecorderConfiguration &config)=0
 
virtual int stopRecording (const char *channelId, uid_t uid, bool isLocal)=0
 
virtual int releaseRecorder (const char *channelId, uid_t uid, bool isLocal)=0
 
virtual int setTimestamp (ENGINE_INIT_TS_POSITION ts_position, uint64_t ts)=0
 
virtual uint64_t getTimestamp (ENGINE_INIT_TS_POSITION ts_position) const =0
 
virtual void reportEngineInitializeEvent () const =0
 
virtual std::string getRecentSid (const RtcConnection *connnection)=0
 
virtual int setupAudioAttributeContext (void *audioAttr)=0
 
virtual int switchCameraId (const char *cameraId)=0
 
virtual bool initialized ()=0
 
virtual base::IAgoraServicegetAgoraService ()=0
 
- Public Member Functions inherited from agora::rtc::IRtcEngineEx
virtual int joinChannelEx (const char *token, const RtcConnection &connection, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
 
virtual int leaveChannelEx (const RtcConnection &connection)=0
 
virtual int leaveChannelEx (const RtcConnection &connection, const LeaveChannelOptions &options)=0
 
virtual int updateChannelMediaOptionsEx (const ChannelMediaOptions &options, const RtcConnection &connection)=0
 
virtual int setVideoEncoderConfigurationEx (const VideoEncoderConfiguration &config, const RtcConnection &connection)=0
 
virtual int setupRemoteVideoEx (const VideoCanvas &canvas, const RtcConnection &connection)=0
 
virtual int muteRemoteAudioStreamEx (uid_t uid, bool mute, const RtcConnection &connection)=0
 
virtual int muteRemoteVideoStreamEx (uid_t uid, bool mute, const RtcConnection &connection)=0
 
virtual int setRemoteVideoStreamTypeEx (uid_t uid, VIDEO_STREAM_TYPE streamType, const RtcConnection &connection)=0
 
virtual int muteLocalAudioStreamEx (bool mute, const RtcConnection &connection)=0
 
virtual int muteLocalVideoStreamEx (bool mute, const RtcConnection &connection)=0
 
virtual int muteAllRemoteAudioStreamsEx (bool mute, const RtcConnection &connection)=0
 
virtual int muteAllRemoteVideoStreamsEx (bool mute, const RtcConnection &connection)=0
 
virtual int setSubscribeAudioBlocklistEx (uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
 
virtual int setSubscribeAudioAllowlistEx (uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
 
virtual int setSubscribeVideoBlocklistEx (uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
 
virtual int setSubscribeVideoAllowlistEx (uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
 
virtual int setRemoteVideoSubscriptionOptionsEx (uid_t uid, const VideoSubscriptionOptions &options, const RtcConnection &connection)=0
 
virtual int setRemoteVoicePositionEx (uid_t uid, double pan, double gain, const RtcConnection &connection)=0
 
virtual int setRemoteUserSpatialAudioParamsEx (uid_t uid, const agora::SpatialAudioParams &params, const RtcConnection &connection)=0
 
virtual int setRemoteRenderModeEx (uid_t uid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode, const RtcConnection &connection)=0
 
virtual int enableLoopbackRecordingEx (const RtcConnection &connection, bool enabled, const char *deviceName=NULL)=0
 
virtual int adjustRecordingSignalVolumeEx (int volume, const RtcConnection &connection)=0
 
virtual int muteRecordingSignalEx (bool mute, const RtcConnection &connection)=0
 
virtual int adjustUserPlaybackSignalVolumeEx (uid_t uid, int volume, const RtcConnection &connection)=0
 
virtual CONNECTION_STATE_TYPE getConnectionStateEx (const RtcConnection &connection)=0
 
virtual int enableEncryptionEx (const RtcConnection &connection, bool enabled, const EncryptionConfig &config)=0
 
virtual int createDataStreamEx (int *streamId, bool reliable, bool ordered, const RtcConnection &connection)=0
 
virtual int createDataStreamEx (int *streamId, const DataStreamConfig &config, const RtcConnection &connection)=0
 
virtual int sendStreamMessageEx (int streamId, const char *data, size_t length, const RtcConnection &connection)=0
 
virtual int addVideoWatermarkEx (const char *watermarkUrl, const WatermarkOptions &options, const RtcConnection &connection)=0
 
virtual int clearVideoWatermarkEx (const RtcConnection &connection)=0
 
virtual int sendCustomReportMessageEx (const char *id, const char *category, const char *event, const char *label, int value, const RtcConnection &connection)=0
 
virtual int enableAudioVolumeIndicationEx (int interval, int smooth, bool reportVad, const RtcConnection &connection)=0
 
virtual int startRtmpStreamWithoutTranscodingEx (const char *url, const RtcConnection &connection)=0
 
virtual int startRtmpStreamWithTranscodingEx (const char *url, const LiveTranscoding &transcoding, const RtcConnection &connection)=0
 
virtual int updateRtmpTranscodingEx (const LiveTranscoding &transcoding, const RtcConnection &connection)=0
 
virtual int stopRtmpStreamEx (const char *url, const RtcConnection &connection)=0
 
virtual int startOrUpdateChannelMediaRelayEx (const ChannelMediaRelayConfiguration &configuration, const RtcConnection &connection)=0
 
virtual int stopChannelMediaRelayEx (const RtcConnection &connection)=0
 
virtual int pauseAllChannelMediaRelayEx (const RtcConnection &connection)=0
 
virtual int resumeAllChannelMediaRelayEx (const RtcConnection &connection)=0
 
virtual int getUserInfoByUserAccountEx (const char *userAccount, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
 
virtual int getUserInfoByUidEx (uid_t uid, rtc::UserInfo *userInfo, const RtcConnection &connection)=0
 
virtual int enableDualStreamModeEx (bool enabled, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
 
virtual int setDualStreamModeEx (SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &streamConfig, const RtcConnection &connection)=0
 
virtual int setSimulcastConfigEx (const SimulcastConfig &simulcastConfig, const RtcConnection &connection)=0
 
virtual int setHighPriorityUserListEx (uid_t *uidList, int uidNum, STREAM_FALLBACK_OPTIONS option, const RtcConnection &connection)=0
 
virtual int takeSnapshotEx (const RtcConnection &connection, uid_t uid, const char *filePath)=0
 
virtual int enableContentInspectEx (bool enabled, const media::ContentInspectConfig &config, const RtcConnection &connection)=0
 
virtual int startMediaRenderingTracingEx (const RtcConnection &connection)=0
 
virtual int setParametersEx (const RtcConnection &connection, const char *parameters)=0
 
virtual int getCallIdEx (agora::util::AString &callId, const RtcConnection &connection)=0
 
virtual int sendAudioMetadataEx (const RtcConnection &connection, const char *metadata, size_t length)=0
 
- Public Member Functions inherited from agora::rtc::IRtcEngine
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 queryCodecCapability (CodecCapInfo *codecInfo, int &size)=0
 
virtual int queryDeviceScore ()=0
 
virtual int preloadChannel (const char *token, const char *channelId, uid_t uid)=0
 
virtual int preloadChannelWithUserAccount (const char *token, const char *channelId, const char *userAccount)=0
 
virtual int updatePreloadChannelToken (const char *token)=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 updateChannelMediaOptions (const ChannelMediaOptions &options)=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 setClientRole (CLIENT_ROLE_TYPE role, const ClientRoleOptions &options)=0
 
virtual int startEchoTest (const EchoTestConfiguration &config)=0
 
virtual int stopEchoTest ()=0
 
virtual int enableMultiCamera (bool enabled, const CameraCapturerConfiguration &config)=0
 
virtual int enableVideo ()=0
 
virtual int disableVideo ()=0
 
virtual int startPreview ()=0
 
virtual int startPreview (VIDEO_SOURCE_TYPE sourceType)=0
 
virtual int stopPreview ()=0
 
virtual int stopPreview (VIDEO_SOURCE_TYPE sourceType)=0
 
virtual int startLastmileProbeTest (const LastmileProbeConfig &config)=0
 
virtual int stopLastmileProbeTest ()=0
 
virtual int setVideoEncoderConfiguration (const VideoEncoderConfiguration &config)=0
 
virtual int setBeautyEffectOptions (bool enabled, const BeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
 
virtual int setFaceShapeBeautyOptions (bool enabled, const FaceShapeBeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
 
virtual int setFaceShapeAreaOptions (const FaceShapeAreaOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
 
virtual int getFaceShapeBeautyOptions (FaceShapeBeautyOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
 
virtual int getFaceShapeAreaOptions (agora::rtc::FaceShapeAreaOptions::FACE_SHAPE_AREA shapeArea, FaceShapeAreaOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
 
virtual int setLowlightEnhanceOptions (bool enabled, const LowlightEnhanceOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
 
virtual int setVideoDenoiserOptions (bool enabled, const VideoDenoiserOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
 
virtual int setColorEnhanceOptions (bool enabled, const ColorEnhanceOptions &options, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
 
virtual int enableVirtualBackground (bool enabled, VirtualBackgroundSource backgroundSource, SegmentationProperty segproperty, agora::media::MEDIA_SOURCE_TYPE type=agora::media::PRIMARY_CAMERA_SOURCE)=0
 
virtual int setupRemoteVideo (const VideoCanvas &canvas)=0
 
virtual int setupLocalVideo (const VideoCanvas &canvas)=0
 
virtual int setVideoScenario (VIDEO_APPLICATION_SCENARIO_TYPE scenarioType)=0
 
virtual int setVideoQoEPreference (VIDEO_QOE_PREFERENCE_TYPE qoePreference)=0
 
virtual int enableAudio ()=0
 
virtual int disableAudio ()=0
 
virtual int setAudioProfile (AUDIO_PROFILE_TYPE profile, AUDIO_SCENARIO_TYPE scenario) __deprecated=0
 
virtual int setAudioProfile (AUDIO_PROFILE_TYPE profile)=0
 
virtual int setAudioScenario (AUDIO_SCENARIO_TYPE scenario)=0
 
virtual int enableLocalAudio (bool enabled)=0
 
virtual int muteLocalAudioStream (bool mute)=0
 
virtual int muteAllRemoteAudioStreams (bool mute)=0
 
virtual int muteRemoteAudioStream (uid_t uid, bool mute)=0
 
virtual int muteLocalVideoStream (bool mute)=0
 
virtual int enableLocalVideo (bool enabled)=0
 
virtual int muteAllRemoteVideoStreams (bool mute)=0
 
virtual int setRemoteDefaultVideoStreamType (VIDEO_STREAM_TYPE streamType)=0
 
virtual int muteRemoteVideoStream (uid_t uid, bool mute)=0
 
virtual int setRemoteVideoStreamType (uid_t uid, VIDEO_STREAM_TYPE streamType)=0
 
virtual int setRemoteVideoSubscriptionOptions (uid_t uid, const VideoSubscriptionOptions &options)=0
 
virtual int setSubscribeAudioBlocklist (uid_t *uidList, int uidNumber)=0
 
virtual int setSubscribeAudioAllowlist (uid_t *uidList, int uidNumber)=0
 
virtual int setSubscribeVideoBlocklist (uid_t *uidList, int uidNumber)=0
 
virtual int setSubscribeVideoAllowlist (uid_t *uidList, int uidNumber)=0
 
virtual int enableAudioVolumeIndication (int interval, int smooth, bool reportVad)=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 AudioRecordingConfiguration &config)=0
 
virtual int registerAudioEncodedFrameObserver (const AudioEncodedFrameObserverConfig &config, IAudioEncodedFrameObserver *observer)=0
 
virtual int stopAudioRecording ()=0
 
virtual agora_refptr< IMediaPlayer > createMediaPlayer ()=0
 
virtual int destroyMediaPlayer (agora_refptr< IMediaPlayer > media_player)=0
 
virtual agora_refptr< IMediaRecorder > createMediaRecorder (const RecorderStreamInfo &info)=0
 
virtual int destroyMediaRecorder (agora_refptr< IMediaRecorder > mediaRecorder)=0
 
virtual int startAudioMixing (const char *filePath, bool loopback, int cycle)=0
 
virtual int startAudioMixing (const char *filePath, bool loopback, int cycle, int startPos)=0
 
virtual int stopAudioMixing ()=0
 
virtual int pauseAudioMixing ()=0
 
virtual int resumeAudioMixing ()=0
 
virtual int selectAudioTrack (int index)=0
 
virtual int getAudioTrackCount ()=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 setAudioMixingDualMonoMode (media::AUDIO_MIXING_DUAL_MONO_MODE mode)=0
 
virtual int setAudioMixingPitch (int pitch)=0
 
virtual int setAudioMixingPlaybackSpeed (int speed)=0
 
virtual int getEffectsVolume ()=0
 
virtual int setEffectsVolume (int volume)=0
 
virtual int preloadEffect (int soundId, const char *filePath, int startPos=0)=0
 
virtual int playEffect (int soundId, const char *filePath, int loopCount, double pitch, double pan, int gain, bool publish=false, int startPos=0)=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 getEffectDuration (const char *filePath)=0
 
virtual int setEffectPosition (int soundId, int pos)=0
 
virtual int getEffectCurrentPosition (int soundId)=0
 
virtual int enableSoundPositionIndication (bool enabled)=0
 
virtual int setRemoteVoicePosition (uid_t uid, double pan, double gain)=0
 
virtual int enableSpatialAudio (bool enabled)=0
 
virtual int setRemoteUserSpatialAudioParams (uid_t uid, const agora::SpatialAudioParams &params)=0
 
virtual int setVoiceBeautifierPreset (VOICE_BEAUTIFIER_PRESET preset)=0
 
virtual int setAudioEffectPreset (AUDIO_EFFECT_PRESET preset)=0
 
virtual int setVoiceConversionPreset (VOICE_CONVERSION_PRESET preset)=0
 
virtual int setAudioEffectParameters (AUDIO_EFFECT_PRESET preset, int param1, int param2)=0
 
virtual int setVoiceBeautifierParameters (VOICE_BEAUTIFIER_PRESET preset, int param1, int param2)=0
 
virtual int setVoiceConversionParameters (VOICE_CONVERSION_PRESET preset, int param1, int param2)=0
 
virtual int setLocalVoicePitch (double pitch)=0
 
virtual int setLocalVoiceFormant (double formantRatio)=0
 
virtual int setLocalVoiceEqualization (AUDIO_EQUALIZATION_BAND_FREQUENCY bandFrequency, int bandGain)=0
 
virtual int setLocalVoiceReverb (AUDIO_REVERB_TYPE reverbKey, int value)=0
 
virtual int setHeadphoneEQPreset (HEADPHONE_EQUALIZER_PRESET preset)=0
 
virtual int setHeadphoneEQParameters (int lowGain, int highGain)=0
 
virtual int enableVoiceAITuner (bool enabled, VOICE_AI_TUNER_TYPE type)=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 uploadLogFile (agora::util::AString &requestId)=0
 
virtual int writeLog (commons::LOG_LEVEL level, const char *fmt,...)=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)=0
 
virtual int setLocalRenderMode (media::base::RENDER_MODE_TYPE renderMode) __deprecated=0
 
virtual int setLocalVideoMirrorMode (VIDEO_MIRROR_MODE_TYPE mirrorMode) __deprecated=0
 
virtual int enableDualStreamMode (bool enabled) __deprecated=0
 
virtual int enableDualStreamMode (bool enabled, const SimulcastStreamConfig &streamConfig) __deprecated=0
 
virtual int setDualStreamMode (SIMULCAST_STREAM_MODE mode)=0
 
virtual int setSimulcastConfig (const SimulcastConfig &simulcastConfig)=0
 
virtual int setDualStreamMode (SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &streamConfig)=0
 
virtual int enableCustomAudioLocalPlayback (track_id_t trackId, bool enabled)=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 setEarMonitoringAudioFrameParameters (int sampleRate, int channel, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
 
virtual int setPlaybackAudioFrameBeforeMixingParameters (int sampleRate, int channel)=0
 
virtual int enableAudioSpectrumMonitor (int intervalInMS=100)=0
 
virtual int disableAudioSpectrumMonitor ()=0
 
virtual int registerAudioSpectrumObserver (agora::media::IAudioSpectrumObserver *observer)=0
 
virtual int unregisterAudioSpectrumObserver (agora::media::IAudioSpectrumObserver *observer)=0
 
virtual int adjustRecordingSignalVolume (int volume)=0
 
virtual int muteRecordingSignal (bool mute)=0
 
virtual int adjustPlaybackSignalVolume (int volume)=0
 
virtual int adjustUserPlaybackSignalVolume (uid_t uid, int volume)=0
 
virtual int setLocalPublishFallbackOption (STREAM_FALLBACK_OPTIONS option)=0
 
virtual int setRemoteSubscribeFallbackOption (STREAM_FALLBACK_OPTIONS option)=0
 
virtual int setHighPriorityUserList (uid_t *uidList, int uidNum, STREAM_FALLBACK_OPTIONS option)=0
 
virtual int enableExtension (const char *provider, const char *extension, const ExtensionInfo &extensionInfo, bool enable=true)=0
 
virtual int setExtensionProperty (const char *provider, const char *extension, const ExtensionInfo &extensionInfo, const char *key, const char *value)=0
 
virtual int getExtensionProperty (const char *provider, const char *extension, const ExtensionInfo &extensionInfo, const char *key, char *value, int buf_len)=0
 
virtual int enableLoopbackRecording (bool enabled, const char *deviceName=NULL)=0
 
virtual int adjustLoopbackSignalVolume (int volume)=0
 
virtual int getLoopbackRecordingVolume ()=0
 
virtual int enableInEarMonitoring (bool enabled, int includeAudioFilters)=0
 
virtual int setInEarMonitoringVolume (int volume)=0
 
virtual int loadExtensionProvider (const char *path, bool unload_after_use=false)=0
 
virtual int setExtensionProviderProperty (const char *provider, const char *key, const char *value)=0
 
virtual int registerExtension (const char *provider, const char *extension, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
 
virtual int enableExtension (const char *provider, const char *extension, bool enable=true, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
 
virtual int setExtensionProperty (const char *provider, const char *extension, const char *key, const char *value, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
 
virtual int getExtensionProperty (const char *provider, const char *extension, const char *key, char *value, int buf_len, agora::media::MEDIA_SOURCE_TYPE type=agora::media::UNKNOWN_MEDIA_SOURCE)=0
 
virtual int setCameraCapturerConfiguration (const CameraCapturerConfiguration &config)=0
 
virtual video_track_id_t createCustomVideoTrack ()=0
 
virtual video_track_id_t createCustomEncodedVideoTrack (const SenderOptions &sender_option)=0
 
virtual int destroyCustomVideoTrack (video_track_id_t video_track_id)=0
 
virtual int destroyCustomEncodedVideoTrack (video_track_id_t video_track_id)=0
 
virtual int switchCamera ()=0
 
virtual bool isCameraZoomSupported ()=0
 
virtual bool isCameraFaceDetectSupported ()=0
 
virtual bool isCameraTorchSupported ()=0
 
virtual bool isCameraFocusSupported ()=0
 
virtual bool isCameraAutoFocusFaceModeSupported ()=0
 
virtual int setCameraZoomFactor (float factor)=0
 
virtual int enableFaceDetection (bool enabled)=0
 
virtual float getCameraMaxZoomFactor ()=0
 
virtual int setCameraFocusPositionInPreview (float positionX, float positionY)=0
 
virtual int setCameraTorchOn (bool isOn)=0
 
virtual int setCameraAutoFocusFaceModeEnabled (bool enabled)=0
 
virtual bool isCameraExposurePositionSupported ()=0
 
virtual int setCameraExposurePosition (float positionXinView, float positionYinView)=0
 
virtual bool isCameraExposureSupported ()=0
 
virtual int setCameraExposureFactor (float factor)=0
 
virtual bool isCameraAutoExposureFaceModeSupported ()=0
 
virtual int setCameraAutoExposureFaceModeEnabled (bool enabled)=0
 
virtual int setCameraStabilizationMode (CAMERA_STABILIZATION_MODE mode)=0
 
virtual int setDefaultAudioRouteToSpeakerphone (bool defaultToSpeaker)=0
 
virtual int setEnableSpeakerphone (bool speakerOn)=0
 
virtual bool isSpeakerphoneEnabled ()=0
 
virtual int setRouteInCommunicationMode (int route)=0
 
virtual bool isCameraCenterStageSupported ()=0
 
virtual int enableCameraCenterStage (bool enabled)=0
 
virtual IScreenCaptureSourceListgetScreenCaptureSources (const SIZE &thumbSize, const SIZE &iconSize, const bool includeScreen)=0
 
virtual int setAudioSessionOperationRestriction (AUDIO_SESSION_OPERATION_RESTRICTION restriction)=0
 
virtual int startScreenCaptureByDisplayId (uint32_t displayId, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams)=0
 
virtual int startScreenCaptureByScreenRect (const Rectangle &screenRect, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams) __deprecated=0
 
virtual int getAudioDeviceInfo (DeviceInfo &deviceInfo)=0
 
virtual int startScreenCaptureByWindowId (view_t windowId, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams)=0
 
virtual int setScreenCaptureContentHint (VIDEO_CONTENT_HINT contentHint)=0
 
virtual int updateScreenCaptureRegion (const Rectangle &regionRect)=0
 
virtual int updateScreenCaptureParameters (const ScreenCaptureParameters &captureParams)=0
 
virtual int startScreenCapture (const ScreenCaptureParameters2 &captureParams)=0
 
virtual int updateScreenCapture (const ScreenCaptureParameters2 &captureParams)=0
 
virtual int queryScreenCaptureCapability ()=0
 
virtual int queryCameraFocalLengthCapability (agora::rtc::FocalLengthInfo *focalLengthInfos, int &size)=0
 
virtual int setScreenCaptureScenario (SCREEN_SCENARIO_TYPE screenScenario)=0
 
virtual int stopScreenCapture ()=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 startRtmpStreamWithoutTranscoding (const char *url)=0
 
virtual int startRtmpStreamWithTranscoding (const char *url, const LiveTranscoding &transcoding)=0
 
virtual int updateRtmpTranscoding (const LiveTranscoding &transcoding)=0
 
virtual int startLocalVideoTranscoder (const LocalTranscoderConfiguration &config)=0
 
virtual int updateLocalTranscoderConfiguration (const LocalTranscoderConfiguration &config)=0
 
virtual int stopRtmpStream (const char *url)=0
 
virtual int stopLocalVideoTranscoder ()=0
 
virtual int startCameraCapture (VIDEO_SOURCE_TYPE sourceType, const CameraCapturerConfiguration &config)=0
 
virtual int stopCameraCapture (VIDEO_SOURCE_TYPE sourceType)=0
 
virtual int setCameraDeviceOrientation (VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation)=0
 
virtual int setScreenCaptureOrientation (VIDEO_SOURCE_TYPE type, VIDEO_ORIENTATION orientation)=0
 
virtual int startScreenCapture (VIDEO_SOURCE_TYPE sourceType, const ScreenCaptureConfiguration &config)=0
 
virtual int stopScreenCapture (VIDEO_SOURCE_TYPE sourceType)=0
 
virtual CONNECTION_STATE_TYPE getConnectionState ()=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 enableEncryption (bool enabled, const EncryptionConfig &config)=0
 
virtual int createDataStream (int *streamId, bool reliable, bool ordered)=0
 
virtual int createDataStream (int *streamId, const DataStreamConfig &config)=0
 
virtual int sendStreamMessage (int streamId, const char *data, size_t length)=0
 
virtual int addVideoWatermark (const RtcImage &watermark) __deprecated=0
 
virtual int addVideoWatermark (const char *watermarkUrl, const WatermarkOptions &options)=0
 
virtual int clearVideoWatermarks ()=0
 
virtual int pauseAudio () __deprecated=0
 
virtual int resumeAudio () __deprecated=0
 
virtual int enableWebSdkInteroperability (bool enabled) __deprecated=0
 
virtual int sendCustomReportMessage (const char *id, const char *category, const char *event, const char *label, int value)=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 uid, 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 uid, const char *location)=0
 
virtual int setAINSMode (bool enabled, AUDIO_AINS_MODE mode)=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)=0
 
virtual int getUserInfoByUserAccount (const char *userAccount, rtc::UserInfo *userInfo)=0
 
virtual int getUserInfoByUid (uid_t uid, rtc::UserInfo *userInfo)=0
 
virtual int startOrUpdateChannelMediaRelay (const ChannelMediaRelayConfiguration &configuration)=0
 
virtual int stopChannelMediaRelay ()=0
 
virtual int pauseAllChannelMediaRelay ()=0
 
virtual int resumeAllChannelMediaRelay ()=0
 
virtual int setDirectCdnStreamingAudioConfiguration (AUDIO_PROFILE_TYPE profile)=0
 
virtual int setDirectCdnStreamingVideoConfiguration (const VideoEncoderConfiguration &config)=0
 
virtual int startDirectCdnStreaming (IDirectCdnStreamingEventHandler *eventHandler, const char *publishUrl, const DirectCdnStreamingMediaOptions &options)=0
 
virtual int stopDirectCdnStreaming ()=0
 
virtual int updateDirectCdnStreamingMediaOptions (const DirectCdnStreamingMediaOptions &options)=0
 
virtual int startRhythmPlayer (const char *sound1, const char *sound2, const AgoraRhythmPlayerConfig &config)=0
 
virtual int stopRhythmPlayer ()=0
 
virtual int configRhythmPlayer (const AgoraRhythmPlayerConfig &config)=0
 
virtual int takeSnapshot (uid_t uid, const char *filePath)=0
 
virtual int enableContentInspect (bool enabled, const media::ContentInspectConfig &config)=0
 
virtual int adjustCustomAudioPublishVolume (track_id_t trackId, int volume)=0
 
virtual int adjustCustomAudioPlayoutVolume (track_id_t trackId, int volume)=0
 
virtual int setCloudProxy (CLOUD_PROXY_TYPE proxyType)=0
 
virtual int setLocalAccessPoint (const LocalAccessPointConfiguration &config)=0
 
virtual int setAdvancedAudioOptions (AdvancedAudioOptions &options, int sourceType=0)=0
 
virtual int setAVSyncSource (const char *channelId, uid_t uid)=0
 
virtual int enableVideoImageSource (bool enable, const ImageTrackOptions &options)=0
 
virtual int64_t getCurrentMonotonicTimeInMs ()=0
 
virtual int enableWirelessAccelerate (bool enabled)=0
 
virtual int getNetworkType ()=0
 
virtual int setParameters (const char *parameters)=0
 
virtual int startMediaRenderingTracing ()=0
 
virtual int enableInstantMediaRendering ()=0
 
virtual uint64_t getNtpWallTimeInMs ()=0
 
virtual bool isFeatureAvailableOnDevice (FeatureType type)=0
 
virtual int sendAudioMetadata (const char *metadata, size_t length)=0
 
- Public Member Functions inherited from agora::base::IEngineBase
virtual ~IEngineBase ()
 
- Public Member Functions inherited from agora::base::IParameterEngine
virtual int setParametersInternal (const char *parameters, int priority)=0
 
virtual int getParameters (const char *key, commons::cjson::JsonWrapper &result)=0
 
virtual ~IParameterEngine ()
 

Static Public Member Functions

static bool isEventHandler (IRtcEngineEventHandler *handler)
 
static bool isEventHandlerEx (IRtcEngineEventHandler *handler)
 
- Static Public Member Functions inherited from agora::rtc::IRtcEngine
static AGORA_CPP_API void release (bool sync=false)
 

Protected Member Functions

virtual ~IRtcEngineInternal ()
 

Constructor & Destructor Documentation

◆ ~IRtcEngineInternal()

virtual agora::rtc::IRtcEngineInternal::~IRtcEngineInternal ( )
inlineprotectedvirtual

Member Function Documentation

◆ ref()

virtual aosl_ref_t agora::rtc::IRtcEngineInternal::ref ( )
pure virtual

◆ initializeEx()

virtual int agora::rtc::IRtcEngineInternal::initializeEx ( const RtcEngineContextInternal context)
pure virtual

◆ getSid()

virtual const char* agora::rtc::IRtcEngineInternal::getSid ( const RtcConnection connection = {})
pure virtual

◆ setProfile()

virtual int agora::rtc::IRtcEngineInternal::setProfile ( const char *  profile,
bool  merge 
)
pure virtual

◆ getProfile()

virtual int agora::rtc::IRtcEngineInternal::getProfile ( std::string &  result)
pure virtual

◆ initializeInternal()

virtual int agora::rtc::IRtcEngineInternal::initializeInternal ( const RtcEngineContextInternal context)
pure virtual

◆ setAudioOptionParams()

virtual int agora::rtc::IRtcEngineInternal::setAudioOptionParams ( const char *  params)
pure virtual

◆ getAudioOptionParams()

virtual int agora::rtc::IRtcEngineInternal::getAudioOptionParams ( char *  params)
pure virtual

◆ isMicrophoneOn()

virtual bool agora::rtc::IRtcEngineInternal::isMicrophoneOn ( )
pure virtual

◆ reportWebAgentVideoStats()

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

◆ monitorDeviceChange()

virtual int agora::rtc::IRtcEngineInternal::monitorDeviceChange ( bool  enabled)
pure virtual

◆ printLog()

virtual int agora::rtc::IRtcEngineInternal::printLog ( int  level,
const char *  message 
)
pure virtual

◆ runOnWorkerThread()

virtual int agora::rtc::IRtcEngineInternal::runOnWorkerThread ( std::function< void(void)> &&  f)
pure virtual

◆ reportArgusCounters()

virtual int agora::rtc::IRtcEngineInternal::reportArgusCounters ( int *  counterId,
int *  value,
int  count,
uid_t  uid 
)
pure virtual

◆ enableYuvDumper()

virtual int agora::rtc::IRtcEngineInternal::enableYuvDumper ( bool  enable)
pure virtual

◆ setVideoConfigParam()

virtual int agora::rtc::IRtcEngineInternal::setVideoConfigParam ( const char *  params)
pure virtual

◆ getVideoConfigParam()

virtual int agora::rtc::IRtcEngineInternal::getVideoConfigParam ( char *  params,
size_t  size 
)
pure virtual

◆ setExternalVideoConfigEx() [1/2]

virtual int agora::rtc::IRtcEngineInternal::setExternalVideoConfigEx ( const VideoEncoderConfiguration config)
pure virtual

◆ setExternalVideoConfigEx() [2/2]

virtual int agora::rtc::IRtcEngineInternal::setExternalVideoConfigEx ( const VideoEncoderConfiguration config,
const RtcConnection connection 
)
pure virtual

◆ getParametersEx()

virtual int agora::rtc::IRtcEngineInternal::getParametersEx ( const RtcConnection connection,
const char *  key,
std::string &  results 
)
pure virtual

◆ GetScreenCaptureType()

virtual int agora::rtc::IRtcEngineInternal::GetScreenCaptureType ( )
pure virtual

◆ setLogLevelEx()

virtual int agora::rtc::IRtcEngineInternal::setLogLevelEx ( unsigned int  filter)
pure virtual

◆ simulateOnSetParameters()

virtual int agora::rtc::IRtcEngineInternal::simulateOnSetParameters ( const std::string &  parameters)
pure virtual

◆ setCameraDevice()

virtual int agora::rtc::IRtcEngineInternal::setCameraDevice ( const char  dev_id[MAX_DEVICE_ID_LENGTH])
pure virtual

◆ getMediaPlayer()

virtual aosl_ref_t agora::rtc::IRtcEngineInternal::getMediaPlayer ( int  sourceId)
pure virtual

◆ putMediaPlayer()

virtual int agora::rtc::IRtcEngineInternal::putMediaPlayer ( int  sourceId)
pure virtual

◆ getConnection()

virtual agora_refptr<IRtcConnection> agora::rtc::IRtcEngineInternal::getConnection ( const RtcConnection connection = {}) const
pure virtual

◆ soundPositionChannel() [1/2]

virtual int agora::rtc::IRtcEngineInternal::soundPositionChannel ( uid_t  uid)
pure virtual

◆ soundPositionChannel() [2/2]

virtual int agora::rtc::IRtcEngineInternal::soundPositionChannel ( uid_t  uid,
const RtcConnection connection 
)
pure virtual

◆ setAppType()

virtual int32_t agora::rtc::IRtcEngineInternal::setAppType ( APP_TYPE  appType)
pure virtual

◆ enableVosUserInfoHidden()

virtual int32_t agora::rtc::IRtcEngineInternal::enableVosUserInfoHidden ( bool  enabled)
pure virtual

◆ setMediaRecorderObserver()

virtual int agora::rtc::IRtcEngineInternal::setMediaRecorderObserver ( const char *  channelId,
uid_t  uid,
bool  isLocal,
media::IMediaRecorderObserverEx observer,
int  sys_version = 0 
)
pure virtual

◆ startRecording()

virtual int agora::rtc::IRtcEngineInternal::startRecording ( const char *  channelId,
uid_t  uid,
bool  isLocal,
const media::MediaRecorderConfiguration config 
)
pure virtual

◆ stopRecording()

virtual int agora::rtc::IRtcEngineInternal::stopRecording ( const char *  channelId,
uid_t  uid,
bool  isLocal 
)
pure virtual

◆ releaseRecorder()

virtual int agora::rtc::IRtcEngineInternal::releaseRecorder ( const char *  channelId,
uid_t  uid,
bool  isLocal 
)
pure virtual

◆ setTimestamp()

virtual int agora::rtc::IRtcEngineInternal::setTimestamp ( ENGINE_INIT_TS_POSITION  ts_position,
uint64_t  ts 
)
pure virtual

◆ getTimestamp()

virtual uint64_t agora::rtc::IRtcEngineInternal::getTimestamp ( ENGINE_INIT_TS_POSITION  ts_position) const
pure virtual

◆ reportEngineInitializeEvent()

virtual void agora::rtc::IRtcEngineInternal::reportEngineInitializeEvent ( ) const
pure virtual

◆ getRecentSid()

virtual std::string agora::rtc::IRtcEngineInternal::getRecentSid ( const RtcConnection connnection)
pure virtual

◆ setupAudioAttributeContext()

virtual int agora::rtc::IRtcEngineInternal::setupAudioAttributeContext ( void *  audioAttr)
pure virtual

◆ switchCameraId()

virtual int agora::rtc::IRtcEngineInternal::switchCameraId ( const char *  cameraId)
pure virtual

◆ initialized()

virtual bool agora::rtc::IRtcEngineInternal::initialized ( )
pure virtual

◆ getAgoraService()

virtual base::IAgoraService* agora::rtc::IRtcEngineInternal::getAgoraService ( )
pure virtual

◆ isEventHandler()

static bool agora::rtc::IRtcEngineInternal::isEventHandler ( IRtcEngineEventHandler handler)
inlinestatic

◆ isEventHandlerEx()

static bool agora::rtc::IRtcEngineInternal::isEventHandlerEx ( IRtcEngineEventHandler handler)
inlinestatic