总体参数介绍
音视频通话option参数介绍
option参数说明
参数 | 类型 | 说明 |
---|---|---|
videoCaptureParam | NIMNetCallVideoCaptureParam | 视频采集参数, 指定该参数以在加入网络通话时自动设置视频采集, 如果不指定该参数, 需要开发者调用 startVideoCapture: 手动开启视频采集。如果在加入网络通话前已经开启了视频采集, 该参数无效,该参数与 customVideoParam 不能同时设置 |
customVideoParam | NIMNetCallCustomVideoParam | 自定义输入视频参数,该参数与 videoCaptureParam 不能同时设置 |
stopVideoCaptureOnLeave | BOOL | 结束网络通话时自动停止视频采集, 默认为 YES。如果需要在离开会话以后摄像头保持开启,将该选项设置为 NO |
remoteViewoShowType | NIMNetCallRemoteVideoShowType | 远端视频展示类型 默认为 NIMNetCallRemoteVideoShowTypeLocalView |
autoRotateRemoteVideo | BOOL | 自动旋转远端画面, 默认为 YES |
preferredVideoEncoder | NIMNetCallVideoCodec | 期望的视频编码器. 硬件编码设置仅在 iOS 8.0 及以上系统有效 |
preferredVideoDecoder | NIMNetCallVideoCodec | 期望的视频解码器. 硬件解码设置仅在 iOS 8.0 及以上系统有效 |
videoMaxEncodeBitrate | NSUInteger | 视频最大编码码率 (bps). 如果不指定, SDK 会根据视频质量自动选择 |
pureVideo | BOOL | 纯视频模式, 将不启动所有音频相关的模块, 默认为 NO |
autoDeactivateAudioSession | BOOL | 结束网络通话时自动停止AudioSession, 默认为 YES |
disEnableAudioSessionConfigration | BOOL | 是否关闭SDK AudioSession配置 默认为 NO, 如果使用自己的配置并且与SDK兼容 Category 请选择AVAudioSessionCategoryPlayAndRecord,Mode 请选择AVAudioSessionModeDefault,acousticEchoCanceler 参数选择SDK内建。 |
audioDenoise | BOOL | 语音降噪, 默认为 YES |
voiceDetect | BOOL | 人声检测, 默认为 YES |
playbackSampleRate | NIMAVChatAudioSamplerate | 音频播放采样率 默认 48K 采样率 在某些蓝牙耳机连接时可能会降至16k |
acousticEchoCanceler | NIMAVChatAcousticEchoCanceler | 回声消除。可以选择 SDK 内建回声抑制,也可以按照需求关闭回声抑制。一般开发者无需设置该参数 |
audioHowlingSuppress | BOOL | 啸叫抑制, 默认为 NO |
preferHDAudio | BOOL | 期望发送高清语音, 默认开启,只有在通话的所有的参与者都设置为高清语音时才完全生效。3.3.0 之前的版本无法加入已经开启高清语音的多人会议。开启该选项后蓝牙耳机将不能使用 |
autoResetAudio | BOOL | 自动重置音频设备, 默认为NO 当检查音频采集数据不正常时,自动重置音频设备 |
scene | NIMAVChatScene | 音频场景设置 |
videoAdaptiveStrategy | NIMAVChatVideoAdaptiveStrategy | 视频调控策略 默认为 清晰优先 |
audioHandler | NIMNetCallAudioSamplesHandler | 本地采集的语音数据回调,供上层实现变音等功能 |
enableBypassStreaming | BOOL | 启用互动直播,只在加入会议时设置有效 |
bypassTaskConfig | NSArray |
互动直播房间推流配置,房间推流:没有主播的概念,任何角色(无论是否加入房间)均可以通过对应接口设置推流任务,设置推流任务的成员离开房间后不影响推流的继续。 只在互动直播(房间推流)有效 , 房间推流优先级高于主播推流,房间推流参数与主播推流参数同时设置时,已房间推流为主 |
bypassStreamingUrl | NSString | 互动直播主播推流地址。只在加入会议时设置有效,只有主播端可以指定,每个频道只能有一个主播 只在互动直播(主播推流)有效 |
bypassStreamingMixMode | NSUInteger | 互动直播主播推流音视频混屏模式,在 NIMNetCallBypassStreamingMixMode 里面选择合适的模式,图文介绍,只有主播设置有效。 只在互动直播(主播推流)有效 |
bypassStreamingMixCustomLayoutConfig | NSString | 互动直播主播推流音视频混屏自定义布局配置,在 bypassStreamingMixMode 为 NIMNetCallBypassStreamingMixModeCustomVideoLayout 或 NIMNetCallBypassStreamingMixModeCustomAudioLayout 时必须设置,详见布局参数配置介绍,同时我们提供了一个参数校验工具,帮助开发者校验参数有效性并快速看到布局效果图。只在互动直播(主播推流)有效 |
bypassStreamingServerRecording | BOOL | 互动直播主播推流服务器录制,只有主播设置生效(互动直播服务器录制功能需要开通才能使用)只在互动直播(主播推流)有效 |
extendMessage | NSString | 扩展消息 |
alwaysKeepCalling | BOOL | 始终持续呼叫 只在点对点有效 |
webrtcCompatible | BOOL | 兼容 webrtc. 在发起点对点通话和预订多人会议时指定改参数,如果没有 webrtc 参与,不要打开该开关 |
apnsInuse | BOOL | 网络通话请求是否附带推送 只在点对点有效 |
apnsBadge | BOOL | 推送是否需要角标计数 只在点对点有效 |
apnsWithPrefix | BOOL | 推送是否需要带前缀(一般为昵称) 只在点对点有效 |
apnsContent | NSString | apns推送声音文件 只在点对点有效 |
apnsSound | NSString | 推送是否需要带前缀(一般为昵称) 只在点对点有效 |
apnsPayload | NSDictionary | apns推送Payload 只在点对点有效 |
socks5Info | NIMNetCallSocks5 | 音视频socks5代理配置 |
房间Meeting参数介绍
NIMNetCallMeeting 参数说明
参数 | 类型 | 说明 |
---|---|---|
name | NSString | 会议名称 |
callID | NSString | 会议对应的当前通话 call id |
ext | UInt64 | 扩展信息 |
type | NIMNetCallMediaType | 加入会议的音视频类型 |
actor | BOOL | 以发言者的角色加入, 非发言者 (观众)不发送音视频数据 |
option | NIMNetCallOption | 网络通话可选配置 |
前处理videoProcessorParam参数介绍
videoProcessorParam 参数说明
参数 | 类型 | 说明 |
---|---|---|
filterType | NIMNetCallFilterType | 美颜类型 |
contrastIntensity | float | 对比度强度 [0-4] 默认为 1 |
smoothIntensity | float | 磨皮强度 [0-1] 默认为 0 |
waterMarkParam | NIMNetCallVideoWaterMarkParam | 水印参数 如果需要在通话开始时添加请指定 |
水印waterMarkParam参数介绍
waterMarkParam 参数说明
参数 | 类型 | 说明 |
---|---|---|
image | UIImage | 水印图片 (静态水印需要指定) |
rect | CGRect | 具体位置和大小(x,y根据location位置,计算具体的位置信息) |
location | NIMNetCallWaterMarkLocation | 位置 默认右上 |
imageArray | NSArray | 动态图像数组 (动态水印需要指定) |
count | NSUInteger | 播放速度的快慢:count代表count帧显示同一张图 (动态水印需要指定) |
loop | BOOL | 是否循环,不循环就显示一次 (动态水印需要指定) |
Socks5代理NIMNetCallSocks5参数介绍
socks5Info 参数说明
参数 | 类型 | 说明 |
---|---|---|
useSocks5Proxy | BOOL | 是否使用全局socks5代理 |
socks5Type | NSString | 代理类型,默认为socks5 |
socks5Addr | NSString | socks5服务地址, 格式:ip:port |
socks5Username | NSString | socks5服务用户名 |
socks5Password | NSString | socks5服务密码 |
MP4本地录制 NIMNetCallMP4RecordOption参数介绍
参数说明
参数 | 类型 | 说明 |
---|---|---|
videoQuality | NIMNetCallVideoQuality | 录制的分辨率,默认为NIMNetCallVideoQualityDefault 480p, 可不设置 |
videoBitrate | NSUInteger | 录制的视频码率,可不设置 |
互动直播房间推流 NIMNetCallBypassTaskConfig参数介绍
房间推流优先级高于主播推流,房间推流参数与主播推流参数同时设置时,已房间推流为主。
参数说明
参数 | 类型 | 说明 |
---|---|---|
taskId | NSString | 推流任务Id |
streamingUrl | NSString | 互动直播推流地址 |
streamingLayoutMode | NSInteger | 互动直播音视频混屏模式,在NIMNetCallBypassStreamingMixMode 里面选择合适的模式,图文介绍 |
streaminglayoutConfig | NSString | 互动直播音视频混屏自定义布局配置,在 streamingLayoutMode 为 NIMNetCallBypassStreamingMixModeCustomVideoLayout 或 NIMNetCallBypassStreamingMixModeCustomAudioLayout 时必须设置,详见布局参数配置介绍,同时我们提供了一个参数校验工具,帮助开发者校验参数有效性并快速看到布局效果图。 |
serverRecord | BOOL | 互动直播服务器录制,互动直播服务器录制功能需要开通才能使用 |
accid | NSString | 要设置主画面的accid,可以不指定 |
本篇文档内容是否对您有帮助?
有帮助
我要吐槽
此文档对你是否有帮助
×
有帮助
我要吐槽
×