NIMNetCallOption Class Reference
| Inherits from | NSObject |
|---|---|
| Declared in | NIMNetCallOption.h |
videoCaptureParam
视频采集参数, 指定该参数以在加入网络通话时自动设置视频采集, 如果不指定该参数, 需要开发者调用 startVideoCapture: 手动开启视频采集。如果在加入网络通话前已经开启了视频采集, 该参数无效，该参数与 customVideoParam 不能同时设置
@property (nullable, nonatomic, strong) NIMNetCallVideoCaptureParam *videoCaptureParamDiscussion
视频采集参数, 指定该参数以在加入网络通话时自动设置视频采集, 如果不指定该参数, 需要开发者调用 startVideoCapture: 手动开启视频采集。如果在加入网络通话前已经开启了视频采集, 该参数无效，该参数与 customVideoParam 不能同时设置
Declared In
NIMNetCallOption.h
customVideoParam
自定义输入视频参数，该参数与 videoCaptureParam 不能同时设置
@property (nullable, nonatomic, strong) NIMNetCallCustomVideoParam *customVideoParamDiscussion
自定义输入视频参数，该参数与 videoCaptureParam 不能同时设置
Declared In
NIMNetCallOption.h
stopVideoCaptureOnLeave
结束网络通话时自动停止视频采集, 默认为 YES。如果需要在离开会话以后摄像头保持开启，将该选项设置为 NO
@property (nonatomic, assign) BOOL stopVideoCaptureOnLeaveDiscussion
结束网络通话时自动停止视频采集, 默认为 YES。如果需要在离开会话以后摄像头保持开启，将该选项设置为 NO
Declared In
NIMNetCallOption.h
remoteViewoShowType
远端视频展示类型
@property (nonatomic, assign) NIMNetCallRemoteVideoShowType remoteViewoShowTypeDiscussion
远端视频展示类型
Declared In
NIMNetCallOption.h
autoRotateRemoteVideo
自动旋转远端画面, 默认为 YES
@property (nonatomic, assign) BOOL autoRotateRemoteVideoDiscussion
自动旋转远端画面, 默认为 YES
开启该选项, 以在远端设备旋转时在本端自动调整角度
Declared In
NIMNetCallOption.h
preferredVideoEncoder
期望的视频编码器. 硬件编码设置仅在 iOS 8.0 及以上系统有效
@property (nonatomic, assign) NIMNetCallVideoCodec preferredVideoEncoderDiscussion
期望的视频编码器. 硬件编码设置仅在 iOS 8.0 及以上系统有效
Declared In
NIMNetCallOption.h
preferredVideoDecoder
期望的视频解码器. 硬件解码设置仅在 iOS 8.0 及以上系统有效
@property (nonatomic, assign) NIMNetCallVideoCodec preferredVideoDecoderDiscussion
期望的视频解码器. 硬件解码设置仅在 iOS 8.0 及以上系统有效
Declared In
NIMNetCallOption.h
videoMaxEncodeBitrate
视频最大编码码率 (bps). 如果不指定, SDK 会根据视频质量自动选择
@property (nonatomic, assign) NSUInteger videoMaxEncodeBitrateDiscussion
视频最大编码码率 (bps). 如果不指定, SDK 会根据视频质量自动选择
Declared In
NIMNetCallOption.h
pureVideo
纯视频模式, 将不启动所有音频相关的模块, 默认为 NO
@property (nonatomic, assign) BOOL pureVideoDiscussion
纯视频模式, 将不启动所有音频相关的模块, 默认为 NO
Declared In
NIMNetCallOption.h
autoDeactivateAudioSession
结束网络通话时自动停止AudioSession, 默认为 YES
@property (nonatomic, assign) BOOL autoDeactivateAudioSessionDiscussion
结束网络通话时自动停止AudioSession, 默认为 YES
Declared In
NIMNetCallOption.h
disEnableAudioSessionConfigration
是否关闭SDK AudioSession配置 默认为 NO
@property (nonatomic, assign) BOOL disEnableAudioSessionConfigrationDiscussion
是否关闭SDK AudioSession配置 默认为 NO
Declared In
NIMNetCallOption.h
audioDenoise
语音降噪, 默认为 YES
@property (nonatomic, assign) BOOL audioDenoiseDiscussion
语音降噪, 默认为 YES
Declared In
NIMNetCallOption.h
agcType
自动增益, 默认为 YES
@property (nonatomic, assign) NIMAVChatAGCType agcTypeDiscussion
自动增益, 默认为 YES
Declared In
NIMNetCallOption.h
voiceDetect
人声检测, 默认为 YES
@property (nonatomic, assign) BOOL voiceDetectDiscussion
人声检测, 默认为 YES
Declared In
NIMNetCallOption.h
playbackSampleRate
音频播放采样率 默认 48K 采样率 在某些蓝牙耳机连接时可能会降至16k
@property (nonatomic, assign) NIMAVChatAudioSamplerate playbackSampleRateDiscussion
音频播放采样率 默认 48K 采样率 在某些蓝牙耳机连接时可能会降至16k
Declared In
NIMNetCallOption.h
acousticEchoCanceler
回声抑制
@property (nonatomic, assign) NIMAVChatAcousticEchoCanceler acousticEchoCancelerDiscussion
回声抑制
Declared In
NIMNetCallOption.h
preferHDAudio
期望发送高清语音, 只有在通话的所有的参与者都设置为高清语音时才完全生效。3.3.0 之前的版本无法加入已经开启高清语音的多人会议。默认开启，开启该选项后在蓝牙耳机下效果可能达不到预期
@property (nonatomic, assign) BOOL preferHDAudioDiscussion
期望发送高清语音, 只有在通话的所有的参与者都设置为高清语音时才完全生效。3.3.0 之前的版本无法加入已经开启高清语音的多人会议。默认开启，开启该选项后在蓝牙耳机下效果可能达不到预期
Declared In
NIMNetCallOption.h
autoResetAudio
自动重置音频设备, 默认为NO 当检查音频采集数据不正常时，自动重置音频设备
@property (nonatomic, assign) BOOL autoResetAudioDiscussion
自动重置音频设备, 默认为NO 当检查音频采集数据不正常时，自动重置音频设备
Declared In
NIMNetCallOption.h
proximityMonitoringType
近距离传感器类型，默认为 NIMNetCallProximityMonitoringTypeDefault
@property (nonatomic, assign) NIMNetCallProximityMonitoringType proximityMonitoringTypeDiscussion
近距离传感器类型，默认为 NIMNetCallProximityMonitoringTypeDefault
Declared In
NIMNetCallOption.h
scene
场景设置
@property (nonatomic, assign) NIMAVChatScene sceneDiscussion
场景设置
Declared In
NIMNetCallOption.h
videoAdaptiveStrategy
视频调控策略 默认为 清晰优先
@property (nonatomic, assign) NIMAVChatVideoAdaptiveStrategy videoAdaptiveStrategyDiscussion
视频调控策略 默认为 清晰优先
Declared In
NIMNetCallOption.h
audioHandler
本地采集的语音数据回调，供上层实现变音等功能
@property (nullable, nonatomic, copy) NIMNetCallAudioSamplesHandler audioHandlerDiscussion
本地采集的语音数据回调，供上层实现变音等功能
Declared In
NIMNetCallOption.h
enableBypassStreaming
启用互动直播，只在加入会议时设置有效
@property (nonatomic, assign) BOOL enableBypassStreamingDiscussion
启用互动直播，只在加入会议时设置有效
Declared In
NIMNetCallOption.h
bypassTaskConfig
互动直播房间推流配置
@property (nonatomic, strong) NSArray<NIMNetCallBypassTaskConfig*> *bypassTaskConfigDiscussion
互动直播房间推流配置
Declared In
NIMNetCallOption.h
bypassStreamingUrl
互动直播推流地址。只在加入会议时设置有效，只有主播端可以指定，每个频道只能有一个主播。
@property (nullable, nonatomic, strong) NSString *bypassStreamingUrlDiscussion
互动直播推流地址。只在加入会议时设置有效，只有主播端可以指定，每个频道只能有一个主播。
指定推流地址的客户端被认为是互动直播的主播端
Declared In
NIMNetCallOption.h
bypassStreamingMixMode
互动直播音视频混屏模式，在 NIMNetCallBypassStreamingMixMode 里面选择合适的模式，只有主播设置有效
@property (nonatomic, assign) NSUInteger bypassStreamingMixModeDiscussion
互动直播音视频混屏模式，在 NIMNetCallBypassStreamingMixMode 里面选择合适的模式，只有主播设置有效
Declared In
NIMNetCallOption.h
bypassStreamingMixCustomLayoutConfig
互动直播音视频混屏自定义布局配置，在 bypassStreamingMixMode 为 NIMNetCallBypassStreamingMixModeCustomVideoLayout 或 NIMNetCallBypassStreamingMixModeCustomAudioLayout 时必须设置
@property (nonatomic, copy) NSString *bypassStreamingMixCustomLayoutConfigDiscussion
互动直播音视频混屏自定义布局配置，在 bypassStreamingMixMode 为 NIMNetCallBypassStreamingMixModeCustomVideoLayout 或 NIMNetCallBypassStreamingMixModeCustomAudioLayout 时必须设置
Declared In
NIMNetCallOption.h
bypassStreamingServerRecording
互动直播服务器录制，只有主播设置生效（互动直播服务器录制功能需要开通才能使用）
@property (nonatomic, assign) BOOL bypassStreamingServerRecordingDiscussion
互动直播服务器录制，只有主播设置生效（互动直播服务器录制功能需要开通才能使用）
Declared In
NIMNetCallOption.h
extendMessage
扩展消息
@property (nullable, nonatomic, copy) NSString *extendMessageDiscussion
扩展消息
仅在主叫发起点对点通话时设置有效，用于在主被叫之间传递额外信息，被叫收到呼叫时会携带该信息
Declared In
NIMNetCallOption.h
alwaysKeepCalling
始终持续呼叫
@property (nonatomic, assign) BOOL alwaysKeepCallingDiscussion
始终持续呼叫
仅在主叫发起点对点通话时设置有效，用于设置被叫离线时是否仍然需要持续呼叫, 默认为 YES
Declared In
NIMNetCallOption.h
apnsInuse
网络通话请求是否附带推送
@property (nonatomic, assign) BOOL apnsInuseDiscussion
网络通话请求是否附带推送
仅在主叫发起点对点通话时设置有效，默认为YES。将这个字段设为NO，网络通话请求将不再有苹果推送通知。
Declared In
NIMNetCallOption.h
apnsBadge
推送是否需要角标计数
@property (nonatomic, assign) BOOL apnsBadgeDiscussion
推送是否需要角标计数
仅在主叫发起点对点通话时设置有效，默认为YES。将这个字段设为NO，网络通话请求将不再对角标计数。
Declared In
NIMNetCallOption.h
apnsWithPrefix
推送是否需要带前缀(一般为昵称)
@property (nonatomic, assign) BOOL apnsWithPrefixDiscussion
推送是否需要带前缀(一般为昵称)
仅在主叫发起点对点通话时设置有效，默认为YES。将这个字段设为NO，推送消息将不带有前缀(xx:)。
Declared In
NIMNetCallOption.h
apnsContent
apns推送文案，长度限制500字
@property (nullable, nonatomic, copy) NSString *apnsContentDiscussion
apns推送文案，长度限制500字
仅在主叫发起点对点通话时设置有效，默认为nil，用户可以设置当前通知的推送文案
Declared In
NIMNetCallOption.h
apnsSound
apns推送声音文件
@property (nullable, nonatomic, copy) NSString *apnsSoundDiscussion
apns推送声音文件
仅在主叫发起点对点通话时设置有效，默认为nil，用户可以设置当前通知的推送声音。该设置会覆盖apnsPayload中的sound设置
Declared In
NIMNetCallOption.h
apnsPayload
apns推送Payload
@property (nullable, nonatomic, copy) NSDictionary *apnsPayloadDiscussion
apns推送Payload
仅在主叫发起点对点通话时设置有效，可以通过这个字段定义自定义通知的推送Payload,支持字段参考苹果技术文档,最多支持2K
Declared In
NIMNetCallOption.h
serverRecord
服务端录制参数
@property (nullable, nonatomic, strong) NIMNetCallServerRecord *serverRecordDiscussion
服务端录制参数
服务端录制相关参数
Declared In
NIMNetCallOption.h
socks5Info
Sock5代理设置
@property (nullable, nonatomic, strong) NIMNetCallSocksParam *socks5InfoDiscussion
Sock5代理设置
是否使用音视频代理socks5代理，建议使用接口方式设置代理，该参数已废弃，且不能与接口方式同时使用
Declared In
NIMNetCallOption.h
extInfo
可选参数
@property (nullable, nonatomic, strong) NSDictionary *extInfoDiscussion
可选参数
Declared In
NIMNetCallOption.h