跳到主要内容

MoClient

MoClient


new MoClient(options)

MoClient SDK入口

Parameters:
NameTypeDescription
optionsobject

参数对象

Properties
NameTypeDescription
clientIdstring

终端标识ID(用于区分多实例,可在新建实例的时候传入,未设置则随机生成)

baseUrlstring

基础的URL,用于平台登录,未设置则为空

e164string

用户e164

apsUrlstring

Aps URL,未设置则默认为baseUrl

moSeverUrlstring

moyun sever的URL,用于krtcsdk登录,未设置则为空

Methods


addCallback(name, callback)

设置回调接口

Parameters:

NameTypeDescription
namestring回调名
callbackfunction回调函数

init(serviceInitParams, meetingInitParams, loginCallback)

初始化接口

Parameters:

NameTypeDescription
serviceInitParamsobject

service参数对象

Properties
NameTypeDescription
app_keystring

认证的软件key

app_secretstring

认证软件key对应的value

usernamestring

登录用户名

passwordstring

登录密码

aps_paramsobject

aps登录参数

Properties
NameTypeDescription
Versionstring

终端版本号

IsSecuritynumber

是否支持账号安全规则,0:否,1:是 默认值:0

DeviceTypestring

必填,终端型号

ApsLocalIpstring

必填,APS的本地IP地址

UserNamestring

必填,登录账号

PassWordstring

必填,登录密码,需要使用MD5加密

OemMarkstring

运营商信息

PreferredApsIpstring

优选APS地址,即界面配置的登陆地址(域名需解析成IP)

SNstring

终端SN序列号(适用于硬终端

MainTypestring

设备主型号

SubTypestring

设备子型号

IsAnonymousstring

是否匿名登录,非匿名登录不要添加此参数,匿名登陆填写True


meetingInitParamsobject

日志参数

Properties
NameTypeDescription
krtcSdkLogParamobject

krtcsdk log参数

Properties
NameTypeDescription
enableLogboolean

是否开启

logPathstring

路径

callbackfunction

日志回调

krtcSdkInitParamobject

音视频初始化参数

Properties
NameTypeDescription
customVideoCaptureboolean

启用或关闭自定义视频采集

customVideoRenderboolean

启用或关闭自定义视频渲染

customAudioCaptureboolean

启用或关闭自定义音频采集

customAudioPlayoutboolean

启用或关闭自定义音频输出

customVideoEncodeboolean

启用或关闭自定义视频编码

customVideoDecodeboolean

启用或关闭自定义视频解码

loginCallbackfunction

登录结果回调. 0: Success, 1: Error


initialize_for_token_login(params, login_callback)

username+token登录初始化接口,

Parameters:
NameTypeDescription
paramsobject

参数对象

Properties
NameTypeDescription
enable_logboolean

选填, 是否开启log, 默认是true

log_pathstring

选填,log存放路径,默认是当前路径

versionstring

版本号

loginCallbackfunction

登录结果回调. 0: Success, 1: Error


<async> login(login_params) → {promise}

完整登录流程 getKrtcSdkToken > loginKrtc > getAccountToken > login > loginAps

Parameters:
NameTypeDescription
login_paramsobject

登录参数对象

Properties
NameTypeDescription
user_idstring

用户id

krtcsdk_login_paramsobject

参数对象

Properties
NameTypeDescription
serverAddrstring

服务器地址

idstring

用户id

nickNamestring

用户昵称

oauth_consumer_keystring

认证的软件key

oauth_consumer_secretstring

认证软件key对应的value

usernamestring

登录用户名

passwordstring

登录密码

aps_paramsobject

aps登录信息

Properties
NameTypeDescription
Versionstring

终端版本号

IsSecuritynumber

是否支持账号安全规则,0:否,1:是 默认值:0

DeviceTypestring

必填,终端型号

ApsLocalIpstring

必填,APS的本地IP地址

UserNamestring

必填,登录账号

PassWordstring

必填,登录密码,需要使用MD5加密

OemMarkstring

运营商信息

PreferredApsIpstring

优选APS地址,即界面配置的登陆地址(域名需解析成IP)

SNstring

终端SN序列号(适用于硬终端

MainTypestring

设备主型号

SubTypestring

设备子型号

IsAnonymousstring

是否匿名登录,非匿名登录不要添加此参数,匿名登陆填写True

Returns:

返回一个promise

Type

promise


<async> login_by_token(params)

Parameters:
NameTypeDescription
paramsobject

登录参数对象

Properties
NameTypeDescription
user_idstring

用户id

login_tokenstring

登录token

nick_namestring

用户昵称