NERtcChannel类 参考

#include <NERtcChannel.h>

类 NERtcChannel 继承关系图:

额外继承的成员函数
构造函数 继承自 <INERtcChannel>
(int)	- destroy
(int)	- setChannelDelegate:
	设置 channel 的回调。
(int)	- setDelegateQueue:
	设置驱动 NERtcChannelDelegate 事件回调队列
(NSString *)	- getChannelName
	获取当前房间名。
(NERtcConnectionStateType)	- connectionState
	获取当前房间连接状态。
(int)	- joinChannelWithToken:completion:
	加入音视频房间。 通过本接口可以实现加入音视频房间，加入房间后可以与房间内的其他用户进行音视频通话。
(int)	- joinChannelWithToken:myUid:completion:
	加入音视频房间。 通过本接口可以实现加入音视频房间，加入房间后可以与房间内的其他用户进行音视频通话。
(int)	- joinChannelWithToken:myUid:channelOptions:completion:
	加入音视频房间。 通过本接口可以实现加入音视频房间，加入房间后可以与房间内的其他用户进行音视频通话。
(int)	- leaveChannel
	离开音视频房间。 通过本接口可以实现挂断或退出通话，并释放本房间内的相关资源。
(int)	- enableLocalAudio:
	开启/关闭本地音频采集和发送。 通过本接口可以实现开启或关闭本地语音功能，进行本地音频采集及处理。
(int)	- enableLocalVideo:
	开启或关闭本地视频的采集与发送。 通过本接口可以实现开启或关闭本地视频，不影响接收远端视频。
(int)	- enableLocalVideo:streamType:
	开启或关闭本地视频的采集与发送。 通过主流或辅流视频通道进行本地视频流的采集与发送。
(int)	- enableMediaPub:withMediaType:
	开启或关闭本地媒体流（主流）的发送。 该方法用于开始或停止向网络发送本地音频或视频数据。 该方法不影响接收或播放远端媒体流，也不会影响本地音频或视频的采集状态。
(int)	- enableDualStreamMode:
	设置是否开启视频大小流模式。 通过本接口可以实现设置单流或者双流模式。发送端开启双流模式后，接收端可以选择接收大流还是小流。其中，大流指高分辨率、高码率的视频流，小流指低分辨率、低码率的视频流。
(int)	- setCameraCaptureConfig:
	设置本地摄像头的视频主流采集配置。 通过此接口可以设置本地摄像头采集的主流视频宽度、高度、旋转角度等。
(int)	- setCameraCaptureConfig:streamType:
	设置本地摄像头的视频主流或辅流采集配置。 通过此接口可以设置本地摄像头采集的主流或辅流视频宽度、高度、旋转角度等。
(int)	- setLocalVideoConfig:
	设置视频编码属性。 通过此接口可以设置视频主流的编码分辨率、裁剪模式、码率、帧率、带宽受限时的视频编码降级偏好、编码的镜像模式、编码的方向模式参数，详细信息请参考 设置视频属性。
(int)	- setLocalVideoConfig:streamType:
	设置视频编码属性。 通过此接口可以设置视频主流或辅流的编码分辨率、裁剪模式、码率、帧率、带宽受限时的视频编码降级偏好、编码的镜像模式、编码的方向模式参数。
(int)	- switchCamera
	切换前置/后置摄像头。 该方法需要在相机启动后调用，例如调用 startPreview 或 joinChannel 后。
(int)	- switchCameraWithPosition:
	指定前置/后置摄像头。 该方法需要在相机启动后调用，例如调用 startPreview 或 joinChannel 后。
(int)	- subscribeRemoteAudio:forUserID:
	取消或恢复订阅指定远端用户的音频主流。 加入房间时，默认订阅所有远端用户的音频主流，您也可以通过此方法取消或恢复订阅指定远端用户的音频主流。
(int)	- subscribeAllRemoteAudio:
	取消或恢复订阅所有远端用户的音频主流。 加入房间时，默认订阅所有远端用户的音频主流，即 INERtcEngine#setParameters: 方法的 kNERtcKeyAutoSubscribeAudio 参数默认设置为 YES；只有当该参数的设置为 NO 时，此接口的调用才会生效。
(int)	- setAudioSubscribeOnlyBy:
	设置自己的音频只能被房间内指定的人订阅。 默认房间所有其他人都可以订阅自己的音频。
(int)	- muteLocalAudio:
	开启或关闭本地音频主流的发送。 该方法用于向网络发送或取消发送本地音频数据，不影响本地音频的采集状态，也不影响接收或播放远端音频流。
(int)	- enableAudioVolumeIndication:interval:vad:
	启用说话者音量提示。 该方法允许 SDK 定期向 App 反馈本地发流用户和瞬时音量最高的远端用户（最多 3 位）的音量相关信息，即当前谁在说话以及说话者的音量。 启用该方法后，只要房间内有发流用户，无论是否有人说话，SDK 都会在加入房间后根据预设的时间间隔触发 NERtcEngineDelegateEx#onRemoteAudioVolumeIndication:totalVolume: 回调。
(int)	- setupLocalVideoCanvas:
	设置本地用户视图。 通过本接口可以实现绑定本地用户和显示视图，并设置本地用户视图在本地显示时的镜像模式和裁减比例，只影响本地用户看到的视频画面。
(int)	- setLocalRenderScaleMode:
	设置画布中本地视频画面的显示模式。 通过本接口可以实现设置本地视频画面的适应性，即是否裁剪或缩放。
(int)	- setupRemoteVideoCanvas:forUserID:
	设置远端用户视图。 通过本接口可以实现绑定远端用户和显示视图，并设置远端用户视图在本地显示时的镜像模式和裁减比例，只影响本地用户看到的视频画面。
(int)	- setRemoteRenderScaleMode:forUserID:
	设置画布中远端视频画面的显示模式。 通过本接口可以实现设置远端视频画面的适应性，即是否裁剪或缩放。
(int)	- subscribeRemoteVideo:forUserID:streamType:
	订阅或取消订阅指定远端用户的视频主流。 加入房间后，默认不订阅所有远端用户的视频主流；若您希望看到指定远端用户的视频，可以在监听到对方加入房间或发布视频流之后，通过此方法订阅该用户的视频主流。
(int)	- muteLocalVideo:
	取消或恢复发布本端视频主流。 调用该方法取消发布本地视频主流后，SDK 不再发送本地视频主流。
(int)	- muteLocalVideo:streamType:
	取消或恢复发布本地视频。 调用该方法取消发布本地视频主流或辅流后，SDK 不再发送本地视频流。
(int)	- setExternalVideoSource:streamType:
	开启或关闭外部视频源数据输入。 通过本接口可以实现创建自定义的外部视频源，您可以选择通过主流或辅流通道传输该外部视频源的数据，但暂不支持同时开启。
(int)	- pushExternalVideoFrame:streamType:
	推送外部视频帧。 该方法主动将视频帧数据用 NERtcVideoFrame 类封装后传递给 SDK。
(int)	- setClientRole:
	设置直播场景下的用户角色。 通过本接口可以实现将用户角色在“主播”（kNERtcClientRoleBroadcaster）和“观众“（kNERtcClientRoleAudience）之间的切换，用户加入房间后默认为“主播”。
(int)	- adjustUserPlaybackSignalVolume:forUserID:
	调节本地播放的指定远端用户的信号音量。 通过此接口可以实现在通话过程中随时调节指定远端用户在本地播放的混音音量。
(int)	- adjustChannelPlaybackSignalVolume:
	调节本地播放的指定房间的所有远端用户的信号音量。 通过此接口可以实现在通话过程中随时调节指定房间内的所有远端用户在本地播放的混音音量。
(int)	- enableLocalSubStreamAudio:
	开启或关闭音频辅流。 开启时远端会收到 NERtcChannelDelegate#onNERtcChannelUserSubStreamAudioDidStart: 回调，关闭时远端会收到 NERtcChannelDelegate#onNERtcChannelUserSubStreamAudioDidStop: 回调。
(int)	- subscribeRemoteSubStreamAudio:forUserID:
	设置是否订阅指定远端用户的音频辅流。
(int)	- muteLocalSubStreamAudio:
	静音或解除静音本地上行的音频辅流。
(int)	- setupLocalSubStreamVideoCanvas:
	设置本端用户的视频辅流画布。 通过此接口可以实现设置本端用户的辅流显示视图。
(int)	- startScreenCapture:
	开启屏幕共享。 通过此接口开启屏幕共享后，屏幕共享内容以视频辅流的形式发送。
(int)	- stopScreenCapture
	关闭屏幕共享。 通过此接口可以实现关闭屏幕共享辅流。
(int)	- setLocalRenderSubStreamScaleMode:
	设置画布中本地屏幕共享辅流视频画面的显示模式。 通过本接口可以实现设置本地发布的屏幕共享视频画面的适应性，即是否裁剪或缩放。
(int)	- setupRemoteSubStreamVideoCanvas:forUserID:
	设置远端用户的视频辅流画布。 通过此接口可以实现绑定远端用户和对应辅流的显示视图，即指定某个 uid 使用对应的画布显示。
(int)	- subscribeRemoteSubStreamVideo:forUserID:
	订阅或取消订阅远端用户的视频辅流。
(int)	- setRemoteRenderSubStreamVideoScaleMode:forUserID:
	设置画布中远端屏幕共享视频画面的显示模式。 通过本接口可以实现设置远端发布的屏幕共享视频画面的适应性，即是否裁剪或缩放。
(int)	- setRemoteHighPriorityAudioStream:forUserID:streamType:
	设置远端用户音频流的高优先级。 支持在音频自动订阅的情况下，设置某一个远端用户的音频为最高优先级，可以优先听到该用户的音频。
(int)	- setRangeAudioMode:
	设置范围语音模式
(int)	- setRangeAudioTeamID:
	设置范围语音小队
(int)	- setAudioRecvRange:conversationalDistance:rollOff:
	引擎 3D 音效算法距离范围设置
(int)	- updateSelfPosition:
	设置空间音效中说话者和接收者的空间位置信息。SDK 会根据该方法中的参数计算接收者和说话者之间的相对位置，进而渲染出空间音效。
(int)	- enableSpatializerRoomEffects:
	开启或关闭空间音效的房间混响效果
(int)	- setSpatializerRoomProperty:
	设置空间音效的房间混响属性
(int)	- setSpatializerRenderMode:
	设置空间音效的渲染模式
(int)	- initSpatializer
	初始化引擎 3D 音效算法
(int)	- enableSpatializer:applyToTeam:
	开启或关闭空间音效
(int)	- setSubscribeAudioBlocklist:uidArray:
	您可以调用该方法指定不订阅的音频流。
(int)	- setSubscribeAudioAllowlist:
	您可以调用该方法指定只订阅的音频流。
(int)	- takeLocalSnapshot:callback:
	本地视频画面截图。 调用 takeLocalSnapshot 截取本地主流或本地辅流的视频画面，并通过 NERtcTakeSnapshotCallback 的回调返回截图画面的数据。
(int)	- takeRemoteSnapshot:forUserID:callback:
	远端视频画面截图。 调用 takeRemoteSnapshot 截取指定 uid 远端主流和远端辅流的视频画面，并通过 NERtcTakeSnapshotCallback 的回调返回截图画面的数据。
(int)	- sendSEIMsg:streamChannelType:
	指定主流或辅流通道发送媒体增强补充信息（SEI）。 在本端推流传输音视频流数据同时，发送流媒体补充增强信息来同步一些其他附加信息。当推流方发送 SEI 后，拉流方可通过监听 onRecvSEIMsg 的回调获取 SEI 内容。
(int)	- sendSEIMsg:
	通过主流通道发送媒体增强补充信息（SEI）。 在本端推流传输音视频流数据同时，发送流媒体补充增强信息来同步一些其他附加信息。当推流方发送 SEI 后，拉流方可通过监听 onRecvSEIMsg 的回调获取 SEI 内容。
(int)	- addLiveStreamTask:compeltion:
	添加房间内推流任务。 通过此接口可以实现增加一路旁路推流任务；若需推送多路流，则需多次调用该方法。
(int)	- updateLiveStreamTask:compeltion:
	更新房间内指定推流任务。 通过此接口可以实现调整指定推流任务的编码参数、画布布局、推流模式等。
(int)	- removeLiveStreamTask:compeltion:
	删除房间内指定推流任务。
(int)	- addChannelMediaStatsObserver:
	注册媒体统计信息观测器。
(int)	- removeChannelMediaStatsObserver:
	移除指定媒体统计信息观测器。
(int)	- cleanupChannelMediaStatsObserver
	清除全部媒体统计信息观测器。
(int)	- startChannelMediaRelay:
	开始跨房间媒体流转发。
(int)	- updateChannelMediaRelay:
	更新媒体流转发的目标房间。 成功开始跨房间转发媒体流后，如果您希望将流转发到多个目标房间，或退出当前的转发房间，可以调用该方法。
(int)	- stopChannelMediaRelay
	停止跨房间媒体流转发。 通常在主播离开房间时，跨房间媒体流转发会自动停止；您也可以根据需要随时调用该方法，此时主播会退出所有目标房间。
(int)	- setLocalMediaPriority:preemptive:
	设置本地用户的媒体流优先级。 通过此接口可以实现设置某用户的媒体流优先级为高，从而弱网环境下 SDK 会优先保证其他用户收到的该用户媒体流的质量。
(int)	- setLocalPublishFallbackOption:
	设置弱网条件下发布的音视频流回退选项。 在网络不理想的环境下，发布的音视频质量都会下降。使用该接口并将 option 设置为 kNERtcStreamFallbackOptionAudioOnly 后:
(int)	- setRemoteSubscribeFallbackOption:
	设置弱网条件下订阅的音视频流回退选项。 弱网环境下，订阅的音视频质量会下降。通过该接口设置订阅音视频流的回退选项后：
(int)	- updatePermissionKey:
	更新权限密钥。
(int)	- reportCustomEvent:customIdentify:param:
	上报自定义事件

---

该类的文档由以下文件生成:

• D:/Formatter/api-doc-to-git/lava/lava/nertcsdk/src/sdk/ios/include/NERtcChannel.h