io.agora.rtc.AgoraService类 参考
AgoraService 类。
AgoraService 是 SDK 的入口类，你可以通过 AgoraService 类创建媒体轨道和连接。
调用 AgoraService 创建 AgoraService 对象。
使用 AgoraServiceConfiguration 配置 AgoraService 对象。
构造及析构函数说明
AgoraService()
| io.agora.rtc.AgoraService.AgoraService | ( | ) |
构造函数。
成员函数说明
agoraRtcConnCreate()
| native AgoraRtcConn io.agora.rtc.AgoraService.agoraRtcConnCreate | ( | RtcConnConfig | rtc_conn_config | ) |
创建一个 AgoraRtcConn 对象。
参数
| 参数名 | 描述 |
|---|---|
rtc_conn_config | 连接设置。 |
返回值
AgoraRtcConn 对象。createCustomAudioTrackEncoded()
| native AgoraLocalAudioTrack io.agora.rtc.AgoraService.createCustomAudioTrackEncoded | ( | AgoraAudioEncodedFrameSender | agora_audio_encoded_frame_sender, |
| int | mix_mode | ||
| ) |
创建本地音频轨道对象，包含一个发送已编码音频数据的音频源。
该轨道对象可用于发送来已编码的音频数据，例如 Opus 编码格式的音频数据。
参数
| 参数名 | 描述 |
|---|---|
agora_audio_encoded_frame_sender | 发送已编码的音频数据的音频源，详见 AgoraAudioEncodedFrameSender。 |
mix_mode | 已编码音频数据的混音模式。 |
返回值
AgoraLocalAudioTrack 对象。createCustomAudioTrackPcm()
| native AgoraLocalAudioTrack io.agora.rtc.AgoraService.createCustomAudioTrackPcm | ( | AgoraAudioPcmDataSender | agora_audio_pcm_data_sender | ) |
创建本地音频轨道对象，包含一个发送 PCM 音频数据的音频源。
该轨道对象可用于发送来 PCM 格式的音频数据。
参数
| 参数名 | 描述 |
|---|---|
agora_audio_pcm_data_sender | 发送 PCM 格式音频数据的音频源。 |
返回值
AgoraLocalAudioTrack 对象。createCustomVideoTrackEncoded()
| native AgoraLocalVideoTrack io.agora.rtc.AgoraService.createCustomVideoTrackEncoded | ( | AgoraVideoEncodedImageSender | agora_video_encoded_image_sender, |
| SenderOptions | options | ||
| ) |
创建本地视频轨道对象，包含一个发送编码视频数据的视频源。
该轨道对象可用于发送编码的视频数据，例如 H.264 或 VP8 格式的视频数据。
参数
| 参数名 | 描述 |
|---|---|
agora_video_encoded_image_sender | 发送编码视频数据的视频源。 |
options | 视频轨道设置。 |
返回值
AgoraVideoEncodedImageSender 对象。createCustomVideoTrackFrame()
| native AgoraLocalVideoTrack io.agora.rtc.AgoraService.createCustomVideoTrackFrame | ( | AgoraVideoFrameSender | agora_video_frame_sender | ) |
创建本地视频轨道对象，包含一个发送 YUV 格式视频数据的视频源。
该轨道对象可用于发送 YUV 格式视频数据。
参数
| 参数名 | 描述 |
|---|---|
agora_video_frame_sender | 发送 YUV 格式视频数据的视频源。 |
返回值
AgoraLocalVideoTrack 对象。createLocalAudioTrack()
| native AgoraLocalAudioTrack io.agora.rtc.AgoraService.createLocalAudioTrack | ( | ) |
创建本地音频轨道对象。
默认情况下，SDK 是根据选定的音频输入设备，如移动设备的内置麦克风，来创建音频轨道。
返回值
AgoraLocalAudioTrack 对象。createMediaNodeFactory()
| native AgoraMediaNodeFactory io.agora.rtc.AgoraService.createMediaNodeFactory | ( | ) |
创建一个媒体节点工厂对象。
返回值
AgoraMediaNodeFactory 对象。destroy()
| void io.agora.rtc.AgoraService.destroy | ( | ) |
析构函数。
destroyAudioSessionConfig()
| native void io.agora.rtc.AgoraService.destroyAudioSessionConfig | ( | AudioSessionConfig | config | ) |
getAgoraParameter()
| native AgoraParameter io.agora.rtc.AgoraService.getAgoraParameter | ( | ) |
获取 SDK 全局的 AgoraParameter 对象。
通过该方法获取的 AgoraParameter 对象，设置对 SDK 全局有效。如果仅需对某个 Connection 进行设置，改用 AgoraRtcConn.getAgoraParameter 方法。
返回值
AgoraParameter对象：方法调用成功。null：方法调用失败。
getAudioSessionConfig()
initialize()
| native int io.agora.rtc.AgoraService.initialize | ( | AgoraServiceConfig | config | ) |
初始化 AgoraService 对象。
参数
| 参数名 | 描述 |
|---|---|
config | 初始化配置。详见 AgoraServiceConfig。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setAudioSessionConfig()
setAudioSessionPreset()
setLogFile()
| native int io.agora.rtc.AgoraService.setLogFile | ( | String | file_path, |
| int | file_size | ||
| ) |
设置 SDK 日志文件的路径和大小。
默认情况下，SDK 会生成 2 个 SDK 日志文件，每个 SDK 日志文件的默认大小为 512 KB。如果你将 file_size 设为 1024 KB， SDK 会最多输出总计 2 MB 的日志文件。如果日志文件的总大小超过所设置的值，旧的日志会被新的日志覆盖。
参数
| 参数名 | 描述 |
|---|---|
file_path | 指向日志文件的指针。请确保指定的目录存在而且可写。 |
file_size | SDK 日志文件的大小（KB）。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
setLogFilter()
| native int io.agora.rtc.AgoraService.setLogFilter | ( | int | filters | ) |
设置日志输出等级。
日志级别顺序依次为 OFF、CRITICAL、ERROR、WARNING、INFO 和 DEBUG。
选择一个级别，你就可以看到在该级别之前所有级别的日志信息。 例如，你选择 WARNING 级别，就可以看到在 CRITICAL、ERROR 和 WARNING 级别上的所有日志信息。
参数
| 参数名 | 描述 |
|---|---|
filters | 日志输出等级：
|
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。