NIM.RtsAPI Class Reference

Static Public Member Functions
static void	Start (NIMRtsChannelType channelType, string uid, RtsStartInfo info, StartResHandler startResHandler)
	创建rts会话 More...
static void	Ack (string sessionId, NIMRtsChannelType channelType, bool accept, RtsStartInfo info, AckResHandler ackResHandler)
	回复收到的邀请 More...
static void	Control (string sessionId, string info, ControlResHandler controlResHandler)
	会话控制（透传） More...
static void	SetVChatMode (string sessionId, NIMRtsVideoChatMode mode)
	修改音视频的模式 More...
static void	Hangup (string sessionId, HangupResHandler hangupResHandler)
	结束会话 More...
static void	SendData (string sessionId, NIMRtsChannelType channelType, IntPtr data, int size, RtsSendDataInfo info=null)
	发送数据，暂时支持tcp通道，建议发送频率在20Hz以下 More...
static void	CreateConference (string name, string custom_info, NimRtsCreateCbFunc cb)
	创建一个多人数据通道房间（后续需要主动调用加入接口进入房间） More...
static void	JoinConference (string name, string json_extension, NimRtsJoinCbFunc cb)
	加入一个多人房间（进入房间后成员变化等，等同点对点nim_vchat_cb_func） More...
static void	SetProxy (NIMProxyType type, string host, int port, string user, string password)
	设置SDK白板的网络代理，暂时只支持socks5代理，全局代理接口也能设置音视频的代理，两接口没有优先级区别。 不需要代理时，type设置为kNIMProxyNone，其余参数都传空字符串（端口设为0）。有些代理不需要用户名和密码，相应参数也传空字符串。 More...
static void	SetStartNotifyCallback (OnStartNotify cb)
static void	SetAckNotifyCallback (OnAckNotify cb)
static void	SetSyncAckNotifyCallback (OnSyncAckNotify cb)
static void	SetConnectionNotifyCallback (OnConnectNotify cb)
static void	SetMemberChangedNotifyCallback (OnMemberNotify cb)
static void	SetControlNotifyCallback (OnControlNotify cb)
static void	SetHungupNotify (OnHangupNotify cb)
static void	SetReceiveDataCallback (OnRecData callback)

Member Function Documentation

Ack()

static void NIM.RtsAPI.Ack ( string  sessionId, NIMRtsChannelType  channelType, bool  accept, RtsStartInfo  info, AckResHandler  ackResHandler  )

static

回复收到的邀请

Parameters

sessionId	会话id
channelType	通道类型,暂时无效
accept	是否接受
info	接受时的发起信息扩展参数
ackResHandler	结果回调

Control()

static void NIM.RtsAPI.Control ( string  sessionId, string  info, ControlResHandler  controlResHandler  )

static

会话控制（透传）

Parameters

sessionId	会话id
info	透传内容
controlResHandler	结果回调

CreateConference()

static void NIM.RtsAPI.CreateConference ( string  name, string  custom_info, NimRtsCreateCbFunc  cb  )

static

创建一个多人数据通道房间（后续需要主动调用加入接口进入房间）

Parameters

name	房间名
custom_info	自定义的房间信息（加入房间的时候会返回）
cb

Hangup()

static void NIM.RtsAPI.Hangup ( string  sessionId, HangupResHandler  hangupResHandler  )

static

结束会话

Parameters

sessionId	会话id
hangupResHandler	结果回调

JoinConference()

static void NIM.RtsAPI.JoinConference ( string  name, string  json_extension, NimRtsJoinCbFunc  cb  )

static

加入一个多人房间（进入房间后成员变化等，等同点对点nim_vchat_cb_func）

Parameters

name	房间名
json_extension	扩展可选参数kNIMRtsDataRecord,kNIMRtsSessionId， 如{"data_record":1, "session_id":"b76e2b7ae065224499e4d7138d643961"}
cb

SendData()

static void NIM.RtsAPI.SendData ( string  sessionId, NIMRtsChannelType  channelType, IntPtr  data, int  size, RtsSendDataInfo  info = null  )

static

发送数据，暂时支持tcp通道，建议发送频率在20Hz以下

Parameters

sessionId	会话id
channelType	通道类型
data	发送数据
size	data的数据长度
info	RtsSendDataInfo 发送数据时的json封装类,默认为空

SetAckNotifyCallback()

static void NIM.RtsAPI.SetAckNotifyCallback ( OnAckNotify  cb )

static

SetConnectionNotifyCallback()

static void NIM.RtsAPI.SetConnectionNotifyCallback ( OnConnectNotify  cb )

static

SetControlNotifyCallback()

static void NIM.RtsAPI.SetControlNotifyCallback ( OnControlNotify  cb )

static

SetHungupNotify()

static void NIM.RtsAPI.SetHungupNotify ( OnHangupNotify  cb )

static

SetMemberChangedNotifyCallback()

static void NIM.RtsAPI.SetMemberChangedNotifyCallback ( OnMemberNotify  cb )

static

SetProxy()

static void NIM.RtsAPI.SetProxy ( NIMProxyType  type, string  host, int  port, string  user, string  password  )

static

设置SDK白板的网络代理，暂时只支持socks5代理，全局代理接口也能设置音视频的代理，两接口没有优先级区别。 不需要代理时，type设置为kNIMProxyNone，其余参数都传空字符串（端口设为0）。有些代理不需要用户名和密码，相应参数也传空字符串。

Parameters

type	代理类型，见NIMProxyType定义,其中音视频和白板暂时只支持kNIMProxySocks5代理
host	代理地址
port	代理端口
user	代理用户名
password	代理密码

SetReceiveDataCallback()

static void NIM.RtsAPI.SetReceiveDataCallback ( OnRecData  callback )

static

SetStartNotifyCallback()

static void NIM.RtsAPI.SetStartNotifyCallback ( OnStartNotify  cb )

static

SetSyncAckNotifyCallback()

static void NIM.RtsAPI.SetSyncAckNotifyCallback ( OnSyncAckNotify  cb )

static

SetVChatMode()

static void NIM.RtsAPI.SetVChatMode ( string  sessionId, NIMRtsVideoChatMode  mode  )

static

修改音视频的模式

Parameters

sessionId	会话id
mode	音频模式或视频模式

Start()

static void NIM.RtsAPI.Start ( NIMRtsChannelType  channelType, string  uid, RtsStartInfo  info, StartResHandler  startResHandler  )

static

创建rts会话

Parameters

channelType	通道类型 如要tcp+音视频，则channel_type=kNIMRtsChannelTypeTcp|kNIMRtsChannelTypeVchat，同时整个SDK只允许一个音视频通道存在（包括vchat）
uid	对方帐号
info	发起扩展参数
startResHandler	结果回调