NERoomRtcController
@objcMembers
public class NERoomRtcController : NERoomRtcBaseController
房间音视频控制器
-
功能是否是否支持
Declaration
Swift
public override var isSupported: Bool { get }
-
加入音视频房间
Declaration
Swift
public func joinRtcChannel(_ callback: NECallback<AnyObject>? = nil)
Parameters
callback
回调闭包
-
离开音视频房间
Declaration
Swift
public func leaveRtcChannel(_ callback: NECallback<AnyObject>? = nil)
Return Value
回调闭包
-
关闭本端音频
Declaration
Swift
public func muteMyAudio(_ callback: NECallback<AnyObject>? = nil)
Parameters
callback
回调闭包
-
打开本端音频
Declaration
Swift
public func unmuteMyAudio(_ callback: NECallback<AnyObject>? = nil)
Parameters
callback
回调闭包
-
关闭成员音频
Declaration
Swift
public func muteMemberAudio(userUuid: String, callback: NECallback<AnyObject>?)
Parameters
userUuid
成员ID
callback
回调
-
打开成员音频
Declaration
Swift
public func unmuteMemberAudio(userUuid: String, callback: NECallback<AnyObject>? = nil)
Parameters
userUuid
成员ID
callback
回调
-
关闭本端视频
Declaration
Swift
public func muteMyVideo(_ callback: NECallback<AnyObject>? = nil)
Parameters
callback
回调闭包
-
打开本端视频
Declaration
Swift
public func unmuteMyVideo(_ callback: NECallback<AnyObject>? = nil)
Parameters
callback
回调闭包
-
关闭成员视频
Declaration
Swift
public func muteMemberVideo(userUuid: String, callback: NECallback<AnyObject>?)
Parameters
userUuid
成员ID
callback
回调
-
打开成员视频
Declaration
Swift
public func unmuteMemberVideo(userUuid: String, callback: NECallback<AnyObject>?)
Parameters
userUuid
成员ID
callback
回调
-
应用外屏幕共享初始化
Declaration
Swift
public func setupShareKit(appGroup: String)
Parameters
appGroup
App Group
-
开启屏幕共享
Declaration
Swift
public func startScreenShare(callback: NECallback<AnyObject>? = nil)
Parameters
callback
回调闭包
-
关闭屏幕共享
Declaration
Swift
public func stopScreenShare(callback: NECallback<AnyObject>? = nil)
Parameters
callback
回调闭包
-
关闭房间内成员的屏幕共享
Declaration
Swift
public func stopMemberScreenShare(userUuid: String, callback: NECallback<AnyObject>? = nil)
Parameters
userUuid
成员ID
callback
回调
-
外部采集输入
Declaration
Swift
@discardableResult public func pushExternalVideoFrame(frame: NERoomVideoFrame) -> Int
-
设置是否采用外部采集
Declaration
Swift
@discardableResult public func setExternalVideoSource(enable: Bool, isScreen: Bool) -> Int
-
查询屏幕共享者的userUuid
Declaration
Swift
public func getScreenSharingUserUuid() -> String?
Return Value
屏幕共享者的userUuid
-
订阅指定远端用户的视频流
Declaration
Swift
@discardableResult public func subscribeRemoteVideoStream(userUuid: String, streamType: NEVideoStreamType) -> Int
-
取消订阅指定远端用户的视频流
Declaration
Swift
@discardableResult public func unsubscribeRemoteVideoStream(userUuid: String, streamType: NEVideoStreamType) -> Int
-
订阅指定远端用户辅流视频
Declaration
Swift
@discardableResult public func subscribeRemoteVideoSubStream(userUuid: String) -> Int
-
取消订阅远端辅流
Declaration
Swift
@discardableResult public func unsubscribeRemoteVideoSubStream(userUuid: String) -> Int
-
设置远端用户视图
Declaration
Swift
@discardableResult public func setupRemoteVideoCanvas(videoView: NERoomVideoView?, userUuid: String) -> Int
-
设置远端的辅流视频画布
Declaration
Swift
@discardableResult public func setupRemoteVideoSubStreamCanvas(videoView: NERoomVideoView?, userUuid: String) -> Int
-
调节本地播放的指定远端用户的信号音量
加入房间后,您可以多次调用该方法设置本地播放的不同远端用户的音量; 也可以反复调节本地播放的某个远端用户的音量
- Return: 0: 代表成功 否则失败
Declaration
Swift
@discardableResult public func adjustUserPlaybackSignalVolume(userUuid: String, volume: UInt32) -> Int
-
开始跨频道转发
该方法可用于实现跨房间连麦等场景。支持同时转发到 4 个房间,同一个房间可以有多个转发进来的媒体流
Declaration
Swift
public func startChannelMediaRelay(callback: NECallback<AnyObject>? = nil)
Parameters
callback
回调闭包
-
结束跨频道转发
主播离开房间时,跨房间媒体流转发自动停止,您也可以在需要的时候随时调用 stopChannelMediaRelay 方法,此时主播会退出所有目标房间
Declaration
Swift
public func stopChannelMediaRelay(callback: NECallback<AnyObject>? = nil)
Parameters
callback
回调闭包
-
打开或关闭扬声器
Declaration
Swift
@discardableResult public func setSpeakerphoneOn(on: Bool) -> Int
-
查询扬声器是否开启
Declaration
Swift
@discardableResult public func isSpeakerphoneOn() -> Bool
-
停止音频dump
Declaration
Swift
@discardableResult public func stopAudioDump() -> Int
-
打开音频dump
Declaration
Swift
@discardableResult public func startAudioDump(type: NEAudioDumpType) -> Int
-
启用说话者音量提示
该方法允许 SDK 定期向 App 反馈本地发流用户和瞬时音量最高的远端用户(最多 3 位)的音量相关信息, 即当前谁在说话以及说话者的音量。启用该方法后,只要房间内有发流用户,无论是否有人说话, SDK 都会在加入房间后根据预设的时间间隔触发 onRemoteAudioVolumeIndication 回调
Declaration
Swift
@discardableResult public func enableAudioVolumeIndication(enable: Bool, interval: Int) -> Int
-
开启耳返
Declaration
Swift
@discardableResult public func enableEarback(volume: UInt32) -> Int
-
关闭耳返
Declaration
Swift
@discardableResult public func disableEarback() -> Int
-
播放指定音效文件
Declaration
Swift
@discardableResult public func playEffect(effectId: UInt32, option: NERoomCreateAudioEffectOption) -> Int
-
设置音效发送音量
Declaration
Swift
@discardableResult public func setEffectSendVolume(effectId: UInt32, volume: UInt32) -> Int
-
设置音效播放音量
Declaration
Swift
@discardableResult public func setEffectPlaybackVolume(effectId: UInt32, volume: UInt32) -> Int
-
停止播放指定音效文件
Declaration
Swift
@discardableResult public func stopEffect(effectId: UInt32) -> Int
-
关闭所有音效
Declaration
Swift
@discardableResult public func stopAllEffects() -> Int
-
开启混音
Declaration
Swift
@discardableResult public func startAudioMixing(option: NERoomCreateAudioMixingOption) -> Int
-
停止播放音乐文件及混音
Declaration
Swift
@discardableResult public func stopAudioMixing() -> Int
-
设置混音发送音量
Declaration
Swift
@discardableResult public func setAudioMixingSendVolume(volume: UInt32) -> Int
-
设置混音播放音量
Declaration
Swift
@discardableResult public func setAudioMixingPlaybackVolume(volume: UInt32) -> Int