更新时间:2024-01-25 GMT+08:00
分享

接口总览

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

HRtcEngine按照其功能可分类为:初始化等基础接口、房间功能、视频管理、屏幕共享、音频管理、音效文件播放管理、自定义视频采集和渲染、自定义音频采集和渲染、设备管理、检测功能、音频增强管理。

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

初始化等基础接口

表1 初始化等基础接口

接口

描述

create

创建SparkRTC引擎实例

destroy

销毁SparkRTC引擎

logUpload

上传日志

disableRejoinRoom

设置是否禁用房间重连功能。

enableStats

打点功能开关

getVersion

获取当前SDK版本号

setEncryption

设置端到端加密模式

setAccessResourceType

设置接入环境

setNetworkBandwidth

设置网络带宽限制

房间功能

表2 房间功能接口

接口

描述

joinRoom

加入房间

leaveRoom

离开房间

changeUserRole

设置用户角色

renewAuthorization

更新鉴权签名

changeUserName

更新用户昵称

createConnection

创建跨房(HRTCConnection)对象

addMultiRoomMediaRelay

添加单个跨房

removeMultiRoomMediaRelay

删除单个跨房

stopMultiRoomMediaRelay

停止所有跨房

音频管理

表3 音频管理接口

接口

描述

muteLocalAudio

设置是否发送本地音频流

muteRemoteAudio

设置是否接收对应远端用户的音频流

muteAllRemoteAudio

设置是否接收所有远端用户的音频流

enableLocalAudioStream

设置是否开启音频采集

adjustRecordingVolume

调整录制音量

adjustPlaybackVolume

调整播放音量

adjustPlaybackVolume

调整单个用户播放音量

sendAudioSeiMsg

发送音频SEI

setAudioFrameRecordParameters

设置音频采集回调参数

setAudioConfig

设置音频场景

视频管理

表4 视频管理接口

接口

描述

createRenderer

创建渲染视图

updateLocalRenderMode

设置本地窗口显示模式,镜像模式

setupLocalView

设置本地窗口

pushLocalVideo

设置是否发送本地视频流

setVideoEncoderConfig

设置视频编码参数

setNonStandardVideoEncoder

设置非标视频编码参数

setRemoteVideoAdjustResolution

设置订阅视频流的分辨率自适应

startLocalPreview

开始本地预览

stopLocalPreview

停止本地预览

startRemoteStreamView

开始订阅远端视频流

stopRemoteStreamView

停止订阅远端视频流

setupRemoteView

设置远端窗口视图

updateRemoteRenderMode

设置远端窗口渲染模式,镜像模式

pullRemoteVideo

设置是否接收对应远端用户的视频流

pullAllRemoteVideo

设置是否接收所有远端用户的视频流

setVideoEncoderMirror

设置视频编码镜像模式

enableLocalVideo

设置是否开启摄像头采集视频

enableVideoSuperResolution

设置是否开启视频超分

enableSmallVideoStream

开启并设置小流编码参数

setPriorRemoteVideoStreamType

设置默认订阅的视频流类型(大流还是小流)

setRemoteVideoStreamType

设置当前订阅的视频流类型

startPublishStream

开始旁路推流

updateTransCoding

更新旁路推流

stopPublishStream

停止旁路推流

startAllRemoteView

批量设置远端流视图

屏幕共享

表5 屏幕共享接口

接口

描述

startScreenShare

开启屏幕共享

stopScreenShare

关闭屏幕共享

辅流管理

表6 辅流管理接口

接口

描述

setAuxiliaryVideoEncodeSmooth

设置是否开启辅流的流畅度优先。

startRemoteAuxiliaryStreamView

开始订阅辅流

stopRemoteAuxiliaryStreamView

停止订阅辅流

setRemoteAuxiliaryStreamViewRotation

设置辅流角度

updateRemoteAuxiliaryStreamRenderMode

设置辅流渲染模式,镜像模式

setAuxiliaryVideoEncoderConfig

设置辅流编码参数

setAuxExternalVideoCapture

设置是否开启视频辅流外部采集

音效文件播放管理

表7 音效文件播放管理接口

接口

描述

startAudioFile

开始播放音频文件

stopAudioFile

停止播放音频文件

pauseAudioFile

暂停播放音频文件

resumeAudioFile

恢复播放音频文件

isPlayMixMyself

是否只有本地可以听到混音

isMixWithMicrophone

是否需要替代采集

adjustAudioFileVolume

调整本地和远端音频播放的音量

adjustAudioFilePlayoutVolume

调整本地音频播放的音量

adjustAudioFilePublishVolume

调整远端音频播放的音量

getAudioFileVolume

获取音频播放的音量

getAudioFilePlayoutVolume

获取音频本地播放的音量

getAudioFilePublishVolume

获取音频远端播放的音量

getAudioFileDuration

获取音频文件的时长

getAudioFilePosition

获取音频文件当前播放位置

setAudioFilePosition

设置音频文件播放位置

playAudioClip

开始播放音效文件

stopAudioClip

停止播放音效文件

pauseAudioClip

暂停播放音效文件

resumeAudioClip

恢复播放音效文件

stopAllAudioClips

停止播放所有音效文件

pauseAllAudioClips

暂停播放所有音效文件

resumeAllAudioClips

恢复播放所有音效文件

setAudioClipsVolume

设置音效播放的最大音量

getAudioClipsVolume

获取音效播放的最大音量

setVolumeOfAudioClip

设置指定音效的播放音量

getVolumeOfAudioClip

获取指定音效的播放音量

setAudioClipPosition

设置指定音效文件的播放位置

getAudioClipCurrentPosition

获取指定音效文件当前的播放位置

getAudioClipDuration

获取音效的文件时长

preloadAudioClip

预加载音效文件

unloadAudioClip

删除预加载音效文件

音频增强管理

表8 音频增强接口

接口

描述

enableUserVolumeNotify

设置音量值上报回调函数onUserVolumeStatsNotify回调周期

检测功能

表9 检测功能接口

接口

描述

startNetworkTest

开启会前网络探测

stopNetworkTest

停止会前网络检测

自定义视频采集和渲染

表10 自定义视频采集和渲染接口

接口

描述

setExternalVideoFrameOutputEnable

设置视频数据输出使能

setExternalDataFrameOutputEnable

设置共享数据输出使能

setExternalVideoCapture

设置是否开启外部视频采集

pushExternalVideoFrame

输入外部视频数据

pushAuxExternalVideoFrame

辅流输入外部视频数据

自定义音频采集和渲染

表11 自定义音频采集和渲染接口

接口

描述

setExternalAudioFrameOutputEnable

设置音频数据输出使能

setExternalAudioCapture

设置是否开启外部音频采集

pushExternalAudioFrame

输入外部音频数据

设备管理

表12 设备管理接口

接口

描述

setCameraConfig

设置摄像头参数

switchCamera

切换摄像头

setSpeakerModel

设置声音播放模式

setDefaultSpeakerModel

设置默认的声音播放模式

setLayoutDirect

设置显示模式,区分横屏还是竖屏,用于保证摄像头方向与本地界面方向一致

isSpeakerphoneEnabled

查询是否启用扬声器

分享:

    相关文档

    相关产品