参数外网ip

云游戏版权所有:腾讯云计算(北京)有限责任公司第1共79页云游戏SDK文档产品文档云游戏版权所有:腾讯云计算(北京)有限责任公司第2共79页【版权声明】2013-2021腾讯云版权所有本文档(含所有文字、数据、图片等内容)完整的著作权归腾讯云计算(北京)有限责任公司单独所有,未经腾讯云事先明确书面许可,任何主体不得以任何形式复制、修改、使用、抄袭、传播本文档全部或部分内容.
前述行为构成对腾讯云著作权的侵犯,腾讯云将依法采取措施追究法律责任.
【商标声明】及其它腾讯云服务相关的商标均为腾讯云计算(北京)有限责任公司及其关联公司所有.
本文档涉及的第三方主体的商标,依法由权利人所有.
未经腾讯云及有关权利人书面许可,任何主体不得以任何方式对前述商标进行使用、复制、修改、传播、抄录等行为,否则将构成对腾讯云及有关权利人商标权的侵犯,腾讯云将依法采取措施追究法律责任.
【服务声明】本文档意在向您介绍腾讯云全部或部分产品、服务的当时的相关概况,部分产品、服务的内容可能不时有所调整.
您所购买的腾讯云产品、服务的种类、服务标准等应由您与腾讯云之间的商业合同约定,除非双方另有约定,否则,腾讯云对本文档内容不做任何明示或默示的承诺或保证.
【联系我们】我们致力于为您提供个性化的售前购买咨询服务,及相应的技术售后服务,任何问题请联系4009100100.
云游戏版权所有:腾讯云计算(北京)有限责任公司第3共79页文档目录SDK文档SDK下载云游戏前端JSSDK云游戏AndroidSDK概览SDK接口SDK类SDK枚举类错误码Demo搭建示例Demo后端与云API对接示例(Node.
js)云游戏版权所有:腾讯云计算(北京)有限责任公司第4共79页腾讯云云游戏提供Web端和Android端的SDK,本文主要为您提供SDK安装包下载及腾讯云云游戏SDK的时序图说明.
云游戏SDK下载SDK所属平台ZIP包SDK说明JSSDK桌面浏览器DOWNLOADDOCAndroidSDKAndroidDOWNLOADDOC云游戏JSSDK时序图SDK文档SDK下载最近更新时间:2021-04-0815:34:13云游戏版权所有:腾讯云计算(北京)有限责任公司第5共79页其中:时序角色对应page用户网页tcgsdk.
js当前使用的云游戏SDKapp_server用户业务服务器cloud_api腾讯云API云游戏版权所有:腾讯云计算(北京)有限责任公司第6共79页SDK概览云游戏生命周期相关接口接口名称接口描述TCGSDK.
init(params)云游戏前端初始化TCGSDK.
getClientSession()获取Client端会话信息TCGSDK.
start(serverSession)启动云游戏TCGSDK.
destroy(msg)立即停止云游戏TCGSDK.
reconnect()重连接口游戏进程相关接口接口名称接口描述TCGSDK.
gameRestart(callback,retry)重启当前运行的游戏进程TCGSDK.
gamePause(callback)暂停当前运行的游戏进程TCGSDK.
gameResume(callback)恢复运行当前运行的游戏进程TCGSDK.
loginHelper(params,callback)辅助登录TCGSDK.
getLoginWindowStat(gameid,callback)获取当前窗口是否为登录窗口TCGSDK.
sendText(content)聚焦输入框时快速发送内容TCGSDK.
createCustomDataChannel({destPort,onMessage})创建自定义dataChannelTCGSDK.
setRemoteDesktopResolution({width,height})设置云端桌面分辨率鼠标键盘控制相关接口接口名称接口描述TCGSDK.
sendKeyboardEvent(event)发送鼠标及键盘事件云游戏前端JSSDK最近更新时间:2021-04-0815:34:25云游戏版权所有:腾讯云计算(北京)有限责任公司第7共79页接口名称接口描述TCGSDK.
sendRawEvent(event)发送鼠标及键盘事件(底层实现)TCGSDK.
setMoveSensitivity(value)设置鼠标移动灵敏度TCGSDK.
sendSeqRawEvents(events)发送按键序列(底层实现)TCGSDK.
getMoveSensitivity()获取当前鼠标灵敏度值TCGSDK.
setMouseCanLock(true/false)设置是否允许锁定鼠标TCGSDK.
mouseMove(identifier,type,x,y,isLogic)移动端向云端发送鼠标移动事件TCGSDK.
mouseTabletMode(enable)开启或关闭滑屏鼠标移动模式TCGSDK.
setRemoteCursor(mode)设置鼠标样式TCGSDK.
setCursorShowStat(show)设置鼠标隐藏或显示TCGSDK.
getCursorShowStat()获取鼠标隐藏状态TCGSDK.
setMobileCursorScale(val)移动端设置鼠标放大系数TCGSDK.
setRemoteCursorStyle(style)设置云端的系统鼠标样式TCGSDK.
clearRemoteKeys()重置云端按键状态TCGSDK.
resetRemoteCapsLock()重置云端大小写状态TCGSDK.
setDefaultCursorImage(url)设置云游戏页面中鼠标默认图片调试及日志相关接口接口名称接口描述TCGSDK.
setDebugMode({showStats,userid,showLog})打开或关闭调试模式TCGSDK.
reportLog()上报问题TCGSDK.
setLogHandler(handler)设置日志回调函数音视频相关接口接口名称接口描述TCGSDK.
setStreamProfile(profile,callback,retry)设置码流参数云游戏版权所有:腾讯云计算(北京)有限责任公司第8共79页接口名称接口描述TCGSDK.
getDisplayRect()获取显示区域的参数TCGSDK.
setVolume(val)设置本地播放音量TCGSDK.
getVolume()获取当前音量值TCGSDK.
setPageBackground(url)设置云游戏页面的背景图生命周期相关接口TCGSDK.
init(params)params对象有效字段描述:参数类型是否可选描述mountstring必填页面挂载点的HTML元素IDappidnumber必填用户的腾讯云APPIDshowLogoboolean可选默认值为truetrue为显示腾讯云Logo,false不显示micboolean可选默认值为falsetrue为开启本地麦克风,false不开启tabletModeboolean可选默认值为falsetrue为使用平板滑动鼠标模式,false为绝对映射模式.
该参数只针对移动端,PC端忽略该参数.
mobileGameboolean可选默认值为falsetrue为使用接入手游,false为适用端游clickToFullscreenboolean可选默认值为false是否启动点击全屏操作,true为启用,false为禁用idleThresholdnumber可选默认值为300s用户操作空闲时间阈值,单位为秒,空闲超过这个时间将触发onNetworkChange事件,消息为{status:'idle',times:1}云游戏版权所有:腾讯云计算(北京)有限责任公司第9共79页参数类型是否可选描述keepLastFrameboolean可选默认值为false断开的时候是否保留最后一帧画面,false为不保留,true保留.
如果需要保留最后一帧画面并重连,不能再次调用init函数,而是先调用destroy()接口,再调用start()接口.
reconnectboolean可选默认值为truetrue为帧率掉0或者异常断开自动重连一次,false为不重连loadingTextstring可选默认值为'正在启动云游戏'加载中的文字提示内容debugSettingobject可选showLog:boolean(可选)是否展示日志,showStats:boolean(可选)是否展示webrtc状态信息,也可使用CTRL+~快捷键显示onInitSuccessfunction可选初始化完毕的回调,触发此回调之后才能调用后面的APIonConnectSuccessfunction可选连接成功回调,调用start接口成功后才会触发onConnectFailfunction可选连接失败回调,调用start接口成功后才会触发onWebrtcStatusChangefunction可选webrtc状态回调,调用start接口成功后才会触发onDisconnectfunction可选断开/被踢触发此回调,调用start接口成功后才会触发onNetworkChangefunction可选网络状态变化onTouchEventfunction可选移动端触摸事件回调,调用start接口成功后才会触发,返回一个object具体参见onTouchEventonLoadGameArchivefunction可选游戏存档加载回调,会不断回调size(需要进行云端配置)onSaveGameArchivefunction可选游戏保存存档回调(需要进行云端配置)云游戏版权所有:腾讯云计算(北京)有限责任公司第10共79页参数类型是否可选描述onInputStatusChangefunction可选云端输入状态改变,有点击事件的时候都会触发,需要判断新旧状态onGamepadConnectChangefunction可选手柄连接/断开事件回调onCursorShowStatChangefunction可选云端鼠标显示/隐藏,只在变化的时候回调onOrientationChangefunction可选屏幕方向变化事件回调onLogfunction可选日志回调函数,用于外部获取日志,作用与setLogHandler接口一致onTouchEvent事件字段描述字段类型描述idnumber触控事件的IDtypestring事件类型,可选择'touchstart','touchmove','touchend'三种之一cursorShowboolean云端鼠标是否隐藏,true为显示,false为隐藏xnumber触控点在视频区域内的x坐标ynumber触控点在视频区域内的y坐标pageXnumber触控点在当前网页内的x坐标pageYnumber触控点在当前网页内的y坐标movementXnumber触控点相对上次坐标的x偏移值movementYnumber触控点相对上次坐标的y偏移值onNetworkChange网络事件类型描述event物理网络已连接{"status":"online"}物理网络已断开{"status":"offline"}帧率低或卡顿{"status":"lag"}空闲或无操作{"status":"idle"}云游戏版权所有:腾讯云计算(北京)有限责任公司第11共79页描述event外网IP变化{"status":"ipchanged"}连接loading时间过长{"status":"noflow"}已连接但帧率掉0{"status":"noflowcenter"}实时状态数据{"status":"stats","stats"stats字段的结构请参见stats字段描述stats字段描述字段类型描述bit_ratestring客户端接收的码率,单位:Mbpscpustring云端CPU占用率,单位:百分比delaystring客户端收到图像帧到解码显示的延时,单位:msfpsstring客户端显示帧率load_cost_timenumber云端加载时长,单位:msnackstring客户端重传次数packet_loststring客户端丢包次数packet_receivedstring客户端收到的包总数rttnumber客户端到云端,网络端数据包往返耗时timestampnumber此数据回调的时间戳,单位:msonWebrtcStatusChange错误码汇总错误码说明code=0请求正常code=1系统繁忙code=2票据不合法code=3用户带宽不足code=4资源不足,没有可用机器云游戏版权所有:腾讯云计算(北京)有限责任公司第12共79页错误码说明code=5session失效,需要重新登录code=6媒体描述信息错误code=7游戏拉起失败onDisconnect错误码汇总错误码说明code=0被踢code=1系统繁忙TCGSDK.
getClientSession()客户端获取Client端的会话信息,后续供业务Server调用CreateSession(ClientSession)使用.
TCGSDK.
start(serverSession)业务Server调用CreateSession获取到serversession后调用该接口启动云游戏.
TCGSDK.
destroy(msg)立即停止云游戏,销毁数据连接和显示画面.
参数参数类型说明msgobject默认错误弹窗的提示内容,结构为:{"code":Number,"message":"yourmessage"},msg可以为nullTCGSDK.
reconnect()轻量级重连接口,需要之前的连接是成功的才有效,不可滥用.
游戏进程相关接口TCGSDK.
gameRestart(callback,retry)重启当前运行的游戏进程.
参数参数类型说明callbackfunction调用结果云游戏版权所有:腾讯云计算(北京)有限责任公司第13共79页参数参数类型说明retrynumber重发次数TCGSDK.
gamePause(callback)暂停当前运行的游戏进程.
参数参数类型说明callbackfunction调用结果TCGSDK.
gameResume(callback)恢复运行当前运行的游戏进程.
参数参数类型说明callbackfunction调用结果TCGSDK.
loginHelper(params,callback)辅助登录.
参数参数类型说明paramsobject辅助登录的参数,主要参数如下:gameid:游戏IDacc:帐号字符串pwd:密码字符串callbackfunction执行结果回调callback的原型:function(res){console.
log(res)}paramsjsobject结构示例如下:云游戏版权所有:腾讯云计算(北京)有限责任公司第14共79页{gameid:'12',acc:'account',pwd:'password',}TCGSDK.
getLoginWindowStat(gameid,callback)获取当前窗口是否登录窗口.
参数参数类型说明gameidstring游戏IDcallbackfunction执行结果回调callback的原型如下:function(res){console.
log(res);}返回的res结构:{code:0,data:{bottom:number,found:1/0,left:number,name:'xxxx',right:number,top:number,capslock:0/1}}found:0表示当前不是登录窗口,1表示是登录窗口.
capslock:0表示当前是小写,1表示是大写.
TCGSDK.
sendText(content)聚焦输入框时,快速发送内容.
参数参数类型说明contentstring发送的内容云游戏版权所有:腾讯云计算(北京)有限责任公司第15共79页TCGSDK.
createCustomDataChannel({destPort,onMessage})创建自定义dataChannel,返回Promise.
(需要server支持)参数参数类型说明destPortnumber目标端口好onMessagefunctiononMessage回调,透传server返回的数据返回值返回值类型说明codenumber0:success;1:ackdataChannel未创建成功,请重试;2:该数据通道已经存在msgstring回传的message信息sendMessagefunction用于发送message的方法,参数类型为any,SDK只负责提供数据透传能力TCGSDK.
setRemoteDesktopResolution({width,height})设置云端桌面分辨率,返回Promise.
参数参数类型说明widthnumber云端桌面宽度heightnumber云端桌面高度返回值返回值类型说明codenumber0:success,1:fail鼠标键盘控制相关接口TCGSDK.
sendKeyboardEvent(event)对sendRawEvent(event)的包装,省掉type参数,可以用html元素定义一些虚拟按键,demo.
html有简单的例子.
事件触发后调用sendKeyboardEvent发送按键消息,您可从键盘码查看网中获取键盘的键位值.
参数参数类型说明云游戏版权所有:腾讯云计算(北京)有限责任公司第16共79页参数参数类型说明eventobject对象结构:{key:Integer,down:true/false}TCGSDK.
sendRawEvent(event)更底层的发送函数,允许定义event的类型.
event对象结构如下:event对象结构说明鼠标偏移(用于无边框限制的鼠标移动事件){type:"mousedeltamove",x:Number,y:Number},x、y坐标值均为整数鼠标移动{type:"mousemove",x:Number,y:Number},x、y坐标值均为整数鼠标左键点击{type:"mouseleft",down:true/false}鼠标右键点击{type:"mouseright",down:true/false}鼠标滚动{type:"mousescroll",delta:Number}键盘按键事件{type:"keyboard",key:Integer,down:true/false}手柄事件手柄连接事件{type:"gamepadconnect"},发送操作按键前必须先发送这个事件手柄断开事件{type:"gamepaddisconnect"}手柄按键事件{type:"gamepadkey",key:Number,down:true/false}方向键事件值:向上键值为0x01,向下键值为0x02,向左键值为0x04,向右键值为0x08按键事件值:X键值为0x4000,Y键值为0x8000,A键值为0x1000,B键值为0x2000select事件值:键值为0x20start事件值:键值为0x10手柄左摇杆事件{type:"axisleft",x:[-32767~32767],y:[-32767~32767]},原浮点数值为(-1~1),实际返回原浮点数值*32767手柄右摇杆事件{type:"axisright",x:[-32767~32767],y:[-32767~32767]},原浮点数值为(-1~1),实际返回原浮点数值*32767手柄左触发键(L1)事件{type:"gamepadkey",key:0x100,down:true/false}云游戏版权所有:腾讯云计算(北京)有限责任公司第17共79页event对象结构说明手柄右触发键(R1)事件{type:"gamepadkey",key:0x200,down:true/false}手柄左触发键(L2)事件{type:"lt",x:[0-255],down:true/false},原浮点数值为(0~1),实际返回原浮点数值*255手柄右触发键(R2)事件{type:"rt",x:[0-255],down:true/false},原浮点数值为(0~1),实际返回原浮点数值*255手柄左摇杆垂直按下(L3)事件{type:"gamepadkey",key:0x80,down:true/false}手柄右摇杆垂直按下(R3)事件{type:"gamepadkey",key:0x40,down:true/false}TCGSDK.
setMoveSensitivity(value)设置鼠标或者触摸移动的敏感度.
参数参数类型说明valuenumber取值范围:[0.
01,100.
0]之间的浮点数TCGSDK.
sendSeqRawEvents(events)底层发送按键序列的函数.
参数参数类型说明eventsobject事件数组,例如:events=[{type:"mouseleft",down:true},{type:"mouseleft",down:true},.
.
.
],数组最大限制10个事件注意:如果直接调用此接口发送鼠标移动/偏移事件,需额外处理显示区域偏移、灵敏度和坐标缩放,灵敏度设置API也无效,因此建议调用后面的mouseMove接口.
说明:event的对象结构参考TCGSDK.
sendRawEvent的描述.
云游戏版权所有:腾讯云计算(北京)有限责任公司第18共79页TCGSDK.
getMoveSensitivity()获取当前的鼠标灵敏度值.
TCGSDK.
setMouseCanLock(true/false)设置是否允许锁定鼠标,用于用户操作网页控件,其中true为允许,false为禁止.
默认为true.
TCGSDK.
mouseMove(identifier,type,x,y,isLogic)移动端向云端(PC端)发送鼠标移动事件.
参数参数类型说明identifiernumber触控点的ID,多点触控时每个触控点ID不能相等,同个触控点的所有事件的触控点ID必须一致typestring触控事件类型,值为touchstart、touchmove、touchend、touchcancel中的一个,对于同一个触控点,touchstart必须且只对应一个touchend或touchcancelxnumber填写数字,触控点的x坐标,但是如果传浮点数,则按逻辑坐标处理ynumber填写数字,触控点的y坐标,但是如果传浮点数,则按逻辑坐标处理isLogicbooleantrue代表逻辑坐标,false或者不传则代表的是物理坐标(像素绝对坐标)TCGSDK.
mouseTabletMode(enable)开启或关闭滑屏鼠标移动模式,可以随时切换,目前仅支持移动端.
参数参数类型说明enablebooleantrue:打开,false:关闭TCGSDK.
setRemoteCursor(mode)设置鼠标样式.
参数参数类型说明注意:调用此接口无需额外处理显示区域偏移、灵敏度和坐标缩放.
云游戏版权所有:腾讯云计算(北京)有限责任公司第19共79页参数参数类型说明modenumber目前支持三种鼠标样式:mode=0:页面渲染的固定鼠标图片mode=1:云端下发鼠标图片,由浏览器页面渲染mode=2:云端画面内渲染鼠标图片,此时会隐藏本地渲染的鼠标,兼容性最好,但是有延时TCGSDK.
setCursorShowStat(show)设置鼠标隐藏或显示.
参数类型说明showbooleantrue:显示,false:隐藏TCGSDK.
getCursorShowStat()获取鼠标隐藏状态.
TCGSDK.
setMobileCursorScale(val)移动端设置鼠标放大系数.
参数参数类型说明valnumber放大系数,默认是1.
0,与云端大小一致,取值范围[0.
1,10]TCGSDK.
setRemoteCursorStyle(style)设置云端的系统鼠标样式,setRemoteCursor的mode为1和2时生效;参数参数类型说明stylestring样式字符串,值为以下的值之一:standard:系统默认鼠标样式,较小default_huge:系统超大鼠标样式,较大TCGSDK.
clearRemoteKeys()重置云端所有按键状态,用于云端按键卡住的场景.
TCGSDK.
resetRemoteCapsLock()重置云端大小写状态为小写.
云游戏版权所有:腾讯云计算(北京)有限责任公司第20共79页TCGSDK.
setDefaultCursorImage(url)设置云游戏页面中鼠标默认图片.
参数参数类型说明urlContext鼠标样式图片URL调试及日志相关接口TCGSDK.
setDebugMode({showLog,showStats,userid})打开或关闭调试模式,打开的情况下将在控制台打印日志.
参数参数类型说明showLogboolean打开日志和状态,true为打开,false为隐藏showStatsboolean是否展示webrtc状态信息,true为打开,false为隐藏useridstring用户的ID,主要是用于过滤日志TCGSDK.
reportLog()上报问题.
TCGSDK.
setLogHandler(handler)设置日志回调函数,便于外部获取详细日志,作用与init时传的onLog回调一致.
参数参数类型说明handlerfunction日志回调函数,原型:function(logText)音视频相关接口TCGSDK.
setStreamProfile(profile,callback,retry)设置码流参数.
参数参数类型说明profilenumber目前可用参数如下:fps:帧率,范围[10,60],单位:帧max_bitrate:最大码率,范围[1,15],单位:Mbpsmin_bitrate:最小码率,范围[1,15],单位:Mbps云游戏版权所有:腾讯云计算(北京)有限责任公司第21共79页参数参数类型说明callbackfunction设置结果回调函数,可为nullretrynumber重试次数,可不填TCGSDK.
getDisplayRect()获取显示区域的参数,边距,宽高等.
TCGSDK.
setVolume(val)设置本地播放音量.
参数参数类型说明valnumber取值范围:[0,1]之间的浮点数TCGSDK.
getVolume()获取当前音量值.
TCGSDK.
setPageBackground(url)设置云游戏页面的背景图.
参数参数类型说明urlContext背景图片URL云游戏版权所有:腾讯云计算(北京)有限责任公司第22共79页云游戏为您提供了Android端SDK程序包com.
tencent.
tcgsdk.
api.
接口接口说明ICursorBitmapListener获取鼠标图片接口IGameArchiveSDK提供的存档操作IGameArchive.
IArchiveListener加载存档监听器IGameProcessLaunchListener远端游戏进程监听器IHitInputBoxListener远端设备输入框选中状态监听器IJitterListener网络抖动状态监听器ILogger日志回调接口ILowFPSListener低帧率回调监听器IOnGameViewTouchListener用户在GameView触发的动作监听器IRemoteCursorVisibleListener远端光标可见性监听器IResolutionChangeListener视频图像宽高变化监听器ITcgListenerTcgSdk生命周期回调,TcgSdk在调用start接口之后进行初始化ITcgSdkSDK接口定义ITcgSdk.
IAutoLoginWindowStatCallback是否支持自动登录功能回调ITcgSdk.
IRTCResult云端接口调用结果ITcgSdk.
IRTCTimeoutCallback接口调用请求超时IWanIpChangeListener外网IP变化回调监听器云游戏AndroidSDK概览最近更新时间:2021-01-2610:04:58云游戏版权所有:腾讯云计算(北京)有限责任公司第23共79页类类说明GameView该视图代理了远程设备视图TcgSdk2.
Builder腾讯云云游戏Android端SDK实现类构建器枚举类枚举说明CursorType鼠标类型LogLevel日志级别ScaleType画面类型错误码错误类型说明TcgErrorType错误类型定义云游戏版权所有:腾讯云计算(北京)有限责任公司第24共79页ICursorBitmapListener鼠标图片数据接口.
publicinterfaceICursorBitmapListener方法概览方法类型说明onGetCursorvoid获取到鼠标图片onGetCursor获取到鼠标图片.
voidonGetCursor(Bitmapbitmap,inthotspotx,inthotspoty)参数:参数类型含义bitmapBitmap获取到的图片hotspotxint鼠标在点击后坐标应该偏移的横轴位置hotspotyint鼠标在点击后坐标应该偏移的纵轴位置IGameArchiveSDK提供的云游戏存档操作.
publicinterfaceIGameArchiveSDK接口最近更新时间:2021-01-2610:04:54云游戏版权所有:腾讯云计算(北京)有限责任公司第25共79页嵌套类概览接口类型说明IGameArchive.
IArchiveListenerstaticinterface加载存档回调IGameArchive.
IArchiveListener加载存档回调.
publicstaticinterfaceIGameArchive.
IArchiveListener方法概览方法类型说明onGameProcessLaunchedvoid游戏进程启动完成回调onSaveGameArchive加载存档状态回调.
voidonSaveGameArchive(intstatus,java.
lang.
StringuserID,java.
lang.
StringgameID,java.
lang.
Stringname,java.
lang.
Stringurl,java.
lang.
StringsaveType,java.
lang.
StringcategoryID,longarchiveSize)参数:参数类型说明statusint存档加载状态userIDjava.
lang.
String云API传入的userIDgameIDjava.
lang.
String游戏ID云游戏版权所有:腾讯云计算(北京)有限责任公司第26共79页参数类型说明namejava.
lang.
String存档文件名urljava.
lang.
String存档下载地址saveTypejava.
lang.
StringAuto自动存档,Normal手动存档categoryIDjava.
lang.
String分类标识archiveSizelong存档大小IGameProcessLaunchListener远端游戏进程回调监听器.
publicinterfaceIGameProcessLaunchListener方法概览方法类型说明onGameProcessLaunchedvoid游戏进程启动完成回调onGameProcessLaunched游戏进程启动完成回调.
voidonGameProcessLaunched(longlaunchStart,longlaunchFinished)参数:参数类型说明launchStartlong游戏开始启动时间(ms)launchFinishedlong游戏启动完成时间(ms)IHitInputBoxListener云游戏版权所有:腾讯云计算(北京)有限责任公司第27共79页远端设备输入框选中状态回调.
publicinterfaceIHitInputBoxListener方法概览方法类型说明onInputBoxvoid表示用户点中了输入框onInputBox表示用户点中了输入框.
voidonInputBox()IJitterListener网络抖动状态监听.
publicinterfaceIJitterListener方法概览方法类型说明onJittervoid客户端收到远端心跳响应回调onJitter客户端收到远端心跳响应回调.
voidonJitter(longrtt)参数:参数类型说明rttlong客户端发起到收到远端响应的时间间隔(ms)云游戏版权所有:腾讯云计算(北京)有限责任公司第28共79页ILogger日志回调接口.
publicinterfaceILoggerILowFPSListener低帧率回调接口.
publicinterfaceILowFPSListener方法概览方法类型说明onLowFpsvoid出现低帧率时回调onLowFps出现低帧率时回调.
voidonLowFps()IOnGameViewTouchListener用户在GameView进行的点击动作的监听器.
publicinterfaceIOnGameViewTouchListener方法概览方法类型说明说明:低帧率的判定标准:连续5秒帧率都低于25帧/秒,则认为是低帧率.
云游戏版权所有:腾讯云计算(北京)有限责任公司第29共79页方法类型说明onLongPressvoid用户长按游戏视图onTapvoid用户轻触游戏视图onTap用户轻触游戏视图.
voidonTap()onLongPress用户长按游戏视图.
voidonLongPress()IRemoteCursorVisibleListener远端光标可见性监听器.
publicinterfaceIRemoteCursorVisibleListener方法概览方法类型说明onCursorVisibilityvoid远端光标可见性改变时回调onCursorVisibility远端光标可见性改变时回调.
voidonCursorVisibility(booleanvisible)参数:参数类型说明云游戏版权所有:腾讯云计算(北京)有限责任公司第30共79页参数类型说明visibleboolean远端设备光标当前是否可见IResolutionChangeListener视频图像宽高变化监听器.
publicinterfaceIResolutionChangeListener方法概览方法类型说明onResolutionChangevoid视频图像宽高发生变化时回调onResolutionChange视频图像宽高发生变化时回调.
voidonResolutionChange(intoldWidth,intoldHeight,intnewWidth,intnewHeight)参数:参数类型说明oldWidthint变化前的视频图像宽度,首次渲染该值为0oldHeightint变化前的视频图像高度,首次渲染该值为0newWidthint变化后的视频图像宽度注意:FPS类游戏鼠标不可见,若您发现云端鼠标消失,则意味着您已进入此类游戏.
屏幕上的触摸单击需要转换成相对位置发送至云端mousedeltamove.
云游戏版权所有:腾讯云计算(北京)有限责任公司第31共79页参数类型说明newHeightint变化后的视频图像高度ITcgListenerTcgSdk生命周期回调,TcgSdk在调用start接口之后进行初始化.
publicinterfaceITcgListener方法概览方法类型说明onInitSuccessvoidSDK初始化成功回调onInitFailurevoid初始化失败回调onConnectionFailurevoid连接失败回调onConnectionSuccessvoid连接成功(所有传递到云端的设置参数,必须在收到这个回调之后才能进行设置)onConnectionTimeoutvoid连接超时onDrawFirstFramevoid首帧绘制时机onInitSuccessSDK初始化成功回调.
voidonInitSuccess(java.
lang.
StringclientSession)参数:参数类型说明clientSessionjava.
lang.
StringClientSession客户端会话onInitFailure初始化失败回调.
云游戏版权所有:腾讯云计算(北京)有限责任公司第32共79页voidonInitFailure(interrorCode)参数:参数类型说明errorCodeint错误码onConnectionFailure连接失败回调.
voidonConnectionFailure(interrorCode,java.
lang.
StringerrorMsg)参数:参数类型含义errorCodeint错误码errorMsgjava.
lang.
String错误原因onConnectionSuccess连接成功.
voidonConnectionSuccess()onConnectionTimeout说明:更多详情请参见错误码(TcgErrorType).
注意:所有传递到云端的设置参数必须在收到这个回调之后才能进行设置.
云游戏版权所有:腾讯云计算(北京)有限责任公司第33共79页连接超时.
voidonConnectionTimeout()onDrawFirstFrame首帧绘制时机.
voidonDrawFirstFrame()ITcgSdkSDK接口定义.
publicinterfaceITcgSdk嵌套类概览接口类型说明ITcgSdk.
IAutoLoginWindowStatCallbackstaticinterface是否支持自动登录功能回调TcgSdk.
IRTCResultstaticinterface远端接口调用结果TcgSdk.
IRTCTimeoutCallbackstaticinterfaceSDK接口调用超时回调方法概览方法类型说明startvoid启动云游戏stopvoid立即停止云游戏reconnectvoid重新连接getLoginWindowStatvoid查询当前窗口是否支持自动登录功能loginHelpervoid辅助登录,云端游戏登录窗口自动输入账号密码gameRestartvoid重启当前运行的游戏进程云游戏版权所有:腾讯云计算(北京)有限责任公司第34共79页方法类型说明pausevoid暂停画面传输resumevoid恢复画面传输setStreamProfilevoid设置FPS及码率resetRemoteCapsLockvoid重置云端大小写状态为小写clearRemoteKeysvoid重置云端按键状态setLogHandlervoid设置日志回调函数,便于外部获取详细日志setVolumevoid设置音量大小getVolumefloat获取当前音量值registerTcgListenervoid设置生命周期回调监听器unRegisterTcgListenervoid注销生命周期监听器registerCursorVisibilityChangeListenervoid注册云端设备光标可见性监听器unRegisterCursorVisibilityChangeListenervoid注销远端设备光标可见性回调监听器registerJitterListenervoid注册网络抖动状态监听器unRegisterJitterListenervoid注销网络抖动状态监听器registerHitInputBoxListenervoid注册云端设备输入框监听器unRegisterHitInputListenervoid注销远端设备输入框监听器registerLowFPSListenervoid注册低帧率回调监听器unRegisterLowFPSListenervoid注销低帧率监听器registerWanIpChangeListenervoid注册外网IP变化回调监听器unRegisterWanIpChangeListenervoid注销外网IP变化监听器registerGameProcessLaunchListenervoid注册云端游戏进程启动监听器unRegisterGameProcessLaunchListenervoid注销远端游戏进程启动监听器registerCursorBitmapListenervoid注册云端鼠标图片监听器unRegisterCursorBitmapListenervoid注销获取鼠标图片监听器云游戏版权所有:腾讯云计算(北京)有限责任公司第35共79页方法类型说明registerRemoteDesktopvoid注册云端桌面变化监听器registerResolutionChangeListenervoid注册视频图像宽高变化监听器unRegisterResolutionChangeListenervoid注销视频图像宽高变化监听器registerGameArchiveListenervoid注册加载游戏存档监听器unRegisterGameArchiveListenervoid注销加载游戏存档监听器sendShiftKeyvoid发送shift键sendShiftKeyvoid发送shift键sendMouseLeftvoid鼠标左键控制sendMouseLeftvoid鼠标左键控制sendMouseRightvoid鼠标右键控制sendMouseRightvoid鼠标右键控制sendMouseScrollvoid鼠标滚轮控制sendMouseScrollvoid鼠标滚轮控制sendRawEventvoid发送底层事件sendRawEventvoid发送底层事件.
与sendRawEvent相同,但可监听消息发送反馈sendKeyboardEventvoid发送键盘事件sendGamePadConnectedvoid告知云端设备已连接上手柄sendGamePadDisconnectedvoid告知云端设备手柄已断开mouseMovevoid向云端设备发送鼠标移动事件mouseDeltaMovevoid向云端设备发送鼠标移动事件start启动云游戏.
voidstart(java.
lang.
Stringsession)云游戏版权所有:腾讯云计算(北京)有限责任公司第36共79页参数:参数类型说明sessionjava.
lang.
StringServerSession从云API获取后需要做一次Base64.
decodestop立即停止云游戏.
voidstop()reconnect重新连接云游戏视频流.
voidreconnect()getLoginWindowStat查询当前窗口是否支持自动登录功能.
voidgetLoginWindowStat(ITcgSdk.
IAutoLoginWindowStatCallbackcallback)参数:参数类型说明callbackITcgSdk.
IAutoLoginWindowStatCallback是否支持自动登录功能回调loginHelper辅助登录,到远端游戏登录窗口输入账号密码.
该接口依赖于云端配置,若回调不生效需要和云游团队确认配置是否开启.
voidloginHelper(java.
lang.
Stringaccount,java.
lang.
Stringpassword,ITcgSdk.
IRTCResultcallback)云游戏版权所有:腾讯云计算(北京)有限责任公司第37共79页参数:参数类型说明accountjava.
lang.
String登录的账号passwordjava.
lang.
String登录的密码callbackITcgSdk.
IRTCResult调用结果回调NOTEgameRestart重启当前运行的游戏进程.
voidgameRestart(ITcgSdk.
IRTCResultresult)参数:参数类型说明resultITcgSdk.
IRTCResult调用结果回调pause暂停画面传输.
voidpause(ITcgSdk.
IRTCResultresult)参数:参数类型说明resultITcgSdk.
IRTCResult调用结果回调resume恢复画面传输.
voidresume(ITcgSdk.
IRTCResultresult)参数:云游戏版权所有:腾讯云计算(北京)有限责任公司第38共79页参数类型说明resultITcgSdk.
IRTCResult调用结果回调setStreamProfile设置FPS及码率.
voidsetStreamProfile(intfps,intminBitrate,intmaxBitrate,TcgSdk.
IRTCResultcallback)参数:参数类型说明fpsint帧率,整型,范围[10,60],单位帧minBitrateint最小码率,整型,范围[1,15],单位MbpsmaxBitrateint最大码率,整型,范围[1,15],单位Mbps注意:假如max_bitrate与min_bitrate相等,则相当于恒定码率callbackITcgSdk.
IRTCResult远程调用回调resetRemoteCapsLock重置云端大小写状态为小写.
voidresetRemoteCapsLock(ITcgSdk.
IRTCResultcallback)参数:参数类型说明callbackITcgSdk.
IRTCResult远程调用回调clearRemoteKeys重置云端按键状态(云端卡键时调用).
云游戏版权所有:腾讯云计算(北京)有限责任公司第39共79页voidclearRemoteKeys(ITcgSdk.
IRTCResultcallback)参数:参数类型说明callbackITcgSdk.
IRTCResult远程调用回调setLogHandler设置日志回调函数,便于外部获取详细日志.
voidsetLogHandler(ILoggerlogger)参数:参数类型说明loggerILogger接收日志的回调setVolume设置音量大小.
voidsetVolume(floatvolume)参数:参数类型说明volumefloat[0,1]之间的浮点数getVolume获取当前音量值.
floatgetVolume()返回:当前音量.
云游戏版权所有:腾讯云计算(北京)有限责任公司第40共79页registerTcgListener注册SDK生命周期监听器.
voidregisterTcgListener(ITcgListenerlistener)参数:参数类型说明listenerITcgListenerSDK生命周unRegisterTcgListener注销SDK生命周期监听器.
voidunRegisterTcgListener(ITcgListenerlistener)参数:参数类型说明listenerITcgListenerSDK生命周期回调监听registerCursorVisibilityChangeListener注册远端设备光标可见性监听器.
voidregisterCursorVisibilityChangeListener(IRemoteCursorVisibleListenerlistener)参数:参数类型说明listenerIRemoteCursorVisibleListener光标可见性变化时候调用的回调unRegisterCursorVisibilityChangeListener注销远端设备光标可见性监听器.
voidunRegisterCursorVisibilityChangeListener(IRemoteCursorVisibleListenerlistener)云游戏版权所有:腾讯云计算(北京)有限责任公司第41共79页参数:参数类型说明listenerIRemoteCursorVisibleListener光标可见性变化时候调用的回调registerHitInputBoxListener注册远端设备输入框监听器.
voidregisterHitInputBoxListener(IHitInputBoxListenerlistener)参数:参数类型说明listenerIHitInputBoxListener远端输入框监听unRegisterHitInputListener注销远端设备输入框回调监听.
voidunRegisterHitInputListener(IHitInputBoxListenerlistener)参数:参数类型说明listenerIHitInputBoxListener远端输入框回调监听registerJitterListener注册网络抖动状态回调监听.
voidregisterJitterListener(IJitterListenerlistener)说明:该接口依赖服务器针对游戏的配置.
云游戏版权所有:腾讯云计算(北京)有限责任公司第42共79页参数:参数类型说明listenerIJitterListener网络抖动状态回调监听unRegisterJitterListener注销网络抖动状态回调监听.
voidunRegisterJitterListener(IJitterListenerlistener)参数:参数类型说明listenerIJitterListener网络抖动状态回调监听registerLowFPSListener注册低帧率监听器.
voidregisterLowFPSListener(ILowFPSListenerlistener)参数:参数类型说明listenerILowFPSListener低帧率回调监听unRegisterLowFPSListener注销低帧率监听器.
voidunRegisterLowFPSListener(ILowFPSListenerlistener)参数:参数类型说明云游戏版权所有:腾讯云计算(北京)有限责任公司第43共79页参数类型说明listenerILowFPSListener低帧率回调监听registerWanIpChangeListener注册外网IP变化监听器.
voidregisterWanIpChangeListener(IWanIpChangeListenerlistener)参数:参数类型说明listenerIWanIpChangeListener外网IP变化回调监听unRegisterWanIpChangeListener注销外网IP变化监听器voidunRegisterWanIpChangeListener(IWanIpChangeListenerlistener)参数:参数类型说明listenerIWanIpChangeListener外网IP变化回调监听registerGameProcessLaunchListener注册远端游戏进程启动监听器.
voidregisterGameProcessLaunchListener(IGameProcessLaunchListenerlistener)参数:参数类型说明listenerIGameProcessLaunchListener游戏进程启动监听云游戏版权所有:腾讯云计算(北京)有限责任公司第44共79页unRegisterGameProcessLaunchListener注销远端游戏进程启动监听器.
voidunRegisterGameProcessLaunchListener(IGameProcessLaunchListenerlistener)参数:参数类型说明listenerIGameProcessLaunchListener游戏进程启动监听registerCursorBitmapListener监听获取鼠标图片.
voidregisterCursorBitmapListener(ICursorBitmapListenerlistener)参数:参数类型说明listenerICursorBitmapListener获取到鼠标图片的回调监听unRegisterCursorBitmapListener注销获取鼠标图片监听器.
voidunRegisterCursorBitmapListener(ICursorBitmapListenerlistener)参数:参数类型说明listenerICursorBitmapListener获取到鼠标图片的回调监听registerResolutionChangeListener注册视频图像宽高变化监听器.
voidregisterResolutionChangeListener(IResolutionChangeListenerlistener)云游戏版权所有:腾讯云计算(北京)有限责任公司第45共79页参数:参数类型说明listenerIResolutionChangeListener视频图像宽高变化监听unRegisterResolutionChangeListener注销视频图像宽高变化监听器.
voidunRegisterResolutionChangeListe(IResolutionChangeListenerlistener)参数:参数类型说明listenerIResolutionChangeListener视频图像宽高变化监听registerGameArchiveListener注册加载游戏存档监听器.
voidregisterGameArchiveListener(IGameArchive.
IArchiveListenerlistener)参数:参数类型说明listenerIGameArchive.
IArchiveListener加载游戏存档回调unRegisterGameArchiveListener注销加载游戏存档监听器.
voidunRegisterGameArchiveListener(IGameArchive.
IArchiveListenerlistener)参数:云游戏版权所有:腾讯云计算(北京)有限责任公司第46共79页参数类型说明listenerIGameArchive.
IArchiveListener加载游戏存档回调sendShiftKey发送shift键.
voidsendShiftKey(booleandown,ITcgSdk.
IRTCResultcallback)参数:参数类型说明downbooleantrue表示按下,false表示抬起callbackITcgSdk.
IRTCResult远端接口调用结果sendShiftKey发送shift键.
voidsendShiftKey(booleandown)参数:参数类型说明downbooleantrue表示按下,false表示抬起sendMouseLeft鼠标左键控制.
voidsendMouseLeft(booleandown)参数:参数类型说明云游戏版权所有:腾讯云计算(北京)有限责任公司第47共79页参数类型说明downbooleantrue表示按下,false表示抬起sendMouseLeft鼠标左键控制.
voidsendMouseLeft(booleandown,ITcgSdk.
IRTCResultcallback)参数:参数类型说明downbooleantrue表示按下,false表示抬起callbackITcgSdk.
IRTCResult远端接口调用结果sendMouseRight鼠标右键控制.
voidsendMouseRight(booleandown)参数:参数类型说明downbooleantrue表示按下,false表示抬起sendMouseRight鼠标右键控制.
voidsendMouseRight(booleandown,ITcgSdk.
IRTCResultcallback)参数:云游戏版权所有:腾讯云计算(北京)有限责任公司第48共79页参数类型说明downbooleantrue表示按下,false表示抬起callbackITcgSdk.
IRTCResult远端接口调用结果sendMouseScroll鼠标滚轮控制.
voidsendMouseScroll(intdelta)参数:参数类型说明deltaint偏移值,取值范围[-255,255]sendMouseScroll鼠标滚轮控制.
voidsendMouseScroll(intdelta,ITcgSdk.
IRTCResultcallback)参数:参数类型说明deltaint偏移值,取值范围[-255,255]callbackITcgSdk.
IRTCResult远端接口调用结果sendRawEvent发送底层事件.
voidsendRawEvent(java.
lang.
Stringevent)参数:云游戏版权所有:腾讯云计算(北京)有限责任公司第49共79页参数类型说明eventjava.
lang.
String事件对象结构event对象结构说明鼠标偏移(用于无边框限制的鼠标移动事件){type:"mousedeltamove",x:Number,y:Number},x、y坐标值均为整数鼠标移动{type:"mousemove",x:Number,y:Number},x、y坐标值均为整数鼠标左键点击{type:"mouseleft",down:true/false}鼠标右键点击{type:"mouseright",down:true/false}鼠标滚动{type:"mousescroll",delta:Number}鼠标滚轮单击{type:"mousemiddle",down:true/false}键盘按键事件{type:"keyboard",key:Integer,down:true/false}手柄事件手柄连接事件{type:"gamepadconnect"},发送操作按键前必须先发送这个事件手柄断开事件{type:"gamepaddisconnect"}手柄按键事件{type:"gamepadkey",key:Number,down:true/false}方向键事件值:向上键值为0x01,向下键值为0x02,向左键值为0x04,向右键值为0x08按键事件值:X键值为0x4000,Y键值为0x8000,A键值为0x1000,B键值为0x2000select事件值:键值为0x20start事件值:键值为0x104手柄左摇杆事件{type:"axisleft",x:[-32767,32767],y:[-32767,32767]},原浮点数值为(-1,1),实际返回原浮点数值*32767手柄右摇杆事件{type:"axisright",x:[-32767,32767],y:[-32767,32767]},原浮点数值为(-1,1),实际返回原浮点数值*32767手柄左触发键(L1)事件{type:"gamepadkey",key:0x100,down:true/false}手柄右触发键(R1)事件{type:"gamepadkey",key:0x200,down:true/false}云游戏版权所有:腾讯云计算(北京)有限责任公司第50共79页event对象结构说明手柄左触发键(L2)事件{type:"lt",x:[0,255],down:true/false},原浮点数值为(0~1),实际返回原浮点数值*255手柄右触发键(R2)事件{type:"rt",x:[0-255],down:true/false},原浮点数值为(0~1),实际返回原浮点数值*255手柄左摇杆垂直按下(L3)事件{type:"gamepadkey",key:0x80,down:true/false}手柄右摇杆垂直按下(R3)事件{type:"gamepadkey",key:0x40,down:true/false}sendRawEvent发送底层事件.
与sendRawEvent相同,但可监听消息发送反馈.
voidsendRawEvent(java.
lang.
Stringevent,ITcgSdk.
IRTCResultcallback)参数:参数类型说明eventjava.
lang.
String事件对象结构callbackITcgSdk.
IRTCResult远端接口调用结果sendKeyboardEvent发送键盘事件,是对sendRawEvent(event)的包装,省掉了type参数.
voidsendKeyboardEvent(intkeycode,booleandown,ITcgSdk.
IRTCResultcallback)注意:如果直接调用此接口发送鼠标移动或偏移事件,需额外处理显示区域偏移、灵敏度和坐标缩放,灵敏度设置API也无效,因此建议调用后面的mouseMove接口.
云游戏版权所有:腾讯云计算(北京)有限责任公司第51共79页参数:参数类型说明keycodeint按键值downbooleantrue表示按下,false表示抬起callbackITcgSdk.
IRTCResult远端接口调用结果sendGamePadConnected告知云端设备已连接上手柄.
voidsendGamePadConnected()sendGamePadDisconnected告知云端设备手柄已经断开.
voidsendGamePadDisconnected()mouseMove向云端设备发送鼠标移动事件.
voidmouseMove(intx,inty)参数:参数类型说明xint需要移动到的横轴绝对位置yint需要移动到的纵轴绝对位置注意:鼠标移动为绝对位置.
云游戏版权所有:腾讯云计算(北京)有限责任公司第52共79页mouseDeltaMove向云端设备发送鼠标移动事件.
voidmouseDeltaMove(intdeltaX,intdeltaY)参数:参数类型说明deltaXint需要移动到的横轴相对位置deltaYint需要移动到的纵轴相对位置ITcgSdk.
IAutoLoginWindowStatCallback是否支持自动登录功能回调.
publicstaticinterfaceITcgSdk.
IAutoLoginWindowStatCallbackextendsITcgSdk.
IRTCResult方法概览方法类型说明onFailedvoid远程调用失败或当前窗口不支持自动登录功能onSuccessvoid当前窗口支持自动登录功能onSuccess当前窗口支持自动登录功能.
voidonSuccess()注意:鼠标移动为相对位置.
云游戏版权所有:腾讯云计算(北京)有限责任公司第53共79页指定者:onSuccess在接口中ITcgSdk.
IRTCResult.
onFailed远程调用失败或当前窗口不支持自动登录功能.
voidonFailed(java.
lang.
Stringmsg)指定者:onFailed在接口中ITcgSdk.
IRTCResult.
参数:参数类型说明msgjava.
lang.
String错误信息ITcgSdk.
IRTCResult远端接口调用结果.
publicstaticinterfaceITcgSdk.
IRTCResultextendsITcgSdk.
IRTCTimeoutCallback方法概览方法类型说明onSuccessvoid仅表示接口调用本身执行成功(收到了远端设备的响应)onFailedvoid调用失败onTimeoutvoid调用超时onSuccess仅表示接口调用本身执行成功(收到了远端设备的响应).
voidonSuccess()onFailed云游戏版权所有:腾讯云计算(北京)有限责任公司第54共79页调用失败.
voidonFailed(java.
lang.
Stringmsg)onTimeout调用超时.
voidonTimeout()指定者:onTimeout在接口中ITcgSdk.
IRTCTimeoutCallback.
ITcgSdk.
IRTCTimeoutCallbackSDK接口调用超时回调接口.
publicstaticinterfaceITcgSdk.
IRTCTimeoutCallback方法概览方法类型说明onTimeoutvoid调用超时onTimeout调用超时.
voidonTimeout()IWanIpChangeListener外网IP回调接口.
publicinterfaceIWanIpChangeListener方法概览云游戏版权所有:腾讯云计算(北京)有限责任公司第55共79页方法类型说明onIpChangedvoid外网IP变化回调onIpChanged外网IP变化回调.
voidonIpChanged(java.
lang.
StringoldIp,java.
lang.
StringnewIp)参数:方法类型说明oldIpjava.
lang.
String变化前的外网IP,SDK首次获取IP时该值为空newIpjava.
lang.
String新的外网IP云游戏版权所有:腾讯云计算(北京)有限责任公司第56共79页GameView该视图代理了远程设备视图,支持功能如下:本地按键和触摸事件的转换、封装,并将事件发送到远端设备.
鼠标控制模式.
调试视图(可以在界面上显示性能指标信息).
方法概览方法类型说明setSDKvoid设置SDK接口setOnGameViewTouchListenervoid设置游戏画面触控事件监听器enableDebugViewvoid开启调试模式,展示性能数据moveDeltavoid移动光标movePosTovoid以绝对坐标方式移动光标位置setMoveSensitivityvoid设置鼠标灵敏度getMoveSensitivityfloat返回已经设置的鼠标灵敏度setTouchClickKeyvoid设置鼠标类型使用的按键setCursorTypevoid设置鼠标模式getCurrentCursorTypeCursorType当前设置的鼠标模式setScaleTypevoid设置画面显示模式setSDK设置SDK.
publicvoidsetSDK(ITcgSdksdk)SDK类最近更新时间:2021-01-2515:27:42云游戏版权所有:腾讯云计算(北京)有限责任公司第57共79页setOnGameViewTouchListener设置游戏画面触控事件监听器.
publicvoidsetOnGameViewTouchListener(IOnGameViewTouchListenerlistener)参数:参数类型说明listenerIOnGameViewTouchListener支持长按和单击enableDebugView开启调试模式,展示性能数据.
publicvoidenableDebugView(booleanenable)参数:参数类型说明enablebooleantrue表示开启调试模式,false表示关闭moveDelta以相对坐标方式移动光标位置.
publicvoidmoveDelta(floatdeltaX,floatdeltaY)参数:参数类型说明deltaXfloat横坐标移动的偏移量,该值受鼠标灵敏度影响deltaYfloat纵坐标移动的偏移量,该值受鼠标灵敏度影响说明:云游戏版权所有:腾讯云计算(北京)有限责任公司第58共79页movePosTo以绝对坐标方式移动光标位置.
protectedvoidmovePosTo(floatx,floaty)参数:参数类型说明xfloat本地设备的x坐标yfloat本地设备的y坐标setMoveSensitivity设置鼠标灵敏度.
publicvoidsetMoveSensitivity(floatmoveSensitivity)参数:参数类型说明moveSensitivityfloat鼠标灵敏度,value为[0.
01,10.
0]之间的的浮点数getMoveSensitivity返回已经设置的鼠标灵敏度.
publicfloatgetMoveSensitivity()setTouchClickKey设置鼠标类型使用的按键.
publicvoidsetTouchClickKey(com.
tencent.
tcgsdk.
api.
CursorType.
TouchClickKeykey)更多详情请参见setMoveSensitivity(float).
云游戏版权所有:腾讯云计算(北京)有限责任公司第59共79页参数:参数类型说明keycom.
tencent.
tcgsdk.
api.
CursorType.
TouchClickKeyTOUCH/RELATIVE_TOUCH单击时的按键,默认是鼠标左键setCursorType设置鼠标模式.
publicvoidsetCursorType(CursorTypemode)参数:参数类型说明modeCursorType鼠标类型,对于TOUCH/RELATIVE_TOUCH两种类型可以指定单击时的按键getCurrentCursorType返回当前设置的鼠标模式.
publicCursorTypegetCurrentCursorType()setScaleType设置画面显示模式,包括平铺、拉伸和自适应.
publicvoidsetScaleType(ScaleTypescaleType)说明:更多详情请参见CursorType.
TOUCH、CursorType.
RELATIVE_TOUCH.
说明:更多详情请参见setTouchClickKey(CursorType.
TouchClickKey).
云游戏版权所有:腾讯云计算(北京)有限责任公司第60共79页参数:参数类型说明scaleTypeScaleType需要指定的显示模式TcgSdk2.
BuilderTcgSdk的构建器.
构造器概览构造器说明Builder构建一个TcgSdk的Builder方法概览方法限定符和类型说明buildITcgSdk构建一个TcgSdk并初始化autoReconnectTcgSdk2.
Builder帧率掉0或者异常断开是否触发自动重连dataChannelTcgSdk2.
Builder开启数据通道(必须开启)localAudioTcgSdk2.
Builder开启本地音频上传能力,默认关闭localVideoTcgSdk2.
Builder开启本地视频上传能力,默认关闭timeoutTcgSdk2.
Builder设置连接超时时间,超时则会触发超时回调logLevelTcgSdk2.
Builder指定日志级别enableHwCodecTcgSdk2.
Builder是否优先使用硬解lowFpsThresholdTcgSdk2.
Builder低帧率阈值,连续lowFpsCountThreshold秒帧率低于lowFpsThreshold会触发ILowFPSListener回调Builder构建一个TcgSdk的Builder.
云游戏版权所有:腾讯云计算(北京)有限责任公司第61共79页publicBuilder(Contextcontext,longappID,ITcgListenerlistener,SurfaceViewRenderersurfaceRender)参数:参数类型说明appIDlong应用IDlistenerITcgListener生命周期回调surfaceRenderSurfaceViewRenderer用于展示游戏画面的绘制器build构建一个TcgSdk并开始初始化,初始化成功会回调.
publicITcgSdkbuild()返回:返回SDK接口.
autoReconnect帧率掉0或者异常断开是否触发自动重连.
publicTcgSdk2.
BuilderautoReconnect(booleanenable)参数:参数类型说明enableboolean默认为true.
true表示帧率连续掉0或者异常断开时自动重连,false表示不重连说明:更多详情请参见ITcgListener.
onInitSuccess(String).
云游戏版权所有:腾讯云计算(北京)有限责任公司第62共79页dataChannel开启数据通道(必须开启).
publicTcgSdk2.
BuilderdataChannel(booleanenable)参数:参数类型说明enableboolean默认为true.
true表示开启数据通道,false表示关闭数据通道返回:被调用的Builder本身.
localAudio开启本地音频上传能力,默认关闭.
publicTcgSdk2.
BuilderlocalAudio(booleanenable)参数:参数类型说明enableboolean默认为false.
true表示开启本地音频上传,false表示关闭本地音频上传返回:被调用的Builder本身.
localVideo开启本地视频上传能力,默认关闭.
publicTcgSdk2.
BuilderlocalVideo(booleanenable)参数:参数类型说明enableboolean默认为false.
true表示开启本地视频上传,false表示关闭本地视频上传返回:被调用的Builder本身.
云游戏版权所有:腾讯云计算(北京)有限责任公司第63共79页timeout连接超时时间,超时则会触发超时回调.
publicTcgSdk2.
Buildertimeout(longtimeoutMs)参数:参数类型说明timeoutMslong超时时间,默认60s返回:被调用的Builder本身.
logLevel指定日志级别.
publicTcgSdk2.
BuilderlogLevel(LogLevellevel)参数:参数类型说明levelLogLevel启动后指定的日志级别返回:被调用的Builder本身.
enableHwCodec是否优先使用硬解.
publicTcgSdk2.
BuilderenableHwCodec(booleanenableHwCodec)参数:说明:更多详情请参见ITcgListener.
onConnectionTimeout().
云游戏版权所有:腾讯云计算(北京)有限责任公司第64共79页参数类型说明enableHwCodecbooleantrue优先使用硬解,false使用软解lowFpsThreshold低帧率阈值,连续lowFpsCountThreshold秒码率低于lowFpsThreshold会触发ILowFPSListener回调.
publicTcgSdk2.
BuilderlowFpsThreshold(intlowFpsThreshold,intlowFpsCountThreshold)参数:参数类型说明lowFpsThresholdint最低帧率lowFpsCountThresholdint出现低帧的秒数返回:被调用的Builder本身.
云游戏版权所有:腾讯云计算(北京)有限责任公司第65共79页概览枚举类枚举类类别说明枚举常量常量说明CursorType鼠标类型枚举NO_CURSOR禁用鼠标,触摸屏幕不触发任何事件TOUCH触控RELATIVE_TOUCH滑鼠单击RELATIVE_MOVE滑屏LogLevel日志级别枚举INFO默认日志级别,只输出关键信息DEBUG调试日志级别,输入部分调试信息VERBOSE输出全部日志信息ScaleType画面类型枚举ASPECT_CROP平铺ASPECT_FILL拉伸ASPECT_FIT自适应使用方法方法限定符和类型说明valuesstaticScaleType[]按照声明该枚举类型的常量的顺序,返回包含这些常量的数组valueOfstaticScaleType返回带有指定名称的该类型的枚举常量CursorType鼠标类型枚举.
publicenumCursorTypeextendsjava.
lang.
EnumSDK枚举类最近更新时间:2021-01-2609:20:26云游戏版权所有:腾讯云计算(北京)有限责任公司第66共79页NO_CURSOR禁用鼠标,触摸屏幕不触发任何事件.
publicstaticfinalCursorTypeNO_CURSORTOUCH触控:鼠标跟随手指移动,可以单击按键(鼠标左键或右键).
publicstaticfinalCursorTypeTOUCHRELATIVE_TOUCH滑鼠单击:轻触触发鼠标左键,长按触发按单击鼠标左键,可以拖动,滑动仅触发鼠标移动.
publicstaticfinalCursorTypeRELATIVE_TOUCHRELATIVE_MOVE滑屏:鼠标在相对位置移动,不触发单击事件(可以发送其他按键事件).
publicstaticfinalCursorTypeRELATIVE_MOVELogLevel日志级别枚举.
publicenumLogLevelextendsjava.
lang.
EnumINFO默认日志级别,只输出关键信息.
publicstaticfinalLogLevelINFODEBUG云游戏版权所有:腾讯云计算(北京)有限责任公司第67共79页调试日志级别,输入部分调试信息.
publicstaticfinalLogLevelDEBUGVERBOSE输出全部日志信息.
publicstaticfinalLogLevelVERBOSEScaleType画面类型枚举.
publicenumScaleTypeextendsjava.
lang.
EnumASPECT_FIT自适应:画面适应视频分辨率(默认).
publicstaticfinalScaleTypeASPECT_FITASPECT_FILL拉伸:让画面和视图一样大,画面会被拉伸.
publicstaticfinalScaleTypeASPECT_FILLASPECT_CROP平铺:画面等比例放大超过屏幕,画面短边和手机屏幕短边重合,另一边裁剪.
publicstaticfinalScaleTypeASPECT_CROP使用方法云游戏版权所有:腾讯云计算(北京)有限责任公司第68共79页values按照声明该枚举类型的常量的顺序,返回包含这些常量的数组.
publicstaticCursorType[]values()该方法可用于迭代常量,如下所示:for(CursorTypec:CursorType.
values())System.
out.
println(c);valueOf返回该类型带有指定名称的枚举常量.
publicstaticCursorTypevalueOf(java.
lang.
Stringname)参数:参数类型说明namejava.
lang.
String要返回的枚举常量的名称抛出:抛出类型说明java.
lang.
IllegalArgumentException如果该枚举类型没有带有指定名称的常量java.
lang.
NullPointerException如果参数为空值注意:字符串必须与用于声明该类型的枚举常量的标识符完全匹配,不允许有多余的空格字符.
云游戏版权所有:腾讯云计算(北京)有限责任公司第69共79页对接SDK过程中,您可根据TcgErrorType返回的错误码信息判断当前具体问题.
TcgErrorType错误码事件定义说明ERROR_UNKNOWN未知错误INIT_ERROR_SYS_BUSY系统繁忙,请稍后重试INIT_ERROR_TICKET_ILLEGAL票据不合法INIT_ERROR_INEFFICIENT_BANDWIDTH您本地带宽不足10Mbps,无法启动游戏,请确认网络环境INIT_ERROR_UNDER_RESOURCE资源不足,请稍后重试INIT_ERROR_TICKET_EXPIRED票据失效INIT_ERROR_INVALID_SPDSDP错误信息错误INIT_ERROR_LAUNCH_GAME_ERROR游戏拉起失败INIT_ERROR_GET_ARCHIVE_FAILED下载用户游戏存档失败CONN_ERROR_SET_REMOTE_SDP_FAILED设置云端SDP异常CONN_ERROR_SET_LOCAL_SDP_FAILED设置本地SDP异常CONN_ERROR_PEER_CONNECTION_FAILED节点连接异常CONN_ERROR_USER_LOGOUT用户已在其他设备登录CONN_ERROR_TICKET_EXPIRED本地获取的Token失效(有效时间80s)CONN_ERROR_GET_TICKET_ERROR获取重连Token失败CONN_ERROR_GET_TICKET_TIMEOUT获取重连Token超时CONN_ERROR_CLOSE_BY_SERVER服务端已断开CONN_ERROR_TIMEOUT连接超时详细说错误码最近更新时间:2021-01-2515:27:49云游戏版权所有:腾讯云计算(北京)有限责任公司第70共79页详细说明ERROR_UNKNOWN未知错误.
publicstaticfinalintERROR_UNKNOWNINIT_ERROR_SYS_BUSY系统繁忙,请稍后重试.
publicstaticfinalintINIT_ERROR_SYS_BUSYINIT_ERROR_TICKET_ILLEGAL票据不合法.
publicstaticfinalintINIT_ERROR_TICKET_ILLEGALINIT_ERROR_INEFFICIENT_BANDWIDTH您本地带宽不足10Mbps,无法启动游戏,请确认网络环境.
publicstaticfinalintINIT_ERROR_INEFFICIENT_BANDWIDTHINIT_ERROR_UNDER_RESOURCE资源不足,请稍后重试.
publicstaticfinalintINIT_ERROR_UNDER_RESOURCEINIT_ERROR_TICKET_EXPIRED票据失效.
publicstaticfinalintINIT_ERROR_TICKET_EXPIREDINIT_ERROR_INVALID_SPDSDP错误信息错误.
云游戏版权所有:腾讯云计算(北京)有限责任公司第71共79页publicstaticfinalintINIT_ERROR_INVALID_SPDINIT_ERROR_LAUNCH_GAME_ERROR游戏拉起失败.
publicstaticfinalintINIT_ERROR_LAUNCH_GAME_ERRORINIT_ERROR_GET_ARCHIVE_FAILED下载用户游戏存档失败.
publicstaticfinalintINIT_ERROR_GET_ARCHIVE_FAILEDCONN_ERROR_SET_REMOTE_SDP_FAILED设置云端SDP异常.
publicstaticfinalintCONN_ERROR_SET_REMOTE_SDP_FAILEDCONN_ERROR_SET_LOCAL_SDP_FAILED设置本地SDP异常.
publicstaticfinalintCONN_ERROR_SET_LOCAL_SDP_FAILEDCONN_ERROR_PEER_CONNECTION_FAILED节点连接异常.
publicstaticfinalintCONN_ERROR_PEER_CONNECTION_FAILEDCONN_ERROR_USER_LOGOUT用户主动退出.
publicstaticfinalintCONN_ERROR_USER_LOGOUT云游戏版权所有:腾讯云计算(北京)有限责任公司第72共79页CONN_ERROR_DUPLICATE_CONNECTION用户已在其他设备登录.
publicstaticfinalintCONN_ERROR_DUPLICATE_CONNECTIONCONN_ERROR_TICKET_EXPIRED本地获取的Token失效(有效时间80s).
publicstaticfinalintCONN_ERROR_TICKET_EXPIREDCONN_ERROR_GET_TICKET_ERROR获取重连Token失败.
publicstaticfinalintCONN_ERROR_GET_TICKET_ERRORCONN_ERROR_GET_TICKET_TIMEOUT获取重连Token超时.
publicstaticfinalintCONN_ERROR_GET_TICKET_TIMEOUTCONN_ERROR_CLOSE_BY_SERVER服务端已断开.
publicstaticfinalintCONN_ERROR_CLOSE_BY_SERVERCONN_ERROR_TIMEOUT连接超时.
publicstaticfinalintCONN_ERROR_TIMEOUT云游戏版权所有:腾讯云计算(北京)有限责任公司第73共79页Web端搭建示例(H5)1.
引入云游戏的js文件.
2.
在页面内定义一个云游戏显示用的锚点,如下所示:3.
页面内按顺序调用init,start接口,接口文档见前端JSSDKAPI文档.
4.
修改demo.
html的get_signature请求url,指向自行部署好的业务后台服务.
5.
刷新页面并等待浏览器连接成功.
Android端搭建示例接入步骤1.
将tcgsdk-1.
1.
0.
1009506_202011262251_release.
aar拷贝到libs目录下.
2.
在应用模块的build.
gradle中加入:3.
进行混淆配置.
由于native层代码需要反射调回java,需要确保SDK内的代码都不被混淆,请在proguard中添加以下配置:Demo搭建示例最近更新时间:2021-01-2515:27:54