io.agora.rtc.AgoraService类 参考

AgoraService 类。

AgoraService 是 SDK 的入口类，你可以通过 AgoraService 类创建媒体轨道和连接。

调用 AgoraService 创建 AgoraService 对象。

使用 AgoraServiceConfiguration 配置 AgoraService 对象。

构造及析构函数说明Copy Anchor Link

AgoraService()Copy Anchor Link

io.agora.rtc.AgoraService.AgoraService()

构造函数。

成员函数说明Copy Anchor Link

agoraRtcConnCreate()Copy Anchor Link

native AgoraRtcConn io.agora.rtc.AgoraService.agoraRtcConnCreate(RtcConnConfig rtc_conn_config)

创建一个 AgoraRtcConn 对象。

返回值

一个 AgoraRtcConn 对象。

createCustomAudioTrackEncoded()Copy Anchor Link

native AgoraLocalAudioTrack io.agora.rtc.AgoraService.createCustomAudioTrackEncoded(AgoraAudioEncodedFrameSender agora_audio_encoded_frame_sender, int mix_mode)

创建本地音频轨道对象，包含一个发送已编码音频数据的音频源。

该轨道对象可用于发送来已编码的音频数据，例如 Opus 编码格式的音频数据。

返回值

一个 AgoraLocalAudioTrack 对象。

createCustomAudioTrackPcm()Copy Anchor Link

native AgoraLocalAudioTrack io.agora.rtc.AgoraService.createCustomAudioTrackPcm(AgoraAudioPcmDataSender agora_audio_pcm_data_sender)

创建本地音频轨道对象，包含一个发送 PCM 音频数据的音频源。

该轨道对象可用于发送来 PCM 格式的音频数据。

返回值

一个 AgoraLocalAudioTrack 对象。

createCustomVideoTrackEncoded()Copy Anchor Link

native AgoraLocalVideoTrack io.agora.rtc.AgoraService.createCustomVideoTrackEncoded(AgoraVideoEncodedImageSender agora_video_encoded_image_sender, SenderOptions options)

创建本地视频轨道对象，包含一个发送编码视频数据的视频源。

该轨道对象可用于发送编码的视频数据，例如 H.264 或 VP8 格式的视频数据。

返回值

一个 AgoraVideoEncodedImageSender 对象。

createCustomVideoTrackFrame()Copy Anchor Link

native AgoraLocalVideoTrack io.agora.rtc.AgoraService.createCustomVideoTrackFrame(AgoraVideoFrameSender agora_video_frame_sender)

创建本地视频轨道对象，包含一个发送 YUV 格式视频数据的视频源。

该轨道对象可用于发送 YUV 格式视频数据。

返回值

一个 AgoraLocalVideoTrack 对象。

createLocalAudioTrack()Copy Anchor Link

native AgoraLocalAudioTrack io.agora.rtc.AgoraService.createLocalAudioTrack()

创建本地音频轨道对象。

默认情况下，SDK 是根据选定的音频输入设备，如移动设备的内置麦克风，来创建音频轨道。

返回值

一个 AgoraLocalAudioTrack 对象。

createMediaNodeFactory()Copy Anchor Link

native AgoraMediaNodeFactory io.agora.rtc.AgoraService.createMediaNodeFactory()

创建一个媒体节点工厂对象。

返回值

一个 AgoraMediaNodeFactory 对象。

destroy()Copy Anchor Link

void io.agora.rtc.AgoraService.destroy()

析构函数。

destroyAudioSessionConfig()Copy Anchor Link

native void io.agora.rtc.AgoraService.destroyAudioSessionConfig(AudioSessionConfig config)

getAgoraParameter()Copy Anchor Link

native AgoraParameter io.agora.rtc.AgoraService.getAgoraParameter()

获取 SDK 全局的 AgoraParameter 对象。

通过该方法获取的 AgoraParameter 对象，设置对 SDK 全局有效。如果仅需对某个 Connection 进行设置，改用 AgoraRtcConn.getAgoraParameter 方法。

返回值

• AgoraParameter 对象：方法调用成功。
• null：方法调用失败。

getAudioSessionConfig()Copy Anchor Link

native AudioSessionConfig io.agora.rtc.AgoraService.getAudioSessionConfig()

获取音效设置。

返回值

音效的设置。

initialize()Copy Anchor Link

native int io.agora.rtc.AgoraService.initialize(AgoraServiceConfig config)

初始化 AgoraService 对象。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。

setAudioSessionConfig()Copy Anchor Link

native int io.agora.rtc.AgoraService.setAudioSessionConfig(AudioSessionConfig config)

自定义音效设置。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。

setAudioSessionPreset()Copy Anchor Link

native int io.agora.rtc.AgoraService.setAudioSessionPreset(int audio_scenario)

设置预设音效。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。

setLogFile()Copy Anchor Link

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 的日志文件。如果日志文件的总大小超过所设置的值，旧的日志会被新的日志覆盖。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。

setLogFilter()Copy Anchor Link

native int io.agora.rtc.AgoraService.setLogFilter(int filters)

设置日志输出等级。

日志级别顺序依次为 OFF、CRITICAL、ERROR、WARNING、INFO 和 DEBUG。

选择一个级别，你就可以看到在该级别之前所有级别的日志信息。 例如，你选择 WARNING 级别，就可以看到在 CRITICAL、ERROR 和 WARNING 级别上的所有日志信息。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。

该类的文档由以下文件生成:

• AgoraService.java