类、常量定义说明

音视频发起扩展参数

键常量名 键常量值 值类型 说明
kNIMVChatUids uids StrArray (点对点通话主叫邀请有效)帐号
kNIMVChatSessionId session_id string 发起会话的本地标识id,将在创建通话及结束通话时有效,帮助针对无channelid的情况下进行映射
kNIMVChatCustomVideo custom_video int 是否用自主的视频数据 >0表示是,默认不填为0
kNIMVChatCustomAudio custom_audio int 是否用自主的音频数据 >0表示是,默认不填为0
kNIMVChatRecord record int 是否需要服务器录制音频数据 >0表示是,默认不填为0 (需要服务器配置支持,本地录制直接调用接口函数)
kNIMVChatVideoRecord video_record int 是否需要服务器录制视频数据 >0表示是 ,默认不填为0(需要服务器配置支持,本地录制直接调用接口函数)
kNIMVChatSingleRecord single_record int (多人模式有效)是否需要录制多人模式下的本人数据 >0表示是 (需要服务器配置支持,并且开kNIMVChatRecord,kNIMVChatVideoRecord其中一个
kNIMVChatMaxVideoRate max_video_rate int 视频发送编码码率 >=100000 <=5000000有效,默认不填为0,由sdk选择合适的编码码率
kNIMVChatVideoQuality video_quality int 视频聊天分辨率选择,见NIMVChatVideoQuality,默认不填为0
kNIMVChatVideoFrameRate frame_rate int 视频画面帧率,见NIMVChatVideoFrameRate,默认不填为0
kNIMVChatAudioHighRate high_rate int 是否使用语音高清模式 >0表示是,默认不填为0。3.3.0 之前的版本无法加入已经开启高清语音的多人会议
kNIMVChatAudioMode audio_mode int 音频模式选择,非默认时kNIMVChatAudioHighRate无效
kNIMVChatVEncodeMode v_encode_mode int 使用的视频编码策略NIMVChatVideoEncodeMode, 默认kNIMVChatVEModeNormal
kNIMVChatBypassRtmp bypass_rtmp int (互动直播有效)是否旁路推流(如果rtmpurl为空是连麦观众,非空是主播的推流控制),>0表示是,默认不填为0
kNIMVChatRtmpUrl rtmp_url string (互动直播有效)直播推流地址,非空代表主播旁路直播, kNIMVChatBypassRtmp决定是否开始推流
kNIMVChatRtmpRecord rtmp_record int (互动直播主播有效)是否开启服务器对直播推流录制(需要开启服务器能力),>0表示是,默认不填为0
kNIMVChatSplitMode split_mode int (互动直播主播有效)主播控制的直播推流时的分屏模式,见NIMVChatVideoSplitMode,默认不填为0
kNIMVChatCustomLayout custom_layout string (互动直播主播有效)自定义布局,当主播选择kNIMVChatSplitCustomLayout或kNIMVChatSplitAudioLayout模式时生效
kNIMVChatPushEnable push_enable int (点对点通话主叫邀请有效)是否需要推送 >0表示是,默认不填是
kNIMVChatNeedBadge need_badge int (点对点通话主叫邀请有效)是否需要角标计数 >0表示是,默认不填是
kNIMVChatNeedFromNick need_nick int (点对点通话主叫邀请有效)是否需要推送昵称 >0表示是,默认不填是
kNIMVChatApnsPayload payload string (点对点通话主叫邀请有效)JSON格式,推送payload
kNIMVChatSound sound string (点对点通话主叫邀请有效)推送声音
kNIMVChatKeepCalling keepcalling int (点对点通话主叫邀请有效)是否强制持续呼叫(对方离线也会呼叫),1表示是,0表示否。默认是

音视频其他接口扩展参数

键常量名 键常量值 值类型 说明
kNIMVChatUid uid string 帐号
kNIMVChatStatus status int 状态
kNIMVChatRecordAddr record_addr string 录制地址(服务器开启录制时有效)
kNIMVChatRecordFile record_file string 服务器音频录制文件名(服务器开启录制时有效)
kNIMVChatVideoRecordFile video_record_file string 服务器视频录制文件名(服务器开启录制时有效)
kNIMVChatType type int 状态
kNIMVChatTime time int64 时间 单位毫秒
kNIMVChatAccept accept int 是否接受 >0表示接受
kNIMVChatClient client int 客户端类型 NIMClientType
kNIMVChatMp4Start mp4_start key Mp4写入数据开始 kNIMVChatMp4File kNIMVChatTime(本地时间点)
kNIMVChatMp4Close mp4_close key 结束Mp4录制,返回时长及原因 kNIMVChatStatus(NIMVChatMp4RecordCode) kNIMVChatTime(时长) kNIMVChatMp4File
kNIMVChatMp4File mp4_file string mp4录制地址
kNIMVChatAuRecordStart audio_record_start key 音频录制写入数据开始 kNIMVChatFile kNIMVChatTime
kNIMVChatAuRecordClose audio_record_close key 结束音频录制,返回时长及原因 kNIMVChatStatus(NIMVChatAudioRecordCode) kNIMVChatTime kNIMVChatFile
kNIMVChatFile file string 文件地址
kNIMVChatCustomInfo custom_info string 自定义数据
kNIMVChatVideo video key 视频
kNIMVChatAudio audio key 音频
kNIMVChatStaticInfo static_info key 音视频实时状态
kNIMVChatFPS fps int 每秒帧率或者每秒发包数
kNIMVChatKBPS KBps int 每秒流量,单位为“千字节”
kNIMVChatLostRate lost_rate int 丢包率,单位是百分比
kNIMVChatRtt rtt int rtt 网络延迟
kNIMVChatAudioVolume audio_volume key 音频实时音量通知,包含发送的音量kNIMVChatSelf和接收音量kNIMVChatReceiver,kNIMVChatStatus的音量值是pcm的平均值最大为int16_max
kNIMVChatSelf self key 本人信息
kNIMVChatReceiver receiver key 接收信息
kNIMVChatLiveState live_state key 直播状态 kNIMVChatStatus(NIMVChatLiveStateCode)
kNIMVChatMp4AudioType mp4_audio int mp4录制时音频情况,0标识只录制当前成员,1标识录制通话全部混音(等同音频文件录制的声音)

音视频设备相关扩展参数

键常量名 键常量值 值类型 说明
kNIMDeviceName name string 设备名称
kNIMDevicePath path string 设备路径
kNIMDeviceSampleRate sample_rate int32 采样频率
kNIMDeviceSampleBit sample_bit int32 采样位深
kNIMDeviceDataUid uid int64 用户id
kNIMDeviceDataAccount account string 用户账号
kNIMDeviceWidth width int32 画面宽
kNIMDeviceHeight height int32 画面高
kNIMVideoSubType subtype int32 视频数据类型,NIMVideoSubType
kNIMDeviceId id string 标识ID
kNIMVolumeWork volume_work int32 大于0标识数据将使用音量参数进行换算(暂时只针对伴音数据)