API 전체 보기 - GiGAGenie-ServiceSDK/UserGuide GitHub Wiki

1. API 초기화 (Namespace: gigagenie)

순번 서비스명 설명 비고 바로가기
1 API 초기화 GiGA Genie Service API 를 초기화 한다. Web → Native gigagenie.init
2 화자인식된 ContainerId로 변경 화자인식된 ContainerId로 App 실행 환경을 변경한다. Web → Native gigagenie.init.changeContainerId
3 Application Pause/Resume Event API 어플리케이션이 Pause 되거나 Resume 될 경우에 이벤트를 알려준다. Native → Web gigagenie.init.onAppStatusChange
4 Background Action
실행
Full/Overlay ActionCode에서 실행중인 웹에서 Background Action 을 실행한다. Web → Native gigagenie.init.startBgAction
5 Background Action
중지
Full/Overlay ActionCode에서 실행중인 웹에서 실행중인 Background Action 을 중지한다. Web → Native gigagenie.init.stopBgAction
6 Background Action
확인
Full/Overlay ActionCode에서 현재 실행중인 background action 을 조회한다. Web → Native gigagenie.init.checkBgAction
7 Foreground Action
실행
Background 에서 실행중인 웹에서 Foreground action을 실행한다. Web → Native gigagenie.init.startFgAction
8 Foreground Action
중지
Background 에서 실행중인 웹에서 Foreground action을 중지한다. Web → Native gigagenie.init.stopFgAction
9 Foreground Action
확인
Background 에서 실행중인 웹에서 Foreground action을 조회한다. Web → Native gigagenie.init.checkFgAction
10 Foreground 함수 호출 Background Action 에서 Foreground 에 등록된 gigagenie.init.onFgCall 함수를 호출한다. Web → Native gigagenie.init.fgCall
11 Foreground 호출 함수 등록 11번에서 호출되기 위한 Foreground Action의 함수를 등록한다 Native → Web gigagenie.init.onFgCall
12 Background 함수 호출 Foreground Action 에서 Background 에 등록된 gigagenie.init.onBgCall 함수를 호출한다. Web → Native gigagenie.init.bgCall
13 Background 호출 함수 등록 13번에서 호출되기 위한 Foreground Action의 함수를 등록한다 Native → Web gigagenie.init.onBgCall
14 다른 app 호출 다른 app 을 호출한다. Web → Native gigagenie.init.runApp

2. Voice API 리스트 정보 (Namespace: gigagenie.voice)

순번 서비스명 설명 비고 바로가기
1 음성 인식 요청 사용자에게 안내를 하고 음성 인식 대기한다. Web → Native

voice.getVoiceText

2 TTS 입력 입력 Text를 사용자에게 TTS로 전달한다. Web → Native

voice.sendTTS

3 음성 명령 수신 이전페이지, 다음페이지 음성 명령 코드를 수신한다. Native → Web

voice.onVoiceCommand

4 음성 명령 수신 설정 KWS 이후 번호 선택과 확인/취소 등을 웹에 전달하도록 설정한다. Web → Native

voice.setKwsVoiceRecv

5 음성 선택 번호 수신 사용자가 특정 번호를 발화하면 발화된 번호를 수신한다. Native → Web

voice.onSelectedIndex

6 서비스 종료 요청 수신 음성명령(종료), 리모컨 나가기 키 수신 시 서비스 종료 요청을 전달한다. Native → Web

voice.onRequestClose

7 서비스 종료처리 완료 서비스 종료 요청에 대한 내부 종료 처리가 완료되었음을 알린다. Web → Native

voice.svcFinished

8 Action 수신 대화에서 현재 실행중인 앱의 ActionCode (대화 SDK: Intent명) 수신시 해당 Action 을 전달한다. Native → Web

voice.onActionEvent

9 TTS 중단 TTS를 중단한다. Web → Native

voice.stopTTS

10 음성 필터 설정 Keyword Spotting(예: 기가지니), 이후 발화 내용 중 App에서 Catch하고자 하는 단어를 설정한다. Web → Native

voice.setVoiceFilter

11 음성 필터 삭제 음성 필터 설정을 제거한다. Web → Native

voice.resetVoiceFilter

12 음성 필터 결과 수신 음성 필터에 설정한 단어가 발화 내용에 포함될 경우 콜백으로 전달한다. Native → Web

voice.onVoiceFilterMsg

13 화자식별 목소리 등록 수신 화자식별/인증 목소리 등록 결과를 수신한다. Native → Web

voice.onRegToneResults

14 음성인식 도메인 설정 음성인식 도메인을 설정한다. Native → Web

voice.setVoiceRecogDomain

15 도메인설정 타임아웃 수신 도메인 설정 타임아웃 이벤트를 수신한다. Native → Web

voice.onVocDomainTimeout

3. 통화 API 리스트 정보 (Namespace: gigagenie.call)

순번 서비스명 설명 비고 바로가기
1 통화 요청 입력한 번호로 GiGA Genie 의 통화 서비스를 요청한다. Web → Native

call.requestCall

4. 데이터 관리 (Namespace: gigagenie.appdata)

순번 서비스명 설명 비고 바로가기
1 데이터네임스페이스 생성 API G-Box 의 특정 앱에 네임스페이스를 생성한다. Web → Native

appdata.createNameSpace

2 데이터네임스페이스 삭제 API G-Box 의 특정 앱에 생성된 네임스페이스를 삭제한다. Web → Native

appdata.destroyNameSpace

3 데이터조회 API G-Box 의 특정 앱의 특정 네임스페이스의 특정 Key 에 대한 데이터를 조회한다. Web → Native

appdata.getKeyData

4 데이터설정 API G-Box 의 특정 앱의 특정 네임스페이스의 특정 Key 에 대한 데이터를 설정한다. Web → Native

appdata.setKeyData

5 데이터삭제 API G-Box 의 특정 앱의 특정 네임스페이스의 특정 Key 에 대한 Key-Data 를 삭제한다. Web → Native

appdata.delKeyData

6 Key 찾기 API G-Box 의 특정 앱/네임스페이스에서 text 로 Key 를 조회한다. Web → Native

appdata.findKeys

5. G-Box 정보 관리 (Namespace: gigagenie.appinfo)

※ 현재 대기/동작 모드 전환 API는 제공되지 않습니다.
대신에 화면을 활용하려면 TTS API를 활용하여 TV를 키라는 안내 멘트는 제공 가능합니다.

순번 서비스명 설명 비고 바로가기
1 AppID 조회 G-Box 의 해당 App 에 대한 ID 를 조회한다. Web → Native

appinfo.getContainerId

2 AuthKey 조회 G-Box 의 해당 App 에 설정된 AuthKey 를 조회한다. Web → Native

appinfo.getAuthKey

3 AuthKey 설정 G-Box 의 해당 App 의 AuthKey 를 설정한다. Web → Native

appinfo.setAuthKey

4 AuthKey 삭제 G-Box 의 해당 App 의 AuthKey 를 삭제한다. Web → Native

appinfo.delAuthKey

5 Push 보내기 Companion App 또는 다른 G-Box 에 Push 메시지를 보낸다. Web → Native → Mobile App

appinfo.sendPushMsg

6 Screen 제한 조회 API Screen 이용이 제한되는지 조회한다. Web → Native

appinfo.getScreenLimit

7 우리집 주소 조회 Companion App 에서 설정한 우리집 주소를 조회한다. Web → Native

appinfo.getAddress

8 User 정보 조회 ContainerID에 대한 User 정보를 조회한다. Web → Native

appinfo.getUserInfo

9 User 설정 정보 조회 사용자가 설정한 정보를 조회한다. Web → Native

appinfo.getUserSetInfo

10 주소록 조회 간편송금등을 위한 주소록을 조회한다. Web → Native

appinfo.queryAddressBook

11 상세주소 조회 Companion App 에서 설정한 우리집 상세 주소를 조회한다. Web → Native

appinfo.getAddressDetail

12 계정변경Event 수신 계정변경 이벤트를 수신한다. Native → Web

appinfo.onChangeUser

6. Media API (Namespace: gigagenie.media)

순번 서비스명 설명 비고 바로가기
1 Mute 이벤트 Mute/unMute 해제 이벤트 전달

(Mandatory)

Native → Web

media.onMuteRequest

2 소프트키보드 표시 화면에 소프트 키보드를 표시한다. Web → Native

media.showSoftKeyboard

3 리모콘키 이벤트 수신 리모콘키 이벤트를 수신한다. Native → Web

media.onRemoteKeyEvent

4 음성 녹음 API 음성 녹음 및 녹음 데이터를 전달한다. Web → Native

media.startRecordAudio

5 음성 녹음 수신 음성 녹음 API 에 의한 녹음 결과를 받는 Event Callback이다. Native → Web

media.onVoiceRecordComplete

6 음성 녹음 중지 음성 녹음을 중지한다. Web → Native

media.stopRecordAudio

7 Channel 생성 기가지니와 P2P로 데이터를 전송하기 위한 Channel을 생성한다. Web → Native

media.createChannel

8 Channel 제거 생성한 Channel을 제거한다. Web → Native

media.destroyChannel

9 WebRTC Audio 연결 생성한 channel에WebRTC 프로토콜 기반 Audio Stream 을 연결한다. Web → Native

media.startWebRTCAudio

10 WebRTC Audio 연결 해제 생성한 webrtcaudio 연결을 해제한다. Web → Native

media.stopWebRTCAudio

11 Channel 연결 유지 생성한 Channel 연결을 유지한다. Web → Native

media.keepaliveChannel

12 Channel 이벤트 수신 생성한 Channel의 이벤트를 수신한다. Native → Web

media.onChannelEvent

7. Payment API (Namespace: gigagenie.payment)

순번 서비스명 설명 비고
1 OTV 사용자 확인 OTV 결제를 위한 사용자 인증 및 상태 체크를 요청한다. Web → Native

payment.otvCheckUser

2 OTV 결제 토큰 요청 OTV 결제 토큰을 요청한다. Web → Native

payment.otvReqPayToken

3 OTV 결제 인증-결제 토큰 요청 OTV 결제를 위한 인증-결제 토큰을 요청한다. Web → Native

payment.otvReqPayTokenWithAuth

8. 영상인식API (Namespace: gigagenie.vision)

순번 서비스명 설명 비고
1 영상인식 서비스 시작 영상인식 서비스를 시작한다 Web → Native

vision.stopFaceAnalysis

2 영상인식 서비스 중지 영상인식 서비스를 중지한다. Web → Native

vision.startFaceAnalysis

3 영상인식 정보 수신 영상인식 정보를 수신한다. Native → Web

vision.onFaceAnalysisResult

9. 통계 API (Namespace: gigagenie.stat)

순번 서비스명 설명 비고 바로가기
1 Event Tracking API Tracking 하고자 하는 Event를 설정한다. Web → Native

stat.trackEvent

10. Admin API (Namespace: gigagenie.admin)

순번 서비스명 설명 비고 바로가기
1 앱 인증정보 조회 AuthKey가 설정된 앱 리스트를 조회한다. Web → Native

admin.getAuthAppList

2 앱AuthKey 정보 삭제 AuthKey가 설정된 앱 리스트를 조회한다. Web → Native

admin.delAuthKey

3 앱설정 데이터 삭제 AuthKey가 설정된 앱 리스트를 조회한다. Web → Native

admin.delAppData

4 앱 설정 정보 조회 특정 앱의 상세 정보(인증, 데이터유무)를 조회한다. Web → Native

admin.getAppSetFlag

⚠️ **GitHub.com Fallback** ⚠️