외부 협력 API 목록
업데이트: 2024/06/25
이 페이지에서는 UID나 파라미터 ID 등에서 외부 연계 API를 통해 에디터의 정보를 설정, 취득하는 명령이나 이벤트, 에러 타입을 소개합니다.
명령
RegisterPlugin
외부 애플리케이션을 편집기에 등록합니다.
등록이 끝나면 토큰을 반환합니다.
이 토큰은 앱과 연결되어 있으며 다음에 연결할 때 지정하여 사용자의 권한 상태를 인계받을 수 있습니다.
자세한 내용은 “토큰 인증“을 참조하세요.
Version | Request | Response | ErrorType |
---|---|---|---|
Response | Name:String, Token?:String, Icon?:String, Path?:String | Token:String | InvalidData |
Name:String | <p><strong>애플리케이션 이름(선택 사항):</strong><br /> |
Token?:String | 토큰: |
Icon?:String | 아이콘 PNG 이미지의 BASE64 문자열: |
Path?:String | 애플리케이션의 경로 정보를 표시합니다. |
주의사항
RegisterPlugin을 먼저 수행하고 사용자로부터 권한을 받지 않는 한 아래의 거의 모든 명령어는 PluginNotRegistered 오류를 반환하고 API 작업을 수락하지 않습니다.
GetIsApprove
사용자가 이 앱에 대한 통신을 허용하는지 여부를 가져옵니다.
설정 다이얼로그의 「허가」의 체크 박스와 연동하고 있습니다.
Version | Request | Response | ErrorType |
---|---|---|---|
0.9.0 | Result:Boolean | InvalidData |
GetParameterValues
version 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
version 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와 값을 설정합니다.
애니메이션 파일의 모델로 매개변수를 전송하는 경우 모델 트랙을 선택해야 합니다.
물리 연산 편집기, 애니메이션 모델의 경우, 파라미터를 즉시 반영하지 않고 임시로 유지됩니다.
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 | 파라미터 타입 |
version 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
version 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
version 0.9.0
문서의 정보를 돌려줍니다.
물리 연산, 모델 편집 및 종류별로 헤어지고, 존재하지 않는 경우는 0개의 문서 배열을 돌려줍니다.
1 모델을 분할 표시하면 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개의 문서 배열을 돌려줍니다.
1 모델을 분할 표시하면 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
현재 에디터상에서 현재 되어 있는 문서의 UID를 돌려줍니다.
Version | Request | Response | ErrorType |
---|---|---|---|
0.9.3 | DocumentUID:String | DocumentUID:String | InvalidData InvalidDocument |
GetCurrentModelUID
version 0.9.0
현재 에디터상에서 현재 되어 있는 모델의 UID를 돌려줍니다.
애니메이션 파일에 포함된 모델의 UID는 검색할 수 없습니다.
Version | Request | Response | ErrorType |
---|---|---|---|
0.9.0 | ModelUID:String | InvalidData InvalidModel |
version 0.9.1
현재 에디터상에서 현재 되어 있는 모델의 UID를 돌려줍니다.
애니메이션 파일에 포함된 모델의 UID를 얻으려면 모델 트랙을 선택해야 합니다.
Version | Request | Response | ErrorType |
---|---|---|---|
0.9.1 | ModelUID:String | InvalidData InvalidModel |
GetCurrentEditMode
version 0.9.0
현재 에디터상에서 현재 되어 있는 편집 모드를 돌려줍니다.
Version | Request | Response | ErrorType |
---|---|---|---|
0.9.0 | EditMode:String | InvalidData |
EditMode:String | 편집 모드 |
SetGlobalVersion
version 0.9.1
사용할 API 버전을 설정할 수 있습니다.
이렇게 하면 외부 응용 프로그램에서 사용하는 API 버전을 고정할 수 있습니다.
설정되지 않은 경우 지정하지 않고 되돌릴 수 있습니다.
Version | Request | Response | ErrorType |
---|---|---|---|
0.9.1 | Version?:String | InvalidData |
ClearParameterValues
version 0.9.1
대상 모델로 보낸 파라미터를 지웁니다.
SetParameterValue로 보낸 매개 변수는 편집기에서 임시로 유지합니다.
물리 연산 편집기 또는 애니메이션의 경우 모델 업데이트 관계에서 임시 매개 변수를 계속 유지할 수 있습니다.
임시로 보유한 매개변수를 명시적으로 지우려면 이 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
편집기의 로그로 문자열을 보냅니다.
Type은 “info”, “warning”을 지정할 수 있으며 기본값은 “info”입니다.
Message의 최대 문자 길이는 5000자입니다.
Display는 로그 팔레트에의 표시 유무가 되어 있어, 생략시는 디폴트치를 true로서 로그 팔레트에 표시합니다.
Version | Request | Response | ErrorType |
---|---|---|---|
0.9.3 | Type?:String, Message:String, Display?:Boolean | InvalidData InvalidModel |
이벤트
이벤트를 처리하는 경우 먼저 클라이언트가 서버에 대해 권한 플래그를 활성화해야 합니다.
{ (생략) "Type": "Request", "Method": "NotifyMocFileExported", "Data": { "Enable" : true } }
그러면 서버는 특정 처리(이벤트)를 수행할 때 클라이언트의 요청에 관계없이 JSON을 전송합니다.
모델 파일이 한 번도 저장되지 않은 경우 ModelFilePath 필드에는 빈 문자가 포함됩니다.
{ (생략) "Type": "Response", "Method": "NotifyMocFileExported", "Data": { "Path" : "c:\\temp\\export.moc3", "ModelFilePath" : "c:\\models\\hoge03.cmo3" } }
NotifyPhysicsFileExported
version 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 |
version 0.9.0
MOC3 파일을 내보낼 때 알림 설정을 수행합니다.
설정이 활성화되면 MOC3 파일의 정보를 알립니다.
Version | Request | Response | Event | ErrorType |
---|---|---|---|---|
0.9.0 | Enabled:Boolean | Accepted:Boolean | Path:String, ModelFilePath:String | InvalidData |
NotifyMotionFileExported
version 0.9.0
모션 파일을 내보낼 때 알림 설정을 수행합니다.
Version | Request | Response | Event | ErrorType |
---|---|---|---|---|
0.9.0 | Enabled:Boolean | Accepted:Boolean | Path:String, ModelFilePath:String | InvalidData |
NotifyMotionSyncFileExported
version 0.9.0
모션 싱크 설정 파일을 내보낼 때 알림 설정을 수행합니다.
Version | Request | Response | Event | ErrorType |
---|---|---|---|---|
0.9.0 | Enabled:Boolean | Accepted:Boolean | Path:String, ModelFilePath:String | InvalidData |
NotifyChangeEditMode
version 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 | 플러그인 등록이 완료되지 않았습니다. | 0.9.0 |
InvalidParameter | 지정된 Live2D 매개변수가 존재하지 않습니다. | 0.9.0 |
InvalidModel | 지정된 Live2D 모델이 존재하지 않습니다. | 0.9.0 |
InvalidDocument | 지정된 문서가 에디터에 존재하지 않습니다. | 0.9.0 |
InvalidView | 지정된 뷰가 존재하지 않습니다. | 0.9.0 |