Klleon Chat SDK
Korean
Korean
  • ✨New Javascript SDK [1.2.0]
    • 시작하기
    • 이벤트
    • UI
    • 메서드
      • 라이프 사이클 메서드
      • 텍스트 대화
      • 음성대화
      • 에코 대화
      • 오디오 에코 대화
      • 기타 메서드
    • 타입스크립트 지원
    • 예제
      • VanillaJS
      • React
      • Nextjs
    • 로그 시스템
    • 업데이트 내역
  • JavaScript SDK [v0.x.x] (deprecated 예정)
    • 시작하기
    • 초기화
    • 아바타 스트리밍
      • 스트리밍 시작하기
      • 스트리밍 중단
      • 스트리밍 화면 출력 제어
    • 채팅 화면
    • 텍스트 메시지
    • 보이스 메시지
    • 에코 - 발화
    • 이벤트 구독
    • 업데이트 내역
  • 서비스 호출 구조
Powered by GitBook
LogoLogo

Products

  • Pricing

Websites

  • Homepage
  • Youtube
  • Linkedin

Copyright © Klleon. All rights reserved

On this page
  • SDK Summary
  • 1. 플랫폼
  • 2. SDK 설치
  • 3. SDK 초기화
  • 4. 주요 기능
  • 5. 예제
  • 6. 타입스크립트 지원
  • 7. 로그 시스템

New Javascript SDK [1.2.0]

Next시작하기

Last updated 4 months ago

SDK Summary

1. 플랫폼

클레온 API를 호출하기 위해 사이트 도메인 등록 필요.

도메인 등록은 의 SDK 관리에서 가능.

문제 발생 시 partnership@klleon.io로 문의.

2. SDK 설치

JavaScript SDK 파일을 웹 페이지에 포함.

script 태그에 SDK 버전 명시.

<script src="https://web.sdk.klleon.io/1.0.0/klleon-chat.umd.js"></script>

3. SDK 초기화

init() 메서드를 사용해 초기화.

필수 옵션:

  • sdk_key

  • avatar_id

window.KlleonChat.init({
  sdk_key: "your sdk key",
  avatar_id: "your avatar id",
});

4. 주요 기능

이벤트 핸들러

  1. onChatEvent: 채팅 이벤트 처리

  2. onStatusEvent: 상태 이벤트 처리

UI 컴포넌트

  1. <avatar-container />: 아바타 Web Component 스트리밍 렌더링

  2. <chat-container />: 채팅 Web Component 렌더링

라이프 사이클 메서드

  1. init: sdk를 초기화하여 소켓과 스트리밍을 연결

  2. destroy:SDK 종료 및 리소스 정리

채팅 메서드

  1. sendTextMessage: 텍스트 메시지 전송

  2. echo:메시지 에코 기능

  3. startStt / endStt: 음성 메시지 녹음 및 전송

기타 메서드

  1. changeAvatar: 아바타 변경.

  2. clearMessageList: 메시지 목록 초기화.

  3. stopSpeech: 아바타 발화 중단

5. 예제

6. 타입스크립트 지원

7. 로그 시스템

: SDK 타입 정의후 tsconfig.json에 적용

✨
클레온 스튜디오
VanillaJS
React
NestJS
KlleonSdk.d.ts
로그 목록
로그 타입
로그 레벨 포함 관계