NIM C# SDK  6.3.0
NIM.NIMVChatInfo Class Reference

发起和接受通话时的参数 More...

Inheritance diagram for NIM.NIMVChatInfo:
NimUtility.NimJsonObject< NIMVChatInfo >

Public Member Functions

 NIMVChatInfo ()
 
- Public Member Functions inherited from NimUtility.NimJsonObject< NIMVChatInfo >
virtual string Serialize ()
 
virtual string SerializeWithIndented ()
 

Properties

List< string > Uids [get, set]
 成员id列表,主动发起非空(必填) More...
 
string SessionId [get, set]
 发起会话的标识id,将在创建通话及结束通话时有效,帮助针对无channelid的情况下进行映射 More...
 
int CustomAudio [get, set]
 是否用自定义音频数据(PCM) More...
 
int CustomVideo [get, set]
 是否用自定义视频数据(i420) More...
 
int ServerAudioRecord [get, set]
 是否需要录制音频数据 >0表示是 (需要服务器配置支持,本地录制直接调用接口函数) More...
 
int ServerVideoRecord [get, set]
 是否需要录制视频数据 >0表示是 (需要服务器配置支持,本地录制直接调用接口函数) More...
 
int ServerSingleRecord [get, set]
 服务器录制模式NIMVChatServRecordType,默认为0 (需要服务器配置支持,并且开kNIMVChatRecord,kNIMVChatSingleRecord其中一个) More...
 
int ServerHostSpeaker [get, set]
 服务器混录时指定本人主画面,默认为0, 非0表示打开(需要服务器配置支持,及录制模式打开混录,并且为多人中的第一个主画面配置 More...
 
int MaxVideoRate [get, set]
 视频发送编码码率 [100000,600000]有效 More...
 
int VideoQuality [get, set]
 视频聊天分辨率选择 NIMVChatVideoQuality More...
 
int FrameRate [get, set]
 视频画面帧率 NIMVChatVideoFrameRate More...
 
int AudioMode [get, set]
 音频模式选择,非默认时kNIMVChatAudioHighRate无效 More...
 
string RtmpUrl [get, set]
 
int BypassRtmp [get, set]
 是否是旁路直播观众,此时MeetingMode无效 >0表示是 More...
 
int RtmpRecord [get, set]
 是否开启服务器对直播推流录制(需要开启服务器能力), >0表示是 More...
 
int SplitMode [get, set]
 主播控制的直播推流时的分屏模式 NIMVChatVideoSplitMode More...
 
string Layout [get, set]
 自定义布局,当主播选择kNIMVChatSplitCustomLayout或kNIMVChatSplitAudioLayout模式时生效 More...
 
int VEncodeMode [get, set]
 无效已经默认支持 是否支持webrtc互通,1表示是,0表示否。默认否 More...
 
int AudioHighRate [get, set]
 是否使用语音高清模式 >0表示是(默认关闭)3.3.0 之前的版本无法加入已经开启高清语音的多人会议 More...
 
int PushEnable [get, set]
 是否需要推送 >0表示是 默认是 More...
 
int NeedBadge [get, set]
 是否需要角标计数 >0表示是 默认是 More...
 
int NeedNick [get, set]
 是否需要推送昵称 >0表示是 默认是 More...
 
string PayLoad [get, set]
 JSON格式,推送payload More...
 
string Sound [get, set]
 推送声音 More...
 
int KeepCalling [get, set]
 int, 是否强制持续呼叫(对方离线也会呼叫),1表示是,0表示否。默认是 More...
 
bool CallingTimeout [get, set]
 是否呼叫超时 More...
 
- Properties inherited from NimUtility.NimJsonObject< NIMVChatInfo >
virtual bool IgnoreDefauleValue [get, set]
 
string JSON [get, set]
 

Additional Inherited Members

- Static Public Member Functions inherited from NimUtility.NimJsonObject< NIMVChatInfo >
static T Deserialize (string json)
 

Detailed Description

发起和接受通话时的参数

Constructor & Destructor Documentation

◆ NIMVChatInfo()

NIM.NIMVChatInfo.NIMVChatInfo ( )

Property Documentation

◆ AudioHighRate

int NIM.NIMVChatInfo.AudioHighRate
getset

是否使用语音高清模式 >0表示是(默认关闭)3.3.0 之前的版本无法加入已经开启高清语音的多人会议

◆ AudioMode

int NIM.NIMVChatInfo.AudioMode
getset

音频模式选择,非默认时kNIMVChatAudioHighRate无效

◆ BypassRtmp

int NIM.NIMVChatInfo.BypassRtmp
getset

是否是旁路直播观众,此时MeetingMode无效 >0表示是

◆ CallingTimeout

bool NIM.NIMVChatInfo.CallingTimeout
getset

是否呼叫超时

◆ CustomAudio

int NIM.NIMVChatInfo.CustomAudio
getset

是否用自定义音频数据(PCM)

◆ CustomVideo

int NIM.NIMVChatInfo.CustomVideo
getset

是否用自定义视频数据(i420)

◆ FrameRate

int NIM.NIMVChatInfo.FrameRate
getset

视频画面帧率 NIMVChatVideoFrameRate

◆ KeepCalling

int NIM.NIMVChatInfo.KeepCalling
getset

int, 是否强制持续呼叫(对方离线也会呼叫),1表示是,0表示否。默认是

◆ Layout

string NIM.NIMVChatInfo.Layout
getset

自定义布局,当主播选择kNIMVChatSplitCustomLayout或kNIMVChatSplitAudioLayout模式时生效

◆ MaxVideoRate

int NIM.NIMVChatInfo.MaxVideoRate
getset

视频发送编码码率 [100000,600000]有效

◆ NeedBadge

int NIM.NIMVChatInfo.NeedBadge
getset

是否需要角标计数 >0表示是 默认是

◆ NeedNick

int NIM.NIMVChatInfo.NeedNick
getset

是否需要推送昵称 >0表示是 默认是

◆ PayLoad

string NIM.NIMVChatInfo.PayLoad
getset

JSON格式,推送payload

◆ PushEnable

int NIM.NIMVChatInfo.PushEnable
getset

是否需要推送 >0表示是 默认是

◆ RtmpRecord

int NIM.NIMVChatInfo.RtmpRecord
getset

是否开启服务器对直播推流录制(需要开启服务器能力), >0表示是

◆ RtmpUrl

string NIM.NIMVChatInfo.RtmpUrl
getset

直播推流地址(加入多人时有效),非空代表主播旁路直播, kNIMVChatBypassRtmp决定是否开始推流

◆ ServerAudioRecord

int NIM.NIMVChatInfo.ServerAudioRecord
getset

是否需要录制音频数据 >0表示是 (需要服务器配置支持,本地录制直接调用接口函数)

◆ ServerHostSpeaker

int NIM.NIMVChatInfo.ServerHostSpeaker
getset

服务器混录时指定本人主画面,默认为0, 非0表示打开(需要服务器配置支持,及录制模式打开混录,并且为多人中的第一个主画面配置

◆ ServerSingleRecord

int NIM.NIMVChatInfo.ServerSingleRecord
getset

服务器录制模式NIMVChatServRecordType,默认为0 (需要服务器配置支持,并且开kNIMVChatRecord,kNIMVChatSingleRecord其中一个)

◆ ServerVideoRecord

int NIM.NIMVChatInfo.ServerVideoRecord
getset

是否需要录制视频数据 >0表示是 (需要服务器配置支持,本地录制直接调用接口函数)

◆ SessionId

string NIM.NIMVChatInfo.SessionId
getset

发起会话的标识id,将在创建通话及结束通话时有效,帮助针对无channelid的情况下进行映射

◆ Sound

string NIM.NIMVChatInfo.Sound
getset

推送声音

◆ SplitMode

int NIM.NIMVChatInfo.SplitMode
getset

主播控制的直播推流时的分屏模式 NIMVChatVideoSplitMode

◆ Uids

List<string> NIM.NIMVChatInfo.Uids
getset

成员id列表,主动发起非空(必填)

◆ VEncodeMode

int NIM.NIMVChatInfo.VEncodeMode
getset

无效已经默认支持 是否支持webrtc互通,1表示是,0表示否。默认否

使用的视频编码策略NIMVChatVideoEncodeMode, 默认kNIMVChatVEModeNormal

◆ VideoQuality

int NIM.NIMVChatInfo.VideoQuality
getset

视频聊天分辨率选择 NIMVChatVideoQuality