华为云用户手册

  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 jobs Array of objects 批量删除任务响应体。 详情请参见表5。 表5 jobs字段数据结构说明 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512 id String 任务ID。 name String 任务名称。 status String 删除结果。 状态码: 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码。 最小长度:12 最大长度:12 error_msg String 错误描述。 最小长度:1 最大长度:512
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。 用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。 请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 jobs 是 Array of strings 批量删除任务请求体。
  • 请求示例 查询任务的参数配置修改历史 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/configuration-histories?offset={offset}&limit={limit}&begin_time={begin_time}&end_time={end_time}
  • 响应示例 状态码: 200 任务参数配置修改历史列表 { "count" : 0, "parameter_history_config_list" : [ { "name" : "strapplier_thread_numing", "old_value" : "10", "new_value" : "20", "is_update_success" : true, "is_applied" : "true", "update_time" : "2020-09-01T18:50:20Z", "apply_time" : "2020-09-01T18:50:20Z" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 历史记录总数。 parameter_history_config_list Array of objects 任务参数历史修改列表。 详情请参见表4。 表4 parameter_history_config_list字段数据结构说明 参数 参数类型 描述 name String 参数名称。 old_value String 旧参数值。 new_value String 新参数值。 is_update_success Boolean 更新结果。true:成功,false:失败 is_applied Boolean 是否已应用。true:已应用,false:未应用 update_time String 参数修改时间。 apply_time String 参数应用时间。
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn
  • URI GET /v5/{project_id}/jobs/{job_id}/configuration-histories 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量,表示从此偏移量开始查询,offset 大于等于 0。 默认为0。 limit 否 Integer 每页显示的条目数量。默认为10,取值范围【1-1000】。 begin_time 否 String 开始时间,UTC时间,例如:2020-09-01T18:50:20Z。 end_time 否 String 结束时间,UTC时间,例如:2020-09-01T19:50:20Z。 name 否 String 参数名称。
  • 请求示例 更新任务全量阶段写数据到目标数据库的线程数和全量阶段从源教据库读取数据的线程数。 https://{endpoint}/v5/054ba152d480d55b2f5dc0069e7ddef0/jobs/c7debc9c-8e09-4a5d-8dd6-cc44f78jb20r/modify-configuration { "values" : [ { "parameter_name" : "applier_thread_num", "parameter_value" : "20" }, { "parameter_name" : "read_task_num", "parameter_value" : "3" } ] }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。用户Token也就是调用IAM获取用户Token接口的响应值,请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn 表3 请求Body参数 参数 是否必选 参数类型 描述 values 是 Array of objects 参数值对象,基于默认参数模板初始化的参数值。 详情请参见表4。 表4 values字段数据结构说明 参数 是否必选 参数类型 描述 parameter_name 是 String 参数名称,如:“applier_thread_num”,“read_task_num”等。为空时表示不修改参数值。 parameter_value 是 String 参数名称对应的参数值,如:“20”,“false”。parameter_name不为空时,parameter_value也不可为空。
  • 响应示例 状态码: 200 任务参数配置列表信息。 { "count" : 0, "parameter_config_list" : [ { "name" : "applier_thread_num", "value" : "20", "default_value" : "10", "value_range" : "1-512", "is_need_restart" : true, "description" : "The number of threads that write data to the target database during the full stage", "created_at" : "2020-09-01T18:50:20Z", "updated_at" : "2020-09-01T18:50:20Z" }, { "name" : "read_task_num", "value" : "20", "default_value" : "10", "value_range" : "1-512", "is_need_restart" : true, "description" : "The number of threads reading data from the source database during the full volume stage", "created_at" : "2020-09-01T18:50:20Z", "updated_at" : "2020-09-01T18:50:20Z" } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Integer 总数。 parameter_config_list Array of 表10-9 objects 任务参数列表。 详情请参见表5。 表5 parameter_config_list字段数据结构说明 参数 参数类型 描述 name String 参数名称。 value String 参数值。 default_value String 参数默认值。 value_range String 参数值范围,如Integer取值0-1、Boolean取值true|false等。 is_need_restart Boolean 是否需要重启。默认为true, “false”表示否。“true”表示是。 description String 参数描述,目前只支持英文。 created_at String 创建时间,例如:2023-01-20T07:18:26Z。 updated_at String 更新时间,例如:2023-03-01T09:42:02Z。
  • 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 Content-Type 是 String 发送的实体的MIME类型。推荐用户默认使用application/json,如果API是对象、镜像上传等接口,媒体类型可按照流类型的不同进行确定。 缺省值:application/json X-Auth-Token 是 String 从IAM服务获取的用户Token。用户Token也就是调用获取用户Token接口的响应值,该接口是唯一不需要认证的接口。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。 X-Language 否 String 请求语言类型。 缺省值:en-us 枚举值: en-us zh-cn
  • URI GET /v5/{project_id}/jobs/{job_id}/configurations 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户在某一Region下的Project ID。 获取方法请参见获取项目ID。 job_id 是 String 任务ID。 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 String 偏移量,表示从此偏移量开始查询,offset 大于等于 0。默认为0 limit 否 String 每页显示的条目数量。默认为10,取值范围【1-1000】 name 否 String 根据参数名查询。
  • 对数据库影响 对象对比:会查询源库及目标库的系统表,占用10个左右的session的连接数,正常情况不会对数据库产生影响。但是如果对象数量巨大(比如几十万张表),可能会对数据库产生一定的查询压力。 行数对比:会查询源库及目标库的表行数,占用10个左右的session的连接数,正常的select count语句基本不会对数据库产生影响。但是如果表数据量巨大(亿级)会对数据库产生一定的查询压力,返回查询结果会比较慢。 内容对比:会查询源库及目标库的全部数据,涉及每个字段都会对比,所以会对数据库产生一定的查询压力,主要体现在IO上,查询速度受限于源库和目标库的IO和网络带宽。占用1-2个CPU,占用10个左右的session的连接数。 用户对比:会查询源库及目标库的账户和权限,基本不会对数据库产生影响。
  • 设备管理 表11 设备管理接口 接口 描述 setSpeakerModel 设置声音播放模式(只支持iphone) setCameraConfig 设置摄像头相关参数 switchCamera 切换前后镜头(只支持iphone) recordingDeviceTest 音频采集设备测试(只支持macOS) finishRecordingDeviceTest 结束音频采集设备测试(只支持macOS) playbackDeviceTest 音频播放设备测试(只支持macOS) finishPlaybackDeviceTest 结束音频播放设备测试(只支持macOS) echoTest 音频设备回路测试(只支持macOS) finishEchoTest 结束音频设备回路测试(只支持macOS) cameraDeviceTest 视频采集设备测试 finishCameraDeviceTest 结束视频采集设备测试
  • getAudioSampleParam - (HWRtcAudioFrameParam* _Nonnull)getAudioSampleParam; 【功能说明】 获取下行音频流信息,需在setAudioConfig后调用 【请求参数】 HWRtcAudioFrameParam 字段说明 FrameType: 音频帧类型 sampleRate: 采样率 samplesPerSec:样点数 bytesPerSample:每个采样点的字节数,一般2字节 channe:通道数 【返回参数】 字段通过HWRtcAudioFrameParam进行返回
  • 辅流管理 表5 辅流管理接口 接口 描述 setRemoteAuxiliaryStreamViewRotation 设置远端辅流视图旋转角度 startRemoteAuxiliaryStreamView 开启辅流渲染视图(发起辅流选看) stopRemoteAuxiliaryStreamView 关闭辅流渲染视图(停止辅流选看) updateRemoteAuxiliaryStreamRenderMode 设置辅流视图显示模式,镜像模式 setRemoteAuxiliaryStreamViewOrientation 设置远端辅流视图方向(横竖屏)
  • 基本使用逻辑 创建新的项目工程,导入SDK后,需要先创建引擎。 您可以在入会前进行视频编码、声音播放模式等参数的配置。 设置本地视图。 用户加入房间后,将通过回调的方式通知房间内的其他用户,收到其他用户加入的回调后,可以为其设置远端视图。 在会中,也可以进行切换摄像头等参数的配置。 用户离开房间后,需销毁对应资源。 在时序图中,单击相应接口名称可快速跳转到相应接口位置查看其使用方法。 父主题: Android SDK
  • SDK概述 华为云实时音视频服务软件开发工具包是对SparkRTC服务提供的REST API进行的封装,以简化用户的开发工作。用户直接调用SparkRTC SDK提供的接口函数即可实现使用SparkRTC服务业务能力的目的。 相关开发包请提交工单联系华为云技术客服获取。 同时,针对不同平台的SDK提供了集成和接口参考。详细介绍了SDK的集成操作、接口参数定义和代码示例。SparkRTC提供了以下主流平台SDK供开发者使用。 客户端 集成SDK 接口参考 Android Android SDK集成 Android SDK接口参考 iOS iOS SDK集成 iOS SDK接口参考 MAC MAC SDK集成 MAC SDK接口参考 Windows Windows SDK集成 Windows SDK接口参考 Web Web SDK集成 Web SDK接口参考
  • connection-state-changed 【事件说明】 Client连接状态变更事件,Client连接状态变更会收到该事件通知。 【回调参数】 ConnectionStateInfoEvent:{ prevState:必选,ConnectionState类型,变更前状态。 curState:必选,ConnectionState类型,变更后状态。 } 连接状态ConnectionState的取值如下所示: CONNECTING:连接建立中。 CONNECTED:连接已连接。 RECONNECTING:重新连接中。 DISCONNECTED:连接已断开。
  • signature-expired 【事件说明】 签名过期事件。 【回调参数】 errorInfo:错误信息。必选,ErrorInfo类型。 ErrorInfo 定义为:{ errorCode:错误码。必选,string类型。 errorMsg:必选,string类型。取值如下面的取值示例中所示。 } 取值示例,如下所示: 签名过期:{ errorCode: '90100030' errorMsg: 'signature expired' } 签名无效:{ errorCode: '90100031' errorMsg: 'signature invalid' } 监听到签名过期事件后可通过错误码区分是签名无效还是签名过期,签名过期后可通过renewSignature接口更新签名。
  • client-banned 【事件说明】 用户被踢下线事件,当用户以相同的userId 在其他Client加入相同的房间后,被踢的Client会收到该事件通知。 【回调参数】 clientBannedEvent:必选,ClientBanInfo类型, ClientBanInfo定义为:{ userId:必选,string[64]类型,被踢用户标识。 reason:必选,string类型,原因描述。 }
  • camera-changed 【事件说明】 本地摄像头设备变更事件,当插、拔本地摄像头时触发。 【回调参数】 DeviceChangedEvent:必选,DeviceChangedInfo类型,设备变更详情。 DeviceChangedInfo 定义为:{ deviceId:必选,string类型,设备deviceId。 state:必选,DeviceChangeMode类型,DeviceChangeMode枚举值定义如下: ADD:设备添加。 REMOVE:设备移除。 } 视频采集设备,拔插后需要应用层进行相应的处理,如:拔除摄像头的时候是否切换其他视频采集设备重新采集;插入摄像头的时候是否使用新插入设备进行重新采集。
  • volume-indicator 【事件说明】 音频TopN模式下,房间中当前音量最大的用户提示事件。 【回调参数】 userVolumeInfos:必选, UserVolumeInfo[]类型。 UserVolumeInfo定义为:{ user_id:必选,string类型,用户Id。 volume:可选,number类型,取值范围为[0,100]。 } 该事件仅在音频TopN模式下生效,1.5.0版本新增。
  • live-streaming-updated 【事件说明】 旁路推流状态更新事件。该事件为2.0.1版本新增。 【回调参数】 urlStatus:UrlStatus[]类型,所有CDN推流状态更新。UrlStatus定义如下: url:必选,string类型,表示CDN推流URL status:必选,number类型,表示当前推流状态。 0:初始化。 1:链接正常且有流。 2:链接正常但无流。 3:异常重试。 4:处理失败。 errorCode:可选,number类型,表示详细的失败原因,支持的枚举值如下: 0: 正常。 1: 内部错误。 2: 地址解析失败。 3: 连接失败。 4: RTMP握手失败。 5: 内存错误。 6: 参数错误。 7: 重试失败。 8: 响应超时失败。
  • mute-audio 【事件说明】 远端用户禁用音频通知事件,当远端用户禁用音频后,流接收端会收到该事件通知。 【回调参数】 mediaStatus:必选,MediaStatusNotifyInfo类型。 MediaStatusNotifyInfo包含如下属性: roomId:必选,string[64]类型。 userId:必选,string[64]类型。 status:必选,MediaStatusAction类型。MediaStatusAction枚举值定义如下所示: 1:媒资状态可用。 2:媒资状态不可用。 reason:必选,MediaStatusReason类型。MediaStatusReason枚举值定义如下所示: 0:媒体离线。 1:媒体静音。 2:媒体不静音。
  • remote-user-name-changed 【事件说明】 远端用户昵称变更事件。该事件为1.5.0版本新增。 【回调参数】 userNameChangedEvent:必选, UserNameInfo类型。 UserNameInfo定义为:{ roomId:必选,string[64]类型,房间Id。 userId:必选,string[64]类型,用户Id。 userName:必选, string[256]类型,修改后的用户昵称。 }
  • stream-interrupted 【事件说明】 远端流的码流中断事件。中断表示在 enableStreamStateDetection 接口参数 interval 设置的统计周期内未接收到有效视频帧。该事件为 1.4.0 版本新增。 【回调参数】 streamInterruptedEvent:必选,UserList[]类型,已订阅且无视频码流的用户列表。 UserList定义为:{ userId:必选,string类型,用户Id。 isScreen:必选,boolean类型,true表示对应用户的辅流,false表示对应用户的主流。 }
  • rtc-stats 【事件说明】 音视频流数据统计事件。该事件为2.0.3版本新增。 【回调参数】 rtcStatsInfo:必选, rtcStatsInfo[]类型。 rtcStatsInfo定义为:{ userName:必选,string类型,用户昵称。 isRemote:必选,boolean类型,是否为远端流,true表示远端流,false表示本地流。 streamType:必选,ContentType类型,流类型。ContentType类型的枚举值如下:{ main:string类型,表示主流。 middle1:string类型,表示主流,middle1~middle4码流依次降低。 middle2:string类型,表示主流,middle1~middle4码流依次降低。 middle3:string类型,表示主流,middle1~middle4码流依次降低。 middle4:string类型,表示主流,middle1~middle4码流依次降低。 slides:string类型,表示主流视频分辨率最小的流。 desktop:string类型,表示共享流。 } mediaType:必选,MediaType类型,媒体类型,音频或视频。 bitrate:必选,number类型,音视频流码率,单位为kbps。 frameRate:必选,number类型,视频帧率,单位为帧/秒。 rtt:必选,number类型,表示SDK到边缘服务器的RTT (Round-Trip Time),单位毫秒。只有本地流才有rtt 值。 jitter:必选,number类型,音视频流抖动值。 pktLossRate:必选,number类型,音视频流丢包率。 }
  • recording-device-changed 【事件说明】 本地录音设备变更事件,当本地录音设备变更时触发。 【回调参数】 DeviceChangedEvent:必选,DeviceChangedInfo类型,设备变更详情。DeviceChangedInfo定义参考camera-changed中的说明。 麦克风采集设备,拔插后需要应用层进行相应的处理,如:拔除麦克风的时候是否切换其他麦克风采集设备重新采集;插入麦克风的时候是否使用新插入设备进行重新采集。
共100000条