#import <NERtcEngine.h>
类 NERtcEngine 继承关系图:
类方法 | |
| (instancetype) | + sharedEngine |
| 获取 NERtcEngine 实例 获取之后一直到调用destroyEngine之前，返回的实例都将是同一个 更多... | |
| (int) | + destroyEngine |
| 销毁 NERtcEngine 实例，并释放资源。 该方法释放 NERTC SDK 使用的所有资源。有些 App 只在用户需要时才进行实时音视频通信，完成音视频通话后，则将资源释放出来用于其他操作，该方法适用于此类情况。 更多... | |
| (NSString *) | + getVersion |
| 查询 SDK 版本号， 该方法在加入房间前后都能调用 更多... | |
额外继承的成员函数 | |
 构造函数 继承自 <INERtcEngineEx> | |
| (int) | - enableDualStreamMode: |
| 设置是否开启视频大小流模式。 该方法设置单流或者双流模式。发送端开启双流模式后，接收端可以选择接收大流还是小流。其中，大流指高分辨率、高码率的视频流，小流指低分辨率、低码率的视频流。 更多... | |
| (int) | - setLocalMediaPriority:preemptive: |
| 设置本地用户的媒体流优先级。 如果某个用户的优先级为高，那么该用户媒体流的优先级就会高于其他用户，弱网环境下 SDK 会优先保证其他用户收到的、高优先级用户的媒体流的质量。 更多... | |
| (int) | - setLocalPublishFallbackOption: |
| 设置弱网条件下发布的音视频流回退选项。 在网络不理想的环境下，发布的音视频质量都会下降。使用该接口并将 option 设置为 kNERtcStreamFallbackOptionAudioOnly 后: 更多... | |
| (int) | - setRemoteSubscribeFallbackOption: |
| 设置弱网条件下订阅的音视频流回退选项。 弱网环境下，订阅的音视频质量会下降。通过该接口设置订阅音视频流的回退选项后： 更多... | |
| (int) | - muteLocalAudio: |
| 开启或关闭本地音频主流的发送。 该方法用于向网络发送或取消发送本地音频数据。 该方法不影响接收或播放远端音频流，也不会影响本地音频的采集状态。 更多... | |
| (int) | - subscribeRemoteAudio:forUserID: |
| 取消或恢复订阅指定远端用户音频流。 加入房间时，默认订阅所有远端用户的音频流，您可以通过此方法取消或恢复订阅指定远端用户的音频流。 更多... | |
| (int) | - subscribeAllRemoteAudio: |
| 取消或恢复订阅所有远端用户音频流。 更多... | |
| (int) | - setAudioSubscribeOnlyBy: |
| 设置自己的音频只能被房间内指定的人订阅。 默认房间所有其他人都可以订阅自己的音频。 更多... | |
| (int) | - enableLocalSubStreamAudio: |
| 开启或关闭音频辅流。 开启时远端会收到 NERtcChannelDelegate#onNERtcChannelUserSubStreamAudioDidStart: 回调 ，关闭时远端会收到 NERtcChannelDelegate#onNERtcChannelUserSubStreamAudioDidStop: 回调。 更多... | |
| (int) | - subscribeRemoteSubStreamAudio:forUserID: |
| 取消或恢复订阅指定远端用户音频辅流。 加入房间时，默认订阅所有远端用户的音频流，您可以通过此方法取消或恢复订阅指定远端用户的音频辅流。 更多... | |
| (int) | - muteLocalSubStreamAudio: |
| 静音或解除静音本地上行的音频辅流。 更多... | |
| (int) | - setExternalSubStreamAudioSource:sampleRate:channels: |
| 开启或关闭外部音频辅流输入。 调用成功后可以使用 pushExternalSubStreamAudioFrame: 接口发送音频辅流 PCM 数据。 更多... | |
| (int) | - pushExternalSubStreamAudioFrame: |
| 推送外部音频辅流数据帧。 将外部音频辅流帧数据帧主动推送给内部引擎。通过 INERtcEngineEx.enableLocalSubStreamAudio: 启用音频辅流后，可以调用此接口发送音频辅流 PCM 数据。 更多... | |
| (int) | - subscribeRemoteVideo:forUserID:streamType: |
| 订阅或取消订阅指定远端用户的视频流。 更多... | |
| (int) | - startPreview |
| 开启视频预览。 该方法用于在进入房间前启动本地视频预览。调用该 API 前，必须调用 setupLocalVideoCanvas 设置视频画布。 更多... | |
| (int) | - startPreview: |
| 开启视频预览。 通过本接口可以实现在加入房间前启动本地视频预览，支持预览本地摄像头或外部输入视频。 更多... | |
| (int) | - stopPreview |
| 停止视频预览。 更多... | |
| (int) | - stopPreview: |
| 停止视频预览。 通过本接口可以实现在预览本地视频后关闭预览。 更多... | |
| (int) | - setLocalRenderScaleMode: |
| 设置本端的视频显示模式。 更多... | |
| (int) | - setRemoteRenderScaleMode:forUserID: |
| 设置远端的视频显示模式。 更多... | |
| (int) | - setVideoRotationMode: |
| 设置本地视频画面的旋转模式。 该接口用于设置本地视频画面在本地和远端设备上的旋转模式，可以指定本地画面和系统设备的横屏/竖屏模式一致、或者和 App UI的横屏/竖屏模式一致。 更多... | |
| (int) | - muteLocalVideo: |
| 取消或恢复发布本地视频流。 更多... | |
| (int) | - muteLocalVideo:streamType: |
| 取消或恢复发布本地视频。 调用该方法取消发布本地视频主流或辅流后，SDK 不再发送本地视频流。 更多... | |
| (int) | - setLoudspeakerMode: |
| 启用或关闭扬声器播放。 该方法设置是否将语音路由到扬声器，即设备外放。 更多... | |
| (int) | - getLoudspeakerMode: |
| 检查扬声器状态启用状态。 更多... | |
| (int) | - startAudioDump |
| 开始记录音频 dump。 音频 dump 可用于分析音频问题。 更多... | |
| (int) | - startAudioDumpWithType: |
| 开始进行音频 dump。 更多... | |
| (int) | - stopAudioDump |
| 结束记录音频 dump。 更多... | |
| (int) | - setRemoteHighPriorityAudioStream:forUserID:streamType: |
| 设置远端用户音频流的高优先级。 支持在音频自动订阅的情况下，设置某一个远端用户的音频为最高优先级，可以优先听到该用户的音频。 更多... | |
| (int) | - switchCameraWithPosition: |
| 指定前置/后置摄像头。 该方法需要在相机启动后调用，例如调用 startPreview 或 joinChannel 后。 更多... | |
| (int) | - setExternalVideoSource:isScreen: |
| 开启或关闭外部视频源数据输入。 更多... | |
| (int) | - setExternalVideoSource:streamType: |
| 开启或关闭外部视频源数据输入。 通过本接口可以实现创建自定义的外部视频源，您可以选择通过主流或辅流通道传输该外部视频源的数据，但暂不支持同时开启。 更多... | |
| (int) | - pushExternalVideoFrame: |
| 推送外部视频帧。 该方法主动将视频帧数据用 NERtcVideoFrame 类封装后传递给 SDK。 更多... | |
| (int) | - setupLocalSubStreamVideoCanvas: |
| 设置本地辅流视频画布。 该方法设置本地辅流视频显示信息。App 通过调用此接口绑定本地辅流的显示视窗（view）。 在 App 开发中，通常在初始化后调用该方法进行本地视频设置，然后再加入房间。 更多... | |
| (int) | - startScreenCapture: |
| 开启屏幕共享，屏幕共享内容以辅流形式发送。 只能在加入房间后调用。 如果您在加入房间后调用该方法开启辅流，调用成功后，远端触发 onNERtcEngineUserSubStreamDidStartWithUserID 回调。 更多... | |
| (int) | - stopScreenCapture |
| 关闭辅流形式的屏幕共享。 如果您在加入房间后调用该方法关闭辅流，调用成功后，远端触发 onNERtcEngineUserSubStreamDidStop 回调。 更多... | |
| (int) | - setLocalRenderSubStreamScaleMode: |
| 设置本端的屏幕共享辅流视频显示模式。 在本端开启辅流形式的屏幕共享时使用。App 可以多次调用此方法更改显示模式。 更多... | |
| (int) | - setupRemoteSubStreamVideoCanvas:forUserID: |
| 设置远端的辅流视频画布。 该方法绑定远端用户和辅流显示视图，即指定某个 userID 使用对应的画布显示。 更多... | |
| (int) | - subscribeRemoteSubStreamVideo:forUserID: |
| 订阅或取消订阅远端的屏幕共享辅流视频，订阅之后才能接收远端的辅流视频数据。 更多... | |
| (int) | - setRemoteRenderSubStreamVideoScaleMode:forUserID: |
| 设置远端的屏幕共享辅流视频显示模式。 更多... | |
| (int) | - setAudioSessionOperationRestriction: |
| 设置 SDK 对 Audio Session 的控制权限。 该方法仅适用于 iOS 平台。 该方法限制 SDK 对 Audio Session 的操作权限。在默认情况下，SDK 和 App 对 Audio Session 都有控制权，但某些场景下，App 会希望限制 SDK 对 Audio Session 的控制权限，而使用其他应用或第三方组件对 Audio Session 进行操控。调用该方法可以实现该功能。 该接口只能在入会之前调用。 更多... | |
| (int) | - setPlayoutDeviceMute: |
| 设置是否静音音频播放设备。 更多... | |
| (int) | - getPlayoutDeviceMute: |
| 获取音频播放设备的静音状态。 更多... | |
| (int) | - setRecordDeviceMute: |
| 设置是否静音音频采集设备。 更多... | |
| (int) | - getRecordDeviceMute: |
| 查询当前音频采集设备是否静音。 更多... | |
| (BOOL) | - isCameraZoomSupported |
| 检测设备当前使用的摄像头是否支持缩放功能。 该方法需要在相机启动后调用，例如调用 startPreview 或 joinChannel 后。 更多... | |
| (BOOL) | - isCameraTorchSupported |
| 检测设备是否支持闪光灯常亮。 更多... | |
| (BOOL) | - isCameraFocusSupported |
| 检测设备是否支持手动对焦功能。 更多... | |
| (BOOL) | - isCameraExposurePositionSupported |
| 检测设备是否支持手动曝光功能。 更多... | |
| (int) | - setCameraExposurePosition: |
| 设置当前摄像头手动曝光位置。 成功调用该方法后，本地会触发 onCameraExposureChanged 回调。 更多... | |
| (int) | - setCameraTorchOn: |
| 设置是否打开闪光灯。 更多... | |
| (BOOL) | - isCameraTorchOn |
| 查询设备是否开启了闪光灯。 更多... | |
| (int) | - setCameraZoomFactor: |
| 设置当前摄像头缩放比例。 更多... | |
| (float) | - maxCameraZoomScale |
| 获取摄像头支持最大缩放比例。 更多... | |
| (int) | - setCameraFocusPositionX:Y: |
| 设置手动对焦位置。 成功调用该方法后，本地会触发 onNERtcCameraFocusChanged 回调。 更多... | |
| (int) | - setCameraCaptureConfig: |
| 设置本地摄像头的采集偏好等配置。 在视频通话或直播中，SDK 自动控制摄像头的输出参数。默认情况下，SDK 根据用户的 setLocalVideoConfig 配置匹配最合适的分辨率进行采集。但是在部分业务场景中，如果采集画面质量无法满足实际需求，可以调用该接口调整摄像头的采集配置。 更多... | |
| (int) | - setCameraCaptureConfig:streamType: |
| 设置本地摄像头的采集配置。 通过此接口可以设置本地摄像头采集的视频宽度、高度、旋转角度等。 更多... | |
| (int) | - startAudioMixingWithOption: |
| 开始播放音乐文件。 该方法指定本地或在线音频文件来和录音设备采集的音频流进行混音。 更多... | |
| (int) | - stopAudioMixing |
| 停止播放音乐文件及混音。 该方法停止播放伴奏。请在房间内调用该方法。 更多... | |
| (int) | - pauseAudioMixing |
| 暂停播放音乐文件及混音。 该方法暂停播放伴奏。请在房间内调用该方法。 更多... | |
| (int) | - resumeAudioMixing |
| 该方法恢复混音，继续播放伴奏。请在房间内调用该方法。 更多... | |
| (int) | - setAudioMixingSendVolume: |
| 设置伴奏的发送音量。 更多... | |
| (int) | - getAudioMixingSendVolume: |
| 获取伴奏发送音量。 该方法获取混音里伴奏的发送音量大小。请在房间内调用该方法。 更多... | |
| (int) | - setAudioMixingPlaybackVolume: |
| 调节伴奏播放音量。 该方法调节混音里伴奏的播放音量大小。请在房间内调用该方法。 更多... | |
| (int) | - getAudioMixingPlaybackVolume: |
| 获取伴奏播放音量。 该方法获取混音里伴奏的播放音量大小。请在房间内调用该方法。 更多... | |
| (int) | - getAudioMixingDuration: |
| 获取伴奏时长。 该方法获取伴奏时长，单位为毫秒。请在房间内调用该方法。 更多... | |
| (int) | - getAudioMixingCurrentPosition: |
| 获取音乐文件的播放进度。 该方法获取当前伴奏播放进度，单位为毫秒。请在房间内调用该方法。 更多... | |
| (int) | - setAudioMixingPosition: |
| 设置音乐文件的播放位置。 该方法可以设置音频文件的播放位置，这样你可以根据实际情况播放文件，而非从头到尾播放整个文件。 更多... | |
| (int) | - playEffectWitdId:effectOption: |
| 播放指定音效文件。 该方法播放指定的本地或在线音效文件。 更多... | |
| (int) | - stopEffectWitdId: |
| 停止播放指定音效文件。 更多... | |
| (int) | - stopAllEffects |
| 停止播放所有音效文件。 更多... | |
| (int) | - pauseEffectWitdId: |
| 暂停播放指定音效文件。 请在加入房间后调用该方法。 更多... | |
| (int) | - resumeEffectWitdId: |
| 恢复播放指定音效文件。 请在加入房间后调用该方法。 更多... | |
| (int) | - pauseAllEffects |
| 暂停播放所有音效文件。 请在加入房间后调用该方法。 更多... | |
| (int) | - resumeAllEffects |
| 恢复播放所有音效文件。 请在加入房间后调用该方法。 更多... | |
| (int) | - setEffectSendVolumeWithId:volume: |
| 设置音效文件发送音量。 请在加入房间后调用该方法。 更多... | |
| (int) | - getEffectSendVolumeWithId:volume: |
| 获取指定音效文件发送音量。 请在加入房间后调用该方法。 更多... | |
| (int) | - setEffectPlaybackVolumeWithId:volume: |
| 获取音效文件播放音量。 请在加入房间后调用该方法。 更多... | |
| (int) | - getEffectPlaybackVolumeWithId:volume: |
| 获取音效的回放音量 更多... | |
| (int) | - getEffectDurationWithId:duration: |
| 获取音效文件时长。 更多... | |
| (int) | - getEffectCurrentPositionWithId:position: |
| 获取音效的播放进度。 更多... | |
| (int) | - enableEarback:volume: |
| 开启耳返功能。 更多... | |
| (int) | - setEarbackVolume: |
| 设置耳返音量。 更多... | |
| (int) | - startAudioRecording:sampleRate:quality: |
| 开始客户端录音。 调用该方法后，客户端会录制房间内所有用户混音后的音频流，并将其保存在本地一个录音文件中。录制开始或结束时，自动触发 onAudioRecording() 回调。 指定的录音音质不同，录音文件会保存为不同格式： 更多... | |
| (int) | - startAudioRecordingWithConfig: |
| 开始客户端录音。 调用该方法后，客户端会录制房间内所有用户混音后的音频流，并将其保存在本地一个录音文件中。录制开始或结束时，自动触发 onAudioRecording() 回调。 指定的录音音质不同，录音文件会保存为不同格式： 更多... | |
| (int) | - stopAudioRecording |
| 停止客户端录音。 本端离开房间时自动停止录音，您也可以在通话中随时调用 stopAudioRecording 手动停止录音。 更多... | |
| (int) | - setExternalAudioSource:sampleRate:channels: |
| 开启或关闭外部音频源数据输入。 当该方法调用成功后，音频输入设备选择和异常重启会失效。调用成功后可以使用 pushExternalAudioFrame 接口发送音频 PCM 数据。 更多... | |
| (int) | - pushExternalAudioFrame: |
| 推送外部音频帧。 将外部音频数据帧推送给内部引擎。 通过 setExternalAudioSource 启用外部音频数据输入功能成功后，可以使用 pushExternalAudioFrame 接口发送音频 PCM 数据。 更多... | |
| (int) | - setExternalAudioRender:sampleRate:channels: |
| 设置外部音频渲染。 该方法适用于需要自行渲染音频的场景。默认为关闭状态。当该方法调用成功后，音频播放设备选择和异常重启失效。 调用成功后可以使用 pullExternalAudioFrame 接口获取音频 PCM 数据。 更多... | |
| (int) | - pullExternalAudioFrame:length: |
| 拉取外部音频数据。 该方法将从内部引擎拉取音频数据。 通过 setExternalAudioRender 启用外部音频数据渲染功能成功后，可以使用 pullExternalAudioFrame 接口获取音频 PCM 数据。 更多... | |
| (int) | - addEngineMediaStatsObserver: |
| 注册媒体统计信息观测器。 更多... | |
| (int) | - removeEngineMediaStatsObserver: |
| 移除指定媒体统计信息观测器。 更多... | |
| (int) | - cleanupEngineMediaStatsObserver |
| 清除全部媒体统计信息观测器。 更多... | |
| (int) | - addLiveStreamTask:compeltion: |
| 添加房间推流任务。 成功调用该方法后，当前用户可以收到该直播流的状态通知。 更多... | |
| (int) | - updateLiveStreamTask:compeltion: |
| 更新房间推流任务。 更多... | |
| (int) | - removeLiveStreamTask:compeltion: |
| 删除房间推流任务。 更多... | |
| (int) | - setRecordingAudioFrameParameters: |
| 设置采集的音频格式。 该方法设置 NERtcEngineAudioFrameObserver#onNERtcEngineAudioFrameDidRecord: 回调的录制声音格式。 更多... | |
| (int) | - setPlaybackAudioFrameParameters: |
| 设置播放的声音格式。 该方法设置 NERtcEngineAudioFrameObserver#onNERtcEngineAudioFrameWillPlayback: 回调的播放声音格式。 更多... | |
| (int) | - setMixedAudioFrameParameters: |
| 设置录制和播放声音混音后的数据格式。 该方法设置 NERtcEngineAudioFrameObserver#onNERtcEngineMixedAudioFrame: 回调的声音格式。 更多... | |
| (int) | - setAudioFrameObserver: |
| 注册语音观测器对象。 该方法用于设置音频采集/播放 PCM 回调，可用于声音处理等操作。当需要引擎返回 NERtcEngineAudioFrameObserver#onNERtcEngineAudioFrameDidRecord: 或 NERtcEngineAudioFrameObserver#onNERtcEngineAudioFrameWillPlayback: 回调时，需要使用该方法注册回调。 更多... | |
| (int) | - enableAudioVolumeIndication:interval: |
| 启用说话者音量提示。 该方法允许 SDK 定期向 App 反馈本地发流用户和瞬时音量最高的远端用户（最多 3 位）的音量相关信息，即当前谁在说话以及说话者的音量。 启用该方法后，只要房间内有发流用户，无论是否有人说话，SDK 都会在加入房间后根据预设的时间间隔触发 onRemoteAudioVolumeIndication 回调。 更多... | |
| (int) | - enableAudioVolumeIndication:interval:vad: |
| 启用说话者音量提示。 该方法允许 SDK 定期向 App 反馈本地发流用户和瞬时音量最高的远端用户（最多 3 位）的音量相关信息，即当前谁在说话以及说话者的音量。 启用该方法后，只要房间内有发流用户，无论是否有人说话，SDK 都会在加入房间后根据预设的时间间隔触发 NERtcEngineDelegateEx#onRemoteAudioVolumeIndication:totalVolume: 回调。 更多... | |
| (int) | - adjustRecordingSignalVolume: |
| 调节采集信号音量。 更多... | |
| (int) | - adjustPlaybackSignalVolume: |
| 调节本地播放的所有远端用户信号音量。 更多... | |
| (int) | - adjustUserPlaybackSignalVolume:forUserID: |
| 调节本地播放的指定远端用户的信号音量。 加入房间后，您可以多次调用该方法设置本地播放的不同远端用户的音量；也可以反复调节本地播放的某个远端用户的音量。 更多... | |
| (int) | - setLocalVoicePitch: |
| 设置本地语音音调。 该方法改变本地说话人声音的音调。 更多... | |
| (int) | - setLocalVoiceEqualizationOfBandFrequency:withGain: |
| 设置本地语音音效均衡，即自定义设置本地人声均衡波段的中心频率。 更多... | |
| (int) | - setVoiceBeautifierPreset: |
| 设置 SDK 预设的美声效果。 调用该方法可以为本地发流用户设置 SDK 预设的人声美声效果。 更多... | |
| (int) | - setAudioEffectPreset: |
| 设置 SDK 预设的人声的变声音效。 设置变声音效可以将人声原音调整为多种特殊效果，改变声音特性。 更多... | |
| (int) | - setLocalVoiceReverbParam: |
| 设置本地语音混响效果。 更多... | |
| (int) | - setLocalCanvasWatermarkConfigs:withStreamType: |
| 添加本地视频画布水印。 更多... | |
| (int) | - setRemoteCanvasWatermarkConfigs:forUserID:withStreamType: |
| 添加远端视频画布水印。 更多... | |
| (int) | - setLocalVideoWatermarkConfigs:withStreamType: |
| 设置视频水印。水印在本地预览及发送过程中均生效。 更多... | |
| (int) | - takeLocalSnapshot:callback: |
| 本地视频画面截图。 调用 takeLocalSnapshot 截取本地主流或本地辅流的视频画面，并通过 NERtcTakeSnapshotCallback 的回调返回截图画面的数据。 更多... | |
| (int) | - takeRemoteSnapshot:forUserID:callback: |
| 远端视频画面截图。 调用 takeRemoteSnapshot 截取指定 uid 远端主流和远端辅流的视频画面，并通过 NERtcTakeSnapshotCallback 的回调返回截图画面的数据。 更多... | |
| (int) | - uploadSdkInfo |
| 上传 SDK 信息。 上传的信息包括 log 和 Audio dump 等文件。 更多... | |
| (int) | - sendSEIMsg:streamChannelType: |
| 指定主流或辅流通道发送媒体增强补充信息（SEI）。 在本端推流传输音视频流数据同时，发送流媒体补充增强信息来同步一些其他附加信息。当推流方发送 SEI 后，拉流方可通过监听 onRecvSEIMsg 的回调获取 SEI 内容。 更多... | |
| (int) | - sendSEIMsg: |
| 通过主流通道发送媒体增强补充信息（SEI）。 在本端推流传输音视频流数据同时，发送流媒体补充增强信息来同步一些其他附加信息。当推流方发送 SEI 后，拉流方可通过监听 onRecvSEIMsg 的回调获取 SEI 内容。 更多... | |
| (int) | - startChannelMediaRelay: |
| 开始跨房间媒体流转发。 更多... | |
| (int) | - updateChannelMediaRelay: |
| 更新媒体流转发的目标房间。 成功开始跨房间转发媒体流后，如果你希望将流转发到多个目标房间，或退出当前的转发房间，可以调用该方法。 更多... | |
| (int) | - stopChannelMediaRelay |
| 停止跨房间媒体流转发。 主播离开房间时，跨房间媒体流转发自动停止，您也可以在需要的时候随时调用 stopChannelMediaRelay 方法，此时主播会退出所有目标房间。 更多... | |
| (int) | - enableSuperResolution: |
| 启用或停止 AI 超分。 更多... | |
| (int) | - enableEncryption:config: |
| 开启或关闭媒体流加密。 更多... | |
| (int) | - startLastmileProbeTest: |
| 开始通话前网络质量探测。 启用该方法后，SDK 会通过回调方式反馈上下行网络的质量状态与质量探测报告，包括带宽、丢包率、网络抖动和往返时延等数据。一般用于通话前的网络质量探测场景，用户加入房间之前可以通过该方法预估音视频通话中本地用户的主观体验和客观网络状态。 相关回调如下： 更多... | |
| (int) | - stopLastmileProbeTest |
| 停止通话前网络质量探测。 更多... | |
| (nullable NERtcChannel *) | - createChannel: |
| 创建一个 IRtcChannel 对象 更多... | |
| (int) | - enableVideoCorrection: |
| 是否启用视频图像畸变矫正。 更多... | |
| (int) | - setVideoCorrectionConfig: |
| 设置视频图像矫正参数。 更多... | |
| (int) | - enableVirtualBackground:backData: |
| 开启/关闭虚拟背景。 启用虚拟背景功能后，您可以使用自定义背景图片替换本地用户的原始背景图片。 替换后，频道内所有用户都可以看到自定义背景图片。 更多... | |
| (int) | - setCloudProxy: |
| 开启并设置云代理服务。 在内网环境下，如果用户防火墙开启了网络限制，请参考《使用云代理》将指定 IP 地址和端口号加入防火墙白名单，然后调用此方法开启云代理，并将 proxyType 参数设置为 NERtcTransportTypeUDPProxy(1)，即指定使用 UDP 协议的云代理。 更多... | |
| (void) | - setStreamAlignmentProperty: |
| 对齐本地系统与服务端的时间。 更多... | |
| (int64_t) | - getNtpTimeOffset |
| 获取本地系统时间与服务端时间差值。 可以用于做时间对齐，通过 (毫秒级系统时间 - offset) 可能得到当前服务端时间。 更多... | |
| 构造函数 继承自 <INERtcEngine> | |
| (NERtcConnectionStateType) | - connectionState |
| 获取当前房间连接状态。 更多... | |
| (int) | - setupEngineWithContext: |
| 创建 NERtcEngine 并初始化 NERTC SDK 服务。 更多... | |
| (int) | - joinChannelWithToken:channelName:myUid:completion: |
| 加入音视频房间。 加入音视频房间时，如果指定房间尚未创建，云信服务器内部会自动创建一个同名房间。 更多... | |
| (int) | - leaveChannel |
| 离开房间，即挂断或退出通话。 结束通话时，必须调用leaveChannel结束通话，否则无法开始下一次通话。 成功调用该方法离开房间后，本地会触发 onNERtcEngineDidLeaveChannelWithResult 回调，远端会触发 onNERtcEngineUserDidLeaveWithUserID 回调。 更多... | |
| (int) | - switchChannelWithToken:channelName:completion: |
| 快速切换音视频房间。 房间场景为直播场景时，房间中角色为观众的成员可以调用该方法从当前房间快速切换至另一个房间。 成功调用该方切换房间后，本端会收到离开房间的回调 onNERtcEngineDidLeaveChannelWithResult；远端用户会收到 onNERtcEngineUserDidLeaveWithUserID 和 onNERtcEngineUserDidJoinWithUserID 的回调。 更多... | |
| (int) | - enableLocalAudio: |
| 开启/关闭本地音频采集和发送。 当 App 加入房间时，语音功能默认为开启状态。 该方法不影响接收或播放远端音频流，enableLocalAudio(NO) 适用于只下行不上行音频流的场景。 成功调用该方法后，房间内其他用户触发 onNERtcEngineUserAudioDidStart 或 onNERtcEngineUserAudioDidStop 回调。 更多... | |
| (int) | - enableLocalVideo: |
| 是否开启本地视频采集。 更多... | |
| (int) | - enableLocalVideo:streamType: |
| 开启或关闭本地视频的采集与发送。 通过主流或辅流视频通道进行本地视频流的采集与发送。 更多... | |
| (int) | - enableMediaPub:withMediaType: |
| 开启或关闭本地媒体流（主流）的发送。 该方法用于开始或停止向网络发送本地音频或视频数据。 该方法不影响接收或播放远端媒体流，也不会影响本地音频或视频的采集状态。 更多... | |
| (int) | - setChannelProfile: |
| 设置房间场景。 房间场景可设置为通话或直播场景，不同的场景中 QoS 策略不同。 更多... | |
| (int) | - setLocalVideoConfig: |
| 设置视频编码属性。 更多... | |
| (int) | - setLocalVideoConfig:streamType: |
| 设置视频编码属性。 通过此接口可以设置视频主流或辅流的编码分辨率、裁剪模式、码率、帧率、带宽受限时的视频编码降级偏好、编码的镜像模式、编码的方向模式参数。 更多... | |
| (int) | - setAudioProfile:scenario: |
| 设置音频编码属性。 更多... | |
| (int) | - setupLocalVideoCanvas: |
| 设置本地视图。 该方法设置本地视频显示信息。只影响本地用户看到的视频画面，不影响远端。 App 通过调用此接口绑定本地视频流的显示视窗（view）。 在 App 开发中，通常在初始化后调用该方法进行本地视频设置，然后再加入房间。 更多... | |
| (int) | - setupRemoteVideoCanvas:forUserID: |
| 设置远端用户视图。 该方法绑定远端用户和显示视图，并设置远端用户视图在本地显示时的渲染模式和镜像模式，只影响本地用户看到的视频画面。 更多... | |
| (int) | - switchCamera |
| 切换前置/后置摄像头。 该方法需要在相机启动后调用，例如调用 startPreview 或 joinChannel 后。 更多... | |
| (int) | - setClientRole: |
| 在直播场景中设置用户角色。 用户角色支持设置为主播或观众，主播和观众的权限不同。 更多... | |
| (int) | - setParameters: |
| 设置音视频通话的相关参数。 更多... | |
详细描述
函数文档
◆ destroyEngine
| + (int) destroyEngine |
销毁 NERtcEngine 实例，并释放资源。
该方法释放 NERTC SDK 使用的所有资源。有些 App 只在用户需要时才进行实时音视频通信，完成音视频通话后，则将资源释放出来用于其他操作，该方法适用于此类情况。
- 该接口需要在调用
leaveChannel、并收到本端离开房间的回调后调用。或收到onNERtcEngineDidDisconnectWithReason:回调、重连失败时调用此接口销毁实例，并释放资源。 - 调用
destroyEngine方法后，您将无法再使用 SDK 的其它方法和回调。如需再次使用实时音视频通话功能，您必须等待destroyEngine方法执行结束后，重新创建一个新的 NERtc 实例。
- 注解
- 该方法为同步调用，需要等待 NERtcEngine 实例资源释放后才能执行其他操作，建议在子线程中调用该方法，避免主线程阻塞。此外，网易云信不建议 在 SDK 的回调中调用 destroy，否则由于 SDK 要等待回调返回才能回收相关的对象资源，会造成死锁。
- 该接口不得在 SDK 的回调中调用，在接口返回前也不允许调用 SDK 的其他任何接口。
- 如需在销毁后再次创建 NERtcEngine 实例、调用 SDK 接口，需要等待
destroyEngine方法执行结束后，调用sharedEngine获取一个新的 NERtcEngine 实例，再调用setupEngineWithContext初始化 SDK。
◆ getVersion
| + (NSString *) getVersion |
查询 SDK 版本号， 该方法在加入房间前后都能调用
- 自从
- V4.6.10
- 返回
- 版本号，格式为字符串，如 1.0.0。
◆ sharedEngine
| + (instancetype) sharedEngine |
获取 NERtcEngine 实例 获取之后一直到调用destroyEngine之前，返回的实例都将是同一个
- 返回
- NERtcEngine 实例
该类的文档由以下文件生成:
- exportHeaders/NERtcEngine.h
