API 概览
- Python
更新时间不可用
AgoraService 类
| 方法 | 描述 |
|---|---|
| initialize | 初始化 AgoraService 对象。 |
| release | 释放 AgoraService 对象。 |
| create_rtc_connection | 创建一个 RTC 连接对象。 |
| create_custom_audio_track_pcm | 创建本地音频轨道对象，包含一个发送 PCM 音频数据的音频源。 |
| create_custom_audio_track_encoded | 创建本地音频轨道对象，包含一个发送编码音频数据的音频源。 |
| create_media_node_factory | 创建一个媒体节点工厂对象。 |
| create_custom_video_track_frame | 创建本地视频轨道对象，包含一个发送 YUV 格式视频数据的视频源。 |
| create_custom_video_track_encoded | 创建本地视频轨道对象，包含一个发送编码视频数据的视频源。 |
| set_log_file | 设置 SDK 日志文件的路径和大小。 |
RTCConnection 类
| 方法 | 描述 |
|---|---|
| connect | 连接 RTC 频道。 |
| disconnect | 与 RTC 频道断开连接。 |
| renew_token | 更新 Token。 |
| register_observer | 注册 RTC 连接 observer。 |
| unregister_observer | 销毁 RTC 连接 observer。 |
| create_data_stream | 创建数据流。 |
| send_stream_message | 发送数据流消息。 |
| get_agora_parameter | 获取 AgoraParameter 对象。 |
| get_local_user | 获取 LocalUser 对象。 |
| release | 释放 RTC 连接。 |
| enable_encryption | 开启加密功能。 |
IRTCConnectionObserver 类
| 回调 | 描述 |
|---|---|
| on_connected | SDK 与频道的连接状态变更为 3 时触发。 |
| on_disconnected | SDK 与频道的连接状态变更为 1 时触发。 |
| on_token_privilege_will_expire | Token 服务将在 30s 内过期回调。 |
| on_token_privilege_did_expire | Token 已过期回调。 |
| on_user_joined | 远端用户加入频道时触发。 |
| on_user_left | 远端用户离开频道时触发。 |
| on_stream_message_error | 接收数据流消息发生错误的回调。 |
| on_error | 发生错误回调。 |
| on_encryption_error | 加密功能发生错误回调。 |
LocalUser 类
LocalUserObserver 类
| 回调 | 描述 |
|---|---|
| on_local_audio_track_state_changed | 在本地音频轨道状态变化时触发。 |
| on_user_audio_track_state_changed | 在远端音频轨道状态变化时触发。 |
| on_stream_message | 接收到数据流消息的回调。 |
| on_audio_meta_data_received | 接收到对方音频 Metadata 数据的回调。 |
| on_user_info_updated | 用户媒体信息更新时触发。 |
LocalAudioTrack 类
| 方法 | 描述 |
|---|---|
| set_enabled | 开启或关闭本地音频轨道。 |
| adjust_publish_volume | 调整音频发布音量。 |
| set_max_buffer_audio_frame_number | 设置音频发送缓冲区的最大容量。 |
| clear_sender_buffer | 清除当前音频发送缓冲区。 |
| set_send_delay_ms | 设置音频发送缓冲区允许发送的最小数据时长。 |
| release | 释放本地音频轨道资源。 |
LocalVideoTrack 类
| 方法 | 描述 |
|---|---|
| set_enabled | 开启或关闭本地视频轨道。 |
| set_video_encoder_configuration | 设置视频编码属性。 |
MediaNodeFactory 类
| 方法 | 描述 |
|---|---|
| create_audio_pcm_data_sender | 创建一个 PCM 数据发送模块。 |
| create_audio_encoded_frame_sender | 创建一个已编码音频数据发送模块。 |
| create_video_frame_sender | 创建一个 YUV 视频帧发送模块。 |
| create_video_encoded_image_sender | 创建一个已编码视频发送模块。 |
| release | 释放 MediaNodeFactory 对象。 |
AudioPcmDataSender 类
| 方法 | 描述 |
|---|---|
| send_audio_pcm_data | 将 PCM 格式的音频数据发送到本地音频轨道。 |
AudioEncodedFrameSender 类
| 方法 | 描述 |
|---|---|
| send_encoded_audio_frame | 将已编码的音频帧发送到本地音频轨道。 |
IAudioFrameObserver 类
| 回调 | 描述 |
|---|---|
| on_playback_audio_frame_before_mixing | 获得播放声音混音前的数据。 |
VideoFrameSender 类
| 方法 | 描述 |
|---|---|
| send_video_frame | 将 YUV 格式的视频帧发送到视频轨道。 |
IVideoFrameObserver 类
| 回调 | 描述 |
|---|---|
| on_frame | 每次收到视频帧时触发。 |
VideoEncodedImageSender 类
| 方法 | 描述 |
|---|---|
| send_encoded_video_image | 将已编码的视频帧发送到视频轨道。 |
IVideoEncodedFrameObserver 类
| 回调 | 描述 |
|---|---|
| on_encoded_video_frame | 每次 SDK 收到已编码视频帧时触发。 |