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

Public Member Functions

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 muteLocalAudioStreamEx (bool mute, const RtcConnection &connection)=0
 
virtual int muteLocalVideoStreamEx (bool mute, const RtcConnection &connection)=0
 
virtual int muteRemoteAudioStreamEx (uid_t uid, bool mute, const RtcConnection &connection)=0
 
virtual int muteAllRemoteAudioStreamsEx (bool mute, const RtcConnection &connection)=0
 
virtual int muteRemoteVideoStreamEx (uid_t uid, bool mute, const RtcConnection &connection)=0
 
virtual int muteAllRemoteVideoStreamsEx (bool mute, const RtcConnection &connection)=0
 
virtual int setRemoteVideoStreamTypeEx (uid_t uid, VIDEO_STREAM_TYPE streamType, const RtcConnection &connection)=0
 
virtual int setSubscribeAudioBlacklistEx (uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
 
virtual int setSubscribeAudioWhitelistEx (uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
 
virtual int setSubscribeVideoBlacklistEx (uid_t *uidList, int uidNumber, const RtcConnection &connection)=0
 
virtual int setSubscribeVideoWhitelistEx (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 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, 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 startChannelMediaRelayEx (const ChannelMediaRelayConfiguration &configuration, const RtcConnection &connection)=0
 
virtual int updateChannelMediaRelayEx (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 setVideoProfileEx (int width, int height, int frameRate, int bitrate)=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 enableWirelessAccelerate (bool enabled)=0
 
virtual int takeSnapshotEx (const RtcConnection &connection, uid_t uid, const char *filePath)=0
 save current time video frame to jpeg and write as a jpeg More...
 
- 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 queryCodecCapability (CodecCapInfo *codec_info, int &size)=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 ()=0
 
virtual int startEchoTest (int intervalInSeconds)=0
 
virtual int startEchoTest (const EchoTestConfiguration &config)=0
 
virtual int stopEchoTest ()=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 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 enableRemoteSuperResolution (uid_t userId, bool enable)=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) __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 setDefaultMuteAllRemoteAudioStreams (bool mute) __deprecated=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) __deprecated=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 setRemoteDefaultVideoStreamType (VIDEO_STREAM_TYPE streamType)=0
 
virtual int setSubscribeAudioBlacklist (uid_t *uidList, int uidNumber)=0
 
virtual int setSubscribeAudioWhitelist (uid_t *uidList, int uidNumber)=0
 
virtual int setSubscribeVideoBlacklist (uid_t *uidList, int uidNumber)=0
 
virtual int setSubscribeVideoWhitelist (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 int destroyMediaPlayer (agora_refptr< IMediaPlayer > media_player)=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 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 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 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 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 (bool enabled, const SimulcastStreamConfig &streamConfig)=0
 
virtual int setDualStreamMode (SIMULCAST_STREAM_MODE mode)=0
 
virtual int setDualStreamMode (SIMULCAST_STREAM_MODE mode, const SimulcastStreamConfig &streamConfig)=0
 
virtual int enableEchoCancellationExternal (bool enabled, int audioSourceDelay)=0
 
virtual int enableCustomAudioLocalPlayback (int sourceId, bool enabled)=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 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 (unsigned int uid, int volume)=0
 
virtual int setLocalPublishFallbackOption (STREAM_FALLBACK_OPTIONS option)=0
 
virtual int setRemoteSubscribeFallbackOption (STREAM_FALLBACK_OPTIONS option)=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 setExtensionProviderProperty (const char *provider, const char *key, const char *value)=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 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 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 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 stopRtmpStream (const char *url)=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) __deprecated=0
 
virtual int setEncryptionSecret (const char *secret) __deprecated=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 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 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)=0
 
virtual int getUserInfoByUid (uid_t uid, rtc::UserInfo *userInfo)=0
 
virtual int startChannelMediaRelay (const ChannelMediaRelayConfiguration &configuration)=0
 
virtual int updateChannelMediaRelay (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
 save current time video frame to jpeg and write as a jpeg More...
 
virtual int enableContentInspect (bool enabled, const media::ContentInspectConfig &config)=0
 
virtual int adjustCustomAudioPublishVolume (int32_t sourceId, int volume)=0
 
virtual int adjustCustomAudioPlayoutVolume (int32_t sourceId, 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
 enable or disable video image source to replace the current video source published or resume it More...
 
virtual int64_t getCurrentMonotonicTimeInMs ()=0
 
virtual int getNetworkType ()=0
 

Member Function Documentation

◆ 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
connectionRtcConnection
optionsThe channel media options: ChannelMediaOptions.
eventHandlerThe pointer to the IRtcEngine event handler: IRtcEngineEventHandler. you join the same channel multiple times.
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ leaveChannelEx()

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

Leaves the channel with the connection ID.

Parameters
connectionconnection.
Returns
int
  • 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.
connectionRtcConnection.
Returns
int
  • 0: Success.
  • < 0: Failure.

◆ muteLocalAudioStreamEx()

virtual int agora::rtc::IRtcEngineEx::muteLocalAudioStreamEx ( bool  mute,
const RtcConnection connection 
)
pure virtual

Stops or resumes sending the local audio stream with connection.

Parameters
muteDetermines whether to send or stop sending the local audio stream:
  • true: Stop sending the local audio stream.
  • false: Send the local audio stream.
connectionThe connection of the user ID.
Returns
  • 0: Success.
  • < 0: Failure.

◆ muteLocalVideoStreamEx()

virtual int agora::rtc::IRtcEngineEx::muteLocalVideoStreamEx ( bool  mute,
const RtcConnection connection 
)
pure virtual

Stops or resumes sending the local video stream with connection.

Parameters
muteDetermines whether to send or stop sending the local video stream:
  • true: Stop sending the local video stream.
  • false: Send the local video stream.
connectionThe connection of the user ID.
Returns
  • 0: Success.
  • < 0: Failure.

◆ muteAllRemoteAudioStreamsEx()

virtual int agora::rtc::IRtcEngineEx::muteAllRemoteAudioStreamsEx ( bool  mute,
const RtcConnection connection 
)
pure virtual

Stops or resumes receiving all remote audio stream with connection.

Parameters
muteWhether to stop receiving remote audio streams:
  • true: Stop receiving any remote audio stream.
  • false: Resume receiving all remote audio streams.
connectionThe connection of the user ID.
Returns
  • 0: Success.
  • < 0: Failure.

◆ muteAllRemoteVideoStreamsEx()

virtual int agora::rtc::IRtcEngineEx::muteAllRemoteVideoStreamsEx ( bool  mute,
const RtcConnection connection 
)
pure virtual

Stops or resumes receiving all remote video stream with connection.

Parameters
muteWhether to stop receiving remote audio streams:
  • true: Stop receiving any remote audio stream.
  • false: Resume receiving all remote audio streams.
connectionThe connection of the user ID.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setSubscribeAudioBlacklistEx()

virtual int agora::rtc::IRtcEngineEx::setSubscribeAudioBlacklistEx ( uid_t *  uidList,
int  uidNumber,
const RtcConnection connection 
)
pure virtual

Sets the blacklist of subscribe remote stream audio.

Parameters
uidListThe id list of users who do not subscribe to audio.
uidNumberThe number of uid in uidList.
connectionRtcConnection.
Note
If uid is in uidList, the remote user's audio will not be subscribed, even if muteRemoteAudioStream(uid, false) and muteAllRemoteAudioStreams(false) are operated.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setSubscribeAudioWhitelistEx()

virtual int agora::rtc::IRtcEngineEx::setSubscribeAudioWhitelistEx ( uid_t *  uidList,
int  uidNumber,
const RtcConnection connection 
)
pure virtual

Sets the whitelist of subscribe remote stream audio.

Parameters
uidListThe id list of users who do subscribe to audio.
uidNumberThe number of uid in uidList.
connectionRtcConnection.
Note
If uid is in uidList, the remote user's audio will be subscribed, even if muteRemoteAudioStream(uid, true) and muteAllRemoteAudioStreams(true) are operated.

If a user is in the blacklist and whitelist at the same time, the user will not subscribe to audio.

Returns
  • 0: Success.
  • < 0: Failure.

◆ setSubscribeVideoBlacklistEx()

virtual int agora::rtc::IRtcEngineEx::setSubscribeVideoBlacklistEx ( uid_t *  uidList,
int  uidNumber,
const RtcConnection connection 
)
pure virtual

Sets the blacklist of subscribe remote stream video.

Parameters
uidListThe id list of users who do not subscribe to video.
uidNumberThe number of uid in uidList.
connectionRtcConnection.
Note
If uid is in uidList, the remote user's video will not be subscribed, even if muteRemoteVideoStream(uid, false) and muteAllRemoteVideoStreams(false) are operated.
Returns
  • 0: Success.
  • < 0: Failure.

◆ setSubscribeVideoWhitelistEx()

virtual int agora::rtc::IRtcEngineEx::setSubscribeVideoWhitelistEx ( uid_t *  uidList,
int  uidNumber,
const RtcConnection connection 
)
pure virtual

Sets the whitelist of subscribe remote stream video.

Parameters
uidListThe id list of users who do subscribe to video.
uidNumberThe number of uid in uidList.
connectionRtcConnection.
Note
If uid is in uidList, the remote user's video will be subscribed, even if muteRemoteVideoStream(uid, true) and muteAllRemoteVideoStreams(true) are operated.

If a user is in the blacklist and whitelist at the same time, the user will not subscribe to video.

Returns
  • 0: Success.
  • < 0: Failure.

◆ startRtmpStreamWithoutTranscodingEx()

virtual int agora::rtc::IRtcEngineEx::startRtmpStreamWithoutTranscodingEx ( const char *  url,
const RtcConnection connection 
)
pure virtual

Publishes the local stream without transcoding to a specified CDN live RTMP address. (CDN live only.)

Parameters
urlThe CDN streaming URL in the RTMP format. The maximum length of this parameter is 1024 bytes.
connectionRtcConnection.
Returns
  • 0: Success.
  • < 0: Failure.

◆ startRtmpStreamWithTranscodingEx()

virtual int agora::rtc::IRtcEngineEx::startRtmpStreamWithTranscodingEx ( const char *  url,
const LiveTranscoding transcoding,
const RtcConnection connection 
)
pure virtual

Publishes the local stream with transcoding to a specified CDN live RTMP address. (CDN live only.)

Parameters
urlThe CDN streaming URL in the RTMP format. The maximum length of this parameter is 1024 bytes.
transcodingSets the CDN live audio/video transcoding settings. See LiveTranscoding.
connectionRtcConnection.
Returns
  • 0: Success.
  • < 0: Failure.

◆ updateRtmpTranscodingEx()

virtual int agora::rtc::IRtcEngineEx::updateRtmpTranscodingEx ( const LiveTranscoding transcoding,
const RtcConnection connection 
)
pure virtual

Update the video layout and audio settings for CDN live. (CDN live only.)

Note
This method applies to Live Broadcast only.
Parameters
transcodingSets the CDN live audio/video transcoding settings. See LiveTranscoding.
connectionRtcConnection.
Returns
  • 0: Success.
  • < 0: Failure.

◆ stopRtmpStreamEx()

virtual int agora::rtc::IRtcEngineEx::stopRtmpStreamEx ( const char *  url,
const RtcConnection connection 
)
pure virtual

Stop an RTMP stream with transcoding or without transcoding from the CDN. (CDN live only.)

Parameters
urlThe RTMP URL address to be removed. The maximum length of this parameter is 1024 bytes.
connectionRtcConnection.
Returns
  • 0: Success.
  • < 0: Failure.

◆ startChannelMediaRelayEx()

virtual int agora::rtc::IRtcEngineEx::startChannelMediaRelayEx ( const ChannelMediaRelayConfiguration configuration,
const RtcConnection connection 
)
pure virtual

Starts to relay media streams across channels.

Parameters
configurationThe configuration of the media stream relay:ChannelMediaRelayConfiguration.
connectionRtcConnection.
Returns
  • 0: Success.
  • < 0: Failure.

◆ updateChannelMediaRelayEx()

virtual int agora::rtc::IRtcEngineEx::updateChannelMediaRelayEx ( const ChannelMediaRelayConfiguration configuration,
const RtcConnection connection 
)
pure virtual

Updates the channels for media stream relay

Parameters
configurationThe media stream relay configuration: ChannelMediaRelayConfiguration.
connectionRtcConnection.
Returns
  • 0: Success.
  • < 0: Failure.

◆ stopChannelMediaRelayEx()

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

Stops the media stream relay.

Once the relay stops, the host quits all the destination channels.

Parameters
connectionRtcConnection.
Returns
  • 0: Success.
  • < 0: Failure.

◆ pauseAllChannelMediaRelayEx()

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

pause the channels for media stream relay.

Parameters
connectionRtcConnection.
Returns
  • 0: Success.
  • < 0: Failure.

◆ resumeAllChannelMediaRelayEx()

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

resume the channels for media stream relay.

Parameters
connectionRtcConnection.
Returns
  • 0: Success.
  • < 0: Failure.

◆ getUserInfoByUserAccountEx()

virtual int agora::rtc::IRtcEngineEx::getUserInfoByUserAccountEx ( const char *  userAccount,
rtc::UserInfo userInfo,
const RtcConnection connection 
)
pure virtual

Gets the user information by passing in the user account. It is same as agora::rtc::IRtcEngine::getUserInfoByUserAccount.

Parameters
userAccountThe user account of the user. Ensure that you set this parameter.
[in,out]userInfoA userInfo object that identifies the user:
  • Input: A userInfo object.
  • Output: A userInfo object that contains the user account and user ID of the user.
connectionThe connection of the remote user account
Returns
  • 0: Success.
  • < 0: Failure.

◆ getUserInfoByUidEx()

virtual int agora::rtc::IRtcEngineEx::getUserInfoByUidEx ( uid_t  uid,
rtc::UserInfo userInfo,
const RtcConnection connection 
)
pure virtual

Gets the user information by passing in the user ID. It is same as agora::rtc::IRtcEngine::getUserInfoByUid.

Parameters
uidThe user ID of the remote user. Ensure that you set this parameter.
[in,out]userInfoA userInfo object that identifies the user:
  • Input: A userInfo object.
  • Output: A userInfo object that contains the user account and user ID of the user.
connectionThe connection of the remote user ID
Returns
  • 0: Success.
  • < 0: Failure.

◆ setVideoProfileEx()

virtual int agora::rtc::IRtcEngineEx::setVideoProfileEx ( int  width,
int  height,
int  frameRate,
int  bitrate 
)
pure virtual

Specify video stream parameters based on video profile

Parameters
[in]widthwidth of video resolution in pixel
[in]heightheight of video resolution in pixel
[in]frameRateframe rate in fps
[in]bitratebit rate in kbps
Returns
return 0 if success or an error code

◆ enableDualStreamModeEx()

virtual int agora::rtc::IRtcEngineEx::enableDualStreamModeEx ( bool  enabled,
const SimulcastStreamConfig streamConfig,
const RtcConnection connection 
)
pure virtual

Enables or disables the dual video stream mode.

If dual-stream mode is enabled, the subscriber can choose to receive the high-stream (high-resolution high-bitrate video stream) or low-stream (low-resolution low-bitrate video stream) video using setRemoteVideoStreamType.

Parameters
enabled
  • true: Enable the dual-stream mode.
  • false: (default) Disable the dual-stream mode.
streamConfigThe minor stream config
connectionAn output parameter which is used to control different connection instances.

◆ setDualStreamModeEx()

virtual int agora::rtc::IRtcEngineEx::setDualStreamModeEx ( SIMULCAST_STREAM_MODE  mode,
const SimulcastStreamConfig streamConfig,
const RtcConnection connection 
)
pure virtual

Enables, disables or auto enable the dual video stream mode.

If dual-stream mode is enabled, the subscriber can choose to receive the high-stream (high-resolution high-bitrate video stream) or low-stream (low-resolution low-bitrate video stream) video using setRemoteVideoStreamType.

Parameters
modeThe dual stream mode
streamConfigThe minor stream config
connectionAn output parameter which is used to control different connection instances.

◆ enableWirelessAccelerate()

virtual int agora::rtc::IRtcEngineEx::enableWirelessAccelerate ( bool  enabled)
pure virtual

Turn WIFI acceleration on or off.

Note
  • This method is called before and after joining a channel.
  • Users check the WIFI router app for information about acceleration. Therefore, if this interface is invoked, the caller accepts that the caller's name will be displayed to the user in the WIFI router application on behalf of the caller.
Parameters
enabled
  • true:Turn WIFI acceleration on.
  • false:Turn WIFI acceleration off.
Returns
  • 0: Success.
  • < 0: Failure.

Implements agora::rtc::IRtcEngine.

◆ takeSnapshotEx()

virtual int agora::rtc::IRtcEngineEx::takeSnapshotEx ( const RtcConnection connection,
uid_t  uid,
const char *  filePath 
)
pure virtual

save current time video frame to jpeg and write as a jpeg

Parameters
connectionThe connection of the user ID
uidsave remote picture with user id. if uid = 0 save local user's picture
filePathsave file path
Returns
int
  • 0 : Success.
  • <0 : Failure.