云服务器内容精选

  • createConnection - (HWRtcConnection *_Nullable)createConnection:(NSString *_Nullable)roomId; 【功能说明】 根据房间ID,创建HWRtcConnection对象,为跨房做准备。 通过此接口创建一个与房间关联的HWRtcConnection连接对象。 该方法支持多次调用,创建多个HWRtcConnection连接对象,调用每个对象中的joinRoom方法,可以同时加入到多个房间。在每个房间中,可以分别订阅和选看房间中的用户。 具体请参见事件回调(HWRtcConnection)有关接口和回调。 【请求参数】 roomid:房间ID。 【返回参数】 HWRtcConnection:成功返回连接对象指针,失败返回为空。 同一时间最多只能创建4个连接对象,每个连接对象对应的房间ID必须互不相同。 如果使用HWRtcConnection对象加入房间,则加入房间的房间ID不能和已创建连接对象对应的房间ID相同。 同一时间只能以JOINER角色加入某一个房间。
  • 音效文件播放管理 表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 获取音效文件时长
  • 设备管理 表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 推送辅流数据
  • 视频管理 表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 设置网络带宽限制
  • getAudioSampleParam - (HWRtcAudioFrameParam* _Nonnull)getAudioSampleParam; 【功能说明】 获取下行音频流信息,需在setAudioConfig后调用 【请求参数】 HWRtcAudioFrameParam 字段说明 FrameType: 音频帧类型 sampleRate: 采样率 samplesPerSec:样点数 bytesPerSample:每个采样点的字节数,一般2字节 channe:通道数 【返回参数】 字段通过HWRtcAudioFrameParam进行返回
  • createConnection - (HWRtcConnection *_Nullable)createConnection:(NSString *_Nullable)roomId; 【功能说明】 根据房间ID,创建HWRtcConnection对象,为跨房做准备。 通过此接口创建一个与房间关联的HWRtcConnection连接对象。 该方法支持多次调用,创建多个HWRtcConnection连接对象,调用每个对象中的joinRoom方法,可以同时加入到多个房间。在每个房间中,可以分别订阅和选看房间中的用户。 具体请参见事件回调(HWRtcConnection)有关接口和回调。 【请求参数】 roomid:房间ID。 【返回参数】 HWRtcConnection:成功返回连接对象指针,失败返回为空。 同一时间最多只能创建4个连接对象,每个连接对象对应的房间ID必须互不相同。 如果使用HWRtcConnection对象加入房间,则加入房间的房间ID不能和已创建连接对象对应的房间ID相同。 同一时间只能以JOINER角色加入某一个房间。