网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

接口总览

更新时间:2024-10-24 GMT+08:00
分享

本章节介绍了iOS/macOS SDK的HWRtcEngine接口详情。

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

说明:

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

初始化等基础接口

表1 初始化等基础接口

接口

描述

sharedEngine

创建连麦引擎实例

destroy

注销引擎

initWithConfig

初始化引擎配置信息

logUpload

上传日志

setEnableRtcStats

打点开关

getVersion

获取SDK版本号

setEncrytionParam

设置端到端加密模式

setAccessResourceType

设置接入的环境

setNetworkBandwidth

设置网络带宽限制

房间功能

表2 房间功能接口

接口

描述

joinRoom

加入房间

changeUserRole

设置用户的角色,切换角色时使用

renewAuthorization

签名更新

leaveRoom

离开房间

changeUserName

设置用户自己的昵称

createConnection

创建 跨房(HWRtcConnection)对象,跨房前需先创建连接

addMultiRoomMediaRelay

添加单个跨房

removeMultiRoomMediaRelay

删除单个跨房

stopMultiRoomMediaRelay

停止所有跨房

音频管理

表3 音频管理接口

接口

描述

muteLocalAudio

设置是否发送本地音频流

enableLocalAudioStream

设置是否开启麦克风采集音频

muteRemoteAudio

订阅或取消订阅远端某个用户音频流

muteAllRemoteAudio

订阅或取消订阅全部远端用户音频流

setVolumeNotifyInterval

设置最大音量上报频率

adjustRecordingVolume

设置麦克风采集的音量(0-100)

adjustPlaybackVolume

调整扬声器播放的音量(0-100)

setShareComputerSound

共享声音 (只支持macOS)

sendAudioSeiMsg

发送音频SEI消息

setDefaultSpeakerModel

设置默认的声音播放模式,在房间外调用

setAudioFrameRecordParameters

设置音频采集回调参数

setAudioConfig

设置音频场景

视频管理

表4 视频管理接口

接口

描述

enableLocalVideo

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

setVideoEncoderConfig

设置视频编码参数

enableSmallVideoStream

大小流模式设置是否开启小流并设置小流编码参数

startLocalPreview

开启本地预览

stopLocalPreview

关闭本地预览

setupLocalVideo

设置/取消本地预览视图

updateLocalRenderMode

设置本地视频显示模式和镜像模式

setupRemoteView

设置远端流视图

updateRemoteRenderMode

设置远端视图显示模式,镜像模式

setRemoteVideoStreamType

设置选看指定用户的大流或者小流

setPriorRemoteVideoStreamType

设置默认选看远端的大流或者小流

pushLocalVideo

设置是否发送本地视频流

pullRemoteVideo

订阅或取消订阅远端某个用户视频流

pullAllRemoteVideo

订阅或取消订阅全部远端用户视频流

startRemoteStreamView

设置远端用户渲染视图(发起选看-旧接口)

stopRemoteStreamView

关闭远端用户的渲染视图(停止选看)

setRemoteVideoAdjustResolution

设置远端下行视频流的分辨率自适应

setVideoEncoderMirror

设置视频编码镜像模式

startPublishStream

开始旁路推流

updateTransCoding

更新旁路推流

stopPublishStream

停止旁路推流

startAllRemoteView

批量设置远端流视图

appendLocalView

设置本地视频另一个窗口显示

appendRemoteView

设置远端视频另一个窗口显示

辅流管理

表5 辅流管理接口

接口

描述

startRemoteAuxiliaryStreamView

开启辅流渲染视图(发起辅流选看)

stopRemoteAuxiliaryStreamView

关闭辅流渲染视图(停止辅流选看)

updateRemoteAuxiliaryStreamRenderMode

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

setRemoteAuxiliaryStreamViewRotation

设置辅流视图角度

setAuxiliaryVideoEncoderConfig

设置辅流编码能力

setAuxiliaryVideoEncodeSmooth

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

pushAuxExternalVideoFrame

推送辅流数据

屏幕共享

表6 屏幕共享接口

接口

描述

startScreenShare

开启屏幕共享

startScreenShareWithAppGroup

根据AppGroup开启屏幕共享(只支持iOS)

stopScreenShare

关闭屏幕共享

getScreenShareSources

获取共享资源列表

setScreenShareTarget

设置共享对象

音效文件播放管理

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

接口

描述

startAudioFile

开始播放音频文件

stopAudioFile

停止播放音频文件

pauseAudioFile

暂停播放音频文件

resumeAudioFile

恢复播放音频文件

adjustAudioFileVolume

调节音频文件播放音量

adjustAudioFilePlayoutVolume

设置本地播放音频音量

getAudioFileVolume

获取音频文件播放音量

getAudioFilePlayoutVolume

获取音频文件本地播放音量

getAudioFileDuration

获取音频文件时长

getAudioFileCurrentPosition

获取当前音频播放位置

setAudioFilePosition

设置音频播放位置

getAudioClipsVolume

获取音效总音量

getVolumeOfAudioClip

获取指定音效音量

setAudioClipsVolume

设置音效总音量

setVolumeOfAudioClip

设置指定音效音量

playAudioClip

播放音效文件

stopAudioClip

停止播放指定音效

stopAllAudioClips

停止播放所有音效

pauseAudioClip

暂停播放指定音效

pauseAllAudioClips

暂停播放所有音效

resumeAudioClip

恢复播放指定音效

resumeAllAudioClips

恢复播放所有音效

getAudioClipCurrentPosition

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

setAudioClipPosition

设置指定音效播放位置

getAudioClipDuration

获取音效文件时长

检测功能

表8 检测功能接口

接口

描述

startNetworkTest

会前网络质量开启测试

stopNetworkTest

会前网络质量停止测试

自定义音频采集和渲染

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

接口

描述

setExternalAudioCapture

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

pushExternalAudioFrame

输入外部音频数据

自定义视频采集和渲染

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

接口

描述

setExternalVideoCapture

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

pushExternalVideoFrame

输入外部视频数据

setExternalMediaFrameOutput

设置媒体数据自渲染

setExternalVideoFrameOutputWithFormat

带Format参数设置媒体数据自渲染

pushAuxExternalVideoFrame

辅流输入外部视频数据

设备管理

表11 设备管理接口

接口

描述

setSpeakerModel

设置声音播放模式(只支持iphone)

setCameraConfig

设置摄像头相关参数

switchCamera

切换前后镜头(只支持iphone)

recordingDeviceTest

音频采集设备测试(只支持macOS)

finishRecordingDeviceTest

结束音频采集设备测试(只支持macOS)

playbackDeviceTest

音频播放设备测试(只支持macOS)

finishPlaybackDeviceTest

结束音频播放设备测试(只支持macOS)

echoTest

音频设备回路测试(只支持macOS)

finishEchoTest

结束音频设备回路测试(只支持macOS)

cameraDeviceTest

视频采集设备测试

finishCameraDeviceTest

结束视频采集设备测试

提示

您即将访问非华为云网站,请注意账号财产安全

文档反馈

文档反馈

意见反馈

0/500

标记内容

同时提交标记内容