实时音视频 SparkRTC-接口总览

时间:2023-11-01 16:15:39

接口总览

本章节介绍了Android SDK的HRTCConnection接口详情。

HRTCConnection按照其功能可分类为:初始化等基础接口、房间功能、音频管理、视频管理、屏幕共享。

单击下图中相应接口名称,可快速跳转到相应接口位置查看其使用方法。

表1 初始化等基础接口

接口

描述

release

释放Connection

setEncryption

设置端到端加密模式

setNetworkBandwidth

设置网络带宽限制

表2 房间功能接口

接口

描述

joinRoom

加入房间

leaveRoom

离开房间

getRoomId

获取房间id

renewAuthorization

更新签名

changeUserRole

切换角色

changeUserName

修改用户昵称

表3 视频管理接口

接口

描述

setPriorRemoteVideoStreamType

设置优先选看档位

pullRemoteVideo

订阅或取消订阅远端用户

setupRemoteView

设置远端用户窗口

startRemoteStreamView

按档位选看远端用户,并设置用户窗口

stopRemoteStreamView

取消订阅远端用户,并清除此用户的窗口

pullAllRemoteVideo

订阅或取消订阅全部远端用户,对未入会用户也有影响

setRemoteVideoStreamType

切换用户指定档位的视频

updateRemoteRenderMode

设置远端视频渲染模式,镜像模式

setRemoteVideoAdjustResolution

远端流自动调整分辨率开关

startAllRemoteView

批量设置远端流视图

表4 音频管理接口

接口

描述

muteRemoteAudio

远端用户静音开关

muteAllRemoteAudio

所有远端用户静音开关

adjustPlaybackVolume

调整单个用户播放音量

表5 自定义渲染接口

接口

描述

setExternalAudioFrameOutputEnable

音频流第三方播放开关(音频自渲染)

setExternalVideoFrameOutputEnable

视频流第三方渲染开关(视频自渲染)

setExternalDataFrameOutputEnable

辅流第三方渲染开关(辅流自渲染)

表6 辅流管理接口

接口

描述

startRemoteAuxiliaryStreamView

订阅远端用户辅流,并设置窗口

stopRemoteAuxiliaryStreamView

取消订阅远端用户辅流,并清除用户窗口

updateRemoteAuxiliaryStreamRenderMode

设置辅流渲染填充方式,镜像模式

setRemoteAuxiliaryStreamViewRotation

设置辅流旋转角度

support.huaweicloud.com/csdk-rtc/rtc_05_0185.html