AgoraService 类
- Python
更新时间不可用
AgoraService 类。作为 SDK 的入口类，你可以通过 AgoraService 类创建媒体轨道和连接。
initialize
def initialize(self, config: AgoraServiceConfig)AgoraService 对象。
参数
| 参数 | 描述 |
|---|---|
config | 初始化配置。详见 AgoraServiceConfig。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。
release
def release(self)AgoraService 对象。
注意
release 需要在非回调内的子线程调用，避免在回调中执行。
create_rtc_connection
def create_rtc_connection(self, con_config: RTCConnConfig)注意
如需创建多个 Connection，声网推荐使用多进程的方式，以避免内存泄露等问题。
参数
| 参数 | 描述 |
|---|---|
con_config | RTC 连接配置。详见 RTCConnConfig。 |
返回值
RTCConnection对象: 方法调用成功。None: 方法调用失败。
create_custom_audio_track_pcm
def create_custom_audio_track_pcm(self, audio_pcm_data_sender: AudioPcmDataSender)参数
| 参数 | 描述 |
|---|---|
audio_pcm_data_sender | PCM 格式的音频数据源。详见 AudioPcmDataSender。 |
返回值
LocalAudioTrack对象: 方法调用成功。None: 方法调用失败。
create_custom_audio_track_encoded
def create_custom_audio_track_encoded(self, audio_encoded_frame_sender: AudioEncodedFrameSender, mix_mode: int)参数
| 参数 | 描述 |
|---|---|
audio_encoded_frame_sender | 发送编码音频数据的音频源。详见 AudioEncodedFrameSender。 |
mix_mode | 已编码的音频在频道中的混音模式。
|
返回值
LocalAudioTrack对象: 方法调用成功。None: 方法调用失败。
create_media_node_factory
def create_media_node_factory(self)返回值
MediaNodeFactory对象: 方法调用成功。None: 方法调用失败。
create_custom_video_track_frame
def create_custom_video_track_frame(self, video_frame_sender: VideoFrameSender)参数
| 参数 | 描述 |
|---|---|
video_frame_sender | YUV 格式视频源对象。详见 VideoFrameSender。 |
返回值
LocalVideoTrack对象: 方法调用成功。None: 方法调用失败。
create_custom_video_track_encoded
def create_custom_video_track_encoded(self, video_encoded_frame_sender: VideoEncodedImageSender, options: SenderOptions)参数
| 参数 | 描述 |
|---|---|
video_encoded_frame_sender | 发送编码视频数据的视频源。详见 VideoEncodedImageSender。 |
options | 视频轨道设置。详见 SenderOptions。 |
返回值
LocalVideoTrack对象: 方法调用成功。None: 方法调用失败。
set_log_file
def set_log_file(self, log_path: str, log_size: int = 512 * 1024)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 相同。
参数
| 参数 | 描述 |
|---|---|
log_path | 日志文件的完整路径。该日志文件为 UTF-8 编码。 |
log_size | 单个 agorasdk.log 日志文件的大小，单位为 KB，取值范围为 [128,20480]，默认值为 1,024 KB。 如果你将 file_size 设为小于 128 KB，SDK 会自动调整到 128 KB；如果你将 file_size 设为大于 20,480 KB，SDK 会自动调整到 20,480 KB。 |
返回值
- 0: 方法调用成功。
- < 0: 方法调用失败。