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

Inherits agora::rtc::IRtcEngine.

Inherited by agora::rtc::IRtcEngineInternal.

Public Member Functions

virtual int initialize (const RtcEngineContextEx &context)=0
 
virtual int joinChannelEx (const char *token, const RtcConnection &connection, const ChannelMediaOptions &options, IRtcEngineEventHandler *eventHandler)=0
 
virtual int leaveChannelEx (const RtcConnection &connection)=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 remoteUid, bool mute, const RtcConnection &connection)=0
 
virtual int muteRemoteVideoStreamEx (uid_t remoteUid, bool mute, const RtcConnection &connection)=0
 
virtual int setRemoteVoicePositionEx (uid_t remoteUid, double pan, double gain, const RtcConnection &connection)=0
 
virtual int setRemoteRenderModeEx (uid_t remoteUid, media::base::RENDER_MODE_TYPE renderMode, VIDEO_MIRROR_MODE_TYPE mirrorMode, const RtcConnection &connection)=0
 
virtual int enableLoopbackRecordingEx (bool enabled, const RtcConnection &connection)=0
 
virtual CONNECTION_STATE_TYPE getConnectionStateEx (const RtcConnection &connection)=0
 
virtual int createDataStreamEx (int *streamId, bool reliable, bool ordered, const RtcConnection &connection)=0
 
virtual int createDataStreamEx (int *streamId, 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 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 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 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)=0
 
virtual int setBeautyEffectOptions (bool enabled, const BeautyOptions &options)=0
 
virtual int setupRemoteVideo (const VideoCanvas &canvas)=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 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 setDefaultMuteAllRemoteVideoStreams (bool mute)=0
 
virtual int muteRemoteVideoStream (uid_t uid, 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 registerAudioEncodedFrameObserver (const AudioEncodedFrameObserverConfig &config, IAudioEncodedFrameObserver *observer)=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 enableSoundPositionIndication (bool enabled)=0
 
virtual int setRemoteVoicePosition (uid_t uid, double pan, double gain)=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 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)=0
 
virtual int setLocalRenderMode (media::base::RENDER_MODE_TYPE renderMode)=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 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 (unsigned int uid, int volume)=0
 
virtual int enableLoopbackRecording (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 loadExtensionProvider (const char *extension_lib_path)=0
 
virtual int enableExtension (const char *provider_name, const char *extension_name, bool enable=true)=0
 
virtual int setExtensionProperty (const char *provider_name, const char *extension_name, const char *key, const char *json_value)=0
 
virtual int getExtensionProperty (const char *provider_name, const char *extension_name, const char *key, char *json_value, int buf_len)=0
 
virtual int setCameraCapturerConfiguration (const CameraCapturerConfiguration &config)=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 isCameraAutoExposureFaceModeSupported ()=0
 
virtual int setCameraAutoExposureFaceModeEnabled (bool enabled)=0
 
virtual int setDefaultAudioRouteToSpeakerphone (bool defaultToSpeaker)=0
 
virtual int setEnableSpeakerphone (bool speakerOn)=0
 
virtual bool isSpeakerphoneEnabled ()=0
 
virtual int startScreenCaptureByDisplayId (unsigned int displayId, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams)=0
 
virtual int startScreenCaptureByScreenRect (const Rectangle &screenRect, const Rectangle &regionRect, const ScreenCaptureParameters &captureParams)=0
 
virtual int startScreenCapture (void *mediaProjectionPermissionResultData, const ScreenCaptureParameters &captureParams)=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 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 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 setScreenCaptureOrientation (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 ()=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)=0
 
virtual int createDataStream (int *streamId, DataStreamConfig &config)=0
 
virtual int sendStreamMessage (int streamId, const char *data, size_t length)=0
 
virtual int addVideoWatermark (const RtcImage &watermark)=0
 
virtual int addVideoWatermark (const char *watermarkUrl, const WatermarkOptions &options)=0
 
virtual int clearVideoWatermark ()=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)=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)=0
 
virtual int getUserInfoByUserAccount (const char *userAccount, rtc::UserInfo *userInfo, const char *channelId=NULL, const char *localUserAccount=NULL)=0
 
virtual int getUserInfoByUid (uid_t uid, rtc::UserInfo *userInfo, const char *channelId=NULL, const char *localUserAccount=NULL)=0
 
virtual int startChannelMediaRelay (const ChannelMediaRelayConfiguration &configuration)=0
 
virtual int updateChannelMediaRelay (const ChannelMediaRelayConfiguration &configuration)=0
 
virtual int stopChannelMediaRelay ()=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 pushDirectCdnStreamingCustomVideoFrame (media::base::ExternalVideoFrame *frame)=0
 
- Public Member Functions inherited from agora::base::IEngineBase
virtual ~IEngineBase ()
 

Member Function Documentation

◆ initialize() [1/2]

virtual int agora::rtc::IRtcEngineEx::initialize ( const RtcEngineContextEx context)
pure virtual

◆ joinChannelEx()

virtual int agora::rtc::IRtcEngineEx::joinChannelEx ( const char *  token,
const RtcConnection connection,
const ChannelMediaOptions options,
IRtcEngineEventHandler eventHandler 
)
pure virtual

Joins a channel with the connection ID.

You can call this method multiple times to join more than one channels at a time.

Note
  • If you are already in a channel, you cannot rejoin it with the same uid.
  • We recommend using different user IDs for different channels.
  • If you want to join the same channel from different devices, ensure that the user IDs in all devices are different.
  • Ensure that the app ID you use to generate the token is the same with the app ID used when creating the RtcEngine instance.
Parameters
tokenThe token generated at your server:
  • In situations not requiring high security: You can use the temporary token generated at Console. For details, see Get a temporary token.
  • In situations requiring high security: Set it as the token generated at your server. For details, see Generate a token.
channelIdThe unique channel name for the AgoraRTC session in the string format. The string length must be less than 64 bytes. Supported character scopes are:
  • All lowercase English letters: a to z.
  • All uppercase English letters: A to Z.
  • All numeric characters: 0 to 9.
  • The space character.
  • Punctuation characters and other symbols, including: "!", "#", "$", "%", "&", "(", ")", "+", "-", ":", ";", "<", "=", ".", ">", "?", "@", "[", "]", "^", "_", " {", "}", "|", "~", ",".
uidThe user ID. A 32-bit unsigned integer with a value ranging from 1 to (2^32-1).
optionsThe channel media options: ChannelMediaOptions.
eventHandlerThe pointer to the IRtcEngine event handler: IRtcEngineEventHandler. you join the same channel multiple times.
Returns
  • 0: Success.
  • < 0: Failure.

◆ leaveChannelEx()

virtual int agora::rtc::IRtcEngineEx::leaveChannelEx ( const RtcConnection connection)
pure virtual

Leaves the channel with the connection ID.

Parameters
channelIdThe channel name.
localUidThe user ID.
Returns
  • 0: Success.
  • < 0: Failure.

◆ updateChannelMediaOptionsEx()

virtual int agora::rtc::IRtcEngineEx::updateChannelMediaOptionsEx ( const ChannelMediaOptions options,
const RtcConnection connection 
)
pure virtual

Updates the channel media options after joining the channel.

Parameters
optionsThe channel media options: ChannelMediaOptions.
channelIdThe channel name.
uidThe user ID.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setVideoEncoderConfigurationEx()

virtual int agora::rtc::IRtcEngineEx::setVideoEncoderConfigurationEx ( const VideoEncoderConfiguration config,
const RtcConnection connection 
)
pure virtual

◆ setupRemoteVideoEx()

virtual int agora::rtc::IRtcEngineEx::setupRemoteVideoEx ( const VideoCanvas canvas,
const RtcConnection connection 
)
pure virtual

◆ muteRemoteAudioStreamEx()

virtual int agora::rtc::IRtcEngineEx::muteRemoteAudioStreamEx ( uid_t  remoteUid,
bool  mute,
const RtcConnection connection 
)
pure virtual

◆ muteRemoteVideoStreamEx()

virtual int agora::rtc::IRtcEngineEx::muteRemoteVideoStreamEx ( uid_t  remoteUid,
bool  mute,
const RtcConnection connection 
)
pure virtual

◆ setRemoteVoicePositionEx()

virtual int agora::rtc::IRtcEngineEx::setRemoteVoicePositionEx ( uid_t  remoteUid,
double  pan,
double  gain,
const RtcConnection connection 
)
pure virtual

◆ setRemoteRenderModeEx()

virtual int agora::rtc::IRtcEngineEx::setRemoteRenderModeEx ( uid_t  remoteUid,
media::base::RENDER_MODE_TYPE  renderMode,
VIDEO_MIRROR_MODE_TYPE  mirrorMode,
const RtcConnection connection 
)
pure virtual

◆ enableLoopbackRecordingEx()

virtual int agora::rtc::IRtcEngineEx::enableLoopbackRecordingEx ( bool  enabled,
const RtcConnection connection 
)
pure virtual

◆ getConnectionStateEx()

virtual CONNECTION_STATE_TYPE agora::rtc::IRtcEngineEx::getConnectionStateEx ( const RtcConnection connection)
pure virtual

◆ createDataStreamEx() [1/2]

virtual int agora::rtc::IRtcEngineEx::createDataStreamEx ( int *  streamId,
bool  reliable,
bool  ordered,
const RtcConnection connection 
)
pure virtual

◆ createDataStreamEx() [2/2]

virtual int agora::rtc::IRtcEngineEx::createDataStreamEx ( int *  streamId,
DataStreamConfig config,
const RtcConnection connection 
)
pure virtual

◆ sendStreamMessageEx()

virtual int agora::rtc::IRtcEngineEx::sendStreamMessageEx ( int  streamId,
const char *  data,
size_t  length,
const RtcConnection connection 
)
pure virtual

◆ addVideoWatermarkEx()

virtual int agora::rtc::IRtcEngineEx::addVideoWatermarkEx ( const char *  watermarkUrl,
const WatermarkOptions options,
const RtcConnection connection 
)
pure virtual

◆ clearVideoWatermarkEx()

virtual int agora::rtc::IRtcEngineEx::clearVideoWatermarkEx ( const RtcConnection connection)
pure virtual

◆ sendCustomReportMessageEx()

virtual int agora::rtc::IRtcEngineEx::sendCustomReportMessageEx ( const char *  id,
const char *  category,
const char *  event,
const char *  label,
int  value,
const RtcConnection connection 
)
pure virtual

◆ initialize() [2/2]

virtual int agora::rtc::IRtcEngine::initialize

Initializes the Agora SDK service.

In this method, you need to enter the issued Agora App ID to start initialization. After creating an IRtcEngine object, call this method to initialize the service before calling any other methods. After the initialization, the service is set to enable audio by default.

Parameters
contextThe RtcEngineContext object.
Returns
  • 0: Success.
  • < 0: Failure.