Skip to main content
Version: Latest

AIPlayer DATA

1. AIModel​

Item in getAIList() → data.ai[]. Keys are snake_case. Pass ai_name to init({ aiName }).

ParamTypeDescription
ai_nameStringRequired. Value for init({ aiName })
ai_typeStringRequired. '2D'
ai_display_nameStringOptional. UI label only
model_idStringOptional. Catalog id — not the init argument
languageStringOptional. e.g. 'ko', 'en'
thumb_urlStringOptional. Thumbnail URL

2. AIClipSet​

ParamTypeDescription
jsonObjectAIClipset json object used for GesturePlay
json.textStringA sentence to be synthesized
json.gstStringGesture name.

3. AIGesture​

ParamTypeDescription
jsonObjectAIClipset json object used for GesturePlay
json.enableSpeechBooleanA boolean indicating whether speech can be performed simultaneously to the gesture
json.gstStringGesture's name

4. AIPlayerState​

ParamTypeDescription
stateNumberAIPlayerState(NONE: 0, INITIALIZE: 1, IDLE: 2, PLAY: 3, PAUSE: 4, RELEASE: 5)

5. AIError​

ParamTypeDescription
jsonObjectAIError
json.codeAIErrorCodeAIError code number
json.messageStringAIError message

5.1. AIErrorCode​

ParamTypeDescription
codeNumberSDK band: AI_API_ERR: 10000, AI_SERVER_ERR: 11000, AI_RES_ERR: 12000, AI_INIT_ERR: 13000, INVALID_AICLIPSET_ERR: 14000, AICLIPSET_PRELOAD_ERR: 15000, AICLIPSET_PLAY_ERR: 16000, RESERVED_ERR: 17000, UNKNOWN_ERR: -1. Server codes are 0–9999 and are not those SDK bands. Common values: 1402 token expired, 1407 invalid token. 1402 is not INVALID_AICLIPSET_ERR (14000). See Troubleshooting.

6. AIEvent​

ParamTypeDescription
jsonObjectAIEvent
json.typeAIEventTypeAIEvent type number
json.clipSetAIClipSetAIClipSet related with this AIEvent

6.1. AIEventType​

ParamTypeDescription
typeNumberAIEventType( RES_LOAD_STARTED: 0, RES_LOAD_COMPLETED: 1, AICLIPSET_PLAY_PREPARE_STARTED: 2, AICLIPSET_PLAY_PREPARE_COMPLETED: 3, AICLIPSET_PRELOAD_STARTED: 4, AICLIPSET_PRELOAD_COMPLETED: 5, AICLIPSET_PRELOAD_FAILED: 6, AICLIPSET_PLAY_STARTED: 7, AICLIPSET_PLAY_COMPLETED: 8, AICLIPSET_PLAY_FAILED: 9, AI_CONNECTED: 10, AI_DISCONNECTED: 11, AICLIPSET_PLAY_BUFFERING: 12, AICLIPSET_RESTART_FROM_BUFFERING: 13, AIPLAYER_STATE_CHANGED: 14, AI_RECONNECT_ATTEMPT: 15, AI_RECONNECT_FAILED: 16, UNKNOWN: -1,)