#import <NERtcEngine.h>

类 NERtcEngine 继承关系图:

类方法
(instancetype)	+ sharedEngine
	获取 NERtcEngine 实例获取之后一直到调用destroyEngine之前，返回的实例都将是同一个更多...

(int)	+ destroyEngine
	释放当前的 NERtcEngine 实例建议在 App 确定不再需要使用 NERtcEngine 实例时，通过该接口释放 NERtcEngine 实例的对象资源；更多...

额外继承的成员函数
构造函数继承自 <INERtcEngineEx>
(int)	- enableDualStreamMode:
	设置是否开启视频大小流模式。更多...

(int)	- setLocalMediaPriority:preemptive:
	设置本地用户的媒体流优先级。更多...

(int)	- setLocalPublishFallbackOption:
	设置弱网条件下发布的音视频流回退选项。更多...

(int)	- setRemoteSubscribeFallbackOption:
	设置弱网条件下订阅的音视频流回退选项。更多...

(int)	- muteLocalAudio:
	开关本地音频发送。该方法用于允许或禁止向网络发送本地音频流。更多...

(int)	- subscribeRemoteAudio:forUserID:
	取消或恢复订阅指定远端用户音频流。更多...

(int)	- subscribeAllRemoteAudio:
	取消或恢复订阅所有远端用户音频流。更多...

(int)	- subscribeRemoteVideo:forUserID:streamType:
	订阅或取消订阅指定远端用户的视频流。更多...

(int)	- startPreview
	开启视频预览。更多...

(int)	- stopPreview
	停止视频预览。更多...

(int)	- setLocalRenderScaleMode:
	设置本端的视频显示模式。更多...

(int)	- setRemoteRenderScaleMode:forUserID:
	设置远端的视频显示模式。更多...

(int)	- setVideoRotationMode:
	设置本地视频画面的旋转模式。更多...

(int)	- muteLocalVideo:
	取消或恢复发布本地视频流。更多...

(int)	- setLoudspeakerMode:
	启用或关闭扬声器播放。更多...

(int)	- getLoudspeakerMode:
	检查扬声器状态启用状态。更多...

(int)	- startAudioDump
	开始记录音频 dump。更多...

(int)	- stopAudioDump
	结束记录音频 dump。更多...

(int)	- setExternalVideoSource:isScreen:
	开启或关闭外部视频源数据输入。更多...

(int)	- pushExternalVideoFrame:
	推送外部视频帧。更多...

(int)	- setupLocalSubStreamVideoCanvas:
	设置本地辅流视频画布。该方法设置本地辅流视频显示信息。App 通过调用此接口绑定本地辅流的显示视窗（view）。在 App 开发中，通常在初始化后调用该方法进行本地视频设置，然后再加入房间。更多...

(int)	- startScreenCapture:
	开启屏幕共享，屏幕共享内容以辅流形式发送。更多...

(int)	- stopScreenCapture
	关闭辅流形式的屏幕共享。更多...

(int)	- setLocalRenderSubStreamScaleMode:
	设置本端的屏幕共享辅流视频显示模式。更多...

(int)	- setupRemoteSubStreamVideoCanvas:forUserID:
	设置远端的辅流视频画布。更多...

(int)	- subscribeRemoteSubStreamVideo:forUserID:
	订阅或取消订阅远端的屏幕共享辅流视频，订阅之后才能接收远端的辅流视频数据。更多...

(int)	- setRemoteRenderSubStreamVideoScaleMode:forUserID:
	设置远端的屏幕共享辅流视频显示模式。更多...

(int)	- setAudioSessionOperationRestriction:
	设置 SDK 对 Audio Session 的控制权限。更多...

(int)	- setPlayoutDeviceMute:
	设置是否静音音频播放设备。更多...

(int)	- getPlayoutDeviceMute:
	获取音频播放设备的静音状态。更多...

(int)	- setRecordDeviceMute:
	设置是否静音音频采集设备。更多...

(int)	- getRecordDeviceMute:
	查询当前音频采集设备是否静音。更多...

(BOOL)	- isCameraZoomSupported
	检测设备当前使用的摄像头是否支持缩放功能。更多...

(BOOL)	- isCameraTorchSupported
	检测设备是否支持闪光灯常亮。更多...

(BOOL)	- isCameraFocusSupported
	检测设备是否支持手动对焦功能。更多...

(BOOL)	- isCameraExposurePositionSupported
	检测设备是否支持手动曝光功能。更多...

(int)	- setCameraExposurePosition:
	设置当前摄像头手动曝光位置。更多...

(int)	- setCameraTorchOn:
	设置是否打开闪光灯。更多...

(BOOL)	- isCameraTorchOn
	查询设备是否开启了闪光灯。更多...

(int)	- setCameraZoomFactor:
	设置当前摄像头缩放比例。更多...

(float)	- maxCameraZoomScale
	获取摄像头支持最大缩放比例。更多...

(int)	- setCameraFocusPositionX:Y:
	设置手动对焦位置。更多...

(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:
	开始客户端录音。更多...

(int)	- stopAudioRecording
	停止客户端录音。更多...

(int)	- setExternalAudioSource:sampleRate:channels:
	开启或关闭外部音频源数据输入。更多...

(int)	- pushExternalAudioFrame:
	推送外部音频帧。更多...

(int)	- setExternalAudioRender:sampleRate:channels:
	设置外部音频渲染。更多...

(int)	- pullExternalAudioFrame:length:
	拉取外部音频数据。更多...

(int)	- addEngineMediaStatsObserver:
	注册媒体统计信息观测器。更多...

(int)	- removeEngineMediaStatsObserver:
	移除指定媒体统计信息观测器。更多...

(int)	- cleanupEngineMediaStatsObserver
	清除全部媒体统计信息观测器。更多...

(int)	- addLiveStreamTask:compeltion:
	添加房间推流任务。更多...

(int)	- updateLiveStreamTask:compeltion:
	更新房间推流任务。更多...

(int)	- removeLiveStreamTask:compeltion:
	删除房间推流任务。更多...

(int)	- setRecordingAudioFrameParameters:
	设置采集的音频格式。更多...

(int)	- setPlaybackAudioFrameParameters:
	设置播放的声音格式。更多...

(int)	- setMixedAudioFrameParameters:
	设置录制和播放声音混音后的数据格式。更多...

(int)	- setAudioFrameObserver:
	注册语音观测器对象。更多...

(int)	- enableAudioVolumeIndication:interval:
	启用说话者音量提示。更多...

(int)	- adjustRecordingSignalVolume:
	调节采集信号音量。更多...

(int)	- adjustPlaybackSignalVolume:
	调节本地播放的所有远端用户信号音量。更多...

(int)	- adjustUserPlaybackSignalVolume:forUserID:
	调节本地播放的指定远端用户的信号音量。更多...

(int)	- setLocalVoicePitch:
	设置本地语音音调。更多...

(int)	- setLocalVoiceEqualizationOfBandFrequency:withGain:
	设置本地语音音效均衡，即自定义设置本地人声均衡波段的中心频率。更多...

(int)	- setVoiceBeautifierPreset:
	设置 SDK 预设的美声效果。更多...

(int)	- setAudioEffectPreset:
	设置 SDK 预设的人声的变声音效。更多...

(int)	- setLocalCanvasWatermarkConfigs:withStreamType:
	添加本地视频画布水印。更多...

(int)	- setRemoteCanvasWatermarkConfigs:forUserID:withStreamType:
	添加远端视频画布水印。更多...

(int)	- takeLocalSnapshot:callback:
	本地视频画面截图。更多...

(int)	- takeRemoteSnapshot:forUserID:callback:
	远端视频画面截图。调用 takeRemoteSnapshot 截取指定 uid 远端主流和远端辅流的视频画面，并通过 NERtcTakeSnapshotCallback 的回调返回截图画面的数据。更多...

(int)	- uploadSdkInfo
	上传 SDK 信息。更多...

(int)	- sendSEIMsg:streamChannelType:
	指定主流或辅流通道发送媒体增强补充信息（SEI）。更多...

(int)	- sendSEIMsg:
	通过主流通道发送媒体增强补充信息（SEI）。更多...

(int)	- startChannelMediaRelay:
	开始跨房间媒体流转发。更多...

(int)	- updateChannelMediaRelay:
	更新媒体流转发的目标房间。更多...

(int)	- stopChannelMediaRelay
	停止跨房间媒体流转发。更多...

(int)	- enableSuperResolution:
	启用或停止 AI 超分。更多...

(int)	- enableEncryption:config:
	开启或关闭媒体流加密。更多...

构造函数继承自 <INERtcEngine>
(NERtcConnectionStateType)	- connectionState
	获取当前网络状态。更多...

(int)	- setupEngineWithContext:
	创建 NERtcEngine 并初始化 NERTC SDK 服务。更多...

(int)	- joinChannelWithToken:channelName:myUid:completion:
	加入音视频房间。更多...

(int)	- leaveChannel
	离开房间，即挂断或退出通话。更多...

(int)	- switchChannelWithToken:channelName:completion:
	快速切换音视频房间。更多...

(int)	- enableLocalAudio:
	开启/关闭本地音频采集。更多...

(int)	- enableLocalVideo:
	是否开启本地视频采集。更多...

(int)	- setChannelProfile:
	设置房间场景。更多...

(int)	- setLocalVideoConfig:
	设置视频编码属性。更多...

(int)	- setAudioProfile:scenario:
	设置音频编码属性。更多...

(int)	- setupLocalVideoCanvas:
	设置本地视图。更多...

(int)	- setupRemoteVideoCanvas:forUserID:
	设置远端用户视图。更多...

(int)	- switchCamera
	切换前置/后置摄像头。更多...

(int)	- setClientRole:
	在直播场景中设置用户角色。更多...

(int)	- setParameters:
	设置音视频通话的相关参数。更多...

详细描述

NERtcEngine 类

函数文档

◆ destroyEngine

+ (int) destroyEngine

释放当前的 NERtcEngine 实例建议在 App 确定不再需要使用 NERtcEngine 实例时，通过该接口释放 NERtcEngine 实例的对象资源；

该接口的工作方式为同步调用方式，必须在子线程中才能调用，否则会调用失败；如： dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{ [NERtcEngine destroyEngine]; });
该接口不得在 SDK 的回调中调用，在接口返回前也不允许调用 SDK 的其他任何接口；
接口调用返回之后，如果需要再次使用 SDK，可以重新调用 sharedEngine 来获取一个新的 NERtcEngine 实例。

◆ sharedEngine

+ (instancetype) sharedEngine

获取 NERtcEngine 实例获取之后一直到调用destroyEngine之前，返回的实例都将是同一个

返回: NERtcEngine 实例

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

exportHeaders/NERtcEngine.h

类方法

额外继承的成员函数

详细描述

函数文档

◆ destroyEngine

◆ sharedEngine