|
virtual int | initialize (const AgoraServiceConfiguration &config)=0 |
|
virtual void | atExit ()=0 |
|
virtual int | release ()=0 |
|
virtual int | setAudioSessionPreset (agora::rtc::AUDIO_SCENARIO_TYPE scenario)=0 |
|
virtual int | setAudioSessionConfiguration (const AudioSessionConfiguration &config)=0 |
|
virtual int | getAudioSessionConfiguration (AudioSessionConfiguration *config)=0 |
|
virtual int | setLogFile (const char *filePath, unsigned int fileSize)=0 |
|
virtual int | setLogFilter (unsigned int filters)=0 |
|
virtual agora_refptr< rtc::IRtcConnection > | createRtcConnection (const rtc::RtcConnectionConfiguration &cfg)=0 |
|
virtual agora_refptr< rtc::IRtmpConnection > | createRtmpConnection (const rtc::RtmpConnectionConfiguration &cfg)=0 |
|
virtual agora_refptr< rtc::ILocalAudioTrack > | createLocalAudioTrack ()=0 |
|
virtual agora_refptr< rtc::ILocalAudioTrack > | createCustomAudioTrack (agora_refptr< rtc::IAudioPcmDataSender > audioSource)=0 |
|
virtual agora_refptr< rtc::ILocalAudioTrack > | createCustomAudioTrack (agora_refptr< rtc::IAudioPcmDataSender > audioSource, bool enableAec)=0 |
|
virtual agora_refptr< rtc::ILocalAudioTrack > | createCustomAudioTrack (agora_refptr< rtc::IRemoteAudioMixerSource > audioSource)=0 |
|
virtual agora_refptr< rtc::ILocalAudioTrack > | createCustomAudioTrack (agora_refptr< rtc::IAudioEncodedFrameSender > audioSource, TMixMode mixMode)=0 |
|
virtual agora_refptr< rtc::ILocalAudioTrack > | createCustomAudioTrack (agora_refptr< rtc::IMediaPacketSender > source)=0 |
|
virtual agora_refptr< rtc::ILocalAudioTrack > | createMediaPlayerAudioTrack (agora_refptr< rtc::IMediaPlayerSource > audioSource)=0 |
|
virtual agora_refptr< rtc::ILocalAudioTrack > | createMediaStreamingAudioTrack (agora_refptr< rtc::IMediaStreamingSource > streamingSource)=0 |
|
virtual agora_refptr< rtc::ILocalAudioTrack > | createRecordingDeviceAudioTrack (agora_refptr< rtc::IRecordingDeviceSource > audioSource, bool enableAec)=0 |
|
virtual agora_refptr< rtc::INGAudioDeviceManager > | createAudioDeviceManager ()=0 |
|
virtual agora_refptr< rtc::IMediaNodeFactory > | createMediaNodeFactory ()=0 |
|
virtual agora_refptr< rtc::ILocalVideoTrack > | createCameraVideoTrack (agora_refptr< rtc::ICameraCapturer > videoSource)=0 |
|
virtual agora_refptr< rtc::ILocalVideoTrack > | createScreenVideoTrack (agora_refptr< rtc::IScreenCapturer > videoSource)=0 |
|
virtual agora_refptr< rtc::ILocalVideoTrack > | createMixedVideoTrack (agora_refptr< rtc::IVideoMixerSource > videoSource)=0 |
|
virtual agora_refptr< rtc::ILocalVideoTrack > | createTranscodedVideoTrack (agora_refptr< rtc::IVideoFrameTransceiver > transceiver)=0 |
|
virtual agora_refptr< rtc::ILocalVideoTrack > | createCustomVideoTrack (agora_refptr< rtc::IVideoFrameSender > videoSource)=0 |
|
virtual agora_refptr< rtc::ILocalVideoTrack > | createCustomVideoTrack (agora_refptr< rtc::IVideoEncodedImageSender > videoSource, SenderOptions &options)=0 |
|
virtual agora_refptr< rtc::ILocalVideoTrack > | createCustomVideoTrack (agora_refptr< rtc::IMediaPacketSender > source)=0 |
|
virtual agora_refptr< rtc::ILocalVideoTrack > | createMediaPlayerVideoTrack (agora_refptr< rtc::IMediaPlayerSource > videoSource)=0 |
|
virtual agora_refptr< rtc::ILocalVideoTrack > | createMediaStreamingVideoTrack (agora_refptr< rtc::IMediaStreamingSource > streamingSource)=0 |
|
virtual agora_refptr< rtc::IRtmpStreamingService > | createRtmpStreamingService (agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0 |
|
virtual agora_refptr< rtc::IMediaRelayService > | createMediaRelayService (agora_refptr< rtc::IRtcConnection > rtcConnection, const char *appId)=0 |
|
virtual rtm::IRtmService * | createRtmService ()=0 |
|
virtual int | addExtensionObserver (agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer)=0 |
|
virtual int | removeExtensionObserver (agora::agora_refptr< agora::rtc::IMediaExtensionObserver > observer)=0 |
|
virtual agora_refptr< rtc::IAudioDeviceManager > | createAudioDeviceManagerComponent (rtc::IAudioDeviceManagerObserver *observer)=0 |
|
virtual const char * | getExtensionId (const char *provider_name, const char *extension_name)=0 |
|
virtual int | loadExtensionProvider (const char *extension_lib_path)=0 |
|
virtual int | enableExtension (const char *provider_name, const char *extension_name, const char *track_id=NULL, bool auto_enable_on_track=false)=0 |
|
virtual int | disableExtension (const char *provider_name, const char *extension_name, const char *track_id=NULL)=0 |
|
The IAgoraService class.
IAgoraService
is the entry point of Agora low-level APIs. Use this interface to create access points to Agora interfaces, including RTC connections and media tracks.
You can create an IAgoraService
object by calling createAgoraService.
You can configure the IAgoraService
object for different user scenarios on the global level by using AgoraServiceConfiguration
.
virtual int agora::base::IAgoraService::setLogFile |
( |
const char * |
filePath, |
|
|
unsigned int |
fileSize |
|
) |
| |
|
pure virtual |
Sets the path and size of the SDK log files.
The SDK records all the log data during the SDK runtime in two log files, each with a default size of 512 KB. If you set fileSize
as 1024 KB, the SDK outputs log files with a maximum size of 2 MB. If the total size of the log files exceeds the set value, the new output log overwrites the old output log.
- Note
- To ensure that the output log is complete, call this method immediately after calling initialize.
- Parameters
-
filePath | The pointer to the log file. Ensure that the directory of the log file exists and is writable. |
fileSize | The size of the SDK log file size (KB). |
- Returns
- 0: Success.
- < 0: Failure.
virtual int agora::base::IAgoraService::setLogFilter |
( |
unsigned int |
filters | ) |
|
|
pure virtual |
Sets the SDK log output filter.
The log level follows the sequence of OFF, CRITICAL, ERROR, WARNING, INFO, and DEBUG.
Select a level to output the logs in and above the selected level. For example, if you set the log level to WARNING, you can see the logs in the levels of CRITICAL, ERROR, and WARNING.
- Parameters
-
filters | The log output filter.
LOG_LEVEL_NONE (0x0000) : Do not output any log file.
LOG_LEVEL_INFO (0x0001) : (Recommended) Output log files of the INFO level.
LOG_LEVEL_WARN (0x0002) : Output log files of the WARN level.
LOG_LEVEL_ERROR (0x0004) : Output log files of the ERROR level.
LOG_LEVEL_FATAL (0x0008) : Output log files of the FATAL level.
|
- Returns
- 0: Success.
- < 0: Failure.