Live2D Cubism

nizima

Editor 매뉴얼 Editor 매뉴얼
  • Editor 매뉴얼
  • 외부 애플리케이션 연동 기능
  • 외부 연동 API 목록

외부 연동 API 목록

업데이트： 2024/10/24

이 페이지에서는 UID나 파라미터 ID 등에서 외부 연동 API를 통해 에디터의 정보를 설정, 취득하는 명령이나 이벤트, 오류 타입을 소개합니다.

명령

RegisterPlugin

외부 애플리케이션을 에디터에 등록합니다.
등록이 끝나면 토큰을 반환합니다.
이 토큰은 앱과 연결되어 있으며 다음에 연결할 때 지정하여 사용자의 권한 상태를 인계할 수 있습니다.
자세한 내용은 「토큰 인증」을 참조하십시오.

VersionRequestResponseErrorType
ResponseName:String,
Token?:String,
Icon?:String,
Path?:String		Token:StringInvalidData
Name:String애플리케이션 이름(선택 사항):
독특한 이름을 지정하십시오.
다른 앱과 이름이 겹쳐도 동작에 영향을 미치지 않습니다.
Token?:String토큰:
생략되거나 등록되지 않은 토큰의 경우 RegisterPlugin은 새 토큰을 반환합니다.
지정된 토큰이 등록 완료된 경우 그 토큰을 그대로 반환합니다.
Icon?:String아이콘 PNG 이미지의 BASE64 문자열:
크기는 32×32 이상, 256×256 이하의 정사각형으로 0.5MB 이하로 합니다.
Path?:String애플리케이션의 경로 정보를 표시합니다.
주의사항

RegisterPlugin을 먼저 수행하고 사용자로부터 권한을 받지 않는 한 아래의 거의 모든 명령은 PluginNotRegistered 오류를 반환하고 API 작업을 수락하지 않습니다.

GetIsApproval

사용자가 이 앱에 대한 통신을 허용하는지 여부를 가져옵니다.
설정 대화 상자의 「허용」 체크 박스와 연동됩니다.

VersionRequestResponseErrorType
0.9.0Result:BooleanInvalidData

GetParameterValues

version 0.9.0

파라미터 ID를 지정하여 모델의 현재 파라미터 ID와 값을 가져옵니다.
파라미터 ID를 지정하지 않으면 모델의 모든 파라미터 ID와 값을 가져옵니다.
애니메이션 정보는 포함되지 않습니다.

VersionRequestResponseErrorType
0.9.0ModelUID:String,
Ids?:Array<String>		Parameters:Array<{
  Id:String,
  Value:Number
}>		InvalidData
InvalidModel

version 0.9.1

파라미터 ID를 지정하여 모델의 현재 파라미터 ID와 값을 가져옵니다.
파라미터 ID를 지정하지 않으면 모델의 모든 파라미터 ID와 값을 가져옵니다.
물리 연산, 모델 편집, 애니메이션 정보를 얻을 수 있습니다.

VersionRequestResponseErrorType
0.9.1ModelUID:String,
Ids?:Array<String>		Parameters:Array<{
  Id:String,
  Value:Number
}>		InvalidData
InvalidModel

SetParameterValues

version 0.9.0

지정된 파라미터 ID와 값을 설정합니다.
애니메이션 파일 모델에는 파라미터를 전송할 수 없습니다.

VersionRequestResponseErrorType
0.9.0ModelUID:String,
Parameters:Array<{
  Id:String,
  Value:Number
}>		InvalidData
InvalidModel
InvalidParameter

version 0.9.1

지정된 파라미터 ID와 값을 설정합니다.
애니메이션 파일의 모델에 파라미터를 전송하는 경우 모델 트랙을 선택해야 합니다.
물리 연산 에디터, 애니메이션 모델의 경우 파라미터를 즉시 반영하지 않고 Temporary에 유지됩니다.

VersionRequestResponseErrorType
0.9.1ModelUID: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 : 블렌드 셰이프

version 0.9.0

모델이 가지는 파라미터 목록을 취득합니다.
ModelUID와 DocumentUID는 선택 사항이지만 둘 중 하나는 필수입니다.
Type은 ‘0’이 일반, ‘1’이 블렌드 셰이프가 됩니다.
애니메이션 파일(.can3)의 모델이 가지는 파라미터 목록은 취득할 수 없습니다.

VersionRequestResponseErrorType
0.9.0ModelUID?: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는 빈 문자를 반환합니다.

VersionRequestResponseErrorType
0.9.1ModelUID?: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)에 포함된 모델이 가진 파라미터 목록은 취득할 수 없습니다.

VersionRequestResponseErrorType
0.9.0ModelUID?:String,
DocumentUID?:String		Groups:Array<{
  GroupUID:String,
  GroupName:String,
}>		InvalidData
InvalidModel

version 0.9.1

모델이 가지는 파라미터 그룹의 목록을 취득합니다.
ModelUID와 DocumentUID는 선택 사항이지만 둘 중 하나는 필수입니다.
애니메이션 파일에 포함된 모델의 그룹 목록을 얻으려면 모델 트랙을 선택해야 합니다.
모델이 임베디드용 모델 트랙인 경우 GroupUID는 빈 문자를 반환합니다.

VersionRequestResponseErrorType
0.9.1ModelUID?:String,
DocumentUID?:String		Groups:Array<{
  GroupUID:String,
  GroupName:String,
}>		InvalidData
InvalidModel

GetDocuments

version 0.9.0

문서의 정보를 반환합니다.
물리 연산, 모델 편집 및 종류별로 나뉘며 존재하지 않는 경우 0개의 문서 배열을 반환합니다.
1 모델을 분할 표시하면 Views가 증가합니다.

VersionRequestResponseErrorType
0.9.0PhysicsDocuments: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가 증가합니다.

VersionRequestResponseErrorType
0.9.1PhysicsDocuments: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를 지정하여 문서의 정보를 반환합니다.

VersionRequestResponseErrorType
0.9.3DocumentUID:StringPhysicsDocuments?: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를 반환합니다.

VersionRequestResponseErrorType
0.9.3DocumentUID:StringDocumentUID:StringInvalidData
InvalidDocument

GetCurrentModelUID

version 0.9.0

현재 에디터상에서 사용 중인 모델의 UID를 반환합니다.
애니메이션 파일에 포함된 모델의 UID는 취득할 수 없습니다.

VersionRequestResponseErrorType
0.9.0ModelUID:StringInvalidData
InvalidModel

version 0.9.1

현재 에디터상에서 사용 중인 모델의 UID를 반환합니다.
애니메이션 파일에 포함된 모델의 UID를 얻으려면 모델 트랙을 선택해야 합니다.

VersionRequestResponseErrorType
0.9.1ModelUID:StringInvalidData
InvalidModel

GetCurrentEditMode

version 0.9.0

현재 에디터상에서 사용 중인 편집 모드를 반환합니다.

VersionRequestResponseErrorType
0.9.0EditMode:StringInvalidData
EditMode:String편집 모드
“Physics” : 물리 연산 설정 에디터
“Modeling” : 모델 편집
“Animation” : 애니메이션 편집
“ModelingMeshEdit” : 메쉬 편집
“FormAnimation” : 폼 애니메이션 편집 ※5.1 beta1 이상

SetGlobalVersion

version 0.9.1

사용할 API 버전을 설정할 수 있습니다.
이렇게 하면 외부 애플리케이션에서 사용하는 API 버전을 고정할 수 있습니다.
설정하지 않은 경우 지정하지 않음으로 되돌릴 수 있습니다.

VersionRequestResponseErrorType
0.9.1Version?:StringInvalidData

ClearParameterValues

version 0.9.1

대상 모델로 보낸 파라미터를 지웁니다.
SetParameterValue로 보낸 파라미터는 에디터에서 Temporary에 유지됩니다.
물리 연산 에디터 또는 애니메이션의 경우 모델 업데이트 관계상 Temporary에 파라미터를 계속 유지할 수 있습니다.
Temporary에 유지한 파라미터를 명시적으로 지우려면 이 API를 사용합니다.

VersionRequestResponseErrorType
0.9.1ModelUID:StringInvalidData

GetPhysicsInfo

version 0.9.2

물리 연산 설정 에디터에서 계산 FPS를 가져옵니다.

VersionRequestResponseErrorType
0.9.2ModelUID:String,
Fps?:Number		InvalidData
InvalidModel

SendCubismLog

version 0.9.3

에디터의 로그로서 문자열을 보냅니다.
Type은 “info”, “warning”을 지정할 수 있으며 기본값은 “info”입니다.
Message의 최대 문자 길이는 5000자입니다.
Display는 로그 팔레트 표시 여부로, 생략 시 기본값을 true로 하여 로그 팔레트에 표시합니다.

VersionRequestResponseErrorType
0.9.3Type?: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

물리 연산 설정 파일을 내보낼 때의 알림을 설정합니다.

VersionRequestResponseEventErrorType
0.9.0Enabled:BooleanAccepted:BooleanPath:String,
ModelFilePath:String		InvalidData

NotifyMocFileExported

version 0.9.3

MOC3 파일을 내보낼 때의 알림을 설정합니다.
설정이 활성화되면 MOC3 파일의 정보와 관련 파일의 정보를 알림으로 제공합니다.

VersionRequestResponseEventErrorType
0.9.3Enabled:BooleanAccepted:BooleanPath:String,
ModelFilePath:String,
Files:Array<String>		InvalidData

version 0.9.0

MOC3 파일을 내보낼 때의 알림을 설정합니다.
설정이 활성화되면 MOC3 파일의 정보를 알림으로 제공합니다.

VersionRequestResponseEventErrorType
0.9.0Enabled:BooleanAccepted:BooleanPath:String,
ModelFilePath:String		InvalidData

NotifyMotionFileExported

version 0.9.0

모션 파일을 내보낼 때의 알림을 설정합니다.

VersionRequestResponseEventErrorType
0.9.0Enabled:BooleanAccepted:BooleanPath:String,
ModelFilePath:String		InvalidData

NotifyMotionSyncFileExported

version 0.9.0

모션 싱크 설정 파일을 내보낼 때의 알림을 설정합니다.

VersionRequestResponseEventErrorType
0.9.0Enabled:BooleanAccepted:BooleanPath:String,
ModelFilePath:String		InvalidData

NotifyChangeEditMode

version 0.9.0

편집 모드가 전환되었을 때의 알림을 설정합니다.
EditMode에 대한 자세한 내용은 「GetCurrentEditMode」를 참조하십시오.

VersionRequestResponseEventErrorType
0.9.0Enabled:BooleanAccepted:BooleanEditMode:StringInvalidData

오류 타입

이름설명Since
InvalidJsonJSON 구조가 올바르지 않습니다.0.9.0
UnsupportedVersion호환되지 않는 버전입니다.0.9.0
MethodNotFound지정된 명령을 찾을 수 없습니다.0.9.0
InvalidTypeType 설정이 잘못되었습니다.0.9.0
InvalidData명령의 인수가 올바르지 않습니다.
인수가 부족하거나 인수에 다른 형태를 지정했을 경우에 이 오류를 반환합니다.		0.9.0
PluginNotRegistered플러그인 등록이 완료되지 않았습니다.
플러그인 등록(RegisterPlugin), 사용자의 허가가 완료되지 않은 상태에서 명령을 요청하면 이 오류를 반환합니다.		0.9.0
InvalidParameter지정된 Live2D 파라미터가 존재하지 않습니다.0.9.0
InvalidModel지정된 Live2D 모델이 존재하지 않습니다.0.9.0
InvalidDocument지정된 문서가 에디터에 존재하지 않습니다.0.9.0
InvalidView지정된 뷰가 존재하지 않습니다.0.9.0
이 기사가 도움이 되었나요?
네아니요
이 기사에 관한 의견 및 요청사항을 보내 주시기 바랍니다.