# agora::base::IAgoraService类 参考 (/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1base-1-1-i-agora-service)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## 详细描述 [#详细描述]
[`IAgoraService`](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1base-1-1-i-agora-service) 类。作为 SDK 的入口类,你可以通过 [`IAgoraService`](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1base-1-1-i-agora-service) 类创建媒体轨道和连接。
调用 [createAgoraService](/zh-CN/api-reference/rtc-server-sdk/cpp/group-create-agora-service) 创建 [`IAgoraService`](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1base-1-1-i-agora-service) 对象。
使用 [AgoraServiceConfiguration](/zh-CN/api-reference/rtc-server-sdk/cpp/structagora-1-1base-1-1-agora-service-configuration) 配置 [`IAgoraService`](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1base-1-1-i-agora-service) 对象。
## 构造及析构函数说明 [#构造及析构函数说明]
### ~IAgoraService() [#iagoraservice]
virtual agora::base::IAgoraService::~IAgoraService()
## 成员函数说明 [#成员函数说明]
### initialize() [#initialize]
virtual int agora::base::IAgoraService::initialize(const [AgoraServiceConfiguration](/zh-CN/api-reference/rtc-server-sdk/cpp/structagora-1-1base-1-1-agora-service-configuration) & *config*)
初始化 [IAgoraService](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1base-1-1-i-agora-service) 对象。
初始化配置。 详见 [AgoraServiceConfiguration](/zh-CN/api-reference/rtc-server-sdk/cpp/structagora-1-1base-1-1-agora-service-configuration)。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
### release() [#release]
virtual int agora::base::IAgoraService::release()
释放 [IAgoraService](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1base-1-1-i-agora-service) 对象。
:::info[注解]
该方法需要在非回调内的子线程调用,避免在回调中执行。
:::
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
### setAudioSessionPreset() [#setaudiosessionpreset]
virtual int agora::base::IAgoraService::setAudioSessionPreset([agora::rtc::AUDIO_SCENARIO_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a2c5708461a9e1568bbda636d95055533) *scenario*, aosl_ref_t *ares* = `AOSL_REF_INVALID`)
设置预设音效。
预设音效场景: [AUDIO_SCENARIO_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1rtc#a2c5708461a9e1568bbda636d95055533)。
用于 SDK 的生命周期保护,填写默认值即可。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
### setLogFile() [#setlogfile]
virtual int agora::base::IAgoraService::setLogFile(const char * *filePath*, unsigned int *fileSize*, aosl_ref_t *ares* = `AOSL_REF_INVALID`)
设置 SDK 日志文件的路径和大小。
默认情况下,SDK 会生成 5 个 SDK 日志文件和 5 个 API 调用日志文件,规则如下:
- SDK 日志文件的名称分别为:`agorasdk.log`、`agorasdk.1.log`、`agorasdk.2.log`、`agorasdk.3.log`、`agorasdk.4.log`。
- API 调用日志文件的名称分别为:`agoraapi.log`、`agoraapi.1.log`、`agoraapi.2.log`、`agoraapi.3.log`、`agoraapi.4.log`。
- 每个 SDK 日志文件的默认大小为 1,024 KB;API 调用日志文件的默认大小为 2,048 KB。日志文件均为 UTF-8 编码。
- 最新的日志永远写在 `agorasdk.log` 和 `agoraapi.log` 中。 当 `agorasdk.log` 写满后,SDK 会按照以下顺序对日志文件进行操作:
- 删除 `agorasdk.4.log` 文件(如有)。
- 将 `agorasdk.3.log` 重命名为 `agorasdk.4.log`。
- 将 `agorasdk.2.log` 重命名为 `agorasdk.3.log`。
- 将 `agorasdk.1.log` 重命名为 `agorasdk.2.log`。
- 新建 `agorasdk.log` 文件。 `agoraapi.log` 文件的覆盖规则与 `agorasdk.log` 相同。
日志文件的完整路径。该日志文件为 UTF-8 编码。
单个 `agorasdk.log` 日志文件的大小,单位为 KB,取值范围为 [128,20480],默认值为 1,024 KB。 如果你将 `fileSize` 设为小于 128 KB,SDK 会自动调整到 128 KB;如果你将 `fileSize` 设为大于 20,480 KB,SDK 会自动调整到 20,480 KB。
用于 SDK 的生命周期保护,填写默认值即可。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
### setLogFilter() [#setlogfilter]
virtual int agora::base::IAgoraService::setLogFilter(unsigned int *filters*, aosl_ref_t *ares* = `AOSL_REF_INVALID`)
设置日志输出等级。
该方法设置 SDK 的输出日志输出等级。不同的输出等级可以单独或组合使用。日志级别顺序依次为 OFF、CRITICAL、ERROR、WARNING、INFO 和 DEBUG。 选择一个级别,你就可以看到在该级别之前所有级别的日志信息。
例如,你选择 WARNING 级别,就可以看到在 CRITICAL、ERROR 和 WARNING 级别上的所有日志信息。
日志过滤等级。详见 [LOG_FILTER_TYPE](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1commons#ae089652ab7c76a97e26ff5b2c8cd17d9)。
用于 SDK 的生命周期保护,填写默认值即可。
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
### createRtcConnection() [#creatertcconnection]
virtual [agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)<[rtc::IRtcConnection](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtc-connection)> agora::base::IAgoraService::createRtcConnection(const [rtc::RtcConnectionConfiguration](/zh-CN/api-reference/rtc-server-sdk/cpp/structagora-1-1rtc-1-1-rtc-connection-configuration) & *cfg*)
创建一个 [RtcConnection](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtc-connection) 对象。
RTC 连接配置: [RtcConnectionConfiguration](/zh-CN/api-reference/rtc-server-sdk/cpp/structagora-1-1rtc-1-1-rtc-connection-configuration) 。
返回值
- [IRtcConnection](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtc-connection) 对象的指针:方法调用成功。
- 空指针:方法调用失败。
### createRtmpConnection() [#creatertmpconnection]
virtual [agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)<[rtc::IRtmpConnection](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtmp-connection)> agora::base::IAgoraService::createRtmpConnection(const [rtc::RtmpConnectionConfiguration](/zh-CN/api-reference/rtc-server-sdk/cpp/structagora-1-1rtc-1-1-rtmp-connection-configuration) & *cfg*)
创建一个 [IRtmpConnection](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtmp-connection) 对象。
CDN 连接配置: [RtmpConnectionConfiguration](/zh-CN/api-reference/rtc-server-sdk/cpp/structagora-1-1rtc-1-1-rtmp-connection-configuration)。
返回值
- [IRtmpConnection](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtmp-connection) 对象的指针:方法调用成功。
- 空指针:方法调用失败。
### createLocalAudioTrack() [#createlocalaudiotrack]
virtual [agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)<[rtc::ILocalAudioTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-audio-track)> agora::base::IAgoraService::createLocalAudioTrack()
创建本地音频轨道对象。
SDK 默认通过用户选中的音频输入设备创建本地音频轨道,例如手机的麦克风。
返回值
- [ILocalAudioTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-audio-track) 对象的指针:方法调用成功。
- 空指针:方法调用失败。
### createCustomAudioTrack() [1/2] [#createcustomaudiotrack-12]
virtual [agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)<[rtc::ILocalAudioTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-audio-track)> agora::base::IAgoraService::createCustomAudioTrack([agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)< [rtc::IAudioPcmDataSender](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-audio-pcm-data-sender) > *audioSource*)
创建本地音频轨道对象,包含一个发送 PCM 音频数据的音频源。
该轨道对象可用于发送来 PCM 格式的音频数据。
PCM 格式的音频数据源: [IAudioPcmDataSender](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-audio-pcm-data-sender)。
返回值
- [ILocalAudioTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-audio-track) 对象的指针:方法调用成功。
- 空指针:方法调用失败。
### createDirectCustomAudioTrack() [#createdirectcustomaudiotrack]
virtual [agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)<[rtc::ILocalAudioTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-audio-track)> agora::base::IAgoraService::createDirectCustomAudioTrack([agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)< [rtc::IAudioPcmDataSender](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-audio-pcm-data-sender) > *audioSource*)
创建本地音频轨道对象,包含一个发送 PCM 音频数据的音频源。
该轨道对象可用于发送来 PCM 格式的音频数据。音频数据不参与混音。
PCM 格式的音频数据源: [IAudioPcmDataSender](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-audio-pcm-data-sender)。
返回值
- [ILocalAudioTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-audio-track) 对象的指针:方法调用成功。
- 空指针:方法调用失败。
### createCustomAudioTrack() [2/2] [#createcustomaudiotrack-22]
virtual [agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)<[rtc::ILocalAudioTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-audio-track)> agora::base::IAgoraService::createCustomAudioTrack([agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)< [rtc::IAudioEncodedFrameSender](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-audio-encoded-frame-sender) > *audioSource*, [TMixMode](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1base#a0813f100ad4d2518f2e0d4e2144e8c87) *mixMode*, aosl_ref_t *ares* = `AOSL_REF_INVALID`)
创建本地音频轨道对象,包含一个发送编码音频数据的音频源。
该轨道对象可用于发送已编码的音频数据,例如 Opus 格式的编码数据。
发送编码音频数据的音频源: [IAudioEncoderFrameSender](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-audio-encoded-frame-sender)。
已编码的音频在频道中的混音模式: [TMixMode](/zh-CN/api-reference/rtc-server-sdk/cpp/namespaceagora-1-1base#a0813f100ad4d2518f2e0d4e2144e8c87) 。
用于 SDK 的生命周期保护,填写默认值即可。
返回值
- [ILocalAudioTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-audio-track) 对象的指针:方法调用成功。
- 空指针:方法调用失败。
### createMediaNodeFactory() [#createmedianodefactory]
virtual [agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)<[rtc::IMediaNodeFactory](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-media-node-factory)> agora::base::IAgoraService::createMediaNodeFactory()
创建一个媒体节点工厂对象。
返回值
- [IMediaNodeFactory](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-media-node-factory) 的指针: 方法调用成功。
- 空指针: 方法调用失败。
### createMixedVideoTrack() [#createmixedvideotrack]
virtual [agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)<[rtc::ILocalVideoTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-video-track)> agora::base::IAgoraService::createMixedVideoTrack([agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)< [rtc::IVideoMixerSource](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-video-mixer-source) > *videoSource*, const char * *id* = `OPTIONAL_NULLPTR`)
创建本地视频轨道对象,包含一个合图器。
创建之后,你可以将该轨道添加到合图器进行合图。
合图器: [IVideoMixerSource](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-video-mixer-source)。
流 ID。
返回值
- [ILocalVideoTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-video-track) 对象的指针: 方法调用成功。
- 空指针: 方法调用失败。
### createCustomVideoTrack() [1/2] [#createcustomvideotrack-12]
virtual [agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)<[rtc::ILocalVideoTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-video-track)> agora::base::IAgoraService::createCustomVideoTrack([agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)< [rtc::IVideoFrameSender](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-video-frame-sender) > *videoSource*, const char * *id* = `OPTIONAL_NULLPTR`)
创建本地视频轨道对象,包含一个发送 YUV 格式视频数据的视频源。
该轨道对象可用于发送 YUV 格式视频数据。
YUV 格式视频源对象 [IVideoFrameSender](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-video-frame-sender)。
视频轨道的频道 ID。
返回值
- [ILocalVideoTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-video-track) 对象的指针: 方法调用成功。
- 空指针: 方法调用失败。
### createCustomVideoTrack() [2/2] [#createcustomvideotrack-22]
virtual [agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)<[rtc::ILocalVideoTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-video-track)> agora::base::IAgoraService::createCustomVideoTrack([agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)< [rtc::IVideoEncodedImageSender](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-video-encoded-image-sender) > *videoSource*, const rtc::SenderOptions & *options*, const char * *id* = `OPTIONAL_NULLPTR`)
创建本地视频轨道对象,包含一个发送编码视频数据的视频源。
该轨道对象可用于发送已编码的视频数据,例如 H.264 或 VP8 格式的编码数据。
发送编码视频数据的视频源。详见 [IVideoEncodedImageSender](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-video-encoded-image-sender)。
视频轨道设置。
视频轨道的频道 ID。
返回值
- [ILocalVideoTrack](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-local-video-track) 对象的指针: 方法调用成功。
- 空指针: 方法调用失败。
### getAgoraParameter() [#getagoraparameter]
virtual [agora_refptr](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1agora-refptr)<[base::IAgoraParameter](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1base-1-1-i-agora-parameter)> agora::base::IAgoraService::getAgoraParameter()
获取 SDK 全局的 [IAgoraParameter](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1base-1-1-i-agora-parameter) 对象。
:::info[自从]
4.4.30
:::
通过该方法获取的 [`IAgoraParameter`](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1base-1-1-i-agora-parameter) 对象,设置对 SDK 全局有效。如果仅需对某个 Connection 进行设置,改用 [IRtcConnection::getAgoraParameter](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1rtc-1-1-i-rtc-connection#a44ce079c780ace4b8188d59ad68d96fb) 方法。
返回值
- [`IAgoraParameter`](/zh-CN/api-reference/rtc-server-sdk/cpp/classagora-1-1base-1-1-i-agora-parameter) 对象:方法调用成功。
- 空指针:方法调用失败。
### getNtpWallTimeInMs() [#getntpwalltimeinms]
virtual uint64_t agora::base::IAgoraService::getNtpWallTimeInMs()
获取当前 NTP 时间,返回 Unix 时间戳,单位为毫秒。
:::info[自从]
4.4.33
:::
返回值
当前 NTP 时间戳;NTP 时间不可用时返回 `0`。