检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
【回调参数】 无 父主题: 接口参考
共享桌面 加入房间后可以调用setAuxiliaryVideoEncoderConfig设置编码参数,其中HRTCVideoAuxiliarEncParam需要传入宽高、帧率、码率,然后调用startScreenShare开始共享。
【请求参数】 localEnable:true表示输出本地音频数据,false表示不输出本地音频数据。 remoteEnable:true表示输出远端音频数据,false表示不输出远端音频数据。 【返回参数】 0:成功。 >0:失败。具体请参见客户端错误码。
【请求参数】 audioData:音频数据。 【返回参数】 0:成功。 > 0:失败。具体请参见客户端错误码。 此方法调用前,需要先调用setExternalAudioCapture设置开启外部音频采集。 数据输入周期:10ms。
【请求参数】 无 【返回参数】 0:方法调用成功。 < 0:方法调用失败。具体请参见HRTCErrorCode。
【请求参数】 videoFrame:视频数据,具体请参见HRTCVideoFrame。 【返回参数】 0:成功。 > 0:失败。具体请参见客户端错误码。 此接口与屏幕采集功能互斥。
【请求参数】 无 【返回参数】 0:方法调用成功。 < 0:方法调用失败。具体请参见客户端错误码。
该参数在SDK 1.0+版本中必填,SDK 2.0+版本中非必填。 appId:string[128]类型,必填。应用ID,只有App ID相同的应用程序才能进入同一个房间进行互通。 countryCode:string[2]类型,可选。
【回调参数】 conn:连接对象。 userId:离开房间的远端用户ID。 reason:远端用户离线原因,预留参数。
【请求参数】 enable:YES表示开启,NO表示关闭。默认为NO。 sampleRate:音频采样率,支持16k、24k、32k、44.1k、48k采样率。 channels:音频声道数,1表示单声道,2表示双声道。 【返回参数】 0:方法调用成功。 > 0:方法调用失败。
若您使用了浏览器原生getUserMedia接口进行自定义采集,则需要手动设置3A参数,详细设置请参见媒体追踪约束。
详细介绍了SDK的集成操作、接口参数定义和代码示例。SparkRTC提供了以下主流平台SDK供开发者使用。
参数配置说明,如表1所示。 图1 创建应用 表1 参数说明 参数 说明 应用名称 应用的名称。可由字母、数字和“-”、“_”组成,长度不能超过64个字符。 应用类型 应用的类型。
响应参数 状态码: 200 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。
表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 401 表6 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪。
表2 请求Body参数 参数 是否必选 参数类型 描述 app_name 是 String app名称,仅支持填入utf8格式内容 响应参数 状态码: 201 表3 响应Header参数 参数 参数类型 描述 X-request-Id String 此字段携带请求ID号,以便任务跟踪
URI PUT /v2/apps/{app_id}/auto-record-mode 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String
URI GET /v2/apps/{app_id}/auto-record-mode 表1 路径参数 参数 是否必选 参数类型 描述 app_id 是 String 应用id 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String
请求参数 无 响应参数 状态码: 200 表3 响应Header参数 参数 参数类型 描述 X-request-id String 请求的唯一标识 表4 响应Body参数 参数 参数类型 描述 ctime String 时间 event_id String 异常事件ID event_info
参数 参数 是否必选 参数类型 描述 Content-Type 是 String 内容类型。