云服务器内容精选

  • 步骤三:配置录制规则 登录 实时音视频 控制台。 在左侧导航栏中,选择“应用管理”,进入“应用管理”页面。 在需要创建录制规则的应用行,单击“配置”,进入录制配置页面。 在“录制规则”区域,单击“添加”,进入添加录制规则页面。 一个应用ID在相同区域仅支持创建一个录制规则。 请您按照实际需求配置录制参数,参数说明如表1所示。 表1 录制参数说明 参数名 描述 存储-桶 存储录制文件的OBS桶。 目前录制文件仅支持存储到华北-北京四的OBS桶中。 区域 OBS桶所在的区域。 存储-路径 存储录制文件的OBS桶路径。 录制格式 录制文件的格式,支持HLS和MP4文件格式。 HLS规则 m3u8命名规则 录制m3u8文件的存储路径和文件的前缀。 默认命名格式: {app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 上述特殊变量的含义如下: app_id:应用ID。 record_format:录制格式。 stream:流名。 file_start_time:文件生成时间。 录制周期 录制时长支持0-720分钟,最小录制周期为1分钟,最大录制周期为12小时,超过12小时,系统将按照命名规则生成新文件。如果录制周期为0,则整个流录制为一个文件。 最大断流合并时长 支持如下三种配置: 断流后生成新文件:是指录制的直播流中断后,会立即生成新的录制文件。 断流后不生成新文件:是指录制的直播流中断后,会和之前录制的文件合并为一个文件。最大断流合并时长为30天。 其他数值:是指录制的直播流中断时间在设置范围内,则和之前录制的文件合并为一个文件,否则,生成新的录制文件。 MP4规则 mp4命名规则 录制mp4文件的存储路径和文件的前缀。 默认命名格式: {app_id}/{record_format}/{stream}_{file_start_time}/{stream}_{file_start_time} 上述特殊变量的含义如下: app_id:应用ID。 record_format:录制格式。 stream:流名。 file_start_time:文件生成时间。 录制周期 录制时长支持1-180分钟,最小录制周期为1分钟,最大录制周期为3小时,超过3小时,系统将按照命名规则生成新文件。 最大断流合并时长 支持如下两种配置: 断流后生成新文件:是指录制的直播流中断后,会立即生成新的录制文件。 其他数值:是指录制的直播流中断时间在设置范围内,则和之前录制的文件合并为一个文件,否则,生成新的录制文件。 单击“确定”,在录制规则列表中会增加一条新的录制规则。 图2 录制规则 您可以在录制规则列表中,根据实际需求选择是否开启自动录制功能。自动录制功能开启后,若该应用下有新创建的房间,则会按照已配置的录制规则自动对该房间中的实时音视频互动过程进行单流录制。 自动录制功能开启后,仅对同一应用下新创建的房间生效,自动录制功能开启前已创建的房间不生效。
  • 步骤五:查看录制文件 录制完成后,您可以在OBS控制台中或通过回调消息查看录制文件。 通过OBS控制台查看录制文件 在OBS管理控制台左侧导航栏选择“对象存储”。 在桶列表中单击存储SparkRTC录制文件的桶,进入“概览”页面。 在左侧导航栏,单击“对象”,查看录制文件信息。 您还可以对录制文件进行下载、分享等操作,具体请参见OBS帮助中心。 通过回调消息查看录制文件 若您设置了录制回调地址,则每生成一个录制文件都将收到录制回调消息。具体录制回调配置方法及消息字段说明请参见配置录制回调。
  • 调用API获取项目ID 您还能通过调用查询指定条件下的项目信息API获取项目ID。 获取项目ID的接口为“GET https://{Endpoint}/v3/projects/”,其中{Endpoint}为 IAM 的终端节点可以从地区和终端节点获取。接口的认证鉴权请参见认证鉴权。 响应示例如下,其中projects下的“id”即为项目ID。 { "projects": [ { "domain_id": "65382450e8f64ac0870cd180d14e684b", "is_domain": false, "parent_id": "65382450e8f64ac0870cd180d14e684b", "name": "region01", "description": "", "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99" }, "id": "a4a5d4098fb4474fa22cd05f897d6b99", "enabled": true } ], "links": { "next": null, "previous": null, "self": "https://www.example.com/v3/projects" } }
  • 数据统计分析接口 表9 数据统计分析接口 接口 说明 GET /v1/{project_id}/rtc/rooms 查询房间列表 GET /v1/{project_id}/rtc/users 查询用户列表 GET /v1/{project_id}/rtc/realtime/scale 查询实时规模 GET /v1/{project_id}/rtc/realtime/scale/dimension 查询实时规模分布 GET /v1/{project_id}/rtc/realtime/quality 查询实时质量数据 GET /v1/{project_id}/rtc/realtime/network 查询实时网络 GET /v1/{project_id}/rtc/history/usage 查询用量 GET /v1/{project_id}/rtc/history/scale 查询历史规模 GET /v1/{project_id}/rtc/history/quality 查询历史质量 GET /v1/{project_id}/rtc/client/qos/details 查询用户通话指标 GET /v1/{project_id}/rtc/client/event 查询详情事件 GET /v1/{project_id}/rtc/client/abnormalevent 查询指定项目用户异常体验事件 GET /v1/rtc/data/abnormal-events 查询用户异常体验事件 GET /v1/rtc/data/abnormal-event/dimension 查询异常事件用户分布
  • 录制规则管理接口 表2 录制规则管理接口 接口 说明 POST /v2/apps/{app_id}/record-rules 创建或更新录制规则 GET /v2/apps/{app_id}/record-rules 查询录制规则列表 GET /v2/apps/{app_id}/record-rules/{rule_id} 查询录制规则 PUT /v2/apps/{app_id}/record-rules/{rule_id} 更新录制规则 DELETE /v2/apps/{app_id}/record-rules/{rule_id} 删除录制规则
  • 合流任务管理接口 表5 合流任务管理接口 接口 说明 POST /v2/apps/{app_id}/mix-stream-jobs 启动合流任务 GET /v2/apps/{app_id}/mix-stream-jobs/{job_id} 查询合流任务 PUT /v2/apps/{app_id}/mix-stream-jobs/{job_id} 修改合流任务 DELETE /v2/apps/{app_id}/mix-stream-jobs/{job_id} 停止合流任务
  • 单流任务管理接口 表6 单流任务管理接口 接口 说明 POST /v2/apps/{app_id}/individual-stream-jobs 启动单流任务 GET /v2/apps/{app_id}/individual-stream-jobs/{job_id} 查询单流任务状态 DELETE /v2/apps/{app_id}/individual-stream-jobs/{job_id} 停止单流任务 PUT /v2/apps/{app_id}/individual-stream-jobs/{job_id} 更新单流任务
  • 设备管理 表11 设备管理接口 接口 描述 setSpeakerModel 设置声音播放模式(只支持iphone) setCameraConfig 设置摄像头相关参数 switchCamera 切换前后镜头(只支持iphone) recordingDeviceTest 音频采集设备测试(只支持macOS) finishRecordingDeviceTest 结束音频采集设备测试(只支持macOS) playbackDeviceTest 音频播放设备测试(只支持macOS) finishPlaybackDeviceTest 结束音频播放设备测试(只支持macOS) echoTest 音频设备回路测试(只支持macOS) finishEchoTest 结束音频设备回路测试(只支持macOS) cameraDeviceTest 视频采集设备测试 finishCameraDeviceTest 结束视频采集设备测试
  • 自定义视频采集和渲染 表10 自定义视频采集和渲染接口 接口 描述 setExternalVideoCapture 设置是否开启外部视频采集 pushExternalVideoFrame 输入外部视频数据 setExternalMediaFrameOutput 设置媒体数据自渲染 setExternalVideoFrameOutputWithFormat 带Format参数设置媒体数据自渲染 pushAuxExternalVideoFrame 辅流输入外部视频数据
  • 辅流管理 表5 辅流管理接口 接口 描述 startRemoteAuxiliaryStreamView 开启辅流渲染视图(发起辅流选看) stopRemoteAuxiliaryStreamView 关闭辅流渲染视图(停止辅流选看) updateRemoteAuxiliaryStreamRenderMode 设置辅流视图渲染模式,镜像模式 setRemoteAuxiliaryStreamViewRotation 设置辅流视图角度 setAuxiliaryVideoEncoderConfig 设置辅流编码能力 setAuxiliaryVideoEncodeSmooth 设置是否开启辅流的流畅度优先 pushAuxExternalVideoFrame 推送辅流数据
  • 音效文件播放管理 表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 获取音效文件时长
  • 视频管理 表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 设置远端视频另一个窗口显示
  • 音频管理 表3 音频管理接口 接口 描述 muteLocalAudio 设置是否发送本地音频流 enableLocalAudioStream 设置是否开启麦克风采集音频 muteRemoteAudio 订阅或取消订阅远端某个用户音频流 muteAllRemoteAudio 订阅或取消订阅全部远端用户音频流 setVolumeNotifyInterval 设置最大音量上报频率 adjustRecordingVolume 设置麦克风采集的音量(0-100) adjustPlaybackVolume 调整扬声器播放的音量(0-100) setShareComputerSound 共享声音 (只支持macOS) sendAudioSeiMsg 发送音频SEI消息 setDefaultSpeakerModel 设置默认的声音播放模式,在房间外调用 setAudioFrameRecordParameters 设置音频采集回调参数 setAudioConfig 设置音频场景
  • 房间功能 表2 房间功能接口 接口 描述 joinRoom 加入房间 changeUserRole 设置用户的角色,角色切换时使用 renewAuthorization 签名更新 leaveRoom 离开房间 changeUserName 设置用户自己的昵称 createConnection 创建 跨房(HWRtcConnection)对象,跨房前需先创建连接 addMultiRoomMediaRelay 添加单个跨房 removeMultiRoomMediaRelay 删除单个跨房 stopMultiRoomMediaRelay 停止所有跨房
  • 初始化等基础接口 表1 初始化等基础接口 接口 描述 sharedEngine 创建连麦引擎实例 destroy 注销引擎 initWithConfig 初始化引擎配置信息 logUpload 上传日志 setEnableRtcStats 打点开关 getVersion 获取SDK版本号 setEncrytionParam 设置端到端加密模式 setAccessResourceType 设置接入的环境 setNetworkBandwidth 设置网络带宽限制