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

Inherits agora::rtc::ILocalUser.

Public Member Functions

virtual int initialize ()=0
 
virtual int sendAudioPacket (const audio_packet_t &packet, int delay=0)=0
 
virtual int sendAudioFrame (const SAudioFrame &frame, int delay=0)=0
 
virtual int sendVideoPacket (const video_packet_t &packet)=0
 
virtual int sendControlBroadcastPacket (control_broadcast_packet_t &packet)=0
 
virtual int sendDataStreamPacket (uint16_t streamId, const char *data, size_t length)=0
 
virtual int registerTransportPacketObserver (ITransportPacketObserver *observer)=0
 
virtual int setAudioOptions (const rtc::AudioOptions &options)=0
 
virtual int getAudioOptions (rtc::AudioOptions *options)=0
 
virtual int setAdvancedAudioOptions (const rtc::AudioOptions &options, int sourceType)=0
 
virtual int getAecDelay (int sourceType, int *aecDelay)=0
 
virtual void getBillInfo (CallBillInfo *bill_info)=0
 
virtual void forceDeviceScore (const int32_t deviceScore)=0
 
virtual int setPrerendererSmoothing (bool enabled)=0
 
virtual int setDtx (bool enabled)=0
 
virtual int setCustomAudioBitrate (int bitrate)=0
 
virtual int setAudioFrameSizeMs (int sizeMs)=0
 
virtual int setAudioCC (bool value)=0
 
virtual int registerAudioFrameDumpObserver (IAudioFrameDumpObserver *observer)=0
 
virtual int unregisterAudioFrameDumpObserver (IAudioFrameDumpObserver *observer)=0
 
virtual int startAudioFrameDump (const std::string &location, const std::string &uuid, const std::string &passwd, int64_t duration_ms, bool auto_upload)=0
 
virtual int stopAudioFrameDump (const std::string &location)=0
 
virtual int setPlayoutUserAnonymous (rtc::uid_t uid, bool anonymous)=0
 
virtual int enableAudioPlayout (bool enabled)=0
 
virtual void registerVideoMetadataObserver (IMetadataObserver *observer)=0
 
virtual void unregisterVideoMetadataObserver (IMetadataObserver *observer)=0
 
virtual int setVideoFrameObserver (agora::media::IVideoFrameObserver *observer)=0
 
virtual agora_refptr< IRemoteVideoTrackgetRemoteVideoTrack (rtc::uid_t uid)=0
 
virtual int setAVSyncPeer (rtc::uid_t uid)=0
 
virtual int getOnlySubscribeEncodedVideoFrame (user_id_t peerUid, bool &subscribe)=0
 
virtual void setMinPlayoutDelay (int delay)=0
 
virtual int setAllowSubscribeSelf (bool allow)=0
 
virtual int adjustRecordingSignalVolume (int volume)=0
 
virtual int getRecordingSignalVolume (int *volume)=0
 
virtual bool ForcePeriodicKeyFrame ()=0
 
virtual int registerCapabilitiesObserver (ICapabilitesObserver *cap_observer)=0
 
virtual int unRegisterCapabilitiesObserver (ICapabilitesObserver *cap_observer)=0
 
virtual void updateAppDefinedCapabilities (const Capabilities *cap, size_t size)=0
 
virtual int sendIntraRequestQuick (user_id_t uid)=0
 
virtual void customUpdateBillInfo (int height, int width, bool isSendingVideo)=0
 
virtual void setInteractiveAudience (bool interactive)=0
 
virtual int setVideoDumpMode (int mode, bool enabled)=0
 
- Public Member Functions inherited from agora::rtc::ILocalUser
virtual ~ILocalUser ()
 
virtual void setUserRole (rtc::CLIENT_ROLE_TYPE role)=0
 
virtual CLIENT_ROLE_TYPE getUserRole ()=0
 
virtual void setAudienceLatencyLevel (AUDIENCE_LATENCY_LEVEL_TYPE level)=0
 
virtual AUDIENCE_LATENCY_LEVEL_TYPE getAudienceLatencyLevel ()=0
 
virtual int setAudioEncoderConfiguration (const rtc::AudioEncoderConfiguration &config)=0
 
virtual int setAudioScenario (AUDIO_SCENARIO_TYPE scenario)=0
 
virtual bool getLocalAudioStatistics (LocalAudioDetailedStats &stats)=0
 
virtual int publishAudio (agora_refptr< ILocalAudioTrack > audioTrack)=0
 
virtual int unpublishAudio (agora_refptr< ILocalAudioTrack > audioTrack)=0
 
virtual int publishVideo (agora_refptr< ILocalVideoTrack > videoTrack)=0
 
virtual int unpublishVideo (agora_refptr< ILocalVideoTrack > videoTrack)=0
 
virtual int subscribeAudio (user_id_t userId)=0
 
virtual int subscribeAllAudio ()=0
 
virtual int unsubscribeAudio (user_id_t userId)=0
 
virtual int unsubscribeAllAudio ()=0
 
virtual int adjustPlaybackSignalVolume (int volume)=0
 
virtual int getPlaybackSignalVolume (int *volume)=0
 
virtual int adjustUserPlaybackSignalVolume (user_id_t userId, int volume)=0
 
virtual int getUserPlaybackSignalVolume (user_id_t userId, int *volume)=0
 
virtual int enableSoundPositionIndication (bool enabled)=0
 
virtual int setRemoteVoicePosition (user_id_t userId, double pan, double gain)=0
 
virtual int enableSpatialAudio (bool enabled)=0
 
virtual int setRemoteUserSpatialAudioParams (user_id_t userId, const agora::SpatialAudioParams &param)=0
 
virtual int setPlaybackAudioFrameParameters (size_t numberOfChannels, uint32_t sampleRateHz, RAW_AUDIO_FRAME_OP_MODE_TYPE mode=RAW_AUDIO_FRAME_OP_MODE_READ_ONLY, int samplesPerCall=0)=0
 
virtual int setRecordingAudioFrameParameters (size_t numberOfChannels, uint32_t sampleRateHz, RAW_AUDIO_FRAME_OP_MODE_TYPE mode=RAW_AUDIO_FRAME_OP_MODE_READ_ONLY, int samplesPerCall=0)=0
 
virtual int setMixedAudioFrameParameters (size_t numberOfChannels, uint32_t sampleRateHz, int samplesPerCall=0)=0
 
virtual int setEarMonitoringAudioFrameParameters (bool enabled, size_t numberOfChannels, uint32_t sampleRateHz, RAW_AUDIO_FRAME_OP_MODE_TYPE mode=RAW_AUDIO_FRAME_OP_MODE_READ_ONLY, int samplesPerCall=0)=0
 
virtual int setPlaybackAudioFrameBeforeMixingParameters (size_t numberOfChannels, uint32_t sampleRateHz)=0
 
virtual int registerAudioFrameObserver (agora::media::IAudioFrameObserverBase *observer)=0
 
virtual int unregisterAudioFrameObserver (agora::media::IAudioFrameObserverBase *observer)=0
 
virtual int enableAudioSpectrumMonitor (int intervalInMS=100)=0
 
virtual int disableAudioSpectrumMonitor ()=0
 
virtual int registerAudioSpectrumObserver (agora::media::IAudioSpectrumObserver *observer, void(*safeDeleter)(agora::media::IAudioSpectrumObserver *))=0
 
virtual int unregisterAudioSpectrumObserver (agora::media::IAudioSpectrumObserver *observer)=0
 
virtual int registerLocalVideoEncodedFrameObserver (agora::media::IVideoEncodedFrameObserver *observer)=0
 
virtual int unregisterLocalVideoEncodedFrameObserver (agora::media::IVideoEncodedFrameObserver *observer)=0
 
virtual int forceNextIntraFrame ()=0
 
virtual int registerVideoEncodedFrameObserver (agora::media::IVideoEncodedFrameObserver *observer)=0
 
virtual int unregisterVideoEncodedFrameObserver (agora::media::IVideoEncodedFrameObserver *observer)=0
 
virtual int registerVideoFrameObserver (IVideoFrameObserver2 *observer)=0
 
virtual int unregisterVideoFrameObserver (IVideoFrameObserver2 *observer)=0
 
virtual int setVideoSubscriptionOptions (user_id_t userId, const VideoSubscriptionOptions &options)=0
 
virtual int setSubscribeAudioBlocklist (user_id_t *userList, int userNumber)=0
 
virtual int setSubscribeAudioAllowlist (user_id_t *userList, int userNumber)=0
 
virtual int setSubscribeVideoBlocklist (user_id_t *userList, int userNumber)=0
 
virtual int setSubscribeVideoAllowlist (user_id_t *userList, int userNumber)=0
 
virtual int subscribeVideo (user_id_t userId, const VideoSubscriptionOptions &subscriptionOptions)=0
 
virtual int subscribeAllVideo (const VideoSubscriptionOptions &subscriptionOptions)=0
 
virtual int unsubscribeVideo (user_id_t userId)=0
 
virtual int unsubscribeAllVideo ()=0
 
virtual int setAudioVolumeIndicationParameters (int intervalInMS, int smooth, bool reportVad)=0
 
virtual int registerLocalUserObserver (ILocalUserObserver *observer, void(*safeDeleter)(ILocalUserObserver *)=NULL)=0
 
virtual int unregisterLocalUserObserver (ILocalUserObserver *observer)=0
 
virtual IMediaControlPacketSendergetMediaControlPacketSender ()=0
 
virtual int registerMediaControlPacketReceiver (IMediaControlPacketReceiver *ctrlPacketReceiver)=0
 
virtual int unregisterMediaControlPacketReceiver (IMediaControlPacketReceiver *ctrlPacketReceiver)=0
 
virtual int sendIntraRequest (user_id_t userId)=0
 
virtual int setAudioFilterable (bool filterable)=0
 
virtual int enableRemoteAudioTrackFilter (user_id_t userId, const char *id, bool enable)=0
 
virtual int setRemoteAudioTrackFilterProperty (user_id_t userId, const char *id, const char *key, const char *jsonValue)=0
 
virtual int getRemoteAudioTrackFilterProperty (user_id_t userId, const char *id, const char *key, char *jsonValue, size_t bufSize)=0
 

Member Function Documentation

◆ initialize()

virtual int agora::rtc::ILocalUserEx::initialize ( )
pure virtual

◆ sendAudioPacket()

virtual int agora::rtc::ILocalUserEx::sendAudioPacket ( const audio_packet_t packet,
int  delay = 0 
)
pure virtual

◆ sendAudioFrame()

virtual int agora::rtc::ILocalUserEx::sendAudioFrame ( const SAudioFrame frame,
int  delay = 0 
)
pure virtual

◆ sendVideoPacket()

virtual int agora::rtc::ILocalUserEx::sendVideoPacket ( const video_packet_t packet)
pure virtual

◆ sendControlBroadcastPacket()

virtual int agora::rtc::ILocalUserEx::sendControlBroadcastPacket ( control_broadcast_packet_t packet)
pure virtual

◆ sendDataStreamPacket()

virtual int agora::rtc::ILocalUserEx::sendDataStreamPacket ( uint16_t  streamId,
const char *  data,
size_t  length 
)
pure virtual

◆ registerTransportPacketObserver()

virtual int agora::rtc::ILocalUserEx::registerTransportPacketObserver ( ITransportPacketObserver observer)
pure virtual

◆ setAudioOptions()

virtual int agora::rtc::ILocalUserEx::setAudioOptions ( const rtc::AudioOptions options)
pure virtual

◆ getAudioOptions()

virtual int agora::rtc::ILocalUserEx::getAudioOptions ( rtc::AudioOptions options)
pure virtual

◆ setAdvancedAudioOptions()

virtual int agora::rtc::ILocalUserEx::setAdvancedAudioOptions ( const rtc::AudioOptions options,
int  sourceType 
)
pure virtual

◆ getAecDelay()

virtual int agora::rtc::ILocalUserEx::getAecDelay ( int  sourceType,
int *  aecDelay 
)
pure virtual

◆ getBillInfo()

virtual void agora::rtc::ILocalUserEx::getBillInfo ( CallBillInfo *  bill_info)
pure virtual

◆ forceDeviceScore()

virtual void agora::rtc::ILocalUserEx::forceDeviceScore ( const int32_t  deviceScore)
pure virtual

◆ setPrerendererSmoothing()

virtual int agora::rtc::ILocalUserEx::setPrerendererSmoothing ( bool  enabled)
pure virtual

◆ setDtx()

virtual int agora::rtc::ILocalUserEx::setDtx ( bool  enabled)
pure virtual

◆ setCustomAudioBitrate()

virtual int agora::rtc::ILocalUserEx::setCustomAudioBitrate ( int  bitrate)
pure virtual

◆ setAudioFrameSizeMs()

virtual int agora::rtc::ILocalUserEx::setAudioFrameSizeMs ( int  sizeMs)
pure virtual

◆ setAudioCC()

virtual int agora::rtc::ILocalUserEx::setAudioCC ( bool  value)
pure virtual

◆ registerAudioFrameDumpObserver()

virtual int agora::rtc::ILocalUserEx::registerAudioFrameDumpObserver ( IAudioFrameDumpObserver observer)
pure virtual

◆ unregisterAudioFrameDumpObserver()

virtual int agora::rtc::ILocalUserEx::unregisterAudioFrameDumpObserver ( IAudioFrameDumpObserver observer)
pure virtual

◆ startAudioFrameDump()

virtual int agora::rtc::ILocalUserEx::startAudioFrameDump ( const std::string &  location,
const std::string &  uuid,
const std::string &  passwd,
int64_t  duration_ms,
bool  auto_upload 
)
pure virtual

◆ stopAudioFrameDump()

virtual int agora::rtc::ILocalUserEx::stopAudioFrameDump ( const std::string &  location)
pure virtual

◆ setPlayoutUserAnonymous()

virtual int agora::rtc::ILocalUserEx::setPlayoutUserAnonymous ( rtc::uid_t  uid,
bool  anonymous 
)
pure virtual

◆ enableAudioPlayout()

virtual int agora::rtc::ILocalUserEx::enableAudioPlayout ( bool  enabled)
pure virtual

◆ registerVideoMetadataObserver()

virtual void agora::rtc::ILocalUserEx::registerVideoMetadataObserver ( IMetadataObserver observer)
pure virtual

◆ unregisterVideoMetadataObserver()

virtual void agora::rtc::ILocalUserEx::unregisterVideoMetadataObserver ( IMetadataObserver observer)
pure virtual

◆ setVideoFrameObserver()

virtual int agora::rtc::ILocalUserEx::setVideoFrameObserver ( agora::media::IVideoFrameObserver observer)
pure virtual

◆ getRemoteVideoTrack()

virtual agora_refptr<IRemoteVideoTrack> agora::rtc::ILocalUserEx::getRemoteVideoTrack ( rtc::uid_t  uid)
pure virtual

◆ setAVSyncPeer()

virtual int agora::rtc::ILocalUserEx::setAVSyncPeer ( rtc::uid_t  uid)
pure virtual

◆ getOnlySubscribeEncodedVideoFrame()

virtual int agora::rtc::ILocalUserEx::getOnlySubscribeEncodedVideoFrame ( user_id_t  peerUid,
bool &  subscribe 
)
pure virtual

◆ setMinPlayoutDelay()

virtual void agora::rtc::ILocalUserEx::setMinPlayoutDelay ( int  delay)
pure virtual

◆ setAllowSubscribeSelf()

virtual int agora::rtc::ILocalUserEx::setAllowSubscribeSelf ( bool  allow)
pure virtual

◆ adjustRecordingSignalVolume()

virtual int agora::rtc::ILocalUserEx::adjustRecordingSignalVolume ( int  volume)
pure virtual

◆ getRecordingSignalVolume()

virtual int agora::rtc::ILocalUserEx::getRecordingSignalVolume ( int *  volume)
pure virtual

◆ ForcePeriodicKeyFrame()

virtual bool agora::rtc::ILocalUserEx::ForcePeriodicKeyFrame ( )
pure virtual

◆ registerCapabilitiesObserver()

virtual int agora::rtc::ILocalUserEx::registerCapabilitiesObserver ( ICapabilitesObserver cap_observer)
pure virtual

◆ unRegisterCapabilitiesObserver()

virtual int agora::rtc::ILocalUserEx::unRegisterCapabilitiesObserver ( ICapabilitesObserver cap_observer)
pure virtual

◆ updateAppDefinedCapabilities()

virtual void agora::rtc::ILocalUserEx::updateAppDefinedCapabilities ( const Capabilities cap,
size_t  size 
)
pure virtual

◆ sendIntraRequestQuick()

virtual int agora::rtc::ILocalUserEx::sendIntraRequestQuick ( user_id_t  uid)
pure virtual

◆ customUpdateBillInfo()

virtual void agora::rtc::ILocalUserEx::customUpdateBillInfo ( int  height,
int  width,
bool  isSendingVideo 
)
pure virtual

◆ setInteractiveAudience()

virtual void agora::rtc::ILocalUserEx::setInteractiveAudience ( bool  interactive)
pure virtual

◆ setVideoDumpMode()

virtual int agora::rtc::ILocalUserEx::setVideoDumpMode ( int  mode,
bool  enabled 
)
pure virtual