Agora C++ API Reference for All Platforms
|
12 #include "AgoraRefPtr.h"
14 #include "IAgoraService.h"
15 #include "IAgoraLog.h"
17 #include "audio_options_i.h"
18 #include "content_inspect_i.h"
19 #include "sync_client_i.h"
20 #include "audio_track_i.h"
21 #include "video_track_i.h"
22 #include "media_node_factory_i.h"
23 #include "bitrate_constraints.h"
24 #include "media_component/IAudioDeviceManager.h"
25 #include "api2/NGIAgoraAudioDeviceManager.h"
26 #include "api2/NGIAgoraMediaNode.h"
30 #include <api/aosl_ref.h>
40 class AgoraGenericBridge;
42 class IDiagnosticService;
44 class PredefineIpList;
46 struct RtcConnectionConfigurationEx;
47 class IMediaExtensionObserver;
52 class IAgoraServiceObserver;
92 static constexpr
int kDefaultMaxBitrateBps = (24 * 10 * 1000 * 95);
93 static constexpr
int kDefaultStartBitrateBps = 300000;
101 virtual int initialize(
const rtm::RtmConfig& rtmCfg) {
return 0; }
134 #if defined(FEATURE_RTM_SERVICE)
162 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
232 #if defined(ENABLE_MEDIA_PLAYER)
Definition: agora_service_i.h:250
virtual int initialize(const rtm::RtmConfig &rtmCfg)
Definition: agora_service_i.h:101
virtual agora_refptr< rtc::ILocalAudioTrackEx > createMediaStreamingAudioTrackLLApiInternal(agora_refptr< rtc::IMediaStreamingSource > streamingSource)=0
virtual agora_refptr< rtc::IConfigCenter > getConfigCenterLLApiInternal()=0
Definition: IAgoraService.h:395
int start_bitrate_bps
Definition: bitrate_constraints.h:22
Definition: AgoraBase.h:1233
virtual agora_refptr< rtc::INGAudioDeviceManager > createAudioDeviceManagerLLApiInternal()=0
virtual agora_refptr< rtc::ILocalVideoTrackEx > createCustomVideoTrackLLApiInternal(agora_refptr< rtc::IMediaPacketSender > source, const char *id=nullptr)=0
virtual int destroyRhythmPlayer(aosl_ref_t ref_id)=0
virtual agora_refptr< rtc::ILocalAudioTrackEx > createRecordingDeviceAudioTrackLLApiInternal(agora_refptr< rtc::IRecordingDeviceSource > audioSource, bool enableAec, bool overlap)=0
virtual int initializeLLApiInternal(const AgoraServiceConfiguration &config)=0
virtual agora_refptr< rtc::ILocalAudioTrackEx > createDirectCustomAudioTrackLLApiInternal(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
virtual rtm::IRtmService * createRtmServiceLLApiInternal()=0
virtual agora_refptr< rtc::ILocalAudioTrackEx > createScreenCaptureAudioTrackLLApiInternal(agora_refptr< rtc::IScreenCapturer2 > screen)=0
virtual agora_refptr< rtc::IFileUploaderService > createFileUploadServiceLLApiInternal(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
const char * pluginDir
Definition: agora_service_i.h:76
AgoraServiceConfigEx()
Definition: agora_service_i.h:80
Definition: AgoraRefPtr.h:44
virtual agora_refptr< rtc::IAudioDeviceManager > createAudioDeviceManagerComponentLLApiInternal(rtc::IAudioDeviceManagerObserver *observer)=0
virtual int addExtensionObserverLLApiInternal(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer)=0
Definition: IAgoraService.h:82
virtual agora_refptr< rtc::IMediaRelayService > createMediaRelayServiceLLApiInternal(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
virtual commons::io_engine_base * getIoEngine()=0
MediaEngineType engineType
Definition: agora_service_i.h:70
const char * configDir
Definition: agora_service_i.h:74
virtual int setAudioSessionPresetLLApiInternal(rtc::AUDIO_SCENARIO_TYPE scenario)=0
IAgoraServiceEx * GetService()
virtual int removeExtensionObserverLLApiInternal(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer)=0
virtual agora_refptr< rtc::ILocalVideoTrackEx > createMixedVideoTrackLLApiInternal(agora_refptr< rtc::IVideoMixerSource > videoSource, const char *id)=0
virtual agora_refptr< rtc::IMediaNodeFactoryEx > createMediaNodeFactoryLLApiInternal()=0
virtual agora_refptr< rtc::IRtmpConnection > createRtmpConnectionLLApiInternal(const rtc::RtmpConnectionConfiguration &cfg)=0
const char * deviceInfo
Definition: agora_service_i.h:72
virtual aosl_ref_t createRhythmPlayer()=0
virtual int setExternalAudioSink(bool enabled, int sampleRate, int channels)=0
const char * deviceId
Definition: agora_service_i.h:71
Definition: IAgoraRtmService.h:637
AUDIO_SCENARIO_TYPE
Definition: AgoraBase.h:2617
@ MEDIA_ENGINE_WEBRTC
Definition: agora_service_i.h:58
const char * user_id_t
Definition: AgoraBase.h:806
AgoraServiceConfigEx(const AgoraServiceConfiguration &rhs)
Definition: agora_service_i.h:85
Definition: IAgoraService.h:357
virtual int startTrace(uint32_t count, uint64_t mask)=0
virtual int32_t setAudioDumpPath(const char *filePath)=0
virtual agora_refptr< rtc::ILocalVideoTrackEx > createCustomVideoTrackLLApiInternal(agora_refptr< rtc::IVideoFrameSender > videoSource, const char *id)=0
virtual agora_refptr< rtc::IRtmpStreamingService > createRtmpStreamingServiceLLApiInternal(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
virtual int initializeEx(const AgoraServiceConfigEx &context)=0
Definition: NGIAgoraRtmpConnection.h:231
virtual agora_refptr< rtc::ILocalAudioTrackEx > createLocalMixedAudioTrackLLApiInternal()=0
virtual agora_refptr< rtc::ILocalVideoTrackEx > createMediaPlayerVideoTrackLLApiInternal(agora_refptr< rtc::IMediaPlayerSource > playerVideoSource, const char *id=nullptr)=0
Definition: agora_service_i.h:69
virtual int disableExtensionLLApiInternal(const char *provider_name, const char *extension_name, const char *track_id)=0
Definition: AgoraAtomicOps.h:21
virtual void onLocalUserRegistered(rtc::uid_t uid, const char *userAccount)=0
virtual ~IAgoraServiceObserver()=default
virtual int stopTrace(const char *file_path)=0
TMixMode
Definition: IAgoraService.h:343
virtual const char * getExtensionIdLLApiInternal(const char *provider_name, const char *extension_name)=0
virtual agora_refptr< rtc::ILocalAudioTrackEx > createCustomAudioTrackLLApiInternal(agora_refptr< rtc::IRemoteAudioMixerSource > audioSource)=0
virtual ~IAgoraServiceEx()
Definition: agora_service_i.h:247
virtual agora_refptr< rtc::ILocalVideoTrackEx > createMediaStreamingVideoTrackLLApiInternal(agora_refptr< rtc::IMediaStreamingSource > streamingSource, const char *id=nullptr)=0
virtual agora_refptr< rtc::ILocalAudioTrackEx > createCustomAudioTrackLLApiInternal(agora_refptr< rtc::IMediaPacketSender > source)=0
Definition: rtc_connection_i.h:105
virtual agora_refptr< rtc::ILocalAudioTrackEx > createLocalAudioTrackLLApiInternal()=0
virtual int getAudioSessionConfigurationLLApiInternal(AudioSessionConfiguration *config)=0
const char * systemInfo
Definition: agora_service_i.h:73
Definition: diagnostic_service_i.h:35
Definition: NGIAgoraSyncClient.h:72
virtual int pullPlaybackAudioPcmData(void *payloadData, const rtc::AudioPcmDataInfo &audioFrameInfo)=0
virtual agora_refptr< rtc::ILocalVideoTrackEx > createCameraVideoTrackLLApiInternal(agora_refptr< rtc::ICameraCapturer > videoSource, const char *track_id)=0
virtual agora_refptr< rtc::ILocalVideoTrackEx > createTranscodedVideoTrackLLApiInternal(agora_refptr< rtc::IVideoFrameTransceiver > transceiver, const char *id)=0
virtual agora_refptr< rtc::IRtcConnectionEx > getRtcConnectionInChannel(const char *name, const user_id_t usrId)=0
virtual agora_refptr< ILocalDataChannel > createLocalDataChannelLLApiInternal(const DataChannelConfig &config)=0
Definition: IAgoraService.h:186
virtual int atExitLLApiInternal()=0
virtual int initialize(const AgoraServiceConfiguration &config)=0
virtual int releaseLLApiInternal()=0
virtual int setAudioSessionConfigurationLLApiInternal(const AudioSessionConfiguration &config)=0
virtual bool useStringUid() const =0
@ MEDIA_ENGINE_EMPTY
Definition: agora_service_i.h:62
Definition: agora_service_i.h:98
virtual rtc::IDiagnosticService * getDiagnosticService() const =0
virtual int unregisterAgoraServiceObserver(IAgoraServiceObserver *observer)=0
MediaEngineType
Definition: agora_service_i.h:54
virtual agora_refptr< rtc::ILocalVideoTrackEx > createScreenCaptureVideoTrackLLApiInternal(agora_refptr< rtc::IScreenCapturer > screen, const char *id)=0
Definition: bitrate_constraints.h:20
virtual agora_refptr< rtc::ILocalVideoTrackEx > createCustomVideoTrackLLApiInternal(agora_refptr< rtc::IVideoEncodedImageSender > videoSource, const rtc::SenderOptions &options, const char *id=nullptr)=0
virtual agora_refptr< rtc::ILocalAudioTrackEx > createCustomAudioTrackLLApiInternal(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
int max_bitrate_bps
Definition: bitrate_constraints.h:23
Definition: NGIAgoraAudioDeviceManager.h:91
Definition: AgoraBase.h:1505
virtual agora_refptr< base::ISyncClientEx > createSyncClientLLApiInternal(const SyncConfig &config)=0
virtual agora_refptr< rtc::IRtcConnectionEx > createRtcConnectionEx(const rtc::RtcConnectionConfigurationEx &cfg)=0
Definition: NGIAgoraRtcConnection.h:89
virtual aosl_ref_t createMediaPlayer(media::base::MEDIA_PLAYER_SOURCE_TYPE type)=0
virtual agora_refptr< rtc::ILocalAudioTrackEx > createMediaPlayerAudioTrackLLApiInternal(agora_refptr< rtc::IMediaPlayerSource > playerSource)=0
const char * dataDir
Definition: agora_service_i.h:75
virtual int unregisterServiceEventObserver(IServiceObserver *observer)=0
virtual int enableExtensionLLApiInternal(const char *provider_name, const char *extension_name, const char *track_id, bool auto_enable_on_track)=0
virtual int registerLocalUserAccount(const char *appId, const char *userAccount)=0
virtual int destroyMediaPlayer(aosl_ref_t ref_id)=0
Definition: NGIAgoraRtcConnection.h:183
virtual void enableStringUid(bool enabled)=0
virtual agora_refptr< rtc::ILocalVideoTrackEx > createScreenCaptureVideoTrackLLApiInternal(agora_refptr< rtc::IScreenCapturer2 > screen)=0
@ MEDIA_ENGINE_UNKNOWN
Definition: agora_service_i.h:66
virtual void set_lite_initialized(bool initialized)
Definition: agora_service_i.h:102
virtual rtc::uid_t getUidByUserAccount(const std::string &app_id, const std::string &user_account) const =0
unsigned int uid_t
Definition: AgoraMediaBase.h:28
virtual agora_refptr< rtc::IRtcConnection > createRtcConnectionLLApiInternal(const rtc::RtcConnectionConfiguration &cfg)=0
virtual bool externalAudioSinkEnabled() const =0
Definition: NGIAgoraDataChannel.h:18
virtual agora_refptr< rtc::ILocalAudioTrackEx > createCustomAudioTrackLLApiInternal(agora_refptr< rtc::IAudioEncodedFrameSender > audioSource, TMixMode mixMode)=0
rtc::BitrateConstraints bitrateConstraints
Definition: agora_service_i.h:77
virtual int setLogFilterLLApiInternal(unsigned int filters)=0
bool apSendRequest
Definition: agora_service_i.h:78
Definition: video_node_i.h:28
virtual agora_refptr< rtc::ILocalAudioTrackEx > createCustomAudioTrackLLApiInternal(agora_refptr< rtc::IAudioPcmDataSender > audioSource, bool enableAec)=0
virtual int setLogFileLLApiInternal(const char *filePath, unsigned int fileSize)=0
virtual int registerAgoraServiceObserver(IAgoraServiceObserver *observer)=0
virtual agora_refptr< rtc::IFileUploaderService > createFileUploadServiceEx(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId, media::CONTENT_INSPECT_CLOUD_TYPE cloudType)=0
virtual rtc::IRtcConnection * getOneRtcConnection(bool admBinded) const =0