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 sendVideoPacket (const video_packet_t &packet)=0
 
virtual int sendVideoRtcpPacket (const video_rtcp_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 void getBillInfo (CallBillInfo *bill_info)=0
 
virtual void forceDisableChannelCapability (capability::CapabilityType, uint8_t capability)=0
 
virtual int setPlayoutDelayMaxMs (int delay)=0
 
virtual int setPlayoutDelayMinMs (int delay)=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 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 void registerVideoMetadataObserver (IMetadataObserver *observer)=0
 
virtual void unregisterVideoMetadataObserver (IMetadataObserver *observer)=0
 
virtual int updateAudioSubscriptionOptions (const AudioSubscriptionOptions &options)=0
 
virtual agora_refptr< IRemoteVideoTrackgetRemoteVideoTrack (rtc::uid_t uid)=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 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 (uid_t uid, double pan, double gain)=0
 
virtual bool pullMixedAudioPcmData (void *payload_data, AudioPcmDataInfo &audioFrameInfo)=0
 
virtual int setPlaybackAudioFrameParameters (size_t numberOfChannels, uint32_t sampleRateHz, 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 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 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 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)=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
 

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

◆ sendVideoPacket()

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

◆ sendVideoRtcpPacket()

virtual int agora::rtc::ILocalUserEx::sendVideoRtcpPacket ( const video_rtcp_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

◆ getBillInfo()

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

◆ forceDisableChannelCapability()

virtual void agora::rtc::ILocalUserEx::forceDisableChannelCapability ( capability::CapabilityType  ,
uint8_t  capability 
)
pure virtual

◆ setPlayoutDelayMaxMs()

virtual int agora::rtc::ILocalUserEx::setPlayoutDelayMaxMs ( int  delay)
pure virtual

◆ setPlayoutDelayMinMs()

virtual int agora::rtc::ILocalUserEx::setPlayoutDelayMinMs ( int  delay)
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

◆ 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

◆ registerVideoMetadataObserver()

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

◆ unregisterVideoMetadataObserver()

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

◆ updateAudioSubscriptionOptions()

virtual int agora::rtc::ILocalUserEx::updateAudioSubscriptionOptions ( const AudioSubscriptionOptions options)
pure virtual

◆ getRemoteVideoTrack()

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