Agora RTC Objective-C API Reference
Refactor
|
Go to the documentation of this file.
6 #pragma once // NOLINT(build/header_guard)
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 IAudioPcmDataSender;
28 class IAudioEncodedFrameSender;
29 class IVideoFrameSender;
30 class IVideoEncodedImageSender;
31 class IVideoSourceNode;
32 class IVideoMixerSource;
33 class IVideoFrameTransceiver;
34 class ILocalVideoTrack;
35 class IMediaNodeFactory;
36 class IRecordingDeviceSource;
37 class IRemoteAudioMixerSource;
38 class IRtmpStreamingService;
39 class IMediaPacketSender;
40 class IMediaRelayService;
41 class IAudioDeviceManager;
42 class IAudioDeviceManagerObserver;
44 class IMediaExtensionObserver;
45 class IExtensionProvider;
46 class IFileUploaderService;
67 class ISignalingEngine;
294 template <
typename T>
513 virtual int setLogFile(
const char* filePath,
unsigned int fileSize) = 0;
918 virtual const char*
getExtensionId(
const char* provider_name,
const char* extension_name) = 0;
920 #if defined (_WIN32) || (defined(__linux__) && !defined(__ANDROID__))
927 virtual int loadExtensionProvider(
const char* extension_lib_path) = 0;
943 const char* provider_name,
const char* extension_name,
const char* track_id = NULL,
944 bool auto_enable_on_track =
false) = 0;
957 const char* provider_name,
const char* extension_name,
const char* track_id = NULL) = 0;
bool useExternalEglContext
Definition: IAgoraService.h:153
virtual rtm::IRtmService * createRtmService()=0
@ CHANNEL_PROFILE_LIVE_BROADCASTING
Definition: AgoraBase.h:285
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IVideoFrameSender > videoSource)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createScreenVideoTrack(agora_refptr< rtc::IScreenCapturer > videoSource)=0
Definition: IAgoraService.h:434
ERROR_CODE_TYPE
Definition: AgoraBase.h:477
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioEncodedFrameSender > audioSource, TMixMode mixMode)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createMixedVideoTrack(agora_refptr< rtc::IVideoMixerSource > videoSource)=0
Optional< int > outputNumberOfChannels
Definition: IAgoraService.h:266
Optional< double > ioBufferDuration
Definition: IAgoraService.h:258
virtual agora_refptr< rtc::IFileUploaderService > createFileUploadService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createDirectCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
virtual agora_refptr< rtc::IRtmpStreamingService > createRtmpStreamingService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
Definition: AgoraRefPtr.h:44
Definition: IAgoraService.h:83
virtual ~IAgoraService()
Definition: IAgoraService.h:960
virtual int initialize(const AgoraServiceConfiguration &config)=0
@ MIX_DISABLED
Definition: IAgoraService.h:312
virtual int setAudioSessionConfiguration(const AudioSessionConfiguration &config)=0
Optional< bool > allowBluetoothA2DP
Definition: IAgoraService.h:244
Definition: IAgoraRtmService.h:638
Optional< bool > playbackAndRecord
Definition: IAgoraService.h:185
Optional< double > sampleRate
Definition: IAgoraService.h:251
const char * appId
Definition: IAgoraService.h:116
agora::CHANNEL_PROFILE_TYPE channelProfile
Definition: IAgoraService.h:125
rtc::VIDEO_CODEC_TYPE codecType
Definition: IAgoraService.h:339
Optional< bool > chatMode
Definition: IAgoraService.h:194
@ CC_ENABLED
Definition: IAgoraService.h:321
virtual agora_refptr< rtc::IAudioDeviceManager > createAudioDeviceManagerComponent(rtc::IAudioDeviceManagerObserver *observer)=0
Definition: IAgoraService.h:408
bool operator!=(const AudioSessionConfiguration &o) const
Definition: IAgoraService.h:291
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource, agora_refptr< rtc::IAudioPcmDataSender > audioReverseSource, int audioSourceDelay)=0
@ AUDIO_SCENARIO_DEFAULT
Definition: AgoraBase.h:2559
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaStreamingVideoTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource)=0
virtual const char * getExtensionId(const char *provider_name, const char *extension_name)=0
Get the ID of the registered extension.
TCcMode
Definition: IAgoraService.h:317
Definition: NGIAgoraRtmpConnection.h:213
Optional< bool > allowBluetooth
Definition: IAgoraService.h:232
AGORA_API agora::base::IAgoraService *AGORA_CALL createAgoraService()
bool enableAudioProcessor
Definition: IAgoraService.h:89
Optional< bool > defaultToSpeaker
Definition: IAgoraService.h:203
AudioEncoderConfiguration()
Definition: IAgoraService.h:61
Definition: AgoraAtomicOps.h:21
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IMediaPacketSender > source)=0
commons::LogConfig logConfig
Definition: IAgoraService.h:133
PERMISSION_TYPE
Definition: AgoraBase.h:5056
virtual int enableExtension(const char *provider_name, const char *extension_name, const char *track_id=NULL, bool auto_enable_on_track=false)=0
virtual agora_refptr< rtc::IRtmpConnection > createRtmpConnection(const rtc::RtmpConnectionConfiguration &cfg)=0
unsigned int areaCode
Definition: IAgoraService.h:121
IServiceObserver * serviceObserver
Definition: IAgoraService.h:141
Definition: IAgoraService.h:172
CHANNEL_PROFILE_TYPE
Definition: AgoraBase.h:273
AUDIO_PROFILE_TYPE audioProfile
Definition: IAgoraService.h:54
virtual int setAudioSessionPreset(agora::rtc::AUDIO_SCENARIO_TYPE scenario)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createTranscodedVideoTrack(agora_refptr< rtc::IVideoFrameTransceiver > transceiver)=0
virtual int getAudioSessionConfiguration(AudioSessionConfiguration *config)=0
#define AGORA_API
Definition: AgoraBase.h:60
VIDEO_CODEC_TYPE
Definition: AgoraBase.h:1481
virtual agora_refptr< rtc::IMediaRelayService > createMediaRelayService(agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0
virtual void onPermissionError(agora::rtc::PERMISSION_TYPE permissionType)
Definition: IAgoraService.h:416
bool enableAudioDevice
Definition: IAgoraService.h:100
virtual int setLogFilter(unsigned int filters)=0
void SetAll(AudioSessionConfiguration &change)
Definition: IAgoraService.h:268
virtual agora_refptr< rtc::ILocalAudioTrack > createMediaPlayerAudioTrack(agora_refptr< rtc::IMediaPlayerSource > audioSource)=0
Optional< int > inputNumberOfChannels
Definition: IAgoraService.h:262
virtual int addExtensionObserver(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer)=0
TCcMode ccMode
Definition: IAgoraService.h:335
Definition: IAgoraLog.h:84
virtual agora_refptr< rtc::ILocalAudioTrack > createRecordingDeviceAudioTrack(agora_refptr< rtc::IRecordingDeviceSource > audioSource, bool enableAec)=0
SenderOptions()
Definition: IAgoraService.h:399
AUDIO_SCENARIO_TYPE
Definition: AgoraBase.h:2555
virtual agora_refptr< rtc::IRtcConnection > createRtcConnection(const rtc::RtcConnectionConfiguration &cfg)=0
Optional< rtc::THREAD_PRIORITY_TYPE > threadPriority
Definition: IAgoraService.h:146
bool enableVideo
Definition: IAgoraService.h:106
Definition: NGIAgoraAudioDeviceManager.h:69
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource, bool enableAec)=0
virtual ~IServiceObserver()
Definition: IAgoraService.h:410
AgoraServiceConfiguration()
Definition: IAgoraService.h:155
Definition: NGIAgoraRtcConnection.h:107
virtual void onAudioDeviceError(ERROR_CODE_TYPE error, const char *description)
Definition: IAgoraService.h:421
@ VIDEO_CODEC_H264
Definition: AgoraBase.h:1490
@ MIX_ENABLED
Definition: IAgoraService.h:308
@ CC_DISABLED
Definition: IAgoraService.h:325
int targetBitrate
Definition: IAgoraService.h:397
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0
bool useStringUid
Definition: IAgoraService.h:137
Definition: IAgoraService.h:331
Definition: IAgoraService.h:50
virtual agora_refptr< rtc::ILocalAudioTrack > createCustomAudioTrack(agora_refptr< rtc::IRemoteAudioMixerSource > audioSource)=0
virtual int removeExtensionObserver(agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createMediaPlayerVideoTrack(agora_refptr< rtc::IMediaPlayerSource > videoSource)=0
bool operator==(const AudioSessionConfiguration &o) const
Definition: IAgoraService.h:282
virtual agora_refptr< rtc::ILocalVideoTrack > createCameraVideoTrack(agora_refptr< rtc::ICameraCapturer > videoSource)=0
AUDIO_PROFILE_TYPE
Definition: AgoraBase.h:2515
static void SetFrom(Optional< T > *s, const Optional< T > &o)
Definition: IAgoraService.h:295
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IVideoEncodedImageSender > videoSource, SenderOptions &options)=0
void * context
Definition: IAgoraService.h:112
virtual int setLogFile(const char *filePath, unsigned int fileSize)=0
virtual agora_refptr< rtc::ILocalVideoTrack > createCustomVideoTrack(agora_refptr< rtc::IMediaPacketSender > source)=0
virtual agora_refptr< rtc::ILocalAudioTrack > createLocalAudioTrack()=0
virtual int disableExtension(const char *provider_name, const char *extension_name, const char *track_id=NULL)=0
@ AREA_CODE_GLOB
Definition: AgoraBase.h:4644
#define AGORA_CALL
Definition: AgoraBase.h:61
Optional< bool > overrideSpeaker
Definition: IAgoraService.h:212
rtc::AUDIO_SCENARIO_TYPE audioScenario
Definition: IAgoraService.h:129
TMixMode
Definition: IAgoraService.h:304
virtual agora_refptr< rtc::ILocalAudioTrack > createMediaStreamingAudioTrack(agora_refptr< rtc::IMediaStreamingSource > streamingSource)=0
virtual agora_refptr< rtc::IMediaNodeFactory > createMediaNodeFactory()=0
Definition: AgoraBase.h:5160
virtual agora_refptr< rtc::INGAudioDeviceManager > createAudioDeviceManager()=0
Optional< bool > allowMixWithOthers
Definition: IAgoraService.h:221
@ AUDIO_PROFILE_DEFAULT
Definition: AgoraBase.h:2523