检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
查询应用列表 功能介绍 调用此接口查询应用列表。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps 表1 Query参数 参数 是否必选 参数类型
查询单个应用 功能介绍 调用此接口查询单个应用详情。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id} 表1 路径参数 参数
更新单流任务 功能介绍 调用此接口修改单流任务。 仅部分场景支持修改。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI PUT /v2/apps/{app_id}/individual-stream-jobs
查询录制规则 功能介绍 调用此接口查询指定录制规则。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。 URI GET /v2/apps/{app_id}/record-rules
本地流对象(LocalStream) 该对象继承自Stream对象,并有如下新增接口。 表1 LocalStream接口 接口 描述 initialize 本地流初始化。 setAudioProfile 设置音频流配置。 setVideoProfile 设置视频流配置。 setScreenProfile
辅流管理 setAuxiliaryVideoEncodeSmooth public abstract int setAuxiliaryVideoEncodeSmooth(boolean enabled); 【功能说明】 设置是否开启辅流的流畅度优先。 【请求参数】 enable:true
房间功能 joinRoom - (int)joinRoom:(HWRtcJoinParam * _Nonnull)joinParam; 【功能说明】 加入房间。该方法让用户加入通话房间。如果已在通话中,用户必须调用leaveRoom退出当前通话,才能进入下一个房间。 【请求参数】
启动单流任务 功能介绍 调用此接口接口启动单流任务。 API触发单流录制流名规则:{jobtype}_{jobid}_{roomid}_{userid} jobtype取值为's'代表单流录制。 调试 您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer
其他接口 startNetworkTest virtual int startNetworkTest(const HRTCNetworkTestConfig* networkTestConfig) = 0; 【功能说明】 开启网络质量测试,房间外调用,要等探测结束后才能加入房间。
自定义音频采集和渲染 setExternalAudioCapture - (int)setExternalAudioCapture:(BOOL)enable sampleRate:(NSUInteger)sampleRate channels:(NSUInteger)channels
自定义视频渲染 功能描述 实时音视频传输过程中,上层应用可以不用SDK默认的渲染功能,选择对视频帧数据进行自定义渲染。 接口调用流程 实现过程 加入房间前开启视频自渲染 加入房间前调用接口setExternalVideoFrameOutput打开视频自渲染功能。 //开启远端或者本地的视频自渲染
音频管理 muteLocalAudio public abstract int muteLocalAudio(boolean mute); 【功能说明】 设置是否发送本地音频流。 【请求参数】 mute:true表示不发送,false表示发送。 【返回参数】 0:成功。 >0:失败
接口总览 本章节介绍了全平台C++ SDK的IHRTCConnection接口详情。 初始化等基础接口 表1 初始化等基础接口 接口 描述 release 释放IHRTCConnection对象资源 getRoomId 获取当前连接房间号 setNetworkBandwidth 设置网络带宽限制
自定义视频渲染 功能描述 实时音视频传输过程中,上层应用可以不用SDK默认的渲染功能,选择对视频帧数据进行自定义渲染。 接口调用流程 实现过程 加入房间前开启视频自渲染 加入房间前调用接口setExternalVideoFrameOutputWithFormat 打开视频自渲染功能
房间功能 joinRoom - (int)joinRoom:(HWRtcJoinParam * _Nonnull)joinParam; 【功能说明】 加入房间。该方法让用户加入通话房间。如果已在通话中,用户必须调用leaveRoom退出当前通话,才能进入下一个房间。 【请求参数】
自定义视频渲染 功能描述 实时音视频传输过程中,上层应用可以不用SDK默认的渲染功能,选择对视频帧数据进行自定义渲染。 接口调用流程 实现过程 加入房间前开启视频自渲染 加入房间前调用接口setExternalVideoFrameOutputWithFormat 打开视频自渲染功能
常见问题 初始化引擎时,countryCode应该如何填写? countryCode表示区域码,如果对应的是GLOBAL类型,则直接填空字符串,即"",如果是CN类型,则可以填"CN"。具体请参见国家码对照表。 初始化引擎时,domain应该如何填写? 该字段已废弃,不需要再传值。
状态码 调用实时音视频API时,可能返回的状态码如表1所示。 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 204 No Content 请求完全成功,同时HTTP响应不包含响应体
房间功能 joinRoom virtual int joinRoom(const HRTCJoinParam &joinParam) 【功能说明】 加入房间。该方法让用户加入通话房间。 【请求参数】 joinParam:加入房间信息。具体请参见HRTCJoinParam。 【返回参数
事件回调(IHRTCEngine) 本章节介绍了全平台C++ SDK的回调接口IHRTCEngineEventHandler的详情。 表1 事件回调说明 接口 描述 onError 错误回调。 onJoinRoomSuccess 成功加入房间回调。 onJoinRoomFailure