资源中心初始化

更新记录

版本 日期 修改人 修改内容
1.0.0 2020年4月14日 蔺浪(510525) 新建文档
1.0.1 2020年6月11日 蔺浪(510525) ResCenterConfig新增属性IsNewPlatform
1.0.2 2020年6月12日 蔺浪(510525) 更新记录使用表格
1.0.3 2020年8月12日 蔺浪(510525) 补充配置数据结构详细说明

概况

组件包

  • Nd.VLab.ResourceCenter 任意版本
  • 不同版本初始化支持参数可能有差异,但向前兼容。

程序集

  • VLabResource.dll

接口状态

  • 提测通过

代码引用

//命名空间
namespace VLabResource

//接口实例
VLabResourceCenter.Instance

初始化接口

接口签名:

bool Initialize(ResCenterConfig resCenterConfig)

接口说明:

  • 初始化资源中心
  • 使用资源中心组件前,必须对其进行初始化操作

参数说明:

参数名 类型 说明
resCenterConfig ResCenterConfig 资源中心配置数据结构类

返回值说明

类型 说明
bool 是否成功初始化资源中心?

初始化参数

ResCenterConfig

字段/属性 类型 说明
ndrServiceCfgPath string Ndr服务配置文件路径
moduleServiceCfgPath string Module服务配置文件路径
OldEquipInfoCfgPath string 旧管理平台器材映射信息配置文件路径
ResourceCachePath string 资源缓存目录
PlayerVersion string 播放器版本号
EngineVersion string 引擎版本号
LanguageCode string 语言编码
IsNewPlatform bool 使用新管理平台资源?新平台:在线请求与下载,资源获取;旧平台:资源获取

[I] 构造函数1

接口签名:

ResCenterConfig(string ndrServiceCfgPath, string moduleServiceCfgPath, string resourceCachePath,string playerVersion, string engineVersion)

接口说明:

  • 构造函数(新平台,中文语言)

参数说明:

属性 类型 说明
ndrServiceCfgPath string Ndr服务配置文件路径
moduleServiceCfgPath string Module服务配置文件路径
resourceCachePath string 资源缓存目录
playerVersion string 播放器版本号
engineVersion string 引擎版本

[I] 构造函数2

接口签名:

ResCenterConfig(string ndrServiceCfgPath, string moduleServiceCfgPath, string oldEquipInfoCfgPath, string resourceCachePath, string playerVersion, string engineVersion, string languageCode = LANG_CODE_ZH_CN)

接口说明:

  • 构造函数(旧平台)

参数说明:

属性 类型 说明
ndrServiceCfgPath string Ndr服务配置文件路径
moduleServiceCfgPath string Module服务配置文件路径
OldEquipInfoCfgPath string 旧管理平台器材映射信息配置文件路径
resourceCachePath string 资源缓存目录
playerVersion string 播放器版本号
engineVersion string 引擎版本
LanguageCode string 语言编码,默认中文

[I] 构造函数3

接口签名:

ResCenterConfig(string ndrServiceCfgPath, string moduleServiceCfgPath, string resourceCachePath, string playerVersion, string engineVersion, string languageCode = LANG_CODE_ZH_CN)

接口说明:

  • 构造函数(新平台)

参数说明:

属性 类型 说明
ndrServiceCfgPath string Ndr服务配置文件路径
moduleServiceCfgPath string Module服务配置文件路径
resourceCachePath string 资源缓存目录
playerVersion string 播放器版本号
engineVersion string 引擎版本
LanguageCode string 语言编码,默认中文

[I] 构造函数4

接口签名:

ResCenterConfig(string ndrServiceCfgPath, string moduleServiceCfgPath, string resourceCachePath, string playerVersion, string engineVersion, string languageCode = LANG_CODE_ZH_CN, bool isNewPlatform = true)

接口说明:

  • 构造函数(新/旧平台)

参数说明:

属性 类型 说明
ndrServiceCfgPath string Ndr服务配置文件路径
moduleServiceCfgPath string Module服务配置文件路径
resourceCachePath string 资源缓存目录
playerVersion string 播放器版本号
engineVersion string 引擎版本
LanguageCode string 语言编码,默认中文
isNewPlatform string 使用新管理平台资源?

特别参数说明

  • ndrServiceCfgPath
    参见配置文件详情

  • moduleServiceCfgPath
    参见配置文件详情
    资源中心目前遵循下载配置状态下能够请求到的最新版本的组件/器材/药品/模型资源包;在后续的优化版本中,模型资源包下载的是组件/器材/药品中依赖配置设定的版本。
    配置文件中“newServiceStatus”直接影响资源中心能够从管理平台上下载的资源版本,例如”newServiceStatus” : “ONLINE”设定,则只能下载到状态为“已上线”的组件/器材/药品等资源;如下图所示(图示旨在举例说明逻辑,因平台上资源更新变动,该例子可能不复见)

  • OldEquipInfoCfgPath
    参见配置文件详情

  • playerVersion
    应用接入的Player大包的版本(Nuget发布版本);
    该版本号直接影响资源中心能够从管理平台上下载的资源版本,如下图所示(图示旨在举例说明逻辑,因平台上资源更新变动,该例子可能不复见),传入播放器版本不低于2.4.0才能请求或者下载到大铜片1.3.0版本的资源。

  • engineVersion
    应用接入的Engine大包的版本(Nuget发布版本);
    该版本号直接影响资源中心能够从管理平台上下载的资源版本,如下图所示(图示旨在举例说明逻辑,因平台上资源更新变动,该例子可能不复见),传入引擎版本不低于2.6.20才能请求或者下载到大铜片1.3.0版本的资源。

  • LanguageCode
    参见管理平台语言区域管理中标注的语言编码