文档首页 > > SDK参考> iOS SDK> 接口参考>

HWRtcEngine

HWRtcEngine

分享
更新时间:2021/01/07 GMT+08:00

本章节介绍了iOS/MacOS SDK的HWRtcEngine接口详情。

表1 HWRtcEngine接口

接口

描述

sharedEngine

创建连麦引擎实例。

destroy

注销引擎。

init

初始化引擎配置信息。

setLogParam

设置打印日志级别和日志地址。

setVideoEncParam

设置视频编码参数。

joinRoom

加入房间。

setUserRole

设置用户的角色,角色切换时使用。

setupLocalVideo

设置/取消本地预览视图。

setupLocalViewDisplayMode

设置本地预览视图显示模式。

startRemoteStreamView

开启远端预览视图。

stopRemoteStreamView

关闭远端预览视图。

setRemoteViewDisplayMode

设置远端视图显示模式。

startPreview

开启本地预览。

stopPreview

关闭本地预览。

muteLocalAudio

设置是否发送本地音频流。

muteLocalVideo

设置是否发送本地视频流。

enableLocalVideo

设置是否开启摄像头采集视频。

enableLocalAudio

设置是否开启麦克风采集音频。

setSpeakerModel

设置声音播放模式。(仅iphone)

switchCamera

切换前后镜头。(仅iOS)

adjustRecordingVolume

调整录制音量。

adjustPlaybackVolume

调整播放音量。

renewSignature

更新签名。

startRemoteSubStreamView

开启选看辅流视图。

stopRemoteSubStreamView

停止选看辅流视图。

setRemoteSubStreamViewRotation

设置辅流视图角度。

setRemoteSubStreamViewDisplayMode

设置辅流视图显示模式。

leaveRoom

离开房间。

getPlaybackDevices

获取扬声器设备。(仅MAC)

setPlaybackDevice

设置扬声器设备。(仅MAC)

getRecordingDevices

获取麦克风设备。(仅MAC)

setRecordingDevice

设置麦克风设备。(仅MAC)

getVideoDevices

获取摄像头设备。(仅MAC)

setVideoDevice

设置摄像头设备。(仅MAC)

setPlaybackDevicesVolume

设置当前扬声器音量。(仅MAC)

getPlaybackDevicesVolume

获取当前扬声器的音量。(仅MAC)

setRecordingDevicesVolume

设置麦克风的音量。(仅MAC)

getRecordingDevicesVolume

获取当前麦克风的音量。(仅MAC)

setPlaybackDeviceMute

设置扬声器播放是否静音。(仅MAC)

setRecordingDeviceMute

设置麦克风是否静音。(仅MAC)

getRecordingDeviceMute

获取麦克风是否静音。(仅MAC)

getPlaybackDeviceMute

获取本地扬声器是否静音。(仅MAC)

getCurrentPlaybackDevice

获取所有扬声器设备。(仅MAC)

getCurrentVideoDevice

获取所有摄像头设备。(仅MAC)

getCurrentRecordingDevice

获取当前麦克风设备。(仅MAC)

logUpload

上传日志。

connectOtherRoom

开启跨房,加入其他房间。

disconnectOtherRoom

结束跨房,离开其他房间。

setRemoteAudioTopNVoice

设置在所有可接收的音频流中,接收前N个音量最大的音频流。

muteRemoteAudio

订阅或取消订阅远端某个用户音频流。

muteRemoteVideo

订阅或取消订阅远端某个用户视频流。

muteAllRemoteAudio

订阅或取消订阅全部远端用户音频流。

muteAllRemoteVideo

订阅或取消订阅全部远端用户视频流。

setLocalViewMirror

设置本地视频镜像模式。

setVideoEncoderMirror

设置视频编码镜像模式。

startAudioFile

开始播放音频文件。

stopAudioFile

停止播放音频文件。

pauseAudioFile

暂停播放音频文件。

resumeAudioFile

恢复播放音频文件。

setExternalAudioCapture

设置是否开启外部音频采集。

setExternalVideoCapture

设置是否开启外部视频采集。

pushExternalAudioFrame

输入外部音频数据。

pushExternalVideoFrame

输入外部视频数据。

setExternalMediaFrameOutput

设置媒体数据自渲染。

startNetworkTest

会前网络质量开启测试。

stopNetworkTest

会前网络质量停止测试。

setEnableRtcStats

打点开关。

enableSmallVideoStream

设置小流编码信息。

setPriorRemoteVideoStreamType

设置默认选看远端的大流或者小流。

setRemoteVideoStreamType

设置选看指定用户的大流或者小流。

setDefaultMuteAllRemoteVideoStreams

设置是否自动选看远端视频流。

setupRemoteView

设置远端流视图。

setRemoteVideoAdjustResolution

设置远端下行视频流的分辨率自适应。

setVideoEncodeResolutionMode

设置视频编码分辨率比例模式。

setVolumeNotifyInterval

设置最大音量上报频率。

sharedEngine

+ (instancetype)sharedEngine;

功能说明

创建连麦引擎实例。

请求参数

返回参数

返回引擎实例对象。

destroy

- (void)destroy;

功能说明

注销引擎。

请求参数

返回参数

init

- (int)init:(NSString*)domain appId:(NSString*)appId;

功能说明

初始化引擎配置信息。

请求参数
  • domain:企业域名,通过该域名可以获取就近接入IP地址列表。
  • appId:应用ID。
返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

如果domain和appId发生改变,需要调用destroy

setLogParam

- (int)setLogParam:(HWRtcLogLevel)logLevel logPath:(NSString*)logPath enable:(BOOL)enable;

功能说明

设置打印日志的级别和地址。需要在创建RTC引擎之前调用。

请求参数
  • logLevel:日志级别,具体请参见HWRtcLogLevel
  • logPath:日志地址。
  • enable:是否开启日志。
返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setVideoEncParam

- (int)setVideoEncParam:(NSArray<HWRtcVideoEncode*>*)videoEncodes totalBitRate:(int)totalBitRate;

功能说明

设置视频编码参数。

请求参数
  • videoEncodes:视频编码参数,具体请参见HWRtcVideoEncode
  • totalBitRate:总带宽。
返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

joinRoom

- (int)joinRoom:(HWRtcUserInfo *)userInfo roomId:(NSString*)roomId mediaType:(HWRtcMediaType)mediaType;

功能说明

加入房间。

请求参数
  • userInfo:用户信息,具体请参见HWRtcUserInfo
  • roomId:房间ID。
  • mediaType:媒体类型,具体请参见HWRtcMediaType
返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

会触发以下回调:

setUserRole

- (int)setUserRole:(HWRtcRole)role;
- (int)setUserRole:(NSString *)roomid role:(HWRtcRole)role;

功能说明

设置用户的角色,角色切换时使用。

请求参数

  • roomid:房间ID。
  • role:用户角色,具体请参见HWRtcRole

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

  • 加入房间后才可以切换角色,当前仅支持joiner和player角色切换。
  • roomId可以设置为本房间,即在本房间切换角色。
  • 切换成功触发onUserRoleChange回调。切换失败会触发onError回调,错误码HWRtcErrorCode :HWRtcErrorCodeUserRoleChangeFai。

setupLocalVideo

-(int)setupLocalVideo:(HWRtcVideoCanvas *)local viewMode:(HWRtcVideoDisplayMode)viewMode;
- (int)setupLocalVideo:(HWRtcVideoCanvas *)local;

功能说明

设置/取消本地预览视图。

请求参数

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setupLocalViewDisplayMode

-(int)setupLocalViewDisplayMode:(HWRtcVideoDisplayMode)viewMode;

功能说明

设置本地预览视图显示模式。

请求参数

viewMode:显示模式,具体请参见HWRtcVideoDisplayMode

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

startRemoteStreamView

-(int)startRemoteStreamView:(HWRtcVideoCanvas *)remote  streamType:(HWRtcStreamType)streamType disableAdjustRes:(BOOL)disableAdjustRes;
- (int)startRemoteStreamView:(HWRtcVideoCanvas * _Nonnull)remote;//适用于大小流

功能说明

开启远端预览视图。

请求参数
  • remote:远端预览视图,具体请参见HWRtcVideoCanvas
  • streamType:流清晰度,具体请参见HWRtcStreamType
  • disableAdjustRes:下行流码率自适应,默认关闭。YES表示关闭,NO表示开启。
返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

选看当前未选看用户,或者选看用户的流类型发生变化时,会触发回调onFirstRemoteVideoDecoded

stopRemoteStreamView

- (int)stopRemoteStreamView:(NSString*)userid;

功能说明

关闭远端预览视图。

请求参数

userid:用户id。

返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setRemoteViewDisplayMode

- (int)setRemoteViewDisplayMode:(HWRtcVideoDisplayMode)displayMode userid:(NSString *)userid;

功能说明

设置远端视图显示模式。

请求参数
返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

startPreview

- (int)startPreview;

功能说明

开启本地预览。

请求参数

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

joinRoom之前调用setupLocalView后才会生效。打开预览后需要调用stopPreview关闭预览,否则一直处于预览状态。若需要在房间内预览,可调用setupLocalView,设置有效view开启预览,设置为0表示关闭预览。

stopPreview

- (int)stopPreview;

功能说明

关闭本地预览。

请求参数

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

joinRoom之前调用才会生效。打开预览后需要调用stopPreview关闭预览,否则依然处于预览状态。若需要在房间内预览,可调用setupLocalView,设置有效view开启预览,设置为0表示关闭预览。

muteLocalAudio

- (int)muteLocalAudio:(BOOL)mute;

功能说明

设置是否发送本地音频流。

请求参数

mute:YES表示关闭音频流发送,NO表示开启音频流发送。

返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode
注意事项
  • 默认开启本地音频发流,需要在加入房间后调用。
  • 关闭本地音频发流,不影响本地音频采集。
  • 远端用户选看该用户时,远端用户会触发onRemoteAudioStateChange远端流状态变化回调。

muteLocalVideo

- (int)muteLocalVideo:(BOOL)mute;

功能说明

设置是否发送本地视频流。

请求参数

mute:YES表示关闭视频流发送,NO表示开启视频流发送。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode
注意事项
  • 默认开启本地视频发流,需要在加入房间后调用。
  • 关闭本地视频发流,不影响本地视图采集,仍可见本地视图。
  • 远端用户选看该用户时,远端用户会触发onRemoteVideoStateChange远端流状态变化回调。

enableLocalVideo

- (int)enableLocalVideo:(BOOL)enable;

功能说明

设置是否开启摄像头采集视频。

请求参数

enable:YES表示开启,NO表示关闭。

返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

默认开启,关闭不会影响视频流发送。

enableLocalAudio

- (int)enableLocalAudio:(BOOL)enable;

功能说明

设置是否开启麦克风采集音频。

请求参数

enable:YES表示开启,NO表示关闭。

返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

默认开启,关闭不会影响音频流发送。

setSpeakerModel

- (int)setSpeakerModel:(HWRtcSpeakerModel)speakerModel;

功能说明

设置声音播放模式。

请求参数

speakerModel:声音播放模式,具体请参见HWRtcSpeakerModel

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

只支持iphone。

switchCamera

- (int)switchCamera;

功能说明

切换前后镜头。

【请求参数】

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

只支持iphone。

adjustRecordingVolume

- (int)adjustRecordingVolume:(unsigned int)volume;

功能说明

调整录制音量。

请求参数

volume:采集音量,取值范围为0-100,10表示原始音量。

返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

adjustPlaybackVolume

- (int)adjustPlaybackVolume:(unsigned int)volume;

功能说明

调整播放音量。

请求参数

volume:播放音量,取值范围为0-100,10表示原始音量。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

不影响系统音量。

renewSignature

- (int)renewSignature:(NSString *)signature time:(long long)time;

功能说明

更新签名。

请求参数
  • signature:鉴权签名字串。
  • time:时间戳UTC。
返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

startRemoteSubStreamView

- (int)startRemoteSubStreamView:(HWRtcVideoCanvas *)streamView streamType:(HWRtcStreamType)streamType;

功能说明

开启选看辅流视图。

请求参数

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

stopRemoteSubStreamView

- (int)stopRemoteSubStreamView:(NSString *)userid;

功能说明

停止选看辅流视图。

请求参数

userid:用户ID。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setRemoteSubStreamViewRotation

- (int)setRemoteSubStreamViewRotation:(HWRtcVideoRotation)rotation userid:(NSString *)userid;

功能说明

设置辅流视图角度。

请求参数

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setRemoteSubStreamViewDisplayMode

- (int)setRemoteSubStreamViewDisplayMode:(HWRtcVideoDisplayMode)displayMode userid:(NSString *)userid;

功能说明

设置辅流视图显示模式。

请求参数
返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

leaveRoom

- (int)leaveRoom;

功能说明

离开房间。

请求参数

返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

将会触发onLeaveRoomonConnStateChange回调。

getPlaybackDevices

- (NSArray<HWRtcDeviceInfo*>*)getPlaybackDevices;

功能说明

获取扬声器设备。

请求参数

返回参数

NSArray <HWRtcDeviceInfo*>数组类型。数组内为HWRtcDeviceInfo对象。

注意事项

只支持macOS。

setPlaybackDevice

- (int)setPlaybackDevice:(NSString*_Nonnull)deviceId;

功能说明

设置扬声器设备。

请求参数

deviceId:设备ID,从getPlaybackDevices获取。

返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

只支持macOS。

getRecordingDevices

- (NSArray<HWRtcDeviceInfo*>*)getRecordingDevices;

功能说明

获取麦克风设备。

请求参数

返回参数

NSArray <HWRtcDeviceInfo*>数组类型。数组内为HWRtcDeviceInfo对象。

注意事项

只支持macOS。

setRecordingDevice

- (int)setRecordingDevice:(NSString*_Nonnull)deviceId;

功能说明

设置麦克风设备。

请求参数

deviceId:设备ID,从getPlaybackDevices获取。

返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

只支持macOS。

setPlaybackDevice

- (int)setPlaybackDevice:(NSString*)deviceId;

功能说明

设置当前扬声器设备。

请求参数

deviceId:设备ID,可以从getPlaybackDevices获取。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

支持macOS。

setRecordingDevice

- (int)setRecordingDevice:(NSString*)deviceId;

功能说明

设置麦克风设备。

请求参数

deviceId:设备ID,可以从getRecordingDevices获取到设备ID。

返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

只支持macOS。

getVideoDevices

- (NSArray<HWRtcDeviceInfo*>*)getVideoDevices;

功能说明

获取摄像头设备。

请求参数

无。

返回参数

NSArray <HWRtcDeviceInfo*>数组类型。数组内为HWRtcDeviceInfo对象。

注意事项

只支持macOS。

setVideoDevice

- (int)setVideoDevice:(NSString*)deviceId;

功能说明

设置摄像头设备。

请求参数

deviceId:设备ID,可以从getVideoDevices获取到设备ID。

返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

只支持macOS。

setPlaybackDevicesVolume

- (int)setPlaybackDevicesVolume:(unsigned int)volume;

功能说明

设置扬声器的音量。

请求参数

volume:取值范围为0-100,其中10为正常音量,0为静音,100为最大音量。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

支持macOS。

getPlaybackDevicesVolume

- (int)getPlaybackDevicesVolume;

功能说明

获取扬声器的音量。

请求参数

返回参数

音量,取值范围为0-100,其中10为正常音量,0为静音,100为最大音量。

注意事项

支持macOS。

setRecordingDevicesVolume

- (int)setRecordingDevicesVolume:(unsigned int)volume;

功能说明

设置采集声音音量。

请求参数

volume:音量大小,取值范围为0-100,其中10为正常音量,0为静音,100为最大音量。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

支持macOS。

getRecordingDevicesVolume

- (int)getRecordingDevicesVolume;

功能说明

获取麦克风采集的音量。

请求参数

返回参数

音量,取值在0-100,其中10为正常音量,0为静音,100为最大音量。

注意事项

仅支持macOS。

setPlaybackDeviceMute

- (int)setplaybackDeviceMute:(BOOL)mute;

功能说明

设置扬声器播放是否静音。

请求参数

mute:YES表示静音,NO表示不静音。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

仅支持macOS。

setRecordingDeviceMute

- (int)setRecordingDeviceMute:(BOOL)mute;

功能说明

设置麦克风是否静音。

请求参数

mute:YES表示关闭麦克风,NO表示开启麦克风。

返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

仅支持macOS。

getRecordingDeviceMute

- (BOOL)getRecordingDeviceMute;

功能说明

获取麦克风是否静音。

请求参数

返回参数

  • YES:关闭。
  • NO:未关闭。

注意事项

仅支持macOS。

getPlaybackDeviceMute

- (BOOL)getPlaybackDeviceMute;

功能说明

获取播放器是否静音。

请求参数

返回参数

  • YES:静音。
  • NO:未静音。

注意事项

仅支持macOS。

getCurrentPlaybackDevice

- (NSString *)getCurrentPlaybackDevice;

功能说明

获取当前扬声器设备。

请求参数

返回参数

当前扬声器设备。

注意事项

仅支持macOS。

getCurrentVideoDevice

- (NSString *)getCurrentVideoDevice;

功能说明

获取所有摄像头设备。

请求参数

返回参数

所有摄像头设备。

注意事项

仅支持macOS。

getCurrentRecordingDevice

- (NSString *)getCurrentRecordingDevice;

功能说明

获取当前采集声音设备。

请求参数

返回参数

当前采集声音设备。

注意事项

仅支持macOS。

logUpload

- (int)logUpload;

功能说明

上传日志。

请求参数

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

将会触发以下回调:

connectOtherRoom

- (int)connectOtherRoom:(NSString *)roomid role:(HWRtcRole)role;

功能说明

开启跨房,加入其他房间。

请求参数

  • roomid:房间ID。
  • role:用户角色。
返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

用户加入其他房间,需要收到onUserJoined回调后才能调用跨房接口。
  • 开启跨房前,需要保证该用户在本房间内为joiner角色。开启跨房后,该用户在本房间不允许再切换角色。
  • 开启跨房,需要以player角色加入其他房间,即请求参数HWRtcRole需要设置为HWRtcRolePlayer。
  • 将会触发回调onConnectOtherRoom。

disconnectOtherRoom

- (int)disconnectOtherRoom:(NSString *)roomid role:(HWRtcRole)role;

功能说明

结束跨房,离开其他房间。

请求参数
  • roomid:房间ID。
  • role:用户角色。
返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

将会触发回调onDisconnectOtherRoom。

setRemoteAudioTopNVoice

- (int)setRemoteAudioTopNVoice:(int)topNVoice;

功能说明

设置在所有可接收的音频流中,接收前N个音量最大的音频流。

请求参数

topNVoice:设置接收的音频流数量。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

互动视频建议参数设置为3,接收前3个音量最大的音频流,默认接收所有用户的音频流。

muteRemoteAudio

- (int)muteRemoteAudio:(NSString *)userid muted:(BOOL)muted;

功能说明

订阅或取消订阅某个用户音频。

请求参数

  • userid : 用户id。
  • muted:YES表示取消订阅,NO表示订阅。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

muteRemoteVideo

- (int)muteRemoteVideo:(NSString *)userid muted:(BOOL)muted;

功能说明

订阅或取消订阅某个用户视频流。

请求参数

  • userid:用户id。
  • muted:YES表示取消订阅,NO表示订阅。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

muteAllRemoteAudio

- (int)muteAllRemoteAudio:(BOOL)muted;

功能说明

订阅或取消订阅全部用户。

请求参数

muted:YES表示取消订阅,NO表示订阅。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

  • 取消所有音频流接收,同时也会取消接收新加入用户的音频流。
  • 开启所有音频流接收,同时也会开启接收新加入用户的音频流。
  • 默认开启所有音频流接收。

muteAllRemoteVideo

- (int)muteAllRemoteVideo:(BOOL)muted;

功能说明

订阅或取消订阅全部远端用户视频流。

请求参数

muted:YES表示取消订阅,NO表示订阅。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

  • 取消订阅所有远端用户视频流接收后,同时也会取消接收新加入用户的视频流。
  • 开启订阅所有远端用户视频流接收后,同时也会开启接收新加入用户的视频流。
  • 默认开启订阅所有远端用户视频流接收。

setLocalViewMirror

- (int)setLocalViewMirror:(HWRtcVideoMirrorType)mirror;

功能说明

设置本地视频镜像模式。

请求参数

mirror:镜像类型,具体请参见HWRtcVideoMirrorType

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setVideoEncoderMirror

- (int)setVideoEncoderMirror:(HWRtcVideoMirrorType)mirror;

功能说明

设置视频编码镜像模式。

请求参数

mirror:镜像类型,具体请参见HWRtcVideoMirrorType

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

该接口不改变本地摄像头的预览视图,但会改变另一端用户看到的(以及服务器录制的)视图效果。

startAudioFile

- (int)startAudioFile:(HWRtcStartAudioFileParam * _Nonnull)startAudioFileParam;

功能说明

开始播放音频文件。当前只支持本地播放。

请求参数

startAudioFileParam:镜像类型,具体请参见HWRtcStartAudioFileParam

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

需要加入房间后再调用此接口。

将会触发onStartAudioFile回调。

stopAudioFile

- (int)stopAudioFile;

功能说明

停止播放音频文件。

请求参数

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

需要加入房间后再调用此接口。

将会触发onStopAudioFile回调。

pauseAudioFile

- (int)pauseAudioFile;

功能说明

暂停播放音频文件。

请求参数

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

需要加入房间后再调用此接口。

将会触发onPauseAudioFile回调。

resumeAudioFile

- (int)resumeAudioFile;

功能说明

恢复播放音频文件。

请求参数

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

需要加入房间后再调用此接口。

将会触发onResumeAudioFile回调。

setExternalAudioCapture

- (int)setExternalAudioCapture:(BOOL)enable sampleRate:(NSUInteger)sampleRate channels:(NSUInteger)channels;

功能说明

设置是否开启外部音频采集。需要在加入房间前调用。

请求参数
  • enable:YES表示开启,NO表示关闭。
  • sampleRate:采样率。
  • channels:声道数。
返回参数
  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

  • 如果使用外部输入音频数据,需要在加入房间后,按照一定时间间隔调用pushExternalAudioFrame接口输入音频数据。
  • 不支持房间内切换。
  • 自采集音频输入规格:
    • 格式:PCM。
    • 采样率:8k/16k/44.1k/48k 。
    • 声道数:单声道。
    • 位数:16。

setExternalVideoCapture

- (int)setExternalVideoCapture:(BOOL)enabled;

功能说明

设置是否开启外部视频采集。需要在加入房间前调用。

请求参数

enable:YES表示开启,NO表示关闭。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

注意事项

如果使用外部输入视频数据,需要在加入房间后,按照一定时间间隔调用pushExternalVideoFrame接口输入视频数据。

pushExternalAudioFrame

- (int)pushExternalAudioFrame:(NSData * _Nonnull)audioData size:(NSUInteger)size;

功能说明

输入外部音频数据。

请求参数
  • audioData:音频流数据。
  • size:数据长度。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

pushExternalVideoFrame

- (int)pushExternalVideoFrame:(HWRtcVideoFrame* _Nonnull)videoFrame;

功能说明

输入外部视频数据。

请求参数

videoFrame:视频流数据 ,具体请参见HWRtcVideoFrame

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setExternalMediaFrameOutput

- (int)setExternalMediaFrameOutput:(HWRtcMediaType)mediaType remoteEnable:(BOOL)remoteEnable localEnable:(BOOL)localEnable;

功能说明

设置媒体数据自渲染。

请求参数
  • mediaType:“audio”表示设置音频,“video”表示设置视频 ,具体请参见HWRtcMediaType
  • remoteEnable:YES表示开启远端自渲染, NO表示关闭远端自渲染。
  • localEnable:YES表示开启本地自渲染,NO表示关 闭本地自渲染。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

startNetworkTest

- (int)startNetworkTest:(HWRTCNetworkTestConfig *_Nonnull)netWorkTestConfig;

功能说明

会前网络质量开启测试。

请求参数

netWorkTestConfig:检测配置,具体请参见HWRTCNetworkTestConfig

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

stopNetworkTest

- (int)stopNetworkTest;

功能说明

会前网络质量停止测试。

请求参数

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setEnableRtcStats

- (int)setEnableRtcStats:(BOOL)enable;

功能说明

打点开关。

在初始化前或初始化后调用,默认开启。

请求参数

enable:YES表示开启,NO表示关闭。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

enableSmallVideoStream

- (int)enableSmallVideoStream:(BOOL)enable encParam:(HWRtcVideoEncode * _Nonnull)encParam;

功能说明

设置小流编码信息。

请求参数

  • enable:YES表示开启小流,NO表示关闭小流。
  • encParam:小流编码信息,具体请参见HWRtcVideoEncode

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setPriorRemoteVideoStreamType

- (int)setPriorRemoteVideoStreamType:(HWRtcVideoStreamType)type;

功能说明

大小流模式,设置选看的远端视频流默认类型,默认选看大流。

请求参数

type:大小流类型,具体请参见HWRtcVideoStreamType

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setRemoteVideoStreamType

- (int)setRemoteVideoStreamType:(NSString * _Nonnull)userId  type:(HWRtcVideoStreamType)type;

功能说明

设置选看指定用户的大流或者小流。

请求参数

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setDefaultMuteAllRemoteVideoStreams

- (int)setDefaultMuteAllRemoteVideoStreams:(BOOL)mute;

功能说明

设置是否自动选看远端视频流。此方法需要在加入房间前调用。

请求参数

mute: YES表示关闭远端自动选看,NO表示开启远端自动选看。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setupRemoteView

- (int)setupRemoteView:(HWRtcVideoCanvas * _Nonnull)remote;

功能说明

设置远端视图 。

请求参数

remote: 远端视图,具体请参见HWRtcVideoCanvas。remote为nil时表示关闭远端视图。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setRemoteVideoAdjustResolution

- (int)setRemoteVideoAdjustResolution:(BOOL)enable;

功能说明

设置远端下行视频流分辨率的自适应 。

请求参数

enable:YES表示启动自适应,NO表示关闭自适应。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setVideoEncodeResolutionMode

- (int)setVideoEncodeResolutionMode:(HWRtcVideoEncodeResolutionMode)mode;

功能说明

设置视频编码分辨率比例模式 。

请求参数

mode:视频模式,具体请参见HWRtcVideoEncodeResolutionMode

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode

setVolumeNotifyInterval

- (int)setVolumeNotifyInterval:(int)volInterval;

功能说明

设置最大音量上报频率 。

请求参数

  • volInterval:间隔时间, 0 关闭音量上报不再触发回调 。volInterval取值范围是[100 10000]ms。建议设置为2000ms。

返回参数

  • 0:成功。
  • > 0:方法调用失败。具体请参见HWRtcErrorCode
分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问