外部集成API列表

最終更新： 2024年10月24日

本页面介绍通过外部集成 API从UID、参数ID等设置和获取Editor中信息的命令、Event和错误类型。

命令

RegisterPlugin

在Editor中注册外部应用程序。
注册完成后，将返回一个令牌。
该令牌与应用程序关联，通过在下次连接时指定，可以继承用户的权限状态。
有关详细信息，请参考“令牌认证”。

Version	Request	Response	ErrorType
Response	Name:String, Token?:String, Icon?:String, Path?:String	Token:String	InvalidData

Name:String	应用程序名称（任意）： 请给它一个独特的名称。 即使与其他应用程序重名，也不会影响动作。
Token?:String	令牌： 如果省略或未注册令牌，RegisterPlugin将返回一个新令牌。 如果指定的令牌已注册，则将原样返回该令牌。
Icon?:String	图标PNG图像的BASE64字符串列： 大小应为32×32以上、256×256以下、0.5MB以下的正方形。
Path?:String	显示应用程序路径信息。

GetIsApproval

获取用户是否有权限与该应用程序通信。
它与设置对话框的“权限”复选框连动。

Version	Request	Response	ErrorType
0.9.0		Result:Boolean	InvalidData

GetParameterValues

版本0.9.0

指定参数ID并获取模型当前的参数ID与值。
如果不指定参数ID，则会获取模型的所有参数ID与值。
不包含动画信息。

Version	Request	Response	ErrorType
0.9.0	ModelUID:String, Ids?:Array<String>	Parameters:Array<{   Id:String,   Value:Number }>	InvalidData InvalidModel

version 0.9.1

指定参数ID并获取模型当前的参数ID与值。
如果不指定参数ID，则会获取模型的所有参数ID与值。
可以获取有关物理模拟、模型编辑和动画的信息。

Version	Request	Response	ErrorType
0.9.1	ModelUID:String, Ids?:Array<String>	Parameters:Array<{   Id:String,   Value:Number }>	InvalidData InvalidModel

SetParameterValues

版本0.9.0

设置指定的参数ID与值。
参数无法发送到动画文件中的模型。

Version	Request	Response	ErrorType
0.9.0	ModelUID:String, Parameters:Array<{   Id:String,   Value:Number }>		InvalidData InvalidModel InvalidParameter

version 0.9.1

设置指定的参数ID与值。
如果您想要参数发送到动画文件中的模型，则必须选择模型轨道。
对于物理模拟Editor和动画模型，参数不会立即应用，而是暂时保留。

Version	Request	Response	ErrorType
0.9.1	ModelUID:String, Parameters:Array<{   Id:String,   Value:Number }>		InvalidData InvalidModel InvalidParameter

GetParameters

Id:String	参数ID
Name:String	参数名称
GroupUID:String	所属参数组的UID
Default:Number	默认值
Max,Max:Number	最大值、最小值
Repeat:Boolean	循环
Type:Number	参数类型 0：通常 1：融合变形

版本0.9.0

获取模型具有的参数列表。
ModelUID和DocumentUID可省略，但其中之一是必需的。
Type为“0”表示通常，“1”表示融合变形。
无法获取动画文件（.can3）中模型的参数列表。

Version	Request	Response	ErrorType
0.9.0	ModelUID?:String, DocumentUID?:String	Parameters:Array<{   Id:String,    Name:String,   GroupUID:String,   Default:Number,   Max:Number,   Min:Number,   Repeat:Boolean   Type:Number }>	InvalidData InvalidModel

version 0.9.1

获取模型具有的参数列表。
ModelUID和DocumentUID可省略，但其中之一是必需的。
Type为“0”表示通常，“1”表示融合变形。
如果您想要获取动画文件中包含的模型的参数列表，则必须选择模型轨道。
如果模型是运行时模型轨道，则GroupUID将返回空字符串。

Version	Request	Response	ErrorType
0.9.1	ModelUID?:String, DocumentUID?:String	Parameters:Array<{   Id:String,    Name:String,   GroupUID:String,   Default:Number,   Max:Number,   Min:Number,   Repeat:Boolean   Type:Number }>	InvalidData InvalidModel

GetParameterGroups

版本0.9.0

获取模型具有的参数组列表。
ModelUID和DocumentUID可省略，但其中之一是必需的。
无法获取动画文件（.can3）中包含的模型的参数列表。

Version	Request	Response	ErrorType
0.9.0	ModelUID?:String, DocumentUID?:String	Groups:Array<{   GroupUID:String,   GroupName:String, }>	InvalidData InvalidModel

version 0.9.1

获取模型具有的参数组列表。
ModelUID和DocumentUID可省略，但其中之一是必需的。
如果要获取动画文件中包含的模型组列表，则必须选择模型轨道。
如果模型是运行时模型轨道，则GroupUID将返回空字符串。

Version	Request	Response	ErrorType
0.9.1	ModelUID?:String, DocumentUID?:String	Groups:Array<{   GroupUID:String,   GroupName:String, }>	InvalidData InvalidModel

GetDocuments

版本0.9.0

返回文档信息。
按类型分类物理模拟、模型编辑，如果不存在则返回0个文档数组。
如果分割显示一个模型，Views将会增加。

Version	Request	Response	ErrorType
0.9.0		PhysicsDocuments:Array<{   DocumentUID:String,   DocumentFilePath:String,   ModelUID:String }>, ModelingDocuments:Array<{   DocumentUID:String,   DocumentFilePath:String,   Views:Array<{     ModelUID:String    }> }>	InvalidData InvalidDocument

version 0.9.1

返回文档信息。
按类型分类物理模拟、模型编辑，如果不存在则返回0个文档数组。
如果分割显示一个模型，Views将会增加。

Version	Request	Response	ErrorType
0.9.1		PhysicsDocuments:Array<{   DocumentUID:String,   DocumentFilePath:String   ModelUID:String, }> ModelingDocuments:Array<{   DocumentUID:String,   DocumentFilePath:String   Views:Array<{     ModelUID:String   }> }> AnimationDocuments:Array<{   DocumentUID:String,   DocumentFilePath:String   Views:Array<{     ModelUID:String,     ModelFilePath:String   }> }>	InvalidData InvalidDocument

GetDocument

version 0.9.3

指定文档的UID并返回文档信息。

Version	Request	Response	ErrorType
0.9.3	DocumentUID:String	PhysicsDocuments?:Array<{   DocumentFilePath:String   ModelUID:String, }> ModelingDocuments?:Array<{   DocumentFilePath:String   Views:Array<{     ModelUID:String   }> }> AnimationDocuments?: Array<{   DocumentFilePath:String   Views : Array<{     ModelUID:String,     ModelFilePath:String   }> }>	InvalidData InvalidDocument

GetCurrentDocumentUID

version 0.9.3

返回Editor中当前文档的UID。

Version	Request	Response	ErrorType
0.9.3	DocumentUID:String	DocumentUID:String	InvalidData InvalidDocument

GetCurrentModelUID

版本0.9.0

返回Editor中当前模型的UID。
无法获取动画文件中包含的模型的UID。

Version	Request	Response	ErrorType
0.9.0		ModelUID:String	InvalidData InvalidModel

version 0.9.1

返回Editor中当前模型的UID。
如果要获取动画文件中包含的模型的UID，则必须选择模型轨道。

Version	Request	Response	ErrorType
0.9.1		ModelUID:String	InvalidData InvalidModel

GetCurrentEditMode

版本0.9.0

返回Editor上的当前编辑模式。

Version	Request	Response	ErrorType
0.9.0		EditMode:String	InvalidData

EditMode:String

编辑模式 “Physics”：物理模拟设置 “Modeling”：模型编辑 “Animation”：动画编辑 “ModelingMeshEdit”：网格编辑 “FormAnimation”：形状动画编辑 *5.1 beta1或更高版本

SetGlobalVersion

version 0.9.1

可以设置要使用的API版本。
这允许您固定外部应用程序中使用的API版本。
如果没有设置，可以返回为未指定。

Version	Request	Response	ErrorType
0.9.1	Version?:String		InvalidData

ClearParameterValues

version 0.9.1

清除发送到对象模型的参数。
使用SetParameterValue发送的参数暂时保存在Editor中。
对于物理模拟Editor和动画，参数可能会因模型更新而暂时保留。
如果您想显式清除临时保存的参数，请使用此API。

Version	Request	Response	ErrorType
0.9.1	ModelUID:String		InvalidData

GetPhysicsInfo

version 0.9.2

在物理模拟设置中获取计计算FPS。

Version	Request	Response	ErrorType
0.9.2	ModelUID:String, Fps?:Number		InvalidData InvalidModel

SendCubismLog

version 0.9.3

发送字符串作为Editor的记录。
Type可以指定为“info”、“warning”，默认值为“info”。
Message的最大字符长度为5000个字符。
Display表示是否在记录面板上显示，如果省略，则默认值设置为true，并在记录面板上显示。

Version	Request	Response	ErrorType
0.9.3	Type?:String, Message:String, Display?:Boolean		InvalidData InvalidModel

Event

要处理Event时，客户端必须首先启用服务器的权限标志。

{
    （省略）
    "Type": "Request",
    "Method": "NotifyMocFileExported",
    "Data": {
        "Enable" : true
    }
}

然后，当服务器执行特定处理（Event）时，无论客户端的请求如何，都会发送JSON。
此外，如果模型文件从未保存过，则ModelFilePath字段将包含空字符串。

{
    （省略）
    "Type": "Response",
    "Method": "NotifyMocFileExported",
    "Data": {
        "Path" : "c:\\temp\\export.moc3",
        "ModelFilePath" : "c:\\models\\hoge03.cmo3"
    }
}

NotifyPhysicsFileExported

版本0.9.0

配置输出物理模拟设置文件时的通知设置。

Version	Request	Response	Event	ErrorType
0.9.0	Enabled:Boolean	Accepted:Boolean	Path:String, ModelFilePath:String	InvalidData

NotifyMocFileExported

version 0.9.3

配置输出MOC3文件时的通知设置。
如果设置有效，则会通知MOC3文件信息与相关文件信息。

Version	Request	Response	Event	ErrorType
0.9.3	Enabled:Boolean	Accepted:Boolean	Path:String, ModelFilePath:String, Files:Array<String>	InvalidData

版本0.9.0

配置输出MOC3文件时的通知设置。
如果设置有效，则会通知MOC3文件信息。

Version	Request	Response	Event	ErrorType
0.9.0	Enabled:Boolean	Accepted:Boolean	Path:String, ModelFilePath:String	InvalidData

NotifyMotionFileExported

版本0.9.0

配置输出动态文件时的通知设置。

Version	Request	Response	Event	ErrorType
0.9.0	Enabled:Boolean	Accepted:Boolean	Path:String, ModelFilePath:String	InvalidData

NotifyMotionSyncFileExported

版本0.9.0

配置输出动态同步设置文件时的通知设置。

Version	Request	Response	Event	ErrorType
0.9.0	Enabled:Boolean	Accepted:Boolean	Path:String, ModelFilePath:String	InvalidData

NotifyChangeEditMode

版本0.9.0

配置切换编辑模式时的通知设置。
关于EditMode，请参考“GetCurrentEditMode”。

Version	Request	Response	Event	ErrorType
0.9.0	Enabled:Boolean	Accepted:Boolean	EditMode:String	InvalidData

错误类型

名称	说明	Since
InvalidJson	JSON结构不正确。	0.9.0
UnsupportedVersion	版本不兼容。	0.9.0
MethodNotFound	未找到指定的命令。	0.9.0
InvalidType	Type设置无效。	0.9.0
InvalidData	命令参数无效。 如果参数不足或者为参数指定了不同的类型，则会返回此错误。	0.9.0
PluginNotRegistered	插件注册尚未完成。 如果在未完成插件注册（RegisterPlugin）和用户授权的情况下请求命令，则会返回此错误。	0.9.0
InvalidParameter	指定的Live2D参数不存在。	0.9.0
InvalidModel	指定的Live2D模型不存在。	0.9.0
InvalidDocument	Editor中不存在指定的文档。	0.9.0
InvalidView	指定的视图不存在。	0.9.0