Agora C++ API Reference for All Platforms
|
16 #include "IAgoraService.h"
17 #include "NGIAgoraRtcConnection.h"
18 #include "audio_node_stat_i.h"
19 #include "local_user_i.h"
24 struct ExtraReportData;
33 struct network_info_t;
39 struct LocalAccessPointInfo;
42 struct CmdRecordingEventReportArgus;
47 class IAudioEngineWrapper;
49 class AudioPacketFilter;
50 class VideoPacketFilter;
109 #ifdef P2P_SWITCH_DEFAULT_VALUE
131 #ifdef P2P_SWITCH_DEFAULT_VALUE
206 virtual void setSid(
const char* sid) = 0;
234 virtual void setVos(
const char* name,
int port) = 0;
251 virtual int sendReport(
const void* data,
size_t length,
int level,
int type,
int retry,
252 const base::ExtraReportData* extra) = 0;
253 virtual int setParameters(
const std::string& parameters,
int priority = 50) = 0;
254 virtual int getParameters(
const std::string& parameters, commons::cjson::JsonWrapper& results) = 0;
262 const std::string& description) = 0;
265 uint64_t sentTs) = 0;
267 int total_volume) = 0;
virtual void setChannelId(const char *channel)=0
bool audioRecvEncodedFrame
Definition: NGIAgoraRtcConnection.h:131
virtual bool hasVideoRemoteTrack(user_id_t id, uint32_t ssrc)=0
virtual void subscribeReceivePacketHandler(ReceivePacketHandler &&handler)=0
virtual rtc::uid_t getLocalUid()=0
bool rsfec
Definition: rtc_connection_i.h:65
CHANNEL_PROFILE_TYPE channelProfile
Definition: NGIAgoraRtcConnection.h:126
bool encrypted
Definition: rtc_connection_i.h:73
std::function< int(const peer_message_t &)> onPeerMessageType
Definition: rtc_connection_i.h:147
Definition: AgoraBase.h:3321
virtual void setDefaultMuteAllRemoteAudioStreams(bool mute)=0
virtual void networkChanged(commons::network::network_info_t &&networkInfo)=0
virtual int stopLastmileProbeTestLLApiInternal()=0
Definition: IAgoraParameter.h:147
int minPort
Definition: NGIAgoraRtcConnection.h:115
Definition: AgoraBase.h:4102
Definition: rtc_engine_i.h:344
virtual int initializeLLApiInternal(const base::AgoraServiceConfiguration &serviceCfg, const RtcConnectionConfiguration &connCfg)=0
Definition: NGIAgoraRtcConnection.h:828
@ CONGESTION_CONTROLLER_TYPE_TRANSPORT_CC
Definition: rtc_connection_i.h:90
Definition: rtc_connection_i.h:61
ReceivePacketHandler(onAudioPacketType &&onAudioPacket=nullptr, onVideoPacketType &&onVideoPacket=nullptr, onControlBroadcastPacketType &&onControlBroadcastPacket=nullptr, onPeerMessageType &&onPeerMessagePacket=nullptr, onVideoCustomCtrlPacketType &&onVideoCustomCtrlPacket=nullptr, onAudioFrameType &&onAudioFrame=nullptr)
Definition: rtc_connection_i.h:157
@ CONGESTION_CONTROLLER_TYPE_AGORA_CC
Definition: rtc_connection_i.h:86
Definition: IAgoraService.h:82
virtual void setConnectionState(CONNECTION_STATE_TYPE state)=0
uint8_t payload_type
Definition: rtc_connection_i.h:63
virtual int32_t setEncryptionSecret(const char *secret)=0
Definition: NGIAgoraRtcConnection.h:505
virtual int reportArgusCounters(int *counterId, int *value, int count, user_id_t userId)=0
virtual void muteLocalVideo(bool mute)=0
onVideoCustomCtrlPacketType onVideoCustomCtrlPacket_
Definition: rtc_connection_i.h:155
virtual int sendCustomReportMessageLLApiInternal(const char *id, const char *category, const char *event, const char *label, int value)=0
ConnectionMode
Definition: rtc_connection_i.h:95
virtual TConnectionInfo getConnectionInfoLLApiInternal()=0
virtual void SetLocalApInfo(const LocalAccessPointInfo &config)=0
AUDIO_SCENARIO_TYPE
Definition: AgoraBase.h:2617
const char * user_id_t
Definition: AgoraBase.h:806
virtual int startLastmileProbeTestLLApiInternal(const LastmileProbeConfig &config)=0
Definition: IAgoraRtcEngine.h:1499
Definition: AgoraBase.h:233
virtual const char * getSid()=0
virtual void setBannedTime(const uint64_t banned_time)=0
onControlBroadcastPacketType onControlBroadcastPacket_
Definition: rtc_connection_i.h:153
onAudioFrameType onAudioFrame_
Definition: rtc_connection_i.h:156
std::function< int(SAudioFrame &)> onAudioFrameType
Definition: rtc_connection_i.h:149
virtual void setDefaultMuteAllRemoteVideoStreams(bool mute)=0
onVideoPacketType onVideoPacket_
Definition: rtc_connection_i.h:152
std::function< int(audio_packet_t &)> onAudioPacketType
Definition: rtc_connection_i.h:144
virtual AudioPacketFilter * getAudioPacketFilter()=0
virtual void didStreamMessageSync(uid_t userId, int streamId, const char *data, size_t length, uint64_t sentTs)=0
virtual void setRemoteVideoStreamType(user_id_t userId, VIDEO_STREAM_TYPE type)=0
ReceivePacketHandler(ReceivePacketHandler &&rhs)
Definition: rtc_connection_i.h:169
virtual RtcConnStats GetStats()=0
bool autoSubscribeAudio
Definition: NGIAgoraRtcConnection.h:95
Definition: NGIAgoraRtcConnection.h:55
bool audioRecvMediaPacket
Definition: NGIAgoraRtcConnection.h:136
int clientType
Definition: rtc_connection_i.h:137
onPeerMessageType onPeerMessagePacket_
Definition: rtc_connection_i.h:154
virtual void setChannelProfile(CHANNEL_PROFILE_TYPE channel_profile)=0
std::list< std::string > vosList
Definition: rtc_connection_i.h:140
Definition: AgoraAtomicOps.h:21
virtual int initializeEx(const base::AgoraServiceConfiguration &serviceCfg, const RtcConnectionConfigurationEx &cfg)=0
virtual int setMediaRenderingTracingTick(uint64_t tick)=0
virtual int sendReport(const void *data, size_t length, int level, int type, int retry, const base::ExtraReportData *extra)=0
Definition: rtc_connection_i.h:178
@ CONGESTION_CONTROLLER_TYPE_AUT_CC
Definition: rtc_connection_i.h:92
virtual base::IAgoraParameter * getAgoraParameterLLApiInternal()=0
RtcConnectionConfigurationEx()
Definition: rtc_connection_i.h:106
virtual int renewTokenLLApiInternal(const char *token)=0
Definition: AgoraBase.h:3372
Definition: rtc_connection_i.h:105
Definition: NGIAgoraRtcConnection.h:26
virtual bool isLocalUserId(const std::string &userId)=0
CHANNEL_PROFILE_TYPE
Definition: AgoraBase.h:267
Definition: rtc_connection_i.h:143
virtual int deinitialize()=0
bool isInteractiveAudience
Definition: NGIAgoraRtcConnection.h:150
virtual void muteRemoteAudio(user_id_t userId, bool mute)=0
@ CONNECTION_MODE_ACTIVE
Definition: rtc_connection_i.h:98
Definition: audio_node_stat_i.h:30
virtual agora::base::IAgoraParameter * getAgoraParameter()=0
virtual void muteRemoteVideo(user_id_t userId, bool mute)=0
virtual CongestionControlType ccType()=0
virtual uint32_t getVid()=0
virtual bool getUid(user_id_t userId, rtc::uid_t &uid)=0
virtual int setParameters(const std::string ¶meters, int priority=50)=0
onAudioPacketType onAudioPacket_
Definition: rtc_connection_i.h:151
virtual int32_t enableVosUserInfoHidden(bool enabled)=0
Definition: packet_i.h:164
std::function< int(control_broadcast_packet_t &)> onControlBroadcastPacketType
Definition: rtc_connection_i.h:146
virtual uint32_t getCid()=0
virtual int registerObserverLLApiInternal(IRtcConnectionObserver *observer, void(*safeDeleter)(IRtcConnectionObserver *)=NULL)=0
virtual ILocalUserEx * getLocalUserLLApiInternal()=0
@ CONGESTION_CONTROLLER_TYPE_REMB
Definition: rtc_connection_i.h:88
Definition: packet_i.h:64
std::function< int(video_custom_ctrl_broadcast_packet_t &)> onVideoCustomCtrlPacketType
Definition: rtc_connection_i.h:148
virtual int registerNetworkObserverLLApiInternal(INetworkObserver *observer, void(*safeDeleter)(INetworkObserver *)=NULL)=0
virtual void muteLocalAudio(bool mute)=0
virtual bool isEncryptionEnabled() const =0
bool enableAudioRecordingOrPlayout
Definition: NGIAgoraRtcConnection.h:107
Definition: local_user_i.h:129
AudioFrameHandleInfo handle_info
Definition: rtc_connection_i.h:66
virtual uint64_t statsSpace()=0
virtual int sendVideoPacket(video_packet_t &packet)=0
virtual int sendWebAgentVideoStats(const std::string &uidstr, const WebAgentVideoStats &stats)=0
virtual std::string getLocalUserId()=0
virtual int sendVideoCustomCtrlBroadcastPacket(video_custom_ctrl_broadcast_packet_t &packet)=0
Definition: packet_i.h:152
bool videoRecvMediaPacket
Definition: NGIAgoraRtcConnection.h:141
bool autoSubscribeVideo
Definition: NGIAgoraRtcConnection.h:101
virtual int createDataStreamLLApiInternal(int *streamId, bool reliable, bool ordered, bool sync)=0
virtual int getParameters(const std::string ¶meters, commons::cjson::JsonWrapper &results)=0
static const uint8_t AUDIO_MEDIA_PACKET_PAYLOAD_TYPE
Definition: rtc_connection_i.h:59
virtual int connectLLApiInternal(const TConnectSettings &settings)=0
Definition: AgoraBase.h:5851
virtual int sendCallRating(const std::string &callId, int rating, const std::string &description)=0
Definition: packet_i.h:283
virtual void setRtcStats(const RtcStats &stats)=0
uint32_t ssrc
Definition: rtc_connection_i.h:68
bool is_p2p_switch_enabled
Definition: rtc_connection_i.h:139
virtual void muteAllRemoteAudio(bool mute)=0
virtual void setPacketObserver(IPacketObserver *observer)=0
virtual bool hasAudioRemoteTrack(user_id_t id)=0
Optional< conn_id_t > connId
Definition: rtc_connection_i.h:138
virtual int getRemoteUsersLLApiInternal(UserList &users)=0
virtual void setRemoteDefaultVideoStreamType(VIDEO_STREAM_TYPE type)=0
virtual CLIENT_ROLE_TYPE getUserRole()=0
virtual void stopAsyncHandler(bool waitForExit)=0
uint64_t space_id
Definition: rtc_connection_i.h:181
Definition: AgoraBase.h:2258
virtual void setSid(const char *sid)=0
virtual int unregisterNetworkObserverLLApiInternal(INetworkObserver *observer)=0
Definition: NGIAgoraRtcConnection.h:89
CongestionControlType
Definition: rtc_connection_i.h:85
virtual int32_t setAudioScenarioType(AUDIO_SCENARIO_TYPE type)=0
Definition: AgoraOptional.h:881
virtual int sendStreamMessageLLApiInternal(int streamId, const char *data, size_t length)=0
uint64_t banned_elapse
Definition: rtc_connection_i.h:180
RtcStats stats
Definition: rtc_connection_i.h:179
virtual void sendRecordingArgusEvents(const protocol::CmdRecordingEventReportArgus &events)=0
VIDEO_STREAM_TYPE
Definition: AgoraBase.h:1553
virtual int sendControlBroadcastPacket(std::string &&data)=0
int maxPort
Definition: NGIAgoraRtcConnection.h:119
virtual void sendAudioVolumeIndication(const AudioVolumeInfo *speakers, unsigned int speaker_number, int total_volume)=0
Definition: packet_i.h:289
virtual int unregisterObserverLLApiInternal(IRtcConnectionObserver *observer)=0
virtual int sendAudioFrame(SAudioFrame &frame, int delay_ms=0)=0
Definition: NGIAgoraRtcConnection.h:183
virtual int32_t setEncryptionMode(const char *mode)=0
virtual int initialize(const base::AgoraServiceConfiguration &serviceCfg, const RtcConnectionConfiguration &cfg)=0
virtual int32_t enableBuiltInMediaEncryption(bool enabled)=0
virtual VideoPacketFilter * getVideoPacketFilter()=0
bool with_agora_header
Definition: rtc_connection_i.h:75
virtual void muteAllRemoteVideo(bool mute)=0
Definition: packet_i.h:294
virtual void setUserRole(CLIENT_ROLE_TYPE role)=0
@ CONNECTION_MODE_PASSIVE
Definition: rtc_connection_i.h:102
PacketOptions()
Definition: rtc_connection_i.h:76
unsigned int uid_t
Definition: AgoraMediaBase.h:28
bool isDataChannelOnly
Definition: NGIAgoraRtcConnection.h:155
CLIENT_ROLE_TYPE
Definition: AgoraBase.h:2454
virtual int enableEncryptionLLApiInternal(bool enabled, const EncryptionConfig &config)=0
virtual bool isLocalUid(uid_t uid)=0
virtual int connectLLApiInternal(const char *token, const char *channelId, user_id_t userId)=0
virtual void unsubscribeReceivePacketHandler()=0
CONNECTION_STATE_TYPE
Definition: AgoraBase.h:3734
virtual std::string getAppIdFromToken(const std::string &token)=0
virtual CallContext * getCallContext()=0
virtual int disconnectLLApiInternal()=0
virtual void setLocalUserId(user_id_t userId)=0
virtual void setRtmFlag(bool rtmFlag)=0
virtual void onClientRoleChanged(CLIENT_ROLE_TYPE oldRole, CLIENT_ROLE_TYPE newRole, const ClientRoleOptions &newRoleOptions)=0
int maxSendBitrate
Definition: NGIAgoraRtcConnection.h:111
virtual void setVos(const char *name, int port)=0
std::function< int(video_packet_t &)> onVideoPacketType
Definition: rtc_connection_i.h:145
Definition: video_node_i.h:28
virtual bool isWebrtcPacerEnabled()=0
virtual bool isConnected()=0
Definition: AgoraBase.h:2503
Definition: rtc_connection_i.h:184
virtual int sendPeerMessage(peer_message_t &message)=0
virtual bool getUserId(rtc::uid_t uid, std::string &userId)=0