Agora C++ API Reference for All Platforms
|
12 #include "IAgoraService.h"
13 #include "NGIAgoraLocalUser.h"
14 #include "NGIAgoraMediaNode.h"
15 #include "NGIAgoraRtcConnection.h"
16 #include "NGIAgoraAudioTrack.h"
17 #include "audio_options_i.h"
18 #include "channel_capability_i.h"
24 struct TConnectionInfo;
26 struct audio_packet_t;
28 struct video_packet_t;
29 struct control_broadcast_packet_t;
31 class IMetadataObserver;
32 class IStrategyManager;
33 class ProactiveCaller;
75 const std::vector<std::string>& files) = 0;
164 const std::string& passwd, int64_t duration_ms,
165 bool auto_upload, aosl_ref_t ares = AOSL_REF_INVALID) = 0;
CapabilityItem(uint8_t i, const char *n)
Definition: local_user_i.h:82
virtual int getRecordingSignalVolume(int *volume)=0
virtual int setSubscribeVideoBlocklistLLApiInternal(const std::vector< internal_user_id_t > &userIdList)=0
virtual int setSubscribeAudioBlocklistLLApiInternal(const std::vector< internal_user_id_t > &userIdList)=0
virtual int setExtendPlatformRendererLLApiInternal(agora::media::IVideoFrameObserver *renderer)=0
virtual int unpublishVideoLLApiInternal(agora_refptr< ILocalVideoTrack > videoTrack)=0
virtual int publishVideoLLApiInternal(agora_refptr< ILocalVideoTrack > videoTrack)=0
virtual int enableDownlinkRawAudioLevelReport(bool enable)=0
virtual int unregisterLocalVideoEncodedFrameObserverLLApiInternal(agora::media::IVideoEncodedFrameObserver *observer)=0
virtual int setAudioVolumeIndicationParametersLLApiInternal(int intervalInMS, int smooth, bool reportVad)=0
Definition: NGIAgoraLocalUser.h:176
virtual int enableAudioPlayout(bool enabled)=0
AUDIENCE_LATENCY_LEVEL_TYPE
Definition: AgoraBase.h:2488
virtual int getPlaybackSignalVolumeLLApiInternal(int *volume)=0
virtual int unsubscribeAllVideoLLApiInternal()=0
const std::string AUDIO_PIPELINE_POS_PLAY
virtual int registerLocalVideoEncodedFrameObserverLLApiInternal(agora::media::IVideoEncodedFrameObserver *observer)=0
virtual int setAudioFilterableLLApiInternal(bool filterable)=0
virtual void unregisterVideoLayoutObserver(IVideoLayoutObserver *observer)=0
virtual int subscribeAllVideoLLApiInternal(const agora::rtc::VideoSubscriptionOptions &subscriptionOptions)=0
Definition: audio_options_i.h:61
virtual int setAudioScenarioLLApiInternal(AUDIO_SCENARIO_TYPE scenario)=0
virtual int enableDownlinkNoiseGate(int noise_gate)=0
virtual int setUserPlaybackSignalLoudnessLLApiInternal(user_id_t userId, float loudness)=0
virtual int setCustomAudioChannelNum(int channelNum)=0
CapabilityItem * item
Definition: local_user_i.h:86
const std::string AUDIO_PIPELINE_POS_DEC
const std::string AUDIO_PIPELINE_POS_PRE_SEND_PROC
Definition: local_user_i.h:71
virtual int setAudioFrameSizeMs(int sizeMs)=0
virtual int setDtx(bool enabled)=0
virtual int unregisterLocalUserObserverLLApiInternal(ILocalUserObserver *observer)=0
virtual int registerVideoEncodedFrameObserverLLApiInternal(agora::media::IVideoEncodedFrameObserver *observer)=0
Definition: AgoraRefPtr.h:44
virtual int registerAudioFrameDumpObserver(IAudioFrameDumpObserver *observer)=0
virtual int getUserPlaybackSignalVolumeLLApiInternal(user_id_t userId, int *volume)=0
const std::string AUDIO_PIPELINE_POS_ATW_RECORD
virtual int setPlayoutUserAnonymous(rtc::uid_t uid, bool anonymous)=0
virtual int setCustomAudioBitrate(int bitrate)=0
virtual int registerDataChannelObserverLLApiInternal(IDataChannelObserver *observer)=0
virtual int registerLocalVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer, aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual int onAudioPacket(const agora::rtc::TConnectionInfo &connectionInfo, const audio_packet_t &p)=0
virtual int getAudioOptions(rtc::AudioOptions *options)=0
virtual int unpublishAudioLLApiInternal(agora_refptr< ILocalAudioTrack > audioTrack)=0
virtual void registerVideoMetadataObserver(IMetadataObserver *observer)=0
virtual int publishAudioLLApiInternal(agora_refptr< ILocalAudioTrack > audioTrack)=0
virtual void registerVideoLayoutObserver(IVideoLayoutObserver *observer)=0
const std::string AUDIO_PIPELINE_POS_RECORD_ORIGIN
NS_DELAY
Definition: NGIAgoraLocalUser.h:259
virtual int setRemoteUserSpatialAudioParamsLLApiInternal(user_id_t userId, const agora::SpatialAudioParams ¶m)=0
virtual int setDownlinkSignalLoudness(float loudness_lkfs)=0
virtual int unregisterAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer)=0
virtual int setRemoteVoicePositionLLApiInternal(user_id_t userId, double pan, double gain)=0
virtual int setUserRoleLLApiInternal(rtc::CLIENT_ROLE_TYPE role)=0
agora::capability::CapabilityType type
Definition: local_user_i.h:94
virtual void OnCapabilitesChanged(const Capabilities *capabilities, size_t size)
Definition: local_user_i.h:101
uint32_t rx
Definition: local_user_i.h:109
@ VIDEO_STREAM_HIGH
Definition: AgoraBase.h:1557
uint32_t width
Definition: local_user_i.h:118
const std::string AUDIO_PIPELINE_POS_PCM_SOURCE_PLAYBAC_MIXER
virtual int forceNextIntraFrameLLApiInternal()=0
virtual int setVideoDumpMode(int mode, bool enabled, int frame_cnt=-1)=0
AUDIO_SCENARIO_TYPE
Definition: AgoraBase.h:2617
virtual int setSubscribeAudioAllowlistLLApiInternal(const std::vector< internal_user_id_t > &userIdList)=0
const char * user_id_t
Definition: AgoraBase.h:806
virtual int onDataStreamPacket(const agora::rtc::TConnectionInfo &connectionInfo, agora::rtc::uid_t uid, uint16_t streamId, const char *data, size_t length)=0
virtual int SetAudioNsModeLLApiInternal(bool NsEnable, NS_MODE NsMode, NS_LEVEL NsLevel, NS_DELAY NsDelay)=0
Definition: NGIAgoraLocalUser.h:1207
virtual int subscribeVideoLLApiInternal(user_id_t userId, const agora::rtc::VideoSubscriptionOptions &subscriptionOptions)=0
virtual ~ICapabilitesObserver()=default
NS_MODE
Definition: NGIAgoraLocalUser.h:250
Definition: AgoraBase.h:1589
VIDEO_QOE_PREFERENCE_TYPE
Definition: AgoraBase.h:2766
virtual int startAudioFrameDump(const std::string &location, const std::string &uuid, const std::string &passwd, int64_t duration_ms, bool auto_upload, aosl_ref_t ares=AOSL_REF_INVALID)=0
CapabilityType
Definition: channel_capability_i.h:106
virtual int takeDataChannelSnapshotLLApiInternal()=0
virtual int sendIntraRequestQuick(user_id_t uid)=0
virtual int setAudienceLatencyLevelLLApiInternal(rtc::AUDIENCE_LATENCY_LEVEL_TYPE level, int role)=0
virtual int unregisterDataChannelObserverLLApiInternal(IDataChannelObserver *observer)=0
virtual int unregisterAudioSpectrumObserverLLApiInternal(agora::media::IAudioSpectrumObserver *observer)=0
virtual int getOnlySubscribeEncodedVideoFrame(user_id_t peerUid, bool &subscribe)=0
virtual int EnableLocalMixedAudioTrackLLApiInternal(agora_refptr< ILocalAudioTrack > &track, bool enable, bool MixLocal, bool MixRemote)=0
virtual int disableAudioSpectrumMonitorLLApiInternal()=0
const std::string AUDIO_PIPELINE_POS_ENC
virtual int setPrerendererSmoothing(bool enabled)=0
virtual int setMixedAudioFrameParametersLLApiInternal(size_t numberOfChannels, uint32_t sampleRateHz, int samplesPerCall)=0
uint32_t rw
Definition: local_user_i.h:111
virtual int unsubscribeAudioLLApiInternal(user_id_t userId)=0
virtual int setVideoQoEPreferenceLLApiInternal(VIDEO_QOE_PREFERENCE_TYPE qoePreference)=0
Definition: NGIAgoraLocalUser.h:1584
virtual int setUplinkSignalLoudness(float loudness_lkfs)=0
virtual int getRemoteAudioTrackFilterPropertyLLApiInternal(user_id_t userId, const char *id, const char *key, char *jsonValue, size_t bufSize)=0
uint32_t height
Definition: local_user_i.h:119
size_t size
Definition: local_user_i.h:87
uint32_t layoutSize
Definition: local_user_i.h:120
virtual int adjustAudioAcceleration(rtc::uid_t uid, int percent)=0
Definition: AgoraAtomicOps.h:21
virtual int muteRemoteFromTimestamp(rtc::uid_t uid, uint32_t timestamp)=0
std::string internal_user_id_t
Definition: local_user_i.h:275
virtual int sendIntraRequestLLApiInternal(user_id_t userId, VIDEO_STREAM_TYPE stream_type=VIDEO_STREAM_HIGH)=0
Capabilities()
Definition: local_user_i.h:95
virtual int registerAudioFrameObserverLLApiInternal(agora::media::IAudioFrameObserverBase *observer)=0
virtual int unsubscribeVideoLLApiInternal(user_id_t userId)=0
virtual int setRecordingAudioFrameParametersLLApiInternal(size_t numberOfChannels, uint32_t sampleRateHz, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
virtual int getHighPriorityUserListLLApiInternal(std::vector< uid_t > &vipList, int &option)=0
RAW_AUDIO_FRAME_OP_MODE_TYPE
Definition: AgoraMediaBase.h:203
Definition: local_user_i.h:123
virtual int initialize()=0
virtual int setAudioOptions(const rtc::AudioOptions &options)=0
const std::string AUDIO_PIPELINE_POS_AT_RECORD
virtual int unRegisterCapabilitiesObserver(ICapabilitesObserver *cap_observer)=0
const int64_t AUDIO_FRAME_DUMP_MIN_DURATION_MS
Definition: local_user_i.h:68
virtual int setVideoFrameObserverLLApiInternal(agora::media::IVideoFrameObserver *observer)=0
virtual int setRemoteAudioTrackFilterPropertyLLApiInternal(user_id_t userId, const char *id, const char *key, const char *jsonValue)=0
virtual int sendDataStreamPacket(uint16_t streamId, const char *data, size_t length)=0
virtual int adjustDecodedAudioVolume(rtc::uid_t uid, int decoded_index, int volume)=0
virtual bool ForcePeriodicKeyFrame()=0
Definition: NGIAgoraRtcConnection.h:26
virtual int setCustomAudioSampleRate(int sampleRate)=0
virtual int enableAudioLevelReportInDecibel(bool enable)=0
virtual int stopAudioRecordingLLApiInternal()=0
Definition: local_user_i.h:78
virtual int unsubscribeAllAudioLLApiInternal()=0
virtual int publishDataChannelLLApiInternal(agora_refptr< ILocalDataChannel > channel)=0
virtual int enableSpatialAudioLLApiInternal(bool enabled)=0
uint8_t id
Definition: local_user_i.h:79
virtual ~IAudioFrameDumpObserver()=default
virtual int registerAudioSpectrumObserver(agora::media::IAudioSpectrumObserver *observer, void(*safeDeleter)(agora::media::IAudioSpectrumObserver *), aosl_ref_t ares=AOSL_REF_INVALID)=0
virtual rtc::ProactiveCaller * getStrategyProactiveCaller()=0
virtual int setRemoteSubscribeFallbackOptionLLApiInternal(int option)=0
virtual int setPlaybackAudioFrameBeforeMixingParametersLLApiInternal(size_t numberOfChannels, uint32_t sampleRateHz)=0
uint32_t videoState
Definition: local_user_i.h:113
VIDEO_APPLICATION_SCENARIO_TYPE
Definition: AgoraBase.h:2748
virtual int registerCapabilitiesObserver(ICapabilitesObserver *cap_observer)=0
Definition: local_user_i.h:106
virtual int adjustRecordingSignalVolume(int volume)=0
virtual int enalbeSyncRenderNtpBroadcast(bool enable_sync_render_ntp_broadcast)=0
virtual ~IVideoLayoutObserver()
Definition: local_user_i.h:126
virtual int setExtendPlatformRenderer(agora::media::IVideoFrameObserver *renderer)=0
virtual int enalbeSyncRenderNtpAudience(bool enable_sync_render_ntp_audience)=0
virtual int subscribeDataChannelLLApiInternal(user_id_t userId, int channelId)=0
virtual int registerVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer, aosl_ref_t ares=AOSL_REF_INVALID)=0
const std::string AUDIO_PIPELINE_POS_RX_MIXER
const int64_t AUDIO_FRAME_DUMP_MAX_DURATION_MS
Definition: local_user_i.h:69
virtual void muteLocalAudioStream(bool mute)=0
Definition: packet_i.h:164
Definition: local_user_i.h:115
virtual int unregisterVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
virtual void getBillInfo(CallBillInfo *bill_info)=0
virtual int setExternalAudioSinkMix(bool enabled)=0
virtual void setMinPlayoutDelay(int delay)=0
virtual int registerMediaControlPacketReceiverLLApiInternal(IMediaControlPacketReceiver *ctrlPacketReceiver)=0
virtual int sendAudioMetadataLLApiInternal(const char *metadata, size_t length)=0
virtual int registerAudioSpectrumObserverLLApiInternal(agora::media::IAudioSpectrumObserver *observer, void(*safeDeleter)(agora::media::IAudioSpectrumObserver *))=0
virtual int adjustAudioDeceleration(rtc::uid_t uid, int percent)=0
Definition: local_user_i.h:35
Definition: NGIAgoraLocalUser.h:56
virtual int setVideoSubscriptionOptionsLLApiInternal(user_id_t userId, const VideoSubscriptionOptions &options)=0
virtual int setVideoFrameObserver(agora::media::IVideoFrameObserver *observer)=0
Definition: local_user_i.h:129
virtual rtc::IStrategyManager * getStrategyManager()=0
virtual int registerLocalUserObserverLLApiInternal(ILocalUserObserver *observer, void(*safeDeleter)(ILocalUserObserver *)=NULL)=0
const std::string AUDIO_PIPELINE_POS_TX_MIXER
virtual void muteMicrophone(bool mute)=0
virtual int enableRemoteAudioTrackFilterLLApiInternal(user_id_t userId, const char *id, bool enable)=0
uint32_t ry
Definition: local_user_i.h:110
Definition: packet_i.h:152
CapabilityItemMap * item_map
Definition: local_user_i.h:93
virtual int setAdvancedAudioOptions(const rtc::AudioOptions &options, int sourceType)=0
virtual int registerVideoFrameObserverLLApiInternal(IVideoFrameObserver2 *observer)=0
virtual int startAudioRecordingLLApiInternal(const agora_refptr< agora::rtc::IAudioSinkBase > &audioSink, const AudioSinkWants &wants=AudioSinkWants{})=0
virtual int adjustPlaybackSignalVolumeLLApiInternal(int volume)=0
virtual int unsubscribeDataChannelLLApiInternal(user_id_t userId, int channelId)=0
virtual int enableStablePlayout(bool enable_stable_playout)=0
Definition: packet_i.h:283
virtual agora_refptr< IRemoteVideoTrack > getRemoteVideoTrack(rtc::uid_t uid)=0
const std::string AUDIO_PIPELINE_POS_ATW_PLAYOUT
virtual int setAudioMaxTargetDelay(int delay)=0
virtual int initializeLLApiInternal()=0
virtual int unregisterLocalVideoEncodedFrameObserver(agora::media::IVideoEncodedFrameObserver *observer)=0
virtual int enableAudioSpectrumMonitorLLApiInternal(int intervalInMS)=0
virtual int sendControlBroadcastPacket(std::string &payload)=0
virtual int unmuteRemoteFromTimestamp(rtc::uid_t uid, uint32_t timestamp)=0
virtual bool getLocalAudioStatisticsLLApiInternal(LocalAudioDetailedStats &stats)=0
virtual int setAudioEncoderConfigurationLLApiInternal(const AudioEncoderConfiguration &config)=0
virtual int unregisterVideoEncodedFrameObserverLLApiInternal(agora::media::IVideoEncodedFrameObserver *observer)=0
virtual int subscribeAudioLLApiInternal(user_id_t userId)=0
Definition: NGIAgoraAudioTrack.h:29
virtual int enableSoundPositionIndicationLLApiInternal(bool enabled)=0
Definition: local_user_i.h:85
const char * name
Definition: local_user_i.h:80
virtual int registerTransportPacketObserver(ITransportPacketObserver *observer)=0
virtual int adjustUserPlaybackSignalVolumeLLApiInternal(user_id_t userId, int volume)=0
virtual int onControlBroadcastPacket(const agora::rtc::TConnectionInfo &connectionInfo, control_broadcast_packet_t &p)=0
virtual void updateAppDefinedCapabilities(const Capabilities *cap, size_t size)=0
VIDEO_STREAM_TYPE
Definition: AgoraBase.h:1553
virtual int onVideoPacket(const agora::rtc::TConnectionInfo &connectionInfo, const video_packet_t &p)=0
virtual void customUpdateBillInfo(int height, int width, bool isSendingVideo)=0
std::string cname
Definition: local_user_i.h:107
virtual int unregisterAudioFrameObserverLLApiInternal(agora::media::IAudioFrameObserverBase *observer)=0
const std::string AUDIO_PIPELINE_POS_PRE_PLAY_PROC
const std::string AUDIO_PIPELINE_POS_APM
const std::string AUDIO_PIPELINE_POS_AT_PLAYOUT
virtual int subscribeAllAudioLLApiInternal()=0
uint32_t uid
Definition: local_user_i.h:108
virtual int unregisterMediaControlPacketReceiverLLApiInternal(IMediaControlPacketReceiver *ctrlPacketReceiver)=0
virtual int sendVideoPacket(const video_packet_t &packet)=0
Definition: IAgoraService.h:57
virtual int setAVSyncPeer(rtc::uid_t uid)=0
const std::string AUDIO_PIPELINE_POS_PLAYBACK_MIXER
std::vector< LayoutInternal > uidlayout
Definition: local_user_i.h:121
virtual int unregisterVideoFrameObserverLLApiInternal(IVideoFrameObserver2 *observer)=0
virtual int setVideoScenarioLLApiInternal(VIDEO_APPLICATION_SCENARIO_TYPE scenarioType)=0
virtual void unregisterVideoMetadataObserver(IMetadataObserver *observer)=0
Definition: local_user_i.h:99
virtual int setAudioCC(bool value)=0
virtual int unregisterAudioFrameDumpObserver(IAudioFrameDumpObserver *observer)=0
unsigned int uid_t
Definition: AgoraMediaBase.h:28
CapabilityItemMap()
Definition: local_user_i.h:88
virtual void OnAudioFrameDumpCompleted(const std::string &location, const std::string &uuid, const std::vector< std::string > &files)=0
virtual int enableVideoDecryptedV4StreamDump(bool enabled)=0
virtual ~ITransportPacketObserver()
Definition: local_user_i.h:37
virtual void onLayoutInfo(const char *channelId, uid_t localUid, uid_t uid, VideoLayoutInfoInternal info)=0
virtual int setCustomAudioPayloadType(int payloadtype)=0
CLIENT_ROLE_TYPE
Definition: AgoraBase.h:2454
std::string service
Definition: local_user_i.h:117
virtual void forceDeviceScore(int32_t deviceScore)=0
Definition: AgoraBase.h:6410
virtual int sendAudioPacket(const audio_packet_t &packet, int delay=0)=0
virtual int setAllowSubscribeSelf(bool allow)=0
NS_LEVEL
Definition: NGIAgoraLocalUser.h:255
uint32_t rh
Definition: local_user_i.h:112
virtual int stopAudioFrameDump(const std::string &location)=0
Definition: local_user_i.h:92
Capabilities(CapabilityItemMap *i, agora::capability::CapabilityType t)
Definition: local_user_i.h:96
virtual int setEarMonitoringAudioFrameParametersLLApiInternal(bool enabled, size_t numberOfChannels, uint32_t sampleRateHz, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
CapabilityItem()
Definition: local_user_i.h:81
virtual int setPlaybackAudioFrameParametersLLApiInternal(size_t numberOfChannels, uint32_t sampleRateHz, RAW_AUDIO_FRAME_OP_MODE_TYPE mode, int samplesPerCall)=0
virtual CLIENT_ROLE_TYPE getUserRoleLLApiInternal()=0
CapabilityItemMap(CapabilityItem *i, size_t s)
Definition: local_user_i.h:89
virtual int setHighPriorityUserListLLApiInternal(const std::vector< uid_t > &vipList, int option)=0
virtual int setSubscribeVideoAllowlistLLApiInternal(const std::vector< internal_user_id_t > &userIdList)=0
Definition: NGIAgoraDataChannel.h:128
Definition: video_node_i.h:28
virtual void setInteractiveAudience(bool interactive)=0
virtual int unpublishDataChannelLLApiInternal(agora_refptr< ILocalDataChannel > channel)=0