SDK接口参考
接口 |
描述 |
是否必选 |
|---|---|---|
public IntentCVR(Context context) |
【功能说明】 初始化IntentCVR接口。 【请求参数】 context: 新建项目的上下文对象，可以是Activity，也可以是Application。 |
是 |
public CVRParameter(String userName, String userDomain, String userPassWord, String projectName) |
【功能说明】 用户通过该接口配置华为云用户名及密码，客户端根据该信息访问华为云IAM获取Token后再连接至VR云渲游平台进行鉴权，以下简称“A类 CVRParameter构造函数”。 【请求参数】
说明：
如何获取上述参数对应值，请参考： |
是 CVRParameter构造函数包括A类、B类、C类，请根据需要自选其中一类使用。 三类构造函数的适用场景请参考SDK导入和使用。 |
public CVRParameter(String iamToken) |
【功能说明】 用户可自行访问IAM获取Token，通过该接口注入Token进行CVRParameter初始化，以下简称“B类 CVRParameter构造函数”。 【请求参数】 iamToken：用户Token。 |
|
public CVRParameter(String gpuIp,String gpuToken) |
【功能说明】 用户自行获取gpuIp与gpuToken，通过该接口配置gpuIp与gpuToken用于头显直连GPU服务器，以下简称“C类 CVRParameter构造函数”。 【请求参数】 |
|
public void setServiceDomain(String serviceDomain) |
【功能说明】 设置Service域名，用于指定连接的GPU云服务器所在区域。 【请求参数】 ServiceDomain：Service域名。 ServiceDomain的取值，请参见“地区和终端节点”中的“终端节点（Endpoint）”。 |
是 |
public void setAppId(String appID) |
【功能说明】 设置头显要访问的应用。 【请求参数】 appID：VR应用对应的应用ID。获取应用ID，请参考APP ID的获取方法。 |
是 |
public void setPort(int port) |
【功能说明】 GPU默认监听端口是9944，如果您更改了GPU监听端口（如使用沙箱模式），则需要使用该接口修改客户端访问端口号 【请求参数】 port：指定头显发送连接请求的目的端口信息。 |
否 |
public String initiateLoad(IntentCVR.CVRParameter customParameter, Class<?> classActivity) |
【功能说明】 加载相关参数，启动云VR流化业务，并对输入参数进行检验。 【请求参数】 customParameter：已经初始化的鉴权参数。 classActivity：传入跳转的目标Activity类，目标Activity的编写建议参考SDK导入和使用章节的Demo项目。 |
是 |
public void setAppName(String appName) |
【功能说明】 设置客户端连接等待界面展示的应用名称。 【请求参数】 appName：应用名称。 |
否 |
public void setLocation(String[] location) |
【功能说明】 设置客户端连接的目标云服务器所在区域。 【请求参数】 location：用于设置调度接口的策略，可以指定一个或多个区域，CVR服务会从指定区域中分配空闲的服务器。支持配置公有云region_id，如cn-east-3。 如果未设置location，默认为空数组，此时CVR服务会根据设备的调度策略进行GPU服务器的分配。 location的取值，请参见“地区和终端节点”中的“区域”。 |
否 |
public void setProjectID(String projectID) |
【功能说明】 设置访问客户端调度接口使用的项目ID。 【请求参数】 projectID：项目ID，用于访问调度接口。获取projectID，请参见“获取项目ID”。 |
否 仅使用B类的CVRParameter构造函数时需要传入该值。 |
public String getDeviceID(Context context) |
【功能说明】 获取设备ID，访问前需要保证已经获取到了所需的权限。 【请求参数】 Context：请求发起的上下文。所需要获取的权限为： Manifest.permission.READ_EXTERNAL_STORAGE Manifest.permission.WRITE_EXTERNAL_STORAGE |
否 仅使用C类的CVRParameter构造函数时需要获取该值。 |
public String getBrand() |
【功能说明】 获取设备品牌。 【请求参数】 无 |
否，仅使用C类的CVRParameter构造函数时需要获取该值。 |
public static void setErrCallback(CvrErrCallback errCallback) |
【功能说明】 用于获取SDK内部的错误信息并处理。 【请求参数】 errCallback：回调接口，支持用户自定义。相关注意事项请参考错误信息回调。 |
否 |
public void setTimeLimit(int timeLimit) |
【功能说明】 设置应用与GPU服务器建立的连接在后台的最大保活时间。 【请求参数】 timeLimit：此参数代表应用退至后台后，与GPU服务器建立的连接最大保活时间。 若退至后台到重新打开应用的时间间隔超出该值，则第二次进入应用后会退出当前VRActivity类，并触发错误信息回调的onTokenOutdated方法。 取值范围：0~150s |
否 |
public int getTimeLimit() |
【功能说明】 获取应用与GPU服务器建立的连接在后台的最大保活时间。 【请求参数】 无 |
否 |
public void setIamDomain(String iamDomain) |
【功能说明】 设置访问IAM服务鉴权接口的域名。 【请求参数】 iamDomain：应用访问IAM服务，获取鉴权的域名。默认为 iam.myhuaweicloud.com |
是 |
public String getIamDomain() |
【功能说明】 获取访问IAM服务鉴权接口的域名。 【请求参数】 无 |
否 |
public String getDeviceType() |
【功能说明】 识别并获取当前设备类型，包括vr、mobile、ideahub。 用于访问CVR平台的调度接口，上传当前设备信息。 【请求参数】 无 |
是 |
public void setGpuIpType(String gpuInfoType) |
【功能说明】 设置gpu服务器ip的类型，默认为public。 【请求参数】 gpuInfoType：gpu服务器ip的类型，弹性公有ip填“public”,私有ip填"private"。 |
否 |
public String getGpuIpType() |
【功能说明】 获取设置的gpu服务器ip类型。 【请求参数】 无 |
否 |
表2 3D客户端IntentCVR.java中额外接口列表
接口 |
描述 |
是否必选 |
|---|---|---|
public void setApplicationUser(String applicationUser) |
【功能说明】 设置访问CVR平台的调度接口使用的用户标识ID。 【请求参数】 applicationUser：用户标识ID，用于访问调度接口。 |
是 |
public String getApplicationUser() |
【功能说明】 获取访问客户端调度接口使用的用户标识ID。 【请求参数】 无 |
否 |
public void setAppLaunchArgs(String appLaunchArgs) |
【功能说明】 设置应用启动参数，如应用启动无额外参数，则不需要设置。 【请求参数】 appLaunchArgs：应用启动参数。 |
否 |
public String getAppLaunchArgs() |
【功能说明】 获取设置的应用启动参数。 【请求参数】 无 |
否 |
public void setResolution(String resolution) |
【功能说明】 设置应用启动的分辨率，默认为1080p。 【请求参数】 resolution：应用启动的分辨率。可以设置的参数为“480p”，“540p”，“720p”，“1080p”，“2k”，“4k” |
否 |
public String getResolution() |
【功能说明】 获取设置的应用启动分辨率。 【请求参数】 无 |
否 |
public static void pauseCVR() |
【功能说明】 暂停串流服务，画面停滞。 【请求参数】 无 |
否 |
public static void resumeCVR() |
【功能说明】 恢复串流服务，与pauseCVR组合使用。 【请求参数】 无 |
否 |
public static void restartCVR() |
【功能说明】 重启服务器的应用。 【请求参数】 无 |
否 |
public static void setAppClosedCallback(CaPlayer.ICaAppClosedCallback appClosedCallback) |
【功能说明】 设置服务端应用被动关闭的反馈接口。 【请求参数】 appClosedCallback：用户自定义的接口方法。 |
否 |
public static CaPlayer.ICaAppClosedCallback getAppClosedCallback() |
【功能说明】 获取设置的服务端应用被动关闭的反馈接口。 【请求参数】 无 |
否 |
