Wpf_AiSportsMicrospace/sdks/Yztob.AiSports.Common.xml

503 lines
20 KiB
XML
Raw Normal View History

2025-09-15 12:58:01 +08:00
<?xml version="1.0"?>
<doc>
<assembly>
<name>Yztob.AiSports.Common</name>
</assembly>
<members>
<member name="T:Yztob.AiSports.Common.Abstractions.IDebugTrackChannel">
<summary>
<seealso cref="T:Yztob.AiSports.Common.DebugTracker"/>跟踪追踪抽象接口
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Abstractions.IDebugTrackChannel.Output(System.String,System.String)">
<summary>
输出一条不带格式化的消息
</summary>
<param name="source">消息来源</param>
<param name="message">消息文本</param>
</member>
<member name="M:Yztob.AiSports.Common.Abstractions.IDebugTrackChannel.Output(System.String,System.String,System.Object[])">
<summary>
输出一条带格式化的消息
</summary>
<param name="source">消息来源</param>
<param name="format">消息格式文本</param>
<param name="args">输出参数</param>
</member>
<member name="T:Yztob.AiSports.Common.AiSportLicense">
<summary>
授权相关操作入口
</summary>
</member>
<member name="M:Yztob.AiSports.Common.AiSportLicense.GetMachineId">
<summary>
获取机器识别信息
</summary>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Common.AiSportLicense.Activate(System.String)">
<summary>
激活SDK
</summary>
<param name="licenseText">授权码</param>
<returns>
0: 注册成功
10参数不正确
11机器码不符
100试用授权到期
-1000发生未知异常<seealso cref="T:System.Exception"/>异常
</returns>
</member>
<member name="M:Yztob.AiSports.Common.AiSportLicense.Checking">
<summary>
检查当前SDK激活状态
</summary>
<returns>
0: 激活状态正常
10未激活/无授权文件
11机器码不符
100试用授权到期
-1000发生未知异常<seealso cref="T:System.Exception"/>异常
</returns>
</member>
<member name="T:Yztob.AiSports.Common.DebugTracker">
<summary>
AI运动相关调试信息追踪器
</summary>
</member>
<member name="M:Yztob.AiSports.Common.DebugTracker.#cctor">
<summary>
全局初始化
</summary>
</member>
<member name="P:Yztob.AiSports.Common.DebugTracker.Enabled">
<summary>
获取或设置是否启用消息输出
</summary>
</member>
<member name="P:Yztob.AiSports.Common.DebugTracker.Channels">
<summary>
获取消息输出通道
</summary>
<remarks>
默认会有<seealso cref="T:Yztob.AiSports.Common.Implement.ConsoleDebugTrackChannel"/>通道
</remarks>
</member>
<member name="M:Yztob.AiSports.Common.DebugTracker.Output(System.String,System.String)">
<summary>
向追踪通道输出一条不带格式化追踪消息
</summary>
<param name="source">消息来源</param>
<param name="message">要输入的消息</param>
</member>
<member name="M:Yztob.AiSports.Common.DebugTracker.Output(System.String,System.String,System.Object[])">
<summary>
向追踪通道输出一条带格式化的消息
</summary>
<param name="source">消息来源</param>
<param name="format">消息格式文本</param>
<param name="args">输出参数</param>
</member>
<member name="T:Yztob.AiSports.Common.Fonts">
<summary>
AI运动需要用到的渲染字体相关
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Fonts.GetFontBuffer">
<summary>
获取默认渲染字体字节流
</summary>
<returns></returns>
</member>
<member name="T:Yztob.AiSports.Common.Implement.ConsoleDebugTrackChannel">
<summary>
控制台调试追踪通道
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Implement.ConsoleDebugTrackChannel.Output(System.String,System.String)">
<inheritdoc />
</member>
<member name="M:Yztob.AiSports.Common.Implement.ConsoleDebugTrackChannel.Output(System.String,System.String,System.Object[])">
<inheritdoc />
</member>
<member name="T:Yztob.AiSports.Common.Implement.DiagnosisDebugTrackChannel">
<summary>
诊断Debugger调试追踪通道
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Implement.DiagnosisDebugTrackChannel.Output(System.String,System.String)">
<inheritdoc />
</member>
<member name="M:Yztob.AiSports.Common.Implement.DiagnosisDebugTrackChannel.Output(System.String,System.String,System.Object[])">
<inheritdoc />
</member>
<member name="T:Yztob.AiSports.Common.Implement.LogDebugTrackChannel">
<summary>
日志形式调试追踪通道
</summary>
<remarks>注意要配置名为ai-debugger的日志输出器</remarks>
</member>
<member name="M:Yztob.AiSports.Common.Implement.LogDebugTrackChannel.Output(System.String,System.String)">
<inheritdoc />
</member>
<member name="M:Yztob.AiSports.Common.Implement.LogDebugTrackChannel.Output(System.String,System.String,System.Object[])">
<inheritdoc />
</member>
<member name="T:Yztob.AiSports.Common.Licenses.FeatureCpuPartMap">
<summary>
表示受权机器CPU部件特性图
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureCpuPartMap.#ctor">
<summary>
初始化CPU部件特征图
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureCpuPartMap.Extracting">
<summary>
提取CPU特征
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureCpuPartMap.Print">
<inheritdoc />
</member>
<member name="T:Yztob.AiSports.Common.Licenses.FeatureDiskPartMap">
<summary>
表示受权机器硬盘部件特性图
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureDiskPartMap.#ctor">
<summary>
初始化网卡部件特征图
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureDiskPartMap.Extracting">
<summary>
提取CPU特征
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureDiskPartMap.Print">
<inheritdoc />
</member>
<member name="T:Yztob.AiSports.Common.Licenses.FeatureItem">
<summary>
表示一条受权机器特征条目
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Licenses.FeatureItem.Key">
<summary>
获取或设置特征唯一键
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Licenses.FeatureItem.Value">
<summary>
获取或设置特征值
</summary>
</member>
<member name="T:Yztob.AiSports.Common.Licenses.FeatureMap">
<summary>
表示受权机器特征图
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureMap.#ctor">
<summary>
初始化特征图
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Licenses.FeatureMap.CPU">
<summary>
获取或设置CPU特征值
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Licenses.FeatureMap.Networks">
<summary>
获取或设置网卡特征集
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Licenses.FeatureMap.Disks">
<summary>
获取或设置硬盘特征集
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Licenses.FeatureMap.Digests">
<summary>
获取或设置特征图哈希摘要
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureMap.CalculateDigests">
<summary>
生成特征指纹
</summary>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureMap.Print">
<summary>
打包受权机器整体特征图
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureMap.ToJson">
<summary>
将当前对象转换成JSON对象
</summary>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureMap.Extracting">
<summary>
提取当前特征图,加密输出
</summary>
<returns></returns>
</member>
<member name="T:Yztob.AiSports.Common.Licenses.FeatureNetworkAdapterPartMap">
<summary>
表示受权机器网卡部件特性图
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureNetworkAdapterPartMap.#ctor">
<summary>
初始化网卡部件特征图
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureNetworkAdapterPartMap.Extracting">
<summary>
提取CPU特征
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeatureNetworkAdapterPartMap.Print">
<inheritdoc />
</member>
<member name="T:Yztob.AiSports.Common.Licenses.FeaturePartMap">
<summary>
表示某一类部件的特征图
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeaturePartMap.#ctor(System.String[])">
<summary>
初始化部件特征图
</summary>
<param name="digestKeys">生成特征摘要KEY</param>
</member>
<member name="P:Yztob.AiSports.Common.Licenses.FeaturePartMap.FeatureKeys">
<summary>
获取或设置用于生成特征摘要KEY
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Licenses.FeaturePartMap.Features">
<summary>
获取或设置特征集列表
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Licenses.FeaturePartMap.Digests">
<summary>
获取或设置部件特征图哈希摘要
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeaturePartMap.CalculateDigests">
<summary>
生成特征指纹
</summary>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeaturePartMap.Print">
<summary>
打印特征信息
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.FeaturePartMap.ToJson">
<summary>
将当前对象转换成JSON对象
</summary>
<returns></returns>
</member>
<member name="T:Yztob.AiSports.Common.Licenses.LicenseException">
<summary>
授权相关错误异常
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.LicenseException.#ctor(System.String,System.Int32,System.Exception)">
<summary>
初始化异常
</summary>
<param name="message">错误信息</param>
<param name="code">错误代码</param>
<param name="innterException">内部异常</param>
</member>
<member name="T:Yztob.AiSports.Common.Licenses.LicenseImplant">
<summary>
链接嵌入式授权相关服务
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.LicenseImplant.Checking">
<summary>
检查当前SDK激活状态
</summary>
<returns>
0: 激活状态正常
10未激活/无授权文件
11机器码不符
100试用授权到期
-1000发生未知异常<seealso cref="T:System.Exception"/>异常
</returns>
</member>
<member name="T:Yztob.AiSports.Common.Licenses.Protection">
<summary>
RSA非对称加/解
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.Protection.GetMaxEncryptSize(System.Security.Cryptography.RSA,System.Security.Cryptography.RSAEncryptionPadding)">
<summary>
获取RSA每次最多参加密多少数据
</summary>
<param name="rsa"></param>
<param name="padding">填充模式</param>
<returns></returns>
<exception cref="T:System.NotSupportedException"></exception>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.Protection.Encrypting(System.Byte[])">
<summary>
加密二进制流数据
</summary>
<param name="buffer">要加密的数据缓冲区</param>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.Protection.Encrypting(System.String)">
<summary>
加密文本数据
</summary>
<param name="plain">明文文本</param>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.Protection.Decrypting(System.String)">
<summary>
解密指定的文本
</summary>
<param name="ciphertext">私钥加密的文本Base64字符串</param>
<returns></returns>
</member>
<member name="T:Yztob.AiSports.Common.Licenses.RelaxRsaEncipher">
<summary>
宽松版RSA加密算法
</summary>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.RelaxRsaEncipher.#ctor(System.Security.Cryptography.RSAParameters)">
<summary>
初始化加密器
</summary>
<param name="parameters">RSA加密参数</param>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.RelaxRsaEncipher.RemovePkcs1Padding(System.Byte[])">
<summary>
移除数据中的PKcs#1.5填充
</summary>
<param name="paddedData">已填充的数据</param>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.RelaxRsaEncipher.FromByteArray(System.Byte[])">
<summary>
从字节流加密流中创建大整数如果有前导0则先删除
</summary>
<param name="buffer"></param>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Common.Licenses.RelaxRsaEncipher.PublicDecrypt(System.Byte[])">
<summary>
使用公钥解密
</summary>
<param name="encryptedData">加密数据</param>
<returns></returns>
</member>
<member name="T:Yztob.AiSports.Common.Properties.Resources">
<summary>
一个强类型的资源类,用于查找本地化的字符串等。
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Properties.Resources.ResourceManager">
<summary>
返回此类使用的缓存的 ResourceManager 实例。
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Properties.Resources.Culture">
<summary>
重写当前线程的 CurrentUICulture 属性,对
使用此强类型资源类的所有资源查找执行重写。
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Properties.Resources.AlibabaPuHuiTi_3_Light">
<summary>
查找 System.Byte[] 类型的本地化资源。
</summary>
</member>
<member name="T:Yztob.AiSports.Common.SportAppSettingService">
<summary>
AI运动应用公共设定服务
</summary>
</member>
<member name="M:Yztob.AiSports.Common.SportAppSettingService.#cctor">
<summary>
全局初始化
</summary>
</member>
<member name="M:Yztob.AiSports.Common.SportAppSettingService.Get``1(System.String,System.Func{``0})">
<summary>
获取配置
</summary>
<typeparam name="T">配置类型</typeparam>
<param name="key">配置节唯一键</param>
<param name="defaultGetter">若值不存在取默认取器</param>
<returns></returns>
</member>
<member name="M:Yztob.AiSports.Common.SportAppSettingService.Set``1(System.String,``0)">
<summary>
设定配置
</summary>
<typeparam name="T">配置类型</typeparam>
<param name="key">配置节唯一键</param>
<param name="value">配置参数</param>
</member>
<member name="M:Yztob.AiSports.Common.SportAppSettingService.Save">
<summary>
持久化保存当前配置致文件中
</summary>
</member>
<member name="T:Yztob.AiSports.Common.Things.LicenseInfo">
<summary>
授权许可信息
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Things.LicenseInfo.Type">
<summary>
获取或设置授权类型
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Things.LicenseInfo.MachineId">
<summary>
获取或设置受权机器唯一识别码
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Things.LicenseInfo.Owner">
<summary>
获取或设置,受权主体(公司、个人)名称
</summary>
</member>
<member name="P:Yztob.AiSports.Common.Things.LicenseInfo.GrantTimestamp">
<summary>
获取或设置授予许可的时间戳单位UTC时间
</summary>
</member>
<member name="T:Yztob.AiSports.Common.Things.LicenseType">
<summary>
授权类型
</summary>
</member>
<member name="F:Yztob.AiSports.Common.Things.LicenseType.Trial">
<summary>
试用评估授权
</summary>
</member>
<member name="F:Yztob.AiSports.Common.Things.LicenseType.Permanent">
<summary>
永久授权
</summary>
</member>
</members>
</doc>