Agora C++ API Reference for All Platforms
|
6 #pragma once // NOLINT(build/header_guard)
10 #include "AgoraOptional.h"
15 class IRtmpConnection;
17 class IMediaDeviceManager;
18 class INGAudioDeviceManager;
19 struct TConnectionInfo;
20 struct RtcConnectionConfiguration;
21 struct RtmpConnectionConfiguration;
22 class ILocalAudioTrack;
23 class IMediaPlayerSource;
24 class IMediaStreamingSource;
25 class ICameraCapturer;
26 class IScreenCapturer;
27 class IScreenCapturer2;
28 class IAudioPcmDataSender;
29 class IAudioEncodedFrameSender;
30 class IVideoFrameSender;
31 class IVideoEncodedImageSender;
32 class IVideoSourceNode;
33 class IVideoMixerSource;
34 class IVideoFrameTransceiver;
35 class ILocalVideoTrack;
36 class IMediaNodeFactory;
37 class IRecordingDeviceSource;
38 class IRemoteAudioMixerSource;
39 class IRtmpStreamingService;
40 class IMediaPacketSender;
41 class IMediaRelayService;
42 class IAudioDeviceManager;
43 class IAudioDeviceManagerObserver;
45 class IMediaExtensionObserver;
46 class IExtensionProvider;
47 class IFileUploaderService;
310 template <
typename T>
439 virtual int setLogFile(
const char* filePath,
unsigned int fileSize) = 0;
690 const char*
id = OPTIONAL_NULLPTR) = 0;
704 const char*
id = OPTIONAL_NULLPTR) = 0;
736 const char*
id = OPTIONAL_NULLPTR) = 0;
738 #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
891 virtual const char*
getExtensionId(
const char* provider_name,
const char* extension_name) = 0;
893 #if defined (_WIN32) || defined(__linux__) || defined(__ANDROID__)
917 const char* provider_name,
const char* extension_name,
const char* track_id = NULL,
918 bool auto_enable_on_track =
false) = 0;
931 const char* provider_name,
const char* extension_name,
const char* track_id = NULL) = 0;
bool enableAudioDevice
Definition: IAgoraService.h:91
Optional< bool > allowBluetoothA2DP
Definition: IAgoraService.h:259
const char * appId
Definition: IAgoraService.h:107
Optional< bool > chatMode
Definition: IAgoraService.h:200
Definition: IAgoraService.h:360
Definition: AgoraBase.h:1178
virtual int disableExtension(const char *provider_name, const char *extension_name, const char *track_id=NULL)=0
virtual ~IAgoraService()
Definition: IAgoraService.h:934
Definition: AgoraRefPtr.h:44
Optional< int > inputNumberOfChannels
Definition: IAgoraService.h:277
virtual rtm::IRtmService * createRtmService()=0
virtual agora_refptr< rtc::IFileUploaderService > createFileUploadService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
Definition: IAgoraService.h:74
AUDIO_PROFILE_TYPE
Definition: AgoraBase.h:2486
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenCaptureVideoTrack(agora_refptr< rtc::IScreenCapturer2 > screen)=0
bool enableAudioProcessor
Definition: IAgoraService.h:80
Definition: IAgoraRtmService.h:636
ERROR_CODE_TYPE
Definition: AgoraBase.h:449
AUDIO_SCENARIO_TYPE
Definition: AgoraBase.h:2532
virtual ~IServiceObserver()
Definition: IAgoraService.h:336
Optional< bool > allowMixWithOthers
Definition: IAgoraService.h:227
Definition: IAgoraService.h:334
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaPlayerVideoTrack(agora_refptr< rtc::IMediaPlayerSource > videoSource, const char *id=OPTIONAL_NULLPTR)=0
virtual int setAudioSessionConfiguration(const AudioSessionConfiguration &config)=0
IServiceObserver * serviceObserver
Definition: IAgoraService.h:138
Optional< int > outputNumberOfChannels
Definition: IAgoraService.h:281
virtual agora_refptr< rtc::IRtmpStreamingService > createRtmpStreamingService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IMediaPacketSender > source, const char *id=OPTIONAL_NULLPTR)=0
void * context
Definition: IAgoraService.h:103
AudioEncoderConfiguration()
Definition: IAgoraService.h:57
Definition: NGIAgoraRtmpConnection.h:222
virtual agora_refptr< rtc::ILocalAudioTrack > createLocalAudioTrack()=0
AGORA_API agora::base::IAgoraService *AGORA_CALL createAgoraService()
virtual agora_refptr< rtc::ILocalVideoTrack > createMixedVideoTrack(agora_refptr< rtc::IVideoMixerSource > videoSource, const char *id=OPTIONAL_NULLPTR)=0
Optional< bool > allowBluetooth
Definition: IAgoraService.h:247
Definition: AgoraAtomicOps.h:21
virtual agora_refptr< rtc::ILocalAudioTrack > createMediaPlayerAudioTrack(agora_refptr< rtc::IMediaPlayerSource > audioSource)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioEncodedFrameSender > audioSource, TMixMode mixMode)=0
Optional< bool > playbackAndRecord
Definition: IAgoraService.h:191
TMixMode
Definition: IAgoraService.h:320
bool operator!=(const AudioSessionConfiguration &o) const
Definition: IAgoraService.h:307
virtual int setLogFile(const char *filePath, unsigned int fileSize)=0
@ MIX_ENABLED
Definition: IAgoraService.h:324
bool domainLimit
Definition: IAgoraService.h:157
bool enableVideo
Definition: IAgoraService.h:97
CHANNEL_PROFILE_TYPE
Definition: AgoraBase.h:264
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenCaptureVideoTrack(agora_refptr< rtc::IScreenCapturer > screen, const char *id=OPTIONAL_NULLPTR)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createScreenCaptureAudioTrack(agora_refptr< rtc::IScreenCapturer2 > screen)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createRecordingDeviceAudioTrack(agora_refptr< rtc::IRecordingDeviceSource > audioSource, bool enableAec)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IVideoEncodedImageSender > videoSource, const rtc::SenderOptions &options, const char *id=OPTIONAL_NULLPTR)=0
Definition: IAgoraService.h:178
virtual int initialize(const AgoraServiceConfiguration &config)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCameraVideoTrack(agora_refptr< rtc::ICameraCapturer > videoSource, const char *id=OPTIONAL_NULLPTR)=0
virtual int setLogFilter(unsigned int filters)=0
virtual int getAudioSessionConfiguration(AudioSessionConfiguration *config)=0
bool operator==(const AudioSessionConfiguration &o) const
Definition: IAgoraService.h:298
AgoraServiceConfiguration()
Definition: IAgoraService.h:159
virtual agora_refptr< rtc::IRtmpConnection > createRtmpConnection(const rtc::RtmpConnectionConfiguration &cfg)=0
virtual int removeExtensionObserver(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer)=0
virtual agora_refptr< rtc::IMediaNodeFactory > createMediaNodeFactory()=0
virtual agora_refptr< rtc::IAudioDeviceManager > createAudioDeviceManagerComponent(rtc::IAudioDeviceManagerObserver *observer)=0
virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType)
Definition: IAgoraService.h:342
@ AUDIO_PROFILE_DEFAULT
Definition: AgoraBase.h:2495
Definition: IAgoraLog.h:82
AUDIO_PROFILE_TYPE audioProfile
Definition: IAgoraService.h:55
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IMediaPacketSender > source)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createMediaStreamingAudioTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource)=0
@ MIX_DISABLED
Definition: IAgoraService.h:328
Optional< double > sampleRate
Definition: IAgoraService.h:266
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource, bool enableAec)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IVideoFrameSender > videoSource, const char *id=OPTIONAL_NULLPTR)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createDirectCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
Optional< rtc::THREAD_PRIORITY_TYPE > threadPriority
Definition: IAgoraService.h:143
Definition: NGIAgoraAudioDeviceManager.h:85
Definition: NGIAgoraRtcConnection.h:88
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IRemoteAudioMixerSource > audioSource)=0
PERMISSION_TYPE
Definition: AgoraBase.h:5467
virtual agora_refptr< rtc::IRtcConnection > createRtcConnection(const rtc::RtcConnectionConfiguration &cfg)=0
virtual int enableExtension(const char *provider_name, const char *extension_name, const char *track_id=NULL, bool auto_enable_on_track=false)=0
commons::LogConfig logConfig
Definition: IAgoraService.h:130
const char * license
Definition: IAgoraService.h:121
bool useStringUid
Definition: IAgoraService.h:134
Optional< double > ioBufferDuration
Definition: IAgoraService.h:273
virtual agora_refptr< rtc::IMediaRelayService > createMediaRelayService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario)=0
Optional< bool > allowDuckOthers
Definition: IAgoraService.h:236
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource, agora_refptr< rtc::IAudioPcmDataSender > audioReverseSource, int audioSourceDelay)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaStreamingVideoTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource, const char *id=OPTIONAL_NULLPTR)=0
Optional< bool > defaultToSpeaker
Definition: IAgoraService.h:209
rtc::AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraService.h:126
bool useExternalEglContext
Definition: IAgoraService.h:150
Definition: IAgoraService.h:51
void SetAll(const AudioSessionConfiguration &change)
Definition: IAgoraService.h:283
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
virtual int addExtensionObserver(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenVideoTrack(agora_refptr< rtc::IScreenCapturer > videoSource, const char *id=OPTIONAL_NULLPTR)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createTranscodedVideoTrack(agora_refptr< rtc::IVideoFrameTransceiver > transceiver, const char *id=OPTIONAL_NULLPTR)=0
virtual int loadExtensionProvider(const char *path, bool unload_after_use=false)=0
load the dynamic library of the extension
virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char *description)
Definition: IAgoraService.h:347
Optional< bool > overrideSpeaker
Definition: IAgoraService.h:218
virtual const char * getExtensionId(const char *provider_name, const char *extension_name)=0
Get the ID of the registered extension.
unsigned int areaCode
Definition: IAgoraService.h:112
virtual agora_refptr< rtc::INGAudioDeviceManager > createAudioDeviceManager()=0
Definition: video_node_i.h:25
agora::CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraService.h:116
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition: AgoraBase.h:276