网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
计算
弹性云服务器 ECS
Flexus云服务
裸金属服务器 BMS
云手机服务器 CPH
专属主机 DeH
弹性伸缩 AS
镜像服务 IMS
函数工作流 FunctionGraph
云耀云服务器(旧版)
VR云渲游平台 CVR
Huawei Cloud EulerOS
云化数据中心 CloudDC
网络
虚拟私有云 VPC
弹性公网IP EIP
弹性负载均衡 ELB
NAT网关 NAT
云专线 DC
虚拟专用网络 VPN
云连接 CC
VPC终端节点 VPCEP
企业路由器 ER
企业交换机 ESW
全球加速 GA
企业连接 EC
云原生应用网络 ANC
CDN与智能边缘
内容分发网络 CDN
智能边缘云 IEC
智能边缘平台 IEF
CloudPond云服务
安全与合规
安全技术与应用
Web应用防火墙 WAF
企业主机安全 HSS
云防火墙 CFW
安全云脑 SecMaster
DDoS防护 AAD
数据加密服务 DEW
数据库安全服务 DBSS
云堡垒机 CBH
数据安全中心 DSC
云证书管理服务 CCM
威胁检测服务 MTD
态势感知 SA
认证测试中心 CTC
边缘安全 EdgeSec
大数据
MapReduce服务 MRS
数据湖探索 DLI
表格存储服务 CloudTable
可信智能计算服务 TICS
推荐系统 RES
云搜索服务 CSS
数据可视化 DLV
数据接入服务 DIS
数据仓库服务 GaussDB(DWS)
数据治理中心 DataArts Studio
湖仓构建 LakeFormation
智能数据洞察 DataArts Insight
应用中间件
微服务引擎 CSE
分布式消息服务Kafka版
分布式消息服务RabbitMQ版
分布式消息服务RocketMQ版
API网关 APIG
分布式缓存服务 DCS
多活高可用服务 MAS
事件网格 EG
开天aPaaS
应用平台 AppStage
开天企业工作台 MSSE
开天集成工作台 MSSI
API中心 API Hub
云消息服务 KooMessage
交换数据空间 EDS
云地图服务 KooMap
云手机服务 KooPhone
组织成员账号 OrgID
云空间服务 KooDrive
管理与监管
统一身份认证服务 IAM
消息通知服务 SMN
云监控服务 CES
应用运维管理 AOM
应用性能管理 APM
云日志服务 LTS
云审计服务 CTS
标签管理服务 TMS
配置审计 Config
应用身份管理服务 OneAccess
资源访问管理 RAM
组织 Organizations
资源编排服务 RFS
优化顾问 OA
IAM 身份中心
云运维中心 COC
资源治理中心 RGC
区块链
区块链服务 BCS
数字资产链 DAC
华为云区块链引擎服务 HBS
解决方案
高性能计算 HPC
SAP
混合云灾备
开天工业工作台 MIW
Haydn解决方案工厂
数字化诊断治理专家服务
价格
成本优化最佳实践
专属云商业逻辑
云生态
云商店
合作伙伴中心
华为云开发者学堂
华为云慧通差旅
其他
管理控制台
消息中心
产品价格详情
系统权限
客户关联华为云合作伙伴须知
公共问题
宽限期保留期
奖励推广计划
活动
云服务信任体系能力说明
开发与运维
软件开发生产线 CodeArts
需求管理 CodeArts Req
流水线 CodeArts Pipeline
代码检查 CodeArts Check
编译构建 CodeArts Build
部署 CodeArts Deploy
测试计划 CodeArts TestPlan
制品仓库 CodeArts Artifact
移动应用测试 MobileAPPTest
CodeArts IDE Online
开源镜像站 Mirrors
性能测试 CodeArts PerfTest
应用管理与运维平台 ServiceStage
云应用引擎 CAE
开源治理服务 CodeArts Governance
华为云Astro轻应用
CodeArts IDE
Astro工作流 AstroFlow
代码托管 CodeArts Repo
漏洞管理服务 CodeArts Inspector
联接 CodeArtsLink
软件建模 CodeArts Modeling
Astro企业应用 AstroPro
CodeArts盘古助手
华为云Astro大屏应用
存储
对象存储服务 OBS
云硬盘 EVS
云备份 CBR
高性能弹性文件服务 SFS Turbo
弹性文件服务 SFS
存储容灾服务 SDRS
云硬盘备份 VBS
云服务器备份 CSBS
数据快递服务 DES
云存储网关 CSG
专属分布式存储服务 DSS
数据工坊 DWR
地图数据 MapDS
键值存储服务 KVS
容器
云容器引擎 CCE
云容器实例 CCI
容器镜像服务 SWR
云原生服务中心 OSC
应用服务网格 ASM
华为云UCS
数据库
云数据库 RDS
数据复制服务 DRS
文档数据库服务 DDS
分布式数据库中间件 DDM
云数据库 GaussDB
云数据库 GeminiDB
数据管理服务 DAS
数据库和应用迁移 UGO
云数据库 TaurusDB
人工智能
AI开发平台ModelArts
华为HiLens
图引擎服务 GES
图像识别 Image
文字识别 OCR
自然语言处理 NLP
内容审核 Moderation
图像搜索 ImageSearch
医疗智能体 EIHealth
企业级AI应用开发专业套件 ModelArts Pro
人脸识别服务 FRS
对话机器人服务 CBS
语音交互服务 SIS
人证核身服务 IVS
视频智能分析服务 VIAS
城市智能体
自动驾驶云服务 Octopus
盘古大模型 PanguLargeModels
IoT物联网
设备接入 IoTDA
全球SIM联接 GSL
IoT数据分析 IoTA
路网数字化服务 DRIS
IoT边缘 IoTEdge
设备发放 IoTDP
企业应用
域名注册服务 Domains
云解析服务 DNS
企业门户 EWP
ICP备案
商标注册
华为云WeLink
华为云会议 Meeting
隐私保护通话 PrivateNumber
语音通话 VoiceCall
消息&短信 MSGSMS
云管理网络
SD-WAN 云服务
边缘数据中心管理 EDCM
云桌面 Workspace
应用与数据集成平台 ROMA Connect
ROMA资产中心 ROMA Exchange
API全生命周期管理 ROMA API
政企自服务管理 ESM
视频
实时音视频 SparkRTC
视频直播 Live
视频点播 VOD
媒体处理 MPC
视频接入服务 VIS
数字内容生产线 MetaStudio
迁移
主机迁移服务 SMS
对象存储迁移服务 OMS
云数据迁移 CDM
迁移中心 MGC
专属云
专属计算集群 DCC
开发者工具
SDK开发指南
API签名指南
DevStar
华为云命令行工具服务 KooCLI
Huawei Cloud Toolkit
CodeArts API
云化转型
云架构中心
云采用框架
用户服务
账号中心
费用中心
成本中心
资源中心
企业管理
工单管理
客户运营能力
国际站常见问题
支持计划
专业服务
合作伙伴支持计划
我的凭证
华为云公共事业服务云平台
工业软件
工业数字模型驱动引擎
硬件开发工具链平台云服务
工业数据转换引擎云服务

SDK接口参考

更新时间:2021-08-25 GMT+08:00
分享

接口

描述

是否必选

IntentCVR()

【功能说明】

初始化IntentCVR接口。

CVRParameter(std::string userName, std::string userDomain, std::string userPassWord, std::string projectName)

【功能说明】

用户通过该接口配置华为云用户名及密码,客户端根据该信息访问华为云IAM获取Token后再连接至VR云渲游平台进行鉴权,以下简称“A类 CVRParameter构造函数”

【请求参数】

  • userDomain:华为云租户名
  • userName:华为云用户名
  • password:华为云用户密码
  • projectName:项目名称
说明:

如何获取上述参数对应值,请参考:

https://support.huaweicloud.com/sis_faq/sis_04_0032.html

CVRParameter构造函数包括A类、B类、C类,请根据需要自选其中一类使用。

三类构造函数的适用场景请参考SDK使用

CVRParameter(std::string iamToken)

【功能说明】

用户可自行访问IAM获取Token,通过该接口注入Token进行CVRParameter初始化,以下简称“B类 CVRParameter构造函数”。

【请求参数】

iamToken:用户Token。

CVRParameter(std::string gpuIp, std::string gpuToken)

【功能说明】

用户自行获取gpuIp与gpuToken,通过该接口配置gpuIp与gpuToken用于设备直连GPU服务器,以下简称“C类 CVRParameter构造函数”

【请求参数】

  • gpuIP:GPU服务器公网IP。

    gpuIP的获取方式,请参考“渲染节点调度”。

  • gpuToken:访问GPU服务器所需鉴权Token。

    gpuToken的获取方式,请参考“渲染节点调度”。

void setServiceDomain(std::string serviceDomain)

【功能说明】

设置Service域名,用于指定连接的GPU云服务器所在区域。

【请求参数】

ServiceDomain:Service域名。

ServiceDomain的取值,请参见“地区和终端节点”中的“终端节点(Endpoint)”。

void setAppId(std::string appID)

【功能说明】

设置设备要访问的应用。

【请求参数】

appID:应用对应的应用ID。获取应用ID,请参考APP ID的获取方法

void setPort(int port)

【功能说明】

GPU默认监听端口是10020,如果您更改了GPU监听端口(如使用多路会话模式),则需要使用该接口修改客户端访问端口号

【请求参数】

port:指定设备发送连接请求的目的端口信息。

std::string initiateLoad(CVRParameter customParameter)

【功能说明】

加载相关参数,启动云应用流化业务,并对输入参数进行检验。

【请求参数】

customParameter:已经初始化的鉴权参数。

void setLocation(std::string location)

【功能说明】

设置客户端连接的目标云服务器所在区域。

【请求参数】

location:用于设置调度接口的策略,可以指定一个或多个区域,CVR服务会从指定区域中分配空闲的服务器。支持配置公有云region_id,如cn-east-3。

如果未设置location,默认为空数组,此时CVR服务会根据设备的调度策略进行GPU服务器的分配。

location的取值,请参见“地区和终端节点”中的“区域”。

void setProjectID(std::string projectID)

【功能说明】

设置访问客户端调度接口使用的项目ID。

【请求参数】

projectID:项目ID,用于访问调度接口。获取projectID,请参见“获取项目ID”。

仅使用B类的CVRParameter构造函数时需要传入该值。

void setApplicationUserID(std::string userID)

【功能说明】

设置访问客户端调度接口使用的用户标识ID,如不存在用户标识ID,则不需要设置。

【请求参数】

userID:用户标识ID,用于访问调度接口。

void setAppLaunchArgs(std::string appLaunchArgs)

【功能说明】

设置应用启动参数,如应用启动无额外参数,则不需要设置。

【请求参数】

appLaunchArgs:应用启动参数。

public void setResolution(String resolution)

【功能说明】

设置应用启动的分辨率,默认为1080p。

【请求参数】

resolution:应用启动的分辨率。可以设置的参数为“480p”,“540p”,“720p”,“1080p”,“2k”,“4k”

public String getResolution()

【功能说明】

获取设置的应用启动分辨率。

【请求参数】

public void setGpuIpType(String gpuInfoType)

【功能说明】

设置gpu服务器ip的类型,默认为public。

【请求参数】

gpuInfoType:gpu服务器ip的类型,弹性公有ip填“public”,私有ip填"private"。

public String getGpuIpType()

【功能说明】

获取设置的gpu服务器ip类型。

【请求参数】

std::string getDeviceID()

【功能说明】

获取设备ID。

【请求参数】

仅使用C类的CVRParameter构造函数时需要获取该值。

std::string getBrand()

【功能说明】

获取设备品牌。

【请求参数】

否,仅使用C类的CVRParameter构造函数时需要获取该值。

void setErrCallback(CvrErrCallback errCallback)

【功能说明】

用于获取SDK内部的错误信息并处理。

【请求参数】

errCallback:回调接口,支持用户自定义。相关注意事项请参考错误信息回调

CVRInstance_t* CVRCreateInstance()

【功能说明】

创建一个云应用客户端实例。

【请求参数】

CVRCode CVRSetConfig(CVRInstance_t* thiz, CVRConfig_t* config)

【功能说明】

对云应用客户端实例设置属性。

【请求参数】

  • thiz:由CVRCreateInstance()创建的云应用客户端实例。
  • config:CVRConfig_t类型的初始化参数对象。

CVRCode CVRStart(CVRInstance_t* thiz)

【功能说明】

开始显示画面。

【请求参数】

thiz:由CVRCreateInstance()创建的云应用客户端实例。

【返回值】

返回CVRCode类型的返回码,如果值为CVR_CODE_OK常量,则为成功。

void CVRSetLogLevel(int level);

【功能说明】

设置日志级别。

【请求参数】

level:范围[0-8]。数值越大,日志越详细。

CVRCode CVRSetRenderView(CVRInstance_t* thiz,void* view)

【功能说明】

画面显示在指定窗口句柄。

【请求参数】

  • thiz:由CVRCreateInstance()创建的云应用客户端实例。
  • view:一个窗口句柄。

【返回值】

返回CVRCode类型的返回码,如果值为CVR_CODE_OK常量,则为成功。

CVRCode CVRSetControlStateChangedCallback(CVRInstance_t* thiz, CVRControlStateChangedCallback_t callback,void* user_data)

【功能说明】

设置主控模式状态变化的回调通知。

【请求参数】

  • thiz:由CVRCreateInstance()创建的云应用客户端实例。
  • callback:事件触发时的回调函数。
  • view:一个窗口句柄。

【返回值】

返回CVRCode类型的返回码,如果值为CVR_CODE_OK常量,则为成功。

CVRCode CVRSetOnVideoSizeChangedCallback(CVRInstance_t* thiz, CVROnVideoSizeChangedCallback_t callback,void* user_data)

【功能说明】

设置当前视频大小变化的回调通知。

【请求参数】

  • thiz:由CVRCreateInstance()创建的云应用客户端实例。
  • callback:事件触发时的回调函数。
  • user_data:设置回调函数中自定义数据。

【返回值】

返回CVRCode类型的返回码,如果值为CVR_CODE_OK常量,则为成功。

CVRCode CVRSetShowDebug(CVRInstance_t* thiz,int show_debug)

【功能说明】

是否显示调试参数。

【请求参数】

thiz:由CVRCreateInstance()创建的云应用客户端实例。

【返回值】

返回CVRCode类型的返回码,如果值为CVR_CODE_OK常量,则为成功。

CVRCode CVRGetStatistics(CVRInstance_t* thiz, CVRStatistics_t* statistics)

【功能说明】

获取当前串流的统计数据。

【请求参数】

  • thiz:由CVRCreateInstance()创建的云应用客户端实例。
  • statistics:接收相关统计数据的外部变量。

【返回值】

返回CVRCode类型的返回码,如果值为CVR_CODE_OK常量,则为成功。

CVRCode CVRGetAuth(CVRInstance_t* thiz, CVRAuth* out_val)

【功能说明】

获取当前是主控客户端还是旁观客户端。

【请求参数】

  • thiz:由CVRCreateInstance()创建的云应用客户端实例。
  • out_val:接收当前模式的变量。

【返回值】

返回CVRCode类型的返回码,如果值为CVR_CODE_OK常量,则为成功。

CVRCode CVRSetOnAppClosedCallback(CVRInstance_t* thiz,CVROnAppClosedCallback_t callback,void* user_data)

【功能说明】

设置应用关闭的回调通知。

【请求参数】

  • thiz:由CVRCreateInstance()创建的云应用客户端实例。
  • callback:事件触发时的回调函数。
  • user_data:设置回调函数中自定义数据。

【返回值】

返回CVRCode类型的返回码,如果值为CVR_CODE_OK常量,则为成功。

CVRCode CVRRestartApp(CVRInstance_t* thiz,bool cancel)

【功能说明】

重新启动应用。

【返回值】

返回CVRCode类型的返回码,如果值为CVR_CODE_OK常量,则为成功。

CVRCode CVRPause(CVRInstance_t* thiz)

【功能说明】

暂停云应用资源。

【返回值】

返回CVRCode类型的返回码,如果值为CVR_CODE_OK常量,则为成功。

CVRCode CVRResume(CVRInstance_t* thiz)

【功能说明】

恢复云应用资源。

【返回值】

返回CVRCode类型的返回码,如果值为CVR_CODE_OK常量,则为成功。

void CVRRelease(CVRInstance_t* thiz)

【功能说明】

获取资源并停止云应用。

【返回值】

返回CVRCode类型的返回码,如果值为CVR_CODE_OK常量,则为成功。

相关文档

    提示

    您即将访问非华为云网站,请注意账号财产安全