NERtc iOS SDK V5.6.10
载入中...
搜索中...
未找到
| 变量
NERtcEngineBase.h 文件参考
import <Foundation/Foundation.h>
import "NERtcEngineEnum.h"

浏览源代码.

class  NERtcVideoCanvas
 视频画布设置。 更多...
 
class  NERtcBaseVideoEncodeConfiguration
 本地视频基础发送配置。 更多...
 
class  NERtcCameraCaptureConfiguration
 摄像头采集配置。 更多...
 
class  NERtcVideoEncodeConfiguration
 本地视频发送配置 更多...
 
class  NERtcVideoSubStreamEncodeConfiguration
 本地辅流发送配置。 更多...
 
class  NERtcCreateAudioMixingOption
 Options for creating mixing audios 更多...
 
class  NERtcCreateAudioEffectOption
 Options for creating audio effects 更多...
 
class  NERtcAudioRecordingConfiguration
 
class  NERtcLiveConfig
 音视频流编码参数等设置 更多...
 
class  NERtcLiveStreamUserTranscoding
 直播成员布局。 更多...
 
class  NERtcLiveStreamImageInfo
 图片布局。 更多...
 
class  NERtcLiveStreamLayout
 直播布局。 更多...
 
class  NERtcLiveStreamTaskInfo
 直播推流任务的配置。 更多...
 
class  NERtcAudioFrameRequestFormat
 音频原始数据回调格式(默认不设置)。 更多...
 
class  NERtcAudioFormat
 音频格式。 更多...
 
class  NERtcAudioFrame
 音频帧。 更多...
 
class  NERtcAudioVolumeInfo
 声音音量信息。 更多...
 
class  NERtcVideoFrame
 视频帧信息。 更多...
 
class  NERtcChannelMediaRelayInfo
 媒体流转发相关的数据结构。 更多...
 
class  NERtcChannelMediaRelayConfiguration
 
class  NERtcVideoWatermarkImageConfig
 视频图片水印配置。 更多...
 
class  NERtcVideoWatermarkTextConfig
 
class  NERtcVideoWatermarkTimestampConfig
 
class  NERtcVideoWatermarkConfig
 视频水印设置,目前支持三种类型的水印,但只能其中选择一种水印生效。 更多...
 
class  NERtcEncryptionConfig
 配置媒体流加密模式和密钥。 更多...
 
class  NERtcServerAddresses
 私有化服务器配置项 更多...
 
class  NERtcLastmileProbeConfig
 Last mile 网络探测配置。 更多...
 
class  NERtcLastmileProbeOneWayResult
 单向 Last mile 网络质量探测结果报告。 更多...
 
class  NERtcLastmileProbeResult
 上下行 Last mile 网络质量探测结果。 更多...
 
class  NERtcLogSetting
 日志相关设置。 更多...
 
class  NERtcVideoCorrectionConfiguration
 视频图像畸变矫正相关设置。 更多...
 
class  NERtcVirtualBackgroundSource
 自定义背景图像。 更多...
 
class  NERtcReverbParam
 混响参数 更多...
 
class  NERtcJoinChannelOptions
 joinChannel 时的一些可选信息 更多...
 
class  NERtcJoinChannelExtraInfo
 joinChannel 回调时的一些可选信息 更多...
 
class  NERtcUserJoinExtraInfo
 onUserJoined 回调时的一些可选信息 更多...
 
class  NERtcUserLeaveExtraInfo
 onUserLeave 回调时的一些可选信息 更多...
 
class  NERtcPreDecoderVideoInfo
 编码完的音频帧数据 更多...
 
class  NERtcPreDecoderAudioInfo
 编码完的视频帧数据 更多...
 
class  NERtcPreDecoderFrameInfo
 编码完的媒体数据帧 更多...
 
class  NERtcVideoEncodedFrame
 
class  NERtcAudioEncodedFrame
 编码好的音频数据 更多...
 
class  NERtcPositionInfo
 3D 音效算法中坐标信息。 更多...
 
class  NERtcSpatializerRoomProperty
 3D 音效房间属性设置。 更多...
 
class  NERtcPacket
 
class  NERtcStreamingRoomInfo
 
class  NERtcPushStreamingConfig
 

变量

NS_ASSUME_NONNULL_BEGIN NERTC_EXTERN_API NSString *const kNERtcKeyChannel1V1ModeEnabled
 以下 key 用于 INERtcEngine::setParameters
 
NERTC_EXTERN_API NSString *const kNERtcKeyVideoPreferHWEncode
 是否优先使用硬件编码视频数据。
布尔值,默认值 YES。
请在初始化(setupEngineWithContext)之前设置该参数,否则该参数会在下次初始化之后生效。
 
NERTC_EXTERN_API NSString *const kNERtcKeyVideoPreferHWDecode
 是否优先使用硬件解码视频数据。
布尔值,默认值 YES。
请在初始化(setupEngineWithContext)之前设置该参数,否则该参数会在下次初始化之后生效。
 
NERTC_EXTERN_API NSString *const kNERtcKeyVideoCaptureObserverEnabled
 是否需要开启视频数据采集回调,开启后开发者可以获取到原始视频数据。
布尔值,默认值 NO。
开启后如果需要关闭,需要通过调用 destroyEngine 来清除。
 
NERTC_EXTERN_API NSString *const kNERtcKeyVideoStartWithBackCamera
 第一次开启摄像头时,是否使用后摄像头。
布尔值,默认值 NO,即不使用后置摄像头。
 
NERTC_EXTERN_API NSString *const kNERtcKeyVideoPreferMetalRender
 是否优先使用 Metal 渲染。
布尔值,默认值 NO,即使用 OpenGL 渲染。
 
NERTC_EXTERN_API NSString *const kNERtcKeyVideoSendOnPubType
 通话开始时,默认发送的流类型,通话前设置有效。
int 类型,默认为 3,即大流。详细信息请参考 NERtcVideoPubMode。
 
NERTC_EXTERN_API NSString *const kNERtcKeyAutoSubscribeVideo
 是否自动订阅其他用户的视频流。
布尔值,默认值 NO,即不自动订阅。
 
NERTC_EXTERN_API NSString *const kNERtcKeyAutoSubscribeAudio
 是否自动订阅其他用户的音频流。
布尔值,默认为 YES,即自动订阅。
 
NERTC_EXTERN_API NSString *const kNERtcKeyAutoSubscribeData
 是否自动订阅其他用户的数据通道。
布尔值,默认为 NO,即非自动订阅。
 
NERTC_EXTERN_API NSString *const KNERtcKeyDisableOverrideSpeakerOnReceiver
 当系统切换听筒或扬声器时,SDK 是否以系统设置为准。
布尔值,默认为 NO。
 
NERTC_EXTERN_API NSString *const kNERtcKeySupportCallkit
 是否需要支持 Callkit 框架。
布尔值,默认为 NO。
 
NERTC_EXTERN_API NSString *const KNERtcKeyEnableReportVolumeWhenMute
 本地用户静音时是否返回原始音量。 布尔值,默认值为 false。
 
NERTC_EXTERN_API NSString *const KNERtcKeyDisableSWAECOnHeadset
 设置耳机时不使用软件回声消除功能,默认值 NO。如设置 YES 则 SDK 在耳机模式下不使用软件回声消除功能,会对某些机型下 耳机的音质效果有影响
 
NERTC_EXTERN_API NSString *const KNERtcKeyAudioAINSEnable
 是否开启 AI 降噪。
NERTC SDK 自研 AI 降噪算法,开启 AI 降噪之后,在嘈杂的环境中可以针对背景人声、键盘声等非稳态噪声进行定向降噪,同时也会提升对于环境稳态噪声的抑制,保留更纯粹的人声。
 
NERTC_EXTERN_API NSString *const kNERtcKeyRecordHostEnabled
 是否云端录制主讲人,默认值 NO
 
NERTC_EXTERN_API NSString *const kNERtcKeyRecordAudioEnabled
 是否开启云端音频录制。默认值 NO,即关闭音频录制。
 
NERTC_EXTERN_API NSString *const kNERtcKeyRecordVideoEnabled
 是否开启云端视频录制,默认值 NO,即关闭视频录制。
 
NERTC_EXTERN_API NSString *const kNERtcKeyRecordType
 云端录制模式。详细信息请参考 NERtcRecordType。
 
NERTC_EXTERN_API NSString *const kNERtcKeyPublishSelfStreamEnabled
 在旁路推流场景中,是否允许推送本地媒体流到 CDN。默认值 YES。
 
NERTC_EXTERN_API NSString *const kNERtcKeyLogLevel
 SDK 日志等级,默认为 kNERtcLogLevelInfo,详细信息请参考 NERtcLogLevel。
 
NERTC_EXTERN_API NSString *const kNERtcKeyExtraInfo
 Login 事件中的一个自定义字段,适用于标识一些额外信息,例如 App 版本。
 
NERTC_EXTERN_API NSString *const kNERtcKeyDisableVideoDecoder
 是否关闭 sdk 视频解码(默认不关闭),关闭后 SDK 将不会解码远端视频,因此也无法渲染接收到的远端视频
 
NERTC_EXTERN_API NSString *const kNERtcKeyLoginCustomData
 登录扩展参数,string,默认不设置。
 
NERTC_EXTERN_API NSString *const kNERtcKeyDisableFirstJoinUserCreateChannel
 
NERTC_EXTERN_API uint32_t const NERtcAudioMixingMaxVolume
 
NERTC_EXTERN_API uint32_t const NERtcAudioMixingDefaultVolume
 

变量说明

◆ KNERtcKeyAudioAINSEnable

NERTC_EXTERN_API NSString* const KNERtcKeyAudioAINSEnable

是否开启 AI 降噪。
NERTC SDK 自研 AI 降噪算法,开启 AI 降噪之后,在嘈杂的环境中可以针对背景人声、键盘声等非稳态噪声进行定向降噪,同时也会提升对于环境稳态噪声的抑制,保留更纯粹的人声。

◆ kNERtcKeyAutoSubscribeAudio

NERTC_EXTERN_API NSString* const kNERtcKeyAutoSubscribeAudio

是否自动订阅其他用户的音频流。
布尔值,默认为 YES,即自动订阅。

注解
  • 请在加入房间前设置该参数,通话中设置无效。
  • 如果业务场景中使用 subscribeRemoteAudio 控制音频订阅,则该 Key 必须设置为 NO。

◆ kNERtcKeyAutoSubscribeData

NERTC_EXTERN_API NSString* const kNERtcKeyAutoSubscribeData

是否自动订阅其他用户的数据通道。
布尔值,默认为 NO,即非自动订阅。

注解
  • 请在加入房间前设置该参数,通话中设置无效。
  • 如果业务场景中使用 subscribeData 控制数据订阅,则该 Key 必须设置为 NO。

◆ kNERtcKeyAutoSubscribeVideo

NERTC_EXTERN_API NSString* const kNERtcKeyAutoSubscribeVideo

是否自动订阅其他用户的视频流。
布尔值,默认值 NO,即不自动订阅。

注解
请在加入房间前设置该参数,通话中设置无效。

◆ kNERtcKeyChannel1V1ModeEnabled

NS_ASSUME_NONNULL_BEGIN NERTC_EXTERN_API NSString* const kNERtcKeyChannel1V1ModeEnabled

以下 key 用于 INERtcEngine::setParameters

是否开启双人通话模式。适用于 1v1 通话场景。
布尔值,默认为 NO,即关闭状态。

注解
  • 开启了双人通话模式的客户端创建并加入房间时,该房间会成为一个双人通话房间,只允许同样开启了双通话模式的客户端加入。
  • 请在加入房间前设置。

◆ kNERtcKeyDisableFirstJoinUserCreateChannel

NERTC_EXTERN_API NSString* const kNERtcKeyDisableFirstJoinUserCreateChannel

◆ KNERtcKeyDisableOverrideSpeakerOnReceiver

NERTC_EXTERN_API NSString* const KNERtcKeyDisableOverrideSpeakerOnReceiver

当系统切换听筒或扬声器时,SDK 是否以系统设置为准。
布尔值,默认为 NO。

  • YES: 以系统设置为准。例如当系统切换为听筒时,应用的音频播放则自动转为听筒,开发者需要自行处理该切换事件。
  • NO: 以 SDK 设置为准,SDK 不允许用户通过系统变更音频播放路由为听筒或扬声器。例如当 SDK 设置为扬声器时,即使系统切换为听筒模式,SDK 也会自动将系统修改回扬声器模式。

◆ KNERtcKeyDisableSWAECOnHeadset

NERTC_EXTERN_API NSString* const KNERtcKeyDisableSWAECOnHeadset

设置耳机时不使用软件回声消除功能,默认值 NO。如设置 YES 则 SDK 在耳机模式下不使用软件回声消除功能,会对某些机型下 耳机的音质效果有影响

◆ kNERtcKeyDisableVideoDecoder

NERTC_EXTERN_API NSString* const kNERtcKeyDisableVideoDecoder

是否关闭 sdk 视频解码(默认不关闭),关闭后 SDK 将不会解码远端视频,因此也无法渲染接收到的远端视频

note:需要在初始化前设置,释放 SDK 后失效。一般配合 INERtcEngineEx#setPreDecodeObserver: 使用。

自从
4.6.25

◆ KNERtcKeyEnableReportVolumeWhenMute

NERTC_EXTERN_API NSString* const KNERtcKeyEnableReportVolumeWhenMute

本地用户静音时是否返回原始音量。 布尔值,默认值为 false。

  • true:返回 onLocalAudioVolumeIndication 中的原始音量。
  • false:返回 onLocalAudioVolumeIndication 中的录音音量,静音时为 0。
    注解
    请在加入房间前调用此接口。

◆ kNERtcKeyExtraInfo

NERTC_EXTERN_API NSString* const kNERtcKeyExtraInfo

Login 事件中的一个自定义字段,适用于标识一些额外信息,例如 App 版本。

◆ kNERtcKeyLoginCustomData

NERTC_EXTERN_API NSString* const kNERtcKeyLoginCustomData

登录扩展参数,string,默认不设置。

◆ kNERtcKeyLogLevel

NERTC_EXTERN_API NSString* const kNERtcKeyLogLevel

SDK 日志等级,默认为 kNERtcLogLevelInfo,详细信息请参考 NERtcLogLevel。

◆ kNERtcKeyPublishSelfStreamEnabled

NERTC_EXTERN_API NSString* const kNERtcKeyPublishSelfStreamEnabled

在旁路推流场景中,是否允许推送本地媒体流到 CDN。默认值 YES。

弃用
该参数已废弃。

◆ kNERtcKeyRecordAudioEnabled

NERTC_EXTERN_API NSString* const kNERtcKeyRecordAudioEnabled

是否开启云端音频录制。默认值 NO,即关闭音频录制。

◆ kNERtcKeyRecordHostEnabled

NERTC_EXTERN_API NSString* const kNERtcKeyRecordHostEnabled

是否云端录制主讲人,默认值 NO

◆ kNERtcKeyRecordType

NERTC_EXTERN_API NSString* const kNERtcKeyRecordType

云端录制模式。详细信息请参考 NERtcRecordType。

◆ kNERtcKeyRecordVideoEnabled

NERTC_EXTERN_API NSString* const kNERtcKeyRecordVideoEnabled

是否开启云端视频录制,默认值 NO,即关闭视频录制。

◆ kNERtcKeySupportCallkit

NERTC_EXTERN_API NSString* const kNERtcKeySupportCallkit

是否需要支持 Callkit 框架。
布尔值,默认为 NO。

  • YES: 需要支持,如果需要使用苹果 callkit 框架来实现发起通话,接听通话,需要设置 YES。
  • NO: 不需要支持。

◆ kNERtcKeyVideoCaptureObserverEnabled

NERTC_EXTERN_API NSString* const kNERtcKeyVideoCaptureObserverEnabled

是否需要开启视频数据采集回调,开启后开发者可以获取到原始视频数据。
布尔值,默认值 NO。
开启后如果需要关闭,需要通过调用 destroyEngine 来清除。

◆ kNERtcKeyVideoPreferHWDecode

NERTC_EXTERN_API NSString* const kNERtcKeyVideoPreferHWDecode

是否优先使用硬件解码视频数据。
布尔值,默认值 YES。
请在初始化(setupEngineWithContext)之前设置该参数,否则该参数会在下次初始化之后生效。

◆ kNERtcKeyVideoPreferHWEncode

NERTC_EXTERN_API NSString* const kNERtcKeyVideoPreferHWEncode

是否优先使用硬件编码视频数据。
布尔值,默认值 YES。
请在初始化(setupEngineWithContext)之前设置该参数,否则该参数会在下次初始化之后生效。

◆ kNERtcKeyVideoPreferMetalRender

NERTC_EXTERN_API NSString* const kNERtcKeyVideoPreferMetalRender

是否优先使用 Metal 渲染。
布尔值,默认值 NO,即使用 OpenGL 渲染。

◆ kNERtcKeyVideoSendOnPubType

NERTC_EXTERN_API NSString* const kNERtcKeyVideoSendOnPubType

通话开始时,默认发送的流类型,通话前设置有效。
int 类型,默认为 3,即大流。详细信息请参考 NERtcVideoPubMode。

◆ kNERtcKeyVideoStartWithBackCamera

NERTC_EXTERN_API NSString* const kNERtcKeyVideoStartWithBackCamera

第一次开启摄像头时,是否使用后摄像头。
布尔值,默认值 NO,即不使用后置摄像头。

◆ NERtcAudioMixingDefaultVolume

NERTC_EXTERN_API uint32_t const NERtcAudioMixingDefaultVolume

◆ NERtcAudioMixingMaxVolume

NERTC_EXTERN_API uint32_t const NERtcAudioMixingMaxVolume