EicAgent

EDITH 음성 서비스를 이용하기 위해서 외부에 제공되는 API Class.

음성서비스 사용을 위한 서버 연결, 마이크 입력 처리, 서버 응답 Parsing/Callback 연동, TTS 재생 등의 기능이 제공된다.
AgentDataListener, AgentStateListener, AsrSttListener, CommunicationDataListener, GuidanceDataListener,
NavigationDataListener, ProactiveSuggestionDataListener, QnADataListener, RadioDataListener, TtsListener,
WeatherDataListener, WelcomeDataListener 들의 interface 들를 구현하는 객체들을 등록하여 EDITH SDK 에서 발생하는 이벤트들을 앱에서 받을 수 있다.

Constructors

EicAgent

fun EicAgent(context: Context)

Functions

addAgentDataListener

fun addAgentDataListener(listener: AgentDataListener)

AgentDataLister 를 등록하여 UniversalControl, AgentArea SystemCommand, DmResponseData 이벤트가 전달된다.

addAgentStateListener

fun addAgentStateListener(listener: AgentStateListener)

AgentStateListener 를 등록하여 AgentState 관련 이벤트 정보가 전달된다.

addCargoFreezerDataListener

fun addCargoFreezerDataListener(listener: CargoFreezerDataListener)

CargoFreezerDataListener 를 등록하여 냉동기 관련 발화에 대한 응답 정보가 전달된다.

addCommunicationDataListener

fun addCommunicationDataListener(listener: CommunicationDataListener)

CommunicationDataListener 를 등록하여 전화/문자 관련 발화에 대한 응답 정보가 전달된다.

addConsoleDataListener

fun addConsoleDataListener(listener: ConsoleDataListener)

ConsoleDataListener 를 등록하여 Console 관련 발화에 대한 응답 정보가 전달된다.

addGuidanceDataListener

fun addGuidanceDataListener(listener: GuidanceDataListener)

GuidanceDataListener 를 등록하여 도움말(넛지) 정보가 전달된다.

addNavigationDataListener

fun addNavigationDataListener(listener: NavigationDataListener)

NavigationDataListener 를 등록하여 내비게이션 관련 발화에 대한 응답 정보가 전달된다.

addProactiveSuggestionDataListener

fun addProactiveSuggestionDataListener(listener: ProactiveSuggestionDataListener)

ProactiveSuggestionDataListener 를 등록하여 ProactiveSuggestion(충전소 제안) 관련 응답 정보가 전달된다.

addQnADataListener

fun addQnADataListener(listener: QnADataListener)

QnADataListener 를 등록하여 QnA 관련 발화에 대한 응답 정보가 전달된다.

addRadioDataListener

fun addRadioDataListener(listener: RadioDataListener)

RadioDataListener 를 등록하여 라디오 관련 발화에 대한 응답 정보가 전달된다.

addSttListener

fun addSttListener(listener: AsrSttListener)

AsrSttListener 를 등록하여 사용자 발화에 대한 인식 결과를 받을 수 있다.

addTtsListener

fun addTtsListener(listener: TtsListener)

TtsListener 를 등록하여 TTS 재생 상태를 받을 수 있다.

addWeatherDataListener

fun addWeatherDataListener(listener: WeatherDataListener)

WeatherDataListener 를 등록하여 날씨 관련 발화에 대한 응답 정보가 전달된다..

addWelcomeDataListener

fun addWelcomeDataListener(listener: WelcomeDataListener)

WelcomeDataListener 를 등록하여 월컴 정보가 전달된다.

clearEicSession

fun clearEicSession()

현재의 세션 정보를 초기화 한다.

clearFavoriteHomeOffice

fun clearFavoriteHomeOffice()

즐겨찾기 정보를 초기화 한다.

getCurrentDomain

fun getCurrentDomain(): String

Domain 정보를 확인한다.

getCurrentEdithStatus

fun getCurrentEdithStatus(): EdithStatus

Agent 상태를 확인한다.

getCurrentResponseType

fun getCurrentResponseType(): String

ResponseType 정보를 전달 한다.

getDestination

fun getDestination(): Address

설정된 목적지의 정보를 확인한다.

getDrivingDistance

fun getDrivingDistance(): String

차량의 남은 주행거리를 확인한다.

getIsDriving

fun getIsDriving(): Boolean

차량의 주행 상태를 확인한다.

getNaviCurrentLatitude

fun getNaviCurrentLatitude(): Double

현재 위치의 경도 정보를 확인한다.

getNaviCurrentLongitude

fun getNaviCurrentLongitude(): Double

현재 위치의 위도 정보를 확인한다.

getNaviCurrentRouteType

fun getNaviCurrentRouteType(): String

현재 경로 설정된 목적지의 경로 옵션을 확인한다.

getNaviDisplayContents

fun getNaviDisplayContents(): MutableList<Address>

서버에서 전달된 POI LIST 를 확인한다.

getNaviFavoriteHome

fun getNaviFavoriteHome(): Favorite

즐겨찾기(우리집) 정보를 확인한다.

getNaviFavoriteOffice

fun getNaviFavoriteOffice(): Favorite

즐겨찾기(회사) 정보를 확인한다.

getNaviList

fun getNaviList(): MutableList<Address>

POI LIST 정보를 확인한다.

getNaviRequestRouteOn

fun getNaviRequestRouteOn(): Boolean

현재 경로탐색중인지 여부를 확인한다.

getNaviStopBy1Destination

fun getNaviStopBy1Destination(): Address

경유지1 정보를 확인한다.

getNaviStopBy2Destination

fun getNaviStopBy2Destination(): Address

경유지2 정보를 확인한다.

getNaviTermsAgreement

fun getNaviTermsAgreement(): Boolean

네비 약관 동의 여부를 확인한다.

getRouteTypeList

fun getRouteTypeList(): MutableList<Address>

지원하는 경로 옵션 정보를 확인한다.

getSdkVersion

fun getSdkVersion(): String

SDK 버전 정보를 확인한다.

getStateOfCharge

fun getStateOfCharge(): String

차량의 남은 배터리 정보를 확인한다.

getTtsState

fun getTtsState(): Int

TTS 재생 상태를 확인한다.

getWayPoints

fun getWayPoints(): MutableList<Address>

설정된 경유지의 정보를 확인한다.

initialize

fun initialize()

EdithAgent SDK 를 초기화 동작을 하는 기능이다.

initRouteType

fun initRouteType()

설정된 경로의 옵션 정보를 "추천 경로"로 초기화 한다.

isCurrentAgentStatus

fun isCurrentAgentStatus(edithStatus: EdithStatus): Boolean

현재 Agent 상태가 앱에서 파라미터로 넣는 EdithStatus 상태와 같은 지 확인 한다.

isScrollRunning

fun isScrollRunning(): Boolean

UniversalController 중 ScrollController 가 활성화 되어 있는 지 확인 한다.

notifyConsoleDrivingModeChange

fun notifyConsoleDrivingModeChange(eventId: String)

AD Console 앱에서 수동전환이 일어날 경우 API 를 호출하여 모드 전환 상황을 서버에 전달 한다.

playTts

fun playTts(text: String)

앱에서 TTS 재생을 할 수 있는 기능이다.

release

fun release()

EDITH 음성 서비스를 종료한다.

removeAgentDataListener

fun removeAgentDataListener(listener: AgentDataListener)

앱에서 등록한 AgentDataLister 를 해제하는 기능이다.

removeAgentStateListener

fun removeAgentStateListener(listener: AgentStateListener)

앱에서 등록한 AgentStateListener 를 해제하는 기능이다.

removeCargoFreezerDataListener

fun removeCargoFreezerDataListener(listener: CargoFreezerDataListener)

앱에서 등록한 CargoFreezerDataListener 를 해제하는 기능이다.

removeCommunicationDataListener

fun removeCommunicationDataListener(listener: CommunicationDataListener)

앱에서 등록한 CommunicationDataListener 를 해제하는 기능이다.

removeConsoleDataListener

fun removeConsoleDataListener(listener: ConsoleDataListener)

앱에서 등록한 ConsoleDataListener 를 해제하는 기능이다.

removeGuidanceDataListener

fun removeGuidanceDataListener(listener: GuidanceDataListener)

앱에서 등록한 GuidanceDataListener 를 해제하는 기능이다.

removeNavigationDataListener

fun removeNavigationDataListener(listener: NavigationDataListener)

앱에서 등록한 NavigationDataListener 를 해제하는 기능이다.

removeProactiveSuggestionDataListener

fun removeProactiveSuggestionDataListener(listener: ProactiveSuggestionDataListener)

앱에서 등록한 ProactiveSuggestionDataListener 를 해제하는 기능이다.

removeQnADataListener

fun removeQnADataListener(listener: QnADataListener)

앱에서 등록한 QnADataListener 를 해제하는 기능이다.

removeRadioDataListener

fun removeRadioDataListener(listener: RadioDataListener)

앱에서 등록한 RadioDataListener 를 해제하는 기능이다.

removeSttListener

fun removeSttListener(listener: AsrSttListener)

앱에서 등록한 AsrSttListener 를 해제하는 기능이다.

removeTtsListener

fun removeTtsListener(listener: TtsListener)

앱에서 등록한 TtsListener 를 해제하는 기능이다.

removeWeatherDataListener

fun removeWeatherDataListener(listener: WeatherDataListener)

앱에서 등록한 WeatherDataListener 를 해제하는 기능이다.

removeWelcomeDataListener

fun removeWelcomeDataListener(listener: WelcomeDataListener)

앱에서 등록한 WelcomeDataListener 를 해제하는 기능이다.

requestAddWaypointsError

fun requestAddWaypointsError()

경유지 추가 시 중복된 경유지 추가로 티맵에서 에러가 발생할 경우
이러한 상황을 서버에 전달하여 사용자에게 경유지를 추가할 수 없는 상황을 알려 준다.

requestCancelButtonEvent

fun requestCancelButtonEvent()

앱의 화면에서 "취소" 버튼을 클릭 시 이벤트를 서버에 전달한다.

requestChargingSuggestion

fun requestChargingSuggestion()

전기차 단말에서 Low 배터리 상황인 경우 근처 충전소룰 사용자에게 제공하게 된다.

requestChargingSuggestionAfterGuide

fun requestChargingSuggestionAfterGuide(isWayPoint: Boolean)

전기차 단말에서 목적지를 설정할 때 목적지 도착까지 배터리가 0% 가 되는 상황인 경우 근처 충전소룰 사용자에게 제공하게 된다.

requestCompletedEventForNavi

fun requestCompletedEventForNavi(secTime: Int = 0, meter: Int = 0, fare: Int = 0, isWayPoint: Boolean = false)

목적지 설정이 될 때 도착 정보(시간, 거리, 요금)를 서버에 전달 한다.

requestConfirmCarTipsButtonEvent

fun requestConfirmCarTipsButtonEvent(qid: String)

웰컴 도메인이 지원되는 서비스에서 웰컴 요청 후 서버로 부터 CarTip 응답이 왔을 때 앱에서 CarTip 상세 보기를 위한 버튼이 지원될 경우 버튼 클릭 시 서버로 이벤트를 전달한다.

requestConfirmNoButtonEvent

fun requestConfirmNoButtonEvent()

앱의 화면에서 "아니" 버튼을 클릭 시 이벤트를 서버에 전달한다.

requestConfirmYesButtonEvent

fun requestConfirmYesButtonEvent()

앱의 화면에서 "전화해", "보내줘", "그래" 등 버튼을 클릭 시 이벤트를 서버에 전달한다.

requestGuidance

fun requestGuidance(onComplete: (ResponseGuidanceListData) -> Unit, onFailed: (ResponseGuidanceListData) -> Unit)

도움말/넛지를 지원하는 앱일 경우 도움말 정보를 서버로 부터 받기 위해서 요청한다.

requestMsgBodyEvent

fun requestMsgBodyEvent()

문자 화면에서 문자 내용 터치 할 때 DM 서버로 이벤트를 요청한다.

requestNextMessageEvent

fun requestNextMessageEvent(messageId: String, senderName: String, contactNumber: String, messageBody: String)

"문자 읽어줘" 발화 이후 읽지 않은 문자가 2개 이상인 경우, 첫 번째 문자 정보 응답 시점에
이후 읽지 않은 문자 정보를 서버가 알 수 없기 때문에 앱에서 다음 문자 정보를 업데이트하여 서버에 요청한다.

requestReplyButtonEvent

fun requestReplyButtonEvent()

앱에서 "답장하기" 버튼을 클릭시 서버에 요청한다.

requestRouteOver1000km

fun requestRouteOver1000km()

경로 설정 시 전체 경로 거리가 1000km 이상을 경우 네비 서비스에서 경로 설정을 할 수 없는 상황이 된다.

requestRouteServerError

fun requestRouteServerError()

경로 설정 시 네비 서비스에서 경로 설정 에러가 발생할 경우
이러한 상황을 서버에 전달하여 사용자에게 경로 설정을 할 수 없는 상황을 알려 준다.

requestRouteTimeoutError

fun requestRouteTimeoutError()

경로 설정 시 네비 서비스에서 응답을 받지 못하는 경우
이러한 상황을 서버에 전달하여 사용자에게 경로 설정을 할 수 없는 상황을 알려 준다.

requestSelectedIndex

fun requestSelectedIndex(index: Int)

앱에서 리스트 화면에서 리스트 아이템 선택 시 몇 번째 아이템이 선택되었는 지를 서버로 이벤트를 전달한다.

requestSilence

fun requestSilence()

앱에서 마이크가 열려 있는 상태에서 미발화 시 서버로 이벤트를 전달한다.

requestSpeechStream

fun requestSpeechStream()

앱에서 음성 에이전트를 활성화하여 ListeningPassive 상태가 앱으로 전달되면
음성 인식 시작을 할 수 있도록 gRPC Speech Stream 을 호출한다.

requestTouchText

fun requestTouchText(text: String)

도움말 리스트에서 리스트 아이템 선택 시 선택 된 리스트의 텍스트 내용을 전달한다.

requestUnlockPrivacyModeFail

fun requestUnlockPrivacyModeFail()

AVN 장비에서 개인정보설정잠금 해제를 실행 한 후 해제가 실패됐을 때 서버에 결과를 전달한다.

requestUnlockPrivacyModeSuccess

fun requestUnlockPrivacyModeSuccess()

AVN 장비에서 개인정보설정잠금 해제를 실행 한 후 해제 완료됐을 때 서버에 결과를 전달한다.

requestUnreadMessageEvent

fun requestUnreadMessageEvent(messageId: String, senderName: String, contactNumber: String, messageBody: String)

"문자 읽어줘" 발화 시 DM/NLG 에서 응답을 전달하는데 발화 시점에 현재 읽지 않은 문자 정보를 서버가 알수 없기 때문
앱에서 문자 정보를 업데이트하여 서버에 요청한다.

requestWelcome

fun requestWelcome()

앱에서 웰컴 UI 를 구성하고자 할때 요청한다.

sendASR

fun sendASR(value: String)

앱에서 버튼이나 리스트 클릭 시 선택된 text 를 서버로 전달한다.

setEicContextInfo

fun setEicContextInfo(cmd: EicContextCommand, value: Any? = null)

앱에서 Header Context 정보를 업데이트 한다.

fun setEicContextInfo(deviceId: String, projectName: String, projectVersion: String, deviceType: EicContextType.DeviceType, serviceName: EicContextType.ServiceName, serviceType: EicContextType.ServiceType, language: String = "ko", carCode: String)

EDITH 음성 서비스를 사용하기 위해서 앱으로 부터 필수적으로 전달되어야 하는 정보를 업데이트한다.

setEicServer

fun setEicServer(info: Pair<Int, String>, onComplete: () -> Unit = {})

음성 서비스 연결 서버 정보를 설정한다.

setEicTestServer

fun setEicTestServer(url: String)

테스트 서버 URL 을 설정한다.

setEnableBargeIn

fun setEnableBargeIn(enable: Boolean)

BargeIn 기능을 지원하는 앱에서 활성화 한다.

setEnableDummy

fun setEnableDummy(enable: Boolean)

더미 기능을 활성화/비활성화시킨다default : false

setEnableSpeechSourceSeparation

fun setEnableSpeechSourceSeparation(enable: Boolean)

멀티 화자 기능을 지원하는 앱에서 활성화 한다.

setEnvContextInfo

fun setEnvContextInfo(cmd: EnvContextCommand, value: Any? = null)

앱에서 Environment Context 정보를 업데이트 한다.

setForegroundAppContextInfo

fun setForegroundAppContextInfo(cmd: ForegroundAppContextCommand, value: Any? = null)

앱에서 ForegroundApp Context 정보를 업데이트 한다.

setGRPCKeepAliveTime

fun setGRPCKeepAliveTime(time: Long, unit: TimeUnit, info: Pair<Int, String>, onComplete: () -> Unit = {})

KeepAliveTime 시간을 앱에서 설정할 수 있다.

setLanguageModelContextInfo

fun setLanguageModelContextInfo(cmd: LanguageModelContextCommand, value: Any? = null)

앱에서 LanguageModel Context 정보를 업데이트 한다.

setMobileContextInfo

fun setMobileContextInfo(cmd: MobileInfoContextCommand, value: Any? = null)

앱에서 MobileInfo Context 정보를 업데이트 한다.

setNaviContextInfo

fun setNaviContextInfo(cmd: NaviContextCommand, value: Any? = null)

앱에서 내비게이션 관련 Context 정보를 업데이트 한다.

setRadioContextInfo

fun setRadioContextInfo(cmd: RadioContextCommand, value: Any? = null)

앱에서 Radio Context 정보를 업데이트 한다.

setSpeechLanguageCode

fun setSpeechLanguageCode(code: EdithSpeechLanguageCode)

음성인식과 서버 연동을 할 때 클라이언트에서 Recognition Config 를 설정한다.

setTtsSpeaker

fun setTtsSpeaker(speaker: EdithTtsSpeakerType)

사용하고자 하는 TTS 성우 정보를 설정한다.

setUserContextInfo

fun setUserContextInfo(cmd: UserInfoContextCommand, value: Any? = null)

앱에서 UserInfo Context 정보를 업데이트 한다.

setVehicleContextInfo

fun setVehicleContextInfo(cmd: VehicleContextCommand, value: Any? = null)

앱에서 Vehicle Context 정보를 업데이트 한다.

stopTts

fun stopTts()

앱에서 TTS 재생을 멈추는 기능이다.

updateAgentToCommonError

fun updateAgentToCommonError(status: Int, message: String)

앱에서 네트워크가 연결되어 있지 않은 상화일 때 ServiceStatus 와 에러 메시지를 보낼 수 있다.

updateAgentToListeningPassive

fun updateAgentToListeningPassive()

Agent 상태를 ListeningPassive 상태로 업데이트 할 수 있다.

updateAgentToSleeping

fun updateAgentToSleeping()

Agent 상태를 Sleeping 상태로 업데이트 할 수 있다.

updateAgentToSleepingWithTouchingEnd

fun updateAgentToSleepingWithTouchingEnd()

Agent 상태를 Touching 상태로 업데이트 할 수 있다.

updateAgentToTouching

fun updateAgentToTouching()

Agent 상태를 Touching 상태로 업데이트 할 수 있다.

updateContact

fun updateContact(btId: String, contacts: List<ContactsData>)

앱에서 주소록 업로드를 한다.

updateCurrentRouteInfo

fun updateCurrentRouteInfo(secTime: Int = 0, meter: Int = 0, fare: Int = 0)

현재 설정된 경로의 도착 정보(시간, 거리, 요금)를 업데이트 한다.

updateDefaultController

fun updateDefaultController()

UniversalController 중 DefaultController 를 활성화 한다.

updateDestinationData

fun updateDestinationData(secTime: Int = 0, meter: Int = 0, fare: Int = 0)

목적지 추가 시 도착 정보(시간, 거리, 요금)를 업데이트 한다.

updateWayPointData

fun updateWayPointData(secTime: Int = 0, meter: Int = 0, fare: Int = 0)

경유지 추가 시 도착 정보(시간, 거리, 요금)를 업데이트 한다.

EicAgent

See also

Constructors

Functions