diff --git a/doxygen/annotated.html b/doxygen/annotated.html new file mode 100644 index 0000000000..1e66aef2a9 --- /dev/null +++ b/doxygen/annotated.html @@ -0,0 +1,214 @@ + + +
+ + + + +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
►NNuguCapability | |
►NNuguClientKit | |
C_nugu_http_response | HTTP Response object |
Cnugu_audio_property | Audio property |
Cnugu_decoder_driver_ops | Decoder driver operations |
Cnugu_encoder_driver_ops | Encoder driver operations |
Cnugu_network_server_policy | Server policy information used for network connections |
Cnugu_pcm_driver_ops | Pcm driver operations |
Cnugu_player_driver_ops | Player driver operations |
Cnugu_plugin_desc | Plugin description |
Cnugu_prof_data | Profiling raw data |
Cnugu_recorder_driver_ops |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Go to the source code of this file.
++Classes | |
struct | NuguCapability::_ASRAttribute |
Attributes for setting ASR options. More... | |
class | NuguCapability::IASRHandler |
ASR handler interface. More... | |
class | NuguCapability::IASRListener |
ASR listener interface. More... | |
+Typedefs | |
typedef struct NuguCapability::_ASRAttribute | NuguCapability::ASRAttribute |
Attributes for setting ASR options. More... | |
+Enumerations | |
enum class | NuguCapability::ASRError { + RESPONSE_TIMEOUT +, LISTEN_TIMEOUT +, LISTEN_FAILED +, RECOGNIZE_ERROR +, + UNKNOWN + + } |
ASR error list. More... | |
enum class | NuguCapability::ASRInitiator { + WAKE_UP_WORD +, PRESS_AND_HOLD +, TAP +, EXPECT_SPEECH +, + EARSET + + } |
ASR initiator list. More... | |
enum class | NuguCapability::ASRState { + IDLE +, EXPECTING_SPEECH +, LISTENING +, RECOGNIZING +, + BUSY + + } |
ASR state list. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Go to the source code of this file.
++Classes | |
class | NuguCapability::IAudioPlayerDisplayListener |
audioplayer's display listener interface More... | |
class | NuguCapability::IAudioPlayerHandler |
audioplayer handler interface More... | |
class | NuguCapability::IAudioPlayerListener |
audioplayer listener interface More... | |
+Enumerations | |
enum class | NuguCapability::AudioPlayerEvent { + UNDERRUN +, LOAD_FAILED +, LOAD_DONE +, INVALID_URL +, + PAUSE_BY_DIRECTIVE +, PAUSE_BY_FOCUS +, PAUSE_BY_APPLICATION + + } |
AudioPlayerEvent. More... | |
enum class | NuguCapability::AudioPlayerState { + IDLE +, PLAYING +, STOPPED +, PAUSED +, + FINISHED + + } |
AudioPlayerState. More... | |
enum class | NuguCapability::RepeatType { NONE +, ONE +, ALL + } |
RepeatType. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <clientkit/capability_interface.hh>
Go to the source code of this file.
++Classes | |
struct | NuguCapability::_BatteryInfo |
Battery Information. More... | |
class | NuguCapability::IBatteryHandler |
battery handler interface More... | |
class | NuguCapability::IBatteryListener |
battery listener interface More... | |
+Typedefs | |
+typedef struct NuguCapability::_BatteryInfo | NuguCapability::BatteryInfo |
Battery Information. | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <clientkit/capability_interface.hh>
Go to the source code of this file.
++Classes | |
struct | NuguCapability::_BTDeviceInfo |
Bluetooth device information. More... | |
struct | NuguCapability::_BTProfile |
Bluetooth profiles information. More... | |
class | NuguCapability::IBluetoothHandler |
bluetooth handler interface More... | |
class | NuguCapability::IBluetoothListener |
bluetooth listener interface More... | |
+Typedefs | |
typedef struct NuguCapability::_BTDeviceInfo | NuguCapability::BTDeviceInfo |
Bluetooth device information. More... | |
typedef struct NuguCapability::_BTProfile | NuguCapability::BTProfile |
Bluetooth profiles information. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <algorithm>
#include <memory>
#include <string>
#include <vector>
#include <base/nugu_event.h>
#include <base/nugu_network_manager.h>
#include <clientkit/capability_interface.hh>
Go to the source code of this file.
++Classes | |
class | NuguClientKit::Capability |
Capability. More... | |
class | NuguClientKit::CapabilityEvent |
CapabilityEvent. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <clientkit/capability_interface.hh>
Go to the source code of this file.
++Classes | |
class | NuguCapability::CapabilityFactory |
CapabilityFactory. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <list>
#include <njson/njson.h>
#include <base/nugu_event.h>
#include <clientkit/directive_sequencer_interface.hh>
#include <clientkit/focus_manager_interface.hh>
#include <clientkit/interaction_control_manager_interface.hh>
#include <clientkit/playsync_manager_interface.hh>
#include <clientkit/routine_manager_interface.hh>
#include <clientkit/session_manager_interface.hh>
Go to the source code of this file.
++Classes | |
class | NuguClientKit::ICapabilityHelper |
CapabilityHelper interface. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <functional>
#include <list>
#include <njson/njson.h>
#include <set>
#include <string>
#include <base/nugu_directive.h>
#include <clientkit/nugu_core_container_interface.hh>
Go to the source code of this file.
++Classes | |
struct | NuguClientKit::_DirectiveCancelPolicy |
Policy about canceling directives which are belong to the specific dialog id. More... | |
class | NuguClientKit::ICapabilityInterface |
capability interface More... | |
class | NuguClientKit::ICapabilityListener |
capability listener interface More... | |
+Typedefs | |
+typedef struct NuguClientKit::_DirectiveCancelPolicy | NuguClientKit::DirectiveCancelPolicy |
Policy about canceling directives which are belong to the specific dialog id. | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <clientkit/capability_interface.hh>
Go to the source code of this file.
++Classes | |
struct | NuguCapability::_ChipsInfo |
Model for holding chips Info. More... | |
struct | NuguCapability::_ChipsInfo::Content |
class | NuguCapability::IChipsHandler |
chips handler interface More... | |
class | NuguCapability::IChipsListener |
chips listener interface More... | |
+Typedefs | |
typedef struct NuguCapability::_ChipsInfo | NuguCapability::ChipsInfo |
Model for holding chips Info. More... | |
+Enumerations | |
enum class | NuguCapability::ChipsTarget { DM +, LISTEN +, SPEAKING + } |
Chips Target. More... | |
enum class | NuguCapability::ChipsType { NUDGE +, ACTION +, GENERAL + } |
Chips Type. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::CapabilityFactory, including all inherited members.
+CapabilityFactory()=delete (defined in NuguCapability::CapabilityFactory) | NuguCapability::CapabilityFactory | |
makeCapability(ICapabilityListener *listener=nullptr) | NuguCapability::CapabilityFactory | static |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <capability_factory.hh>
+Static Public Member Functions | |
template<typename T , typename V > | |
static V * | makeCapability (ICapabilityListener *listener=nullptr) |
Create capability agent instance and return related capability handler. More... | |
+
|
+ +static | +
Create capability agent instance and return related capability handler.
+[in] | T | capability agent class type |
[in] | V | capability handler class type |
[in] | listener | capability listener instance |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IASRHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
ASR handler interface. + More...
+ +#include <asr_interface.hh>
+Public Types | |
using | AsrRecognizeCallback = std::function< void(const std::string &dialog_id)> |
ASR recognize callback for user request and response mapping. More... | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
+Public Member Functions | |
virtual void | addListener (IASRListener *listener)=0 |
Add the Listener object. More... | |
+virtual void | finishRecognition ()=0 |
Finish audio recording and request recognition by a user. | |
virtual EpdAttribute | getEpdAttribute ()=0 |
Get EPD attribute. More... | |
virtual void | removeListener (IASRListener *listener)=0 |
Remove the Listener object. More... | |
virtual void | setAttribute (ASRAttribute &&attribute)=0 |
Set attribute about speech recognition. More... | |
virtual void | setEpdAttribute (EpdAttribute &&attribute)=0 |
Set EPD attribute. More... | |
virtual void | startRecognition (ASRInitiator initiator=ASRInitiator::TAP, AsrRecognizeCallback callback=nullptr)=0 |
Turn on the microphone and start speech recognition. More... | |
virtual void | startRecognition (float power_noise, float power_speech, ASRInitiator initiator=ASRInitiator::TAP, AsrRecognizeCallback callback=nullptr)=0 |
Turn on the microphone and start speech recognition (support multi-wakeup) More... | |
virtual void | stopRecognition (bool cancel=false)=0 |
Turn off the microphone and stop speech recognition. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
ASR handler interface.
+using NuguCapability::IASRHandler::AsrRecognizeCallback = std::function<void(const std::string& dialog_id)> | +
ASR recognize callback for user request and response mapping.
+[in] | dialog_id | event request dialog id |
+
|
+ +pure virtual | +
Turn on the microphone and start speech recognition (support multi-wakeup)
+[in] | power_noise | min wakeup power value |
[in] | power_speech | max wakeup power value |
[in] | initiator | asr initiator |
[in] | callback | asr recognize callback |
+
|
+ +pure virtual | +
Turn on the microphone and start speech recognition.
+[in] | initiator | asr initiator |
[in] | callback | asr recognize callback |
+
|
+ +pure virtual | +
Turn off the microphone and stop speech recognition.
+[in] | cancel | If true, cancel the directives to be received for current dialog |
+
|
+ +pure virtual | +
Add the Listener object.
+[in] | listener | listener object |
+
|
+ +pure virtual | +
Remove the Listener object.
+[in] | listener | listener object |
+
|
+ +pure virtual | +
Set attribute about speech recognition.
+[in] | attribute | attribute object |
+
|
+ +pure virtual | +
Set EPD attribute.
+[in] | attribute | EPD attribute |
+
|
+ +pure virtual | +
Get EPD attribute.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IASRListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
onCancel(const std::string &dialog_id)=0 | NuguCapability::IASRListener | pure virtual |
onComplete(const std::string &text, const std::string &dialog_id)=0 | NuguCapability::IASRListener | pure virtual |
onError(ASRError error, const std::string &dialog_id, bool listen_timeout_fail_beep=true)=0 | NuguCapability::IASRListener | pure virtual |
onNone(const std::string &dialog_id)=0 | NuguCapability::IASRListener | pure virtual |
onPartial(const std::string &text, const std::string &dialog_id)=0 | NuguCapability::IASRListener | pure virtual |
onState(ASRState state, const std::string &dialog_id, ASRInitiator initiator)=0 | NuguCapability::IASRListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~IASRListener()=default (defined in NuguCapability::IASRListener) | NuguCapability::IASRListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
ASR listener interface. + More...
+ +#include <asr_interface.hh>
+Public Member Functions | |
virtual void | onCancel (const std::string &dialog_id)=0 |
Speech recognition is canceled. More... | |
virtual void | onComplete (const std::string &text, const std::string &dialog_id)=0 |
Speech recognition results which are reported naturally in situations based on the entire speech. More... | |
virtual void | onError (ASRError error, const std::string &dialog_id, bool listen_timeout_fail_beep=true)=0 |
Report an error occurred during speech recognition to the user. More... | |
virtual void | onNone (const std::string &dialog_id)=0 |
No speech recognition results. More... | |
virtual void | onPartial (const std::string &text, const std::string &dialog_id)=0 |
The result of recognizing the user's speech in real time. More... | |
virtual void | onState (ASRState state, const std::string &dialog_id, ASRInitiator initiator)=0 |
Report to the user asr state changed. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
ASR listener interface.
+
+
|
+ +pure virtual | +
Report to the user asr state changed.
+[in] | state | asr state |
[in] | dialog_id | dialog request id |
[in] | initiator | asr initiator |
+
|
+ +pure virtual | +
No speech recognition results.
+[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
The result of recognizing the user's speech in real time.
+[in] | text | Speech recognition result |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
Speech recognition results which are reported naturally in situations based on the entire speech.
+[in] | text | Speech recognition result |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
Report an error occurred during speech recognition to the user.
+[in] | error | ASR error |
[in] | dialog_id | dialog request id |
[in] | listen_timeout_fail_beep | whether to play fail beep or not when listen-timeout occurred |
+
|
+ +pure virtual | +
Speech recognition is canceled.
+[in] | dialog_id | dialog request id |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IAudioPlayerDisplayListener, including all inherited members.
+clearDisplay(const std::string &id, bool unconditionally, bool has_next)=0 | NuguCapability::IDisplayListener | pure virtual |
controlDisplay(const std::string &id, ControlType type, ControlDirection direction)=0 | NuguCapability::IDisplayListener | pure virtual |
getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
hideLyrics(const std::string &id)=0 | NuguCapability::IAudioPlayerDisplayListener | pure virtual |
renderDisplay(const std::string &id, const std::string &type, const std::string &json_payload, const std::string &dialog_id)=0 | NuguCapability::IDisplayListener | pure virtual |
requestLyricsPageAvailable(const std::string &id, bool &visible)=0 | NuguCapability::IAudioPlayerDisplayListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
showLyrics(const std::string &id)=0 | NuguCapability::IAudioPlayerDisplayListener | pure virtual |
updateDisplay(const std::string &id, const std::string &json_payload)=0 | NuguCapability::IDisplayListener | pure virtual |
updateMetaData(const std::string &id, const std::string &json_payload)=0 | NuguCapability::IAudioPlayerDisplayListener | pure virtual |
~IAudioPlayerDisplayListener()=default (defined in NuguCapability::IAudioPlayerDisplayListener) | NuguCapability::IAudioPlayerDisplayListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~IDisplayListener()=default (defined in NuguCapability::IDisplayListener) | NuguCapability::IDisplayListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
audioplayer's display listener interface + More...
+ +#include <audio_player_interface.hh>
+Public Member Functions | |
virtual bool | hideLyrics (const std::string &id)=0 |
Request to the user to hide the lyrics page. More... | |
virtual bool | requestLyricsPageAvailable (const std::string &id, bool &visible)=0 |
SDK request information about device's lyrics page available. More... | |
virtual bool | showLyrics (const std::string &id)=0 |
Request to the user to show the lyrics page. More... | |
virtual void | updateMetaData (const std::string &id, const std::string &json_payload)=0 |
Request to update metadata the current display. More... | |
Public Member Functions inherited from NuguCapability::IDisplayListener | |
virtual bool | clearDisplay (const std::string &id, bool unconditionally, bool has_next)=0 |
The SDK will ask you to delete the rendered display on the display according to the service context maintenance policy. More... | |
virtual void | controlDisplay (const std::string &id, ControlType type, ControlDirection direction)=0 |
Request to control the display with type and direction. More... | |
virtual void | renderDisplay (const std::string &id, const std::string &type, const std::string &json_payload, const std::string &dialog_id)=0 |
Request rendering by passing metadata so that the device with the display can draw on the screen. More... | |
virtual void | updateDisplay (const std::string &id, const std::string &json_payload)=0 |
Request to update the current display. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
audioplayer's display listener interface
+
+
|
+ +pure virtual | +
SDK request information about device's lyrics page available.
+[in] | id | display template id |
[out] | visible | show lyrics page visible |
+
|
+ +pure virtual | +
Request to the user to show the lyrics page.
+[in] | id | display template id |
+
|
+ +pure virtual | +
Request to the user to hide the lyrics page.
+[in] | id | display template id |
+
|
+ +pure virtual | +
Request to update metadata the current display.
+[in] | id | display template id |
[in] | json_payload | template in json format for display |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IAudioPlayerHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
audioplayer handler interface + More...
+ +#include <audio_player_interface.hh>
+Public Member Functions | |
virtual void | addListener (IAudioPlayerListener *listener)=0 |
Add the Listener object. More... | |
virtual std::string | next ()=0 |
Request the audio player to play the next content. More... | |
virtual std::string | pause (bool direct_access=false)=0 |
Request the audio player to pause the current content. More... | |
virtual std::string | play ()=0 |
Request the audio player to play the current content. More... | |
virtual std::string | prev ()=0 |
Request the audio player to play the previous content. More... | |
virtual void | removeListener (IAudioPlayerListener *listener)=0 |
Remove the Listener object. More... | |
virtual std::string | requestFavoriteCommand (bool current_favorite)=0 |
Send to request favorite command event with current favorite value. More... | |
virtual std::string | requestRepeatCommand (RepeatType current_repeat)=0 |
Send to request repeat command event with current repeat value. More... | |
virtual std::string | requestShuffleCommand (bool current_shuffle)=0 |
Send to request shuffle command event with current shuffle value. More... | |
virtual std::string | resume (bool direct_access=false)=0 |
Request the audio player to resume the current content. More... | |
virtual void | seek (int msec)=0 |
Request the audio player to move the current content section. More... | |
virtual bool | setMute (bool mute)=0 |
set media player's mute More... | |
virtual bool | setVolume (int volume)=0 |
set media player's volume More... | |
virtual std::string | stop (bool direct_access=false)=0 |
Request the audio player to stop the current content. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
Public Member Functions inherited from NuguCapability::IDisplayHandler | |
virtual void | controlTemplate (const std::string &id, TemplateControlType control_type) |
Control templates which are composed by history control. More... | |
virtual void | displayCleared (const std::string &id) |
The user reports that the display is cleared. More... | |
virtual void | displayRendered (const std::string &id, const DisplayContextInfo &context_info=DisplayContextInfo {}) |
The user reports that the display was rendered. More... | |
virtual void | elementSelected (const std::string &id, const std::string &item_token, const std::string &postback="") |
The user informs the selected item of the list and reports the token information of the item. More... | |
virtual void | informControlResult (const std::string &id, ControlType type, ControlDirection direction, bool result) |
The user informs the control result. More... | |
virtual void | refreshRenderingTimer (const std::string &id) |
Refresh display rendering hold timer. More... | |
+virtual void | removeDisplayListener (IDisplayListener *listener) |
Remove the IDisplayListener object. | |
virtual void | setDisplayListener (IDisplayListener *listener) |
Set the IDisplayListener object. More... | |
virtual void | stopRenderingTimer (const std::string &id) |
Stop display rendering hold timer. More... | |
virtual void | triggerChild (const std::string &ps_id, const std::string &data) |
Send TriggerChild event for receiving child template. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
audioplayer handler interface
+
+
|
+ +pure virtual | +
Request the audio player to play the current content.
+
+
|
+ +pure virtual | +
Request the audio player to stop the current content.
+[in] | direct_access | control mediaplayer via sending event or directly access |
+
|
+ +pure virtual | +
Request the audio player to play the next content.
+
+
|
+ +pure virtual | +
Request the audio player to play the previous content.
+
+
|
+ +pure virtual | +
Request the audio player to pause the current content.
+[in] | direct_access | control mediaplayer via sending event or directly access |
+
|
+ +pure virtual | +
Request the audio player to resume the current content.
+[in] | direct_access | control mediaplayer via sending event or directly access |
+
|
+ +pure virtual | +
Request the audio player to move the current content section.
+[in] | msec | content's position. It is moved from the current media position. |
+
|
+ +pure virtual | +
Send to request favorite command event with current favorite value.
+[in] | current_favorite | current favorite value |
+
|
+ +pure virtual | +
Send to request repeat command event with current repeat value.
+[in] | current_repeat | current repeat value |
+
|
+ +pure virtual | +
Send to request shuffle command event with current shuffle value.
+[in] | current_shuffle | current shuffle value |
+
|
+ +pure virtual | +
set media player's volume
+[in] | volume | volume level |
+
|
+ +pure virtual | +
set media player's mute
+[in] | mute | volume mute |
+
|
+ +pure virtual | +
Add the Listener object.
+[in] | listener | listener object |
+
|
+ +pure virtual | +
Remove the Listener object.
+[in] | listener | listener object |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IAudioPlayerListener, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
audioplayer listener interface + More...
+ +#include <audio_player_interface.hh>
+Public Member Functions | |
virtual void | durationChanged (int duration)=0 |
The audio player reports the total duration of the content being played to the user. More... | |
virtual void | favoriteChanged (bool favorite, const std::string &dialog_id)=0 |
The audio player reports to the user the current content's favorite setting changed. More... | |
+virtual void | mediaEventReport (AudioPlayerEvent event, const std::string &dialog_id)=0 |
The audio player reports player's event being played to the user. | |
virtual void | mediaStateChanged (AudioPlayerState state, const std::string &dialog_id)=0 |
Report this to the user when the state of the audio player changes. More... | |
virtual void | positionChanged (int position)=0 |
The audio player reports to the user the current playing time of the content being played. More... | |
virtual void | repeatChanged (RepeatType repeat, const std::string &dialog_id)=0 |
The audio player reports to the user the current content's repeat setting changed. More... | |
virtual void | requestContentCache (const std::string &key, const std::string &playurl)=0 |
The audio player request to the user to cache the content if possible. More... | |
virtual bool | requestToGetCachedContent (const std::string &key, std::string &filepath)=0 |
The audio player request to the user to get the cached content. More... | |
virtual void | shuffleChanged (bool shuffle, const std::string &dialog_id)=0 |
The audio player reports to the user the current content's shuffle setting changed. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
audioplayer listener interface
+
+
|
+ +pure virtual | +
Report this to the user when the state of the audio player changes.
+[in] | state | audioplayer's state |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
The audio player reports the total duration of the content being played to the user.
+[in] | duration | media content's duration |
+
|
+ +pure virtual | +
The audio player reports to the user the current playing time of the content being played.
+[in] | position | media content's position |
+
|
+ +pure virtual | +
The audio player reports to the user the current content's favorite setting changed.
+[in] | favorite | media content's favorite |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
The audio player reports to the user the current content's shuffle setting changed.
+[in] | shuffle | media content's shuffle |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
The audio player reports to the user the current content's repeat setting changed.
+[in] | repeat | media content's repeat |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
The audio player request to the user to cache the content if possible.
+[in] | key | content's unique key |
[in] | playurl | content's playurl |
+
|
+ +pure virtual | +
The audio player request to the user to get the cached content.
+[in] | key | content's unique key |
[out] | filepath | cached content's filepath |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IBatteryHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
battery handler interface + More...
+ +#include <battery_interface.hh>
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
battery handler interface
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IBatteryListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
requestContext(BatteryInfo &battery_info)=0 | NuguCapability::IBatteryListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~IBatteryListener()=default (defined in NuguCapability::IBatteryListener) | NuguCapability::IBatteryListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
battery listener interface + More...
+ +#include <battery_interface.hh>
+Public Member Functions | |
virtual void | requestContext (BatteryInfo &battery_info)=0 |
Request context information for battery context. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
battery listener interface
+
+
|
+ +pure virtual | +
Request context information for battery context.
+[in] | battery_info | battery information |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IBluetoothHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
bluetooth handler interface + More...
+ +#include <bluetooth_interface.hh>
+Public Member Functions | |
+virtual void | connectFailed ()=0 |
Notify the fail result of connect device. | |
+virtual void | connectSucceeded ()=0 |
Notify the success result of connect device. | |
+virtual void | disconnectFailed ()=0 |
Notify the fail result of disconnect device. | |
+virtual void | disconnectSucceeded ()=0 |
Notify the success result of disconnect device. | |
+virtual void | finishDiscoverableModeFailed ()=0 |
Notify the fail result of finish discoverable mode. | |
+virtual void | finishDiscoverableModeSucceeded ()=0 |
Notify the success result of finish discoverable mode. | |
+virtual void | mediaControlNextFailed ()=0 |
Notify the fail result of playing next media. | |
+virtual void | mediaControlNextSucceeded ()=0 |
Notify the success result of playing next media. | |
+virtual void | mediaControlPauseFailed ()=0 |
Notify the fail result of pausing media. | |
+virtual void | mediaControlPauseSucceeded ()=0 |
Notify the success result of pausing media. | |
+virtual void | mediaControlPlayFailed ()=0 |
Notify the fail result of playing media. | |
+virtual void | mediaControlPlaySucceeded ()=0 |
Notify the success result of playing media. | |
+virtual void | mediaControlPreviousFailed ()=0 |
Notify the fail result of playing previous media. | |
+virtual void | mediaControlPreviousSucceeded ()=0 |
Notify the success result of playing previous media. | |
+virtual void | mediaControlStopFailed ()=0 |
Notify the fail result of stopping media. | |
+virtual void | mediaControlStopSucceeded ()=0 |
Notify the success result of stopping media. | |
virtual void | setAudioPlayerState (const std::string &state)=0 |
Notify the audio player's state. More... | |
virtual void | startDiscoverableModeFailed (bool has_paired_devices)=0 |
Notify the fail result of start discoverable mode. More... | |
virtual void | startDiscoverableModeSucceeded (bool has_paired_devices)=0 |
Notify the success result of start discoverable mode. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
bluetooth handler interface
+
+
|
+ +pure virtual | +
Notify the audio player's state.
+state | audio player's state (INACTIVE / ACTIVE / PAUSED / UNUSABLE) |
+
|
+ +pure virtual | +
Notify the success result of start discoverable mode.
+[in] | has_paired_devices | has paired devices flag |
+
|
+ +pure virtual | +
Notify the fail result of start discoverable mode.
+[in] | has_paired_devices | has paired devices flag |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IBluetoothListener, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
bluetooth listener interface + More...
+ +#include <bluetooth_interface.hh>
+Public Member Functions | |
+virtual void | finishDiscoverableMode ()=0 |
Send command to switch discoverable off to bluetooth adaptor. | |
+virtual void | next ()=0 |
Send command to play next media to bluetooth adaptor. | |
virtual void | pause (bool by_focus=false)=0 |
Send command to pause media to bluetooth adaptor. More... | |
virtual void | play (bool by_focus=false)=0 |
Send command to play media to bluetooth adaptor. More... | |
+virtual void | previous ()=0 |
Send command to play previous media to bluetooth adaptor. | |
virtual void | requestContext (BTDeviceInfo &device_info)=0 |
Request device information for bluetooth context. More... | |
virtual void | startDiscoverableMode (long duration_sec)=0 |
Send command to switch discoverable on to bluetooth adaptor. More... | |
virtual void | stop (bool by_focus=false)=0 |
Send command to stop media to bluetooth adaptor. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
bluetooth listener interface
+
+
|
+ +pure virtual | +
Send command to switch discoverable on to bluetooth adaptor.
+[in] | duration_sec | duration time for discoverable on |
+
|
+ +pure virtual | +
Send command to play media to bluetooth adaptor.
+by_focus | request to play media to bluetooth adaptor by focus policy |
+
|
+ +pure virtual | +
Send command to stop media to bluetooth adaptor.
+by_focus | request to stop media to bluetooth adaptor by focus policy |
+
|
+ +pure virtual | +
Send command to pause media to bluetooth adaptor.
+by_focus | request to pause media to bluetooth adaptor by focus policy |
+
|
+ +pure virtual | +
Request device information for bluetooth context.
+[in] | device_info | device information |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IChipsHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
chips handler interface + More...
+ +#include <chips_interface.hh>
+Public Member Functions | |
virtual void | addListener (IChipsListener *listener)=0 |
Add the IChipsListener object. More... | |
virtual void | removeListener (IChipsListener *listener)=0 |
Remove the IChipsListener object. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
chips handler interface
+
+
|
+ +pure virtual | +
Add the IChipsListener object.
+[in] | listener | IChipsListener object |
+
|
+ +pure virtual | +
Remove the IChipsListener object.
+[in] | listener | IChipsListener object |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IChipsListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
onReceiveRender(const ChipsInfo &chips_info)=0 | NuguCapability::IChipsListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~IChipsListener()=default (defined in NuguCapability::IChipsListener) | NuguCapability::IChipsListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
chips listener interface + More...
+ +#include <chips_interface.hh>
+Public Member Functions | |
virtual void | onReceiveRender (const ChipsInfo &chips_info)=0 |
Notified when receiving Render directive from server. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
chips listener interface
+
+
|
+ +pure virtual | +
Notified when receiving Render directive from server.
+[in] | chips_info | received datas for rendering voice command guide |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IDisplayHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
display handler interface + More...
+ +#include <display_interface.hh>
+Public Member Functions | |
virtual void | controlTemplate (const std::string &id, TemplateControlType control_type) |
Control templates which are composed by history control. More... | |
virtual void | displayCleared (const std::string &id) |
The user reports that the display is cleared. More... | |
virtual void | displayRendered (const std::string &id, const DisplayContextInfo &context_info=DisplayContextInfo {}) |
The user reports that the display was rendered. More... | |
virtual void | elementSelected (const std::string &id, const std::string &item_token, const std::string &postback="") |
The user informs the selected item of the list and reports the token information of the item. More... | |
virtual void | informControlResult (const std::string &id, ControlType type, ControlDirection direction, bool result) |
The user informs the control result. More... | |
virtual void | refreshRenderingTimer (const std::string &id) |
Refresh display rendering hold timer. More... | |
+virtual void | removeDisplayListener (IDisplayListener *listener) |
Remove the IDisplayListener object. | |
virtual void | setDisplayListener (IDisplayListener *listener) |
Set the IDisplayListener object. More... | |
virtual void | stopRenderingTimer (const std::string &id) |
Stop display rendering hold timer. More... | |
virtual void | triggerChild (const std::string &ps_id, const std::string &data) |
Send TriggerChild event for receiving child template. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
display handler interface
+
+
|
+ +virtual | +
The user reports that the display was rendered.
+[in] | id | display template id |
[in] | context_info | display context information |
+
|
+ +virtual | +
The user reports that the display is cleared.
+[in] | id | display template id |
+
|
+ +virtual | +
The user informs the selected item of the list and reports the token information of the item.
+[in] | id | display template id |
[in] | item_token | parsed token from metadata |
[in] | postback | postback data if the item is selectable |
+
|
+ +virtual | +
Send TriggerChild event for receiving child template.
+[in] | ps_id | target play service id |
[in] | data | any JSON data |
+
|
+ +virtual | +
Control templates which are composed by history control.
+[in] | id | display template id |
[in] | control_type | TemplateControlType |
+
|
+ +virtual | +
The user informs the control result.
+[in] | id | display template id |
[in] | type | control type |
[in] | direction | control direction |
[in] | result | ControlFocus/ControlScroll processing result |
+
|
+ +virtual | +
Set the IDisplayListener object.
+[in] | listener | listener object |
+
|
+ +virtual | +
Stop display rendering hold timer.
+[in] | id | display template id |
+
|
+ +virtual | +
Refresh display rendering hold timer.
+[in] | id | display template id |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IDisplayListener, including all inherited members.
+clearDisplay(const std::string &id, bool unconditionally, bool has_next)=0 | NuguCapability::IDisplayListener | pure virtual |
controlDisplay(const std::string &id, ControlType type, ControlDirection direction)=0 | NuguCapability::IDisplayListener | pure virtual |
getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
renderDisplay(const std::string &id, const std::string &type, const std::string &json_payload, const std::string &dialog_id)=0 | NuguCapability::IDisplayListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
updateDisplay(const std::string &id, const std::string &json_payload)=0 | NuguCapability::IDisplayListener | pure virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~IDisplayListener()=default (defined in NuguCapability::IDisplayListener) | NuguCapability::IDisplayListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
display listener interface + More...
+ +#include <display_interface.hh>
+Public Member Functions | |
virtual bool | clearDisplay (const std::string &id, bool unconditionally, bool has_next)=0 |
The SDK will ask you to delete the rendered display on the display according to the service context maintenance policy. More... | |
virtual void | controlDisplay (const std::string &id, ControlType type, ControlDirection direction)=0 |
Request to control the display with type and direction. More... | |
virtual void | renderDisplay (const std::string &id, const std::string &type, const std::string &json_payload, const std::string &dialog_id)=0 |
Request rendering by passing metadata so that the device with the display can draw on the screen. More... | |
virtual void | updateDisplay (const std::string &id, const std::string &json_payload)=0 |
Request to update the current display. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
display listener interface
+
+
|
+ +pure virtual | +
Request rendering by passing metadata so that the device with the display can draw on the screen.
+[in] | id | display template id |
[in] | type | display template type |
[in] | json_payload | template in json format for display |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
The SDK will ask you to delete the rendered display on the display according to the service context maintenance policy.
+[in] | id | display template id |
[in] | unconditionally | whether clear display unconditionally or not |
[in] | has_next | whether has next display to render |
+
|
+ +pure virtual | +
Request to control the display with type and direction.
+[in] | id | display template id |
[in] | type | control type |
[in] | direction | control direction |
+
|
+ +pure virtual | +
Request to update the current display.
+[in] | id | display template id |
[in] | json_payload | template in json format for display |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IExtensionHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
extension handler interface + More...
+ +#include <extension_interface.hh>
+Public Member Functions | |
+virtual void | actionFailed ()=0 |
Call if handling action fail. | |
+virtual void | actionSucceeded ()=0 |
Call if handling action succeed. | |
virtual void | commandIssued (const std::string &ps_id, const std::string &data)=0 |
Request the specific command to Play. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
extension handler interface
+
+
|
+ +pure virtual | +
Request the specific command to Play.
+[in] | ps_id | playServiceId for handling request |
[in] | data | raw data to request |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IExtensionListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
receiveAction(const std::string &data, const std::string &ps_id, const std::string &dialog_id)=0 | NuguCapability::IExtensionListener | pure virtual |
requestContext(std::string &context_info)=0 | NuguCapability::IExtensionListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~IExtensionListener()=default (defined in NuguCapability::IExtensionListener) | NuguCapability::IExtensionListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
extension listener interface + More...
+ +#include <extension_interface.hh>
+Public Member Functions | |
virtual void | receiveAction (const std::string &data, const std::string &ps_id, const std::string &dialog_id)=0 |
Notified when receiving Action directive from server. More... | |
virtual void | requestContext (std::string &context_info)=0 |
Request context information for extension context. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
extension listener interface
+
+
|
+ +pure virtual | +
Notified when receiving Action directive from server.
+[in] | data | received raw data |
[in] | ps_id | received playServiceId |
[in] | dialog_id | dialogId of received action |
+
|
+ +pure virtual | +
Request context information for extension context.
+[in] | context_info | context information |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ILocationHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
location handler interface + More...
+ +#include <location_interface.hh>
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
location handler interface
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ILocationListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
requestContext(LocationInfo &location_info)=0 | NuguCapability::ILocationListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~ILocationListener()=default (defined in NuguCapability::ILocationListener) | NuguCapability::ILocationListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
location listener interface + More...
+ +#include <location_interface.hh>
+Public Member Functions | |
virtual void | requestContext (LocationInfo &location_info)=0 |
Request context information for location context. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
location listener interface
+
+
|
+ +pure virtual | +
Request context information for location context.
+[in] | location_info | location information |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IMessageHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
message handler interface + More...
+ +#include <message_interface.hh>
+Public Member Functions | |
virtual void | candidatesListed (const std::string &context_template, const std::string &payload)=0 |
The result of send candidates process. More... | |
virtual void | getMessageFailed (const std::string &payload)=0 |
The failed result of get message process. More... | |
virtual void | getMessageSucceeded (const std::string &payload)=0 |
The succeed result of get message process. More... | |
virtual void | sendMessageFailed (const std::string &payload)=0 |
The failed result of send message process. More... | |
virtual void | sendMessageSucceeded (const std::string &payload)=0 |
The succeed result of send message process. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
message handler interface
+
+
|
+ +pure virtual | +
The result of send candidates process.
+[in] | context_template | template information in context |
[in] | payload | event's payload |
+
|
+ +pure virtual | +
The succeed result of send message process.
+[in] | payload | event's payload |
+
|
+ +pure virtual | +
The failed result of send message process.
+[in] | payload | event's payload |
+
|
+ +pure virtual | +
The succeed result of get message process.
+[in] | payload | event's payload |
+
|
+ +pure virtual | +
The failed result of get message process.
+[in] | payload | event's payload |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IMessageListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
messageStateChanged(MessageState state, const std::string &received_time, const std::string &token, const std::string &dialog_id)=0 | NuguCapability::IMessageListener | pure virtual |
processGetMessage(const std::string &payload)=0 | NuguCapability::IMessageListener | pure virtual |
processSendCandidates(const std::string &payload)=0 | NuguCapability::IMessageListener | pure virtual |
processSendMessage(const std::string &payload)=0 | NuguCapability::IMessageListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~IMessageListener()=default (defined in NuguCapability::IMessageListener) | NuguCapability::IMessageListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
message listener interface + More...
+ +#include <message_interface.hh>
+Public Member Functions | |
virtual void | messageStateChanged (MessageState state, const std::string &received_time, const std::string &token, const std::string &dialog_id)=0 |
Report changes in the speech state to the user. More... | |
virtual void | processGetMessage (const std::string &payload)=0 |
Process get message. More... | |
virtual void | processSendCandidates (const std::string &payload)=0 |
Process send candidates. More... | |
virtual void | processSendMessage (const std::string &payload)=0 |
Process send message. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
message listener interface
+
+
|
+ +pure virtual | +
Process send candidates.
+[in] | payload | directive's payload |
+
|
+ +pure virtual | +
Process send message.
+[in] | payload | directive's payload |
+
|
+ +pure virtual | +
Process get message.
+[in] | payload | directive's payload |
+
|
+ +pure virtual | +
Report changes in the speech state to the user.
+[in] | state | message state |
[in] | received_time | message received time |
[in] | token | message received token |
[in] | dialog_id | dialog request id |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IMicHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
mic handler interface + More...
+ +#include <mic_interface.hh>
+Public Member Functions | |
+virtual void | disable ()=0 |
if application disables mic, EPD and KWD will not work. | |
+virtual void | enable ()=0 |
application enables mic. | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
mic handler interface
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IMicListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
micStatusChanged(MicStatus &status)=0 | NuguCapability::IMicListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~IMicListener()=default (defined in NuguCapability::IMicListener) | NuguCapability::IMicListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
mic listener interface + More...
+ +#include <mic_interface.hh>
+Public Member Functions | |
virtual void | micStatusChanged (MicStatus &status)=0 |
Report to the user mic status changed. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
mic listener interface
+
+
|
+ +pure virtual | +
Report to the user mic status changed.
+[in] | status | mic status |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::INudgeHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
nudge handler interface + More...
+ +#include <nudge_interface.hh>
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
nudge handler interface
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::INudgeListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~INudgeListener()=default (defined in NuguCapability::INudgeListener) | NuguCapability::INudgeListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
nudge listener interface + More...
+ +#include <nudge_interface.hh>
+Additional Inherited Members | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
nudge listener interface
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IPhoneCallHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
phone call handler interface + More...
+ +#include <phone_call_interface.hh>
+Public Member Functions | |
virtual void | callArrived (const std::string &payload)=0 |
Notify when call is arrived. More... | |
virtual void | callEnded (const std::string &payload)=0 |
Notify when call is ended. More... | |
virtual void | callEstablished (const std::string &payload)=0 |
Notify when call is established. More... | |
virtual void | candidatesListed (const std::string &context_template, const std::string &payload)=0 |
The result of send candidates process. More... | |
virtual void | makeCallFailed (const std::string &payload)=0 |
The failed result of make call process. More... | |
virtual void | makeCallSucceeded (const std::string &payload)=0 |
The succeeded result of make call process. More... | |
virtual void | setNumberBlockable (bool flag)=0 |
Set whether numbers can be blocked. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
phone call handler interface
+
+
|
+ +pure virtual | +
The result of send candidates process.
+[in] | context_template | template information in context |
[in] | payload | event's payload |
+
|
+ +pure virtual | +
Notify when call is arrived.
+[in] | payload | event's payload |
+
|
+ +pure virtual | +
Notify when call is ended.
+[in] | payload | event's payload |
+
|
+ +pure virtual | +
Notify when call is established.
+[in] | payload | event's payload |
+
|
+ +pure virtual | +
The succeeded result of make call process.
+[in] | payload | event's payload |
+
|
+ +pure virtual | +
The failed result of make call process.
+[in] | payload | event's payload |
+
|
+ +pure virtual | +
Set whether numbers can be blocked.
+[in] | flag | true if can block number, otherwise false. |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IPhoneCallListener, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
phone call listener interface + More...
+ +#include <phone_call_interface.hh>
+Public Member Functions | |
virtual void | callStateChanged (PhoneCallState state)=0 |
Report changes in the phone call state to the user. More... | |
virtual void | processAcceptCall (const std::string &payload)=0 |
Process accept call. More... | |
virtual void | processBlockIncomingCall (const std::string &payload)=0 |
Process block incoming call. More... | |
virtual void | processBlockNumber (const std::string &payload)=0 |
Process block number. More... | |
virtual void | processEndCall (const std::string &payload)=0 |
Process end call. More... | |
virtual void | processMakeCall (const std::string &payload)=0 |
Process make call. More... | |
virtual void | processSendCandidates (const std::string &payload)=0 |
Process send candidates. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
phone call listener interface
+
+
|
+ +pure virtual | +
Report changes in the phone call state to the user.
+[in] | state | phone call state |
+
|
+ +pure virtual | +
Process send candidates.
+[in] | payload | directive's payload |
+
|
+ +pure virtual | +
Process make call.
+[in] | payload | directive's payload |
+
|
+ +pure virtual | +
Process end call.
+[in] | payload | directive's payload |
+
|
+ +pure virtual | +
Process accept call.
+[in] | payload | directive's payload |
+
|
+ +pure virtual | +
Process block incoming call.
+[in] | payload | directive's payload |
+
|
+ +pure virtual | +
Process block number.
+[in] | payload | directive's payload |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IRoutineHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
routine handler interface + More...
+ +#include <routine_interface.hh>
+Public Member Functions | |
virtual bool | next ()=0 |
move to the next action and process. More... | |
virtual bool | prev ()=0 |
move to the previous action and process. More... | |
virtual bool | startRoutine (const std::string &dialog_id, const std::string &data)=0 |
start routine using by data which is composed of Routine.Start directive. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
routine handler interface
+
+
|
+ +pure virtual | +
start routine using by data which is composed of Routine.Start directive.
+[in] | dialog_id | dialog id |
[in] | data | Routine.Start directive payload |
+
|
+ +pure virtual | +
move to the next action and process.
+true | succeed to move and process |
false | fail to move and process |
+
|
+ +pure virtual | +
move to the previous action and process.
+true | succeed to move and process |
false | fail to move and process |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IRoutineListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~IRoutineListener()=default (defined in NuguCapability::IRoutineListener) | NuguCapability::IRoutineListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
routine listener interface + More...
+ +#include <routine_interface.hh>
+Additional Inherited Members | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
routine listener interface
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ISessionHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
session handler interface + More...
+ +#include <session_interface.hh>
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
session handler interface
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ISessionListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
onState(SessionState state, const std::string &dialog_id)=0 | NuguCapability::ISessionListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~ISessionListener()=default (defined in NuguCapability::ISessionListener) | NuguCapability::ISessionListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
session listener interface + More...
+ +#include <session_interface.hh>
+Public Member Functions | |
virtual void | onState (SessionState state, const std::string &dialog_id)=0 |
Receive callback when the session state is changed. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
session listener interface
+
+
|
+ +pure virtual | +
Receive callback when the session state is changed.
+[in] | state | session state |
[in] | dialog_id | dialog request id for Session |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ISoundHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
sound handler interface + More...
+ +#include <sound_interface.hh>
+Public Member Functions | |
virtual void | sendBeepResult (bool is_succeeded)=0 |
Send beep play result. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
sound handler interface
+
+
|
+ +pure virtual | +
Send beep play result.
+[in] | is_succeeded | result of beep play |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ISoundListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
handleBeep(BeepType beep_type, const std::string &dialog_id)=0 | NuguCapability::ISoundListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~ISoundListener()=default (defined in NuguCapability::ISoundListener) | NuguCapability::ISoundListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
sound listener interface + More...
+ +#include <sound_interface.hh>
+Public Member Functions | |
virtual void | handleBeep (BeepType beep_type, const std::string &dialog_id)=0 |
Handle beep sound which is related to received beep name. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
sound listener interface
+
+
|
+ +pure virtual | +
Handle beep sound which is related to received beep name.
+[in] | beep_type | beep type |
[in] | dialog_id | dialog request id |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ISpeakerHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
speaker handler interface + More...
+ +#include <speaker_interface.hh>
+Public Member Functions | |
virtual std::string | getSpeakerName (const SpeakerType &type)=0 |
Get speaker's name. More... | |
virtual bool | getSpeakerType (const std::string &name, SpeakerType &type)=0 |
Get speaker's type according speaker's name. More... | |
virtual void | informMuteChanged (SpeakerType type, bool mute)=0 |
Inform mute changed by application to the SDK. More... | |
virtual void | informVolumeChanged (SpeakerType type, int volume)=0 |
Inform volume changed by application to the SDK. More... | |
virtual void | sendEventMuteChanged (const std::string &ps_id, bool result)=0 |
Send event the result of request SetMute to the SDK. More... | |
virtual void | sendEventVolumeChanged (const std::string &ps_id, bool result)=0 |
Send event the result of request SetVolume to the SDK. More... | |
virtual void | setSpeakerInfo (const std::map< SpeakerType, SpeakerInfo > &info)=0 |
Set speaker information in SDK to be controlled by application. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
speaker handler interface
+
+
|
+ +pure virtual | +
Set speaker information in SDK to be controlled by application.
+[in] | info | speaker's information map |
+
|
+ +pure virtual | +
Inform volume changed by application to the SDK.
+[in] | type | speaker type |
[in] | volume | volume level |
+
|
+ +pure virtual | +
Inform mute changed by application to the SDK.
+[in] | type | speaker type |
[in] | mute | volume mute |
+
|
+ +pure virtual | +
Send event the result of request SetVolume to the SDK.
+[in] | ps_id | play service id |
[in] | result | result of SetVolume |
+
|
+ +pure virtual | +
Send event the result of request SetMute to the SDK.
+[in] | ps_id | play service id |
[in] | result | result of SetMute |
+
|
+ +pure virtual | +
Get speaker's name.
+[in] | type | speaker type |
+
|
+ +pure virtual | +
Get speaker's type according speaker's name.
+[in] | name | speaker name |
[out] | type | speaker type |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ISpeakerListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
requestSetMute(const std::string &ps_id, SpeakerType type, bool mute)=0 | NuguCapability::ISpeakerListener | pure virtual |
requestSetVolume(const std::string &ps_id, SpeakerType type, int volume, bool linear)=0 | NuguCapability::ISpeakerListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~ISpeakerListener()=default (defined in NuguCapability::ISpeakerListener) | NuguCapability::ISpeakerListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
speaker listener interface + More...
+ +#include <speaker_interface.hh>
+Public Member Functions | |
virtual void | requestSetMute (const std::string &ps_id, SpeakerType type, bool mute)=0 |
The SDK requests the mute setting received from the server. More... | |
virtual void | requestSetVolume (const std::string &ps_id, SpeakerType type, int volume, bool linear)=0 |
The SDK requests the volume setting received from the server. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
speaker listener interface
+
+
|
+ +pure virtual | +
The SDK requests the volume setting received from the server.
+[in] | ps_id | play service id |
[in] | type | speaker type |
[in] | volume | volume level |
[in] | linear | change volume method. if linear is true volume is changed gradually, otherwise immediately |
+
|
+ +pure virtual | +
The SDK requests the mute setting received from the server.
+[in] | ps_id | play service id |
[in] | type | speaker type |
[in] | mute | volume mute |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ISystemHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
system handler interface + More...
+ +#include <system_interface.hh>
+Public Member Functions | |
+virtual void | synchronizeState ()=0 |
When the device is connected to NUGU Platform, all state information is delivered through the context. | |
+virtual void | updateUserActivity ()=0 |
Update a timer that measures the user's inactivity. | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
system handler interface
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ISystemListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
onException(SystemException exception, const std::string &dialog_id)=0 | NuguCapability::ISystemListener | pure virtual |
onNoDirective(const std::string &dialog_id)=0 | NuguCapability::ISystemListener | pure virtual |
onRevoke(RevokeReason reason)=0 | NuguCapability::ISystemListener | pure virtual |
onTurnOff()=0 | NuguCapability::ISystemListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~ISystemListener()=default (defined in NuguCapability::ISystemListener) | NuguCapability::ISystemListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
system listener interface + More...
+ +#include <system_interface.hh>
+Public Member Functions | |
virtual void | onException (SystemException exception, const std::string &dialog_id)=0 |
Deliver the exception received from the server to the user. More... | |
virtual void | onNoDirective (const std::string &dialog_id)=0 |
Received a no directive from the server. More... | |
virtual void | onRevoke (RevokeReason reason)=0 |
Received a revoke request from the server. More... | |
+virtual void | onTurnOff ()=0 |
Received a device turn off request from the server. | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
system listener interface
+
+
|
+ +pure virtual | +
Deliver the exception received from the server to the user.
+[in] | exception | server exception |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
Received a revoke request from the server.
+[in] | reason | reason for revoke |
+
|
+ +pure virtual | +
Received a no directive from the server.
+[in] | dialog_id | dialog request id |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ITTSHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
tts handler interface + More...
+ +#include <tts_interface.hh>
+Public Member Functions | |
virtual void | addListener (ITTSListener *listener)=0 |
Add the ITTSListener object. More... | |
virtual std::string | getPlayServiceId ()=0 |
Get current play service id. More... | |
virtual void | removeListener (ITTSListener *listener)=0 |
Remove the ITTSListener object. More... | |
virtual std::string | requestTTS (const std::string &text, const std::string &play_service_id, const std::string &referrer_id="")=0 |
request the sentence to speech. More... | |
virtual void | setAttribute (TTSAttribute &&attribute)=0 |
Set attribute about speech synthesizer. More... | |
virtual bool | setMute (bool mute)=0 |
set pcm player's mute More... | |
virtual bool | setVolume (int volume)=0 |
set pcm player's volume More... | |
+virtual void | stopTTS ()=0 |
Stop currently speech. | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
tts handler interface
+
+
|
+ +pure virtual | +
Add the ITTSListener object.
+[in] | listener | ITTSListener object |
+
|
+ +pure virtual | +
Remove the ITTSListener object.
+[in] | listener | ITTSListener object |
+
|
+ +pure virtual | +
request the sentence to speech.
+[in] | text | sentence |
[in] | play_service_id | received from server |
[in] | referrer_id | referrer request dialog id for analysis |
+
|
+ +pure virtual | +
set pcm player's volume
+[in] | volume | volume level |
+
|
+ +pure virtual | +
set pcm player's mute
+[in] | mute | volume mute |
+
|
+ +pure virtual | +
Set attribute about speech synthesizer.
+[in] | attribute | attribute object |
+
|
+ +pure virtual | +
Get current play service id.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ITTSListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
onTTSCancel(const std::string &dialog_id)=0 | NuguCapability::ITTSListener | pure virtual |
onTTSState(TTSState state, const std::string &dialog_id)=0 | NuguCapability::ITTSListener | pure virtual |
onTTSText(const std::string &text, const std::string &dialog_id)=0 | NuguCapability::ITTSListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~ITTSListener()=default (defined in NuguCapability::ITTSListener) | NuguCapability::ITTSListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
tts listener interface + More...
+ +#include <tts_interface.hh>
+Public Member Functions | |
virtual void | onTTSCancel (const std::string &dialog_id)=0 |
Report canceled the text speech to the User. More... | |
virtual void | onTTSState (TTSState state, const std::string &dialog_id)=0 |
Report changes in the speech state to the user. More... | |
virtual void | onTTSText (const std::string &text, const std::string &dialog_id)=0 |
Report the speech sentence to the User. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
tts listener interface
+
+
|
+ +pure virtual | +
Report changes in the speech state to the user.
+[in] | state | tts state |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
Report the speech sentence to the User.
+[in] | text | sentence |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
Report canceled the text speech to the User.
+[in] | dialog_id | dialog request id |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ITextHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
text handler interface + More...
+ +#include <text_interface.hh>
+Public Member Functions | |
virtual std::string | requestTextInput (const std::string &text, const std::string &token="", const std::string &source="", bool include_dialog_attribute=true)=0 |
Request NUGU services based on text input. More... | |
virtual void | setAttribute (TextAttribute &&attribute)=0 |
Set attribute about response. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
text handler interface
+
+
|
+ +pure virtual | +
Request NUGU services based on text input.
+[in] | text | text command |
[in] | token | received token |
[in] | source | source that triggered the text input |
[in] | include_dialog_attribute | whether including dialog attribute |
+
|
+ +pure virtual | +
Set attribute about response.
+[in] | attribute | attribute object |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::ITextListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
handleTextCommand(const std::string &text, const std::string &token)=0 | NuguCapability::ITextListener | pure virtual |
onComplete(const std::string &dialog_id)=0 | NuguCapability::ITextListener | pure virtual |
onError(TextError error, const std::string &dialog_id)=0 | NuguCapability::ITextListener | pure virtual |
onState(TextState state, const std::string &dialog_id)=0 | NuguCapability::ITextListener | pure virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~ITextListener()=default (defined in NuguCapability::ITextListener) | NuguCapability::ITextListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
text listener interface + More...
+ +#include <text_interface.hh>
+Public Member Functions | |
virtual bool | handleTextCommand (const std::string &text, const std::string &token)=0 |
Handle text command and return whether consumed. More... | |
virtual void | onComplete (const std::string &dialog_id)=0 |
When server processing for text input requests is completed. More... | |
virtual void | onError (TextError error, const std::string &dialog_id)=0 |
An error occurred during requesting text input. More... | |
virtual void | onState (TextState state, const std::string &dialog_id)=0 |
TextState changed. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
text listener interface
+
+
|
+ +pure virtual | +
TextState changed.
+[in] | state | text state |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
When server processing for text input requests is completed.
+[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
An error occurred during requesting text input.
+[in] | error | text error |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
Handle text command and return whether consumed.
+[in] | text | text command |
[in] | token | received token |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IUtilityHandler, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
utility handler interface + More...
+ +#include <utility_interface.hh>
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
utility handler interface
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::IUtilityListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
~IUtilityListener()=default (defined in NuguCapability::IUtilityListener) | NuguCapability::IUtilityListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
utility listener interface + More...
+ +#include <utility_interface.hh>
+Additional Inherited Members | |
Public Member Functions inherited from NuguClientKit::ICapabilityListener | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
utility listener interface
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguCapability::SpeakerInfo, including all inherited members.
+can_control | NuguCapability::SpeakerInfo | |
group | NuguCapability::SpeakerInfo | |
level | NuguCapability::SpeakerInfo | |
max | NuguCapability::SpeakerInfo | |
min | NuguCapability::SpeakerInfo | |
mute | NuguCapability::SpeakerInfo | |
SpeakerInfo()=default (defined in NuguCapability::SpeakerInfo) | NuguCapability::SpeakerInfo | |
step | NuguCapability::SpeakerInfo | |
type | NuguCapability::SpeakerInfo | |
volume | NuguCapability::SpeakerInfo | |
~SpeakerInfo()=default (defined in NuguCapability::SpeakerInfo) | NuguCapability::SpeakerInfo |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <speaker_interface.hh>
+Public Attributes | |
bool | can_control = false |
std::string | group |
int | level = 50 |
int | max = 100 |
int | min = 0 |
int | mute = -1 |
int | step = 10 |
SpeakerType | type = SpeakerType::NUGU |
int | volume = 50 |
SpeakerType NuguCapability::SpeakerInfo::type = SpeakerType::NUGU | +
Speaker type
+
std::string NuguCapability::SpeakerInfo::group | +
Speaker volume group
+
int NuguCapability::SpeakerInfo::min = 0 | +
Speaker min volume
+
int NuguCapability::SpeakerInfo::max = 100 | +
Speaker max volume
+
int NuguCapability::SpeakerInfo::volume = 50 | +
Speaker current volume
+
int NuguCapability::SpeakerInfo::step = 10 | +
Speaker default volume step
+
int NuguCapability::SpeakerInfo::level = 50 | +
Speaker default volume level
+
int NuguCapability::SpeakerInfo::mute = -1 | +
Speaker mute state
+
bool NuguCapability::SpeakerInfo::can_control = false | +
Speaker controllability
+ +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::Capability, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <capability.hh>
+Public Member Functions | |
void | addBlockingPolicy (const std::string &dname, BlockingPolicy policy) |
Add blocking policy for directive name. More... | |
void | addEventResultCallback (const std::string &ename, EventResultCallback callback) override |
Add event result callback for error handling. More... | |
void | addReferrerEvents (const std::string &ename, const std::string &dname) |
Add event name and directive name for referred dialog request id. More... | |
void | cancelDirective (NuguDirective *ndir) override |
Receive a directive cancellation from the Directive sequencer. More... | |
+ | Capability (const std::string &name, const std::string &ver="1.0") |
+void | deInitialize () override |
Deinitialize the current object. | |
void | destroyDirective (NuguDirective *ndir, bool is_cancel=false) |
Destroy directive received from Directive Sequencer. More... | |
ICapabilityHelper * | getCapabilityHelper () |
Get ICapabilityHelper instance for using NuguCore functions. More... | |
virtual std::string | getContextInfo () |
Get current context info. More... | |
InteractionMode | getInteractionMode (const NJson::Value &interaction_control) |
Get interaction mode which is included in interactionControl. More... | |
std::string | getName () override |
Get the capability name of the current object. More... | |
NuguDirective * | getNuguDirective () |
Get directive received from Directive Sequencer. More... | |
std::string | getPlayServiceIdInStackControl (const char *payload) |
Get play service id which is managed by play stack control. More... | |
std::string | getPlayServiceIdInStackControl (const NJson::Value &playstack_control) |
Get play service id which is managed by play stack control. More... | |
bool | getProperties (const std::string &property, std::list< std::string > &values) override |
It is possible to share own property values among objects. More... | |
bool | getProperty (const std::string &property, std::string &value) override |
It is possible to share own property value among objects. More... | |
std::string | getReferrerDialogRequestId (const std::string &ename) |
Get referred dialog request id. More... | |
std::string | getVersion () override |
Get the capability version of the current object. More... | |
+void | initialize () override |
Initialize the current object. | |
void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success) override |
Notify event response info. More... | |
void | notifyEventResult (const std::string &event_desc) override |
Notify event result. More... | |
virtual void | parsingDirective (const char *dname, const char *message) |
Parsing directive and do the required action. More... | |
void | preprocessDirective (NuguDirective *ndir) override |
Receive a directive preprocessing request from Directive sequencer. More... | |
void | processDirective (NuguDirective *ndir) override final |
Receive a directive processing request from Directive sequencer. More... | |
bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m) override |
Process command from other objects. More... | |
void | receiveCommandAll (const std::string &command, const std::string ¶m) override |
Process command received from capability manager. More... | |
void | removeEventResultCallback (const std::string &ename) override |
Remove event result callback. More... | |
+void | restore () override |
Restore previous suspended action. | |
void | sendAttachmentEvent (CapabilityEvent *event, bool is_end, size_t size, unsigned char *data) |
Send attachment event to server. More... | |
void | sendEvent (CapabilityEvent *event, const std::string &context, const std::string &payload, EventResultCallback cb=nullptr) |
Send event to server. More... | |
std::string | sendEvent (const std::string &name, const std::string &context, const std::string &payload, EventResultCallback cb=nullptr) |
Send event to server. More... | |
void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true }) override |
Set directive cancel policy. More... | |
void | setCapabilityListener (ICapabilityListener *clistener) override |
Set the listener object. More... | |
void | setName (const std::string &name) |
Set the capability name of the current object. More... | |
void | setNuguCoreContainer (INuguCoreContainer *core_container) override |
Set INuguCoreContainer for using functions in NuguCore. More... | |
void | setReferrerDialogRequestId (const std::string &dname, const std::string &id) |
Set referred dialog request id. More... | |
void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP) override |
Set capability suspend policy. More... | |
void | setVersion (const std::string &ver) |
Set the capability version of the current object. More... | |
+void | suspend () override |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx) override |
Update the compact context information of the capability agent. More... | |
Public Member Functions inherited from NuguClientKit::ICapabilityInterface | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
+Protected Attributes | |
+ICapabilityHelper * | capa_helper = nullptr |
ICapabilityHelper instance for using NuguCore functions. | |
+INuguCoreContainer * | core_container = nullptr |
INuguCoreContainer instance for using NuguCore functions. | |
+bool | destroy_directive_by_agent = false |
whether destroy received directive by agent | |
+IDirectiveSequencer * | directive_sequencer = nullptr |
IDirectiveSequencer instance for directive sequence management. | |
+IFocusManager * | focus_manager = nullptr |
IFocusManager instance for using audio focus. | |
+bool | initialized = false |
whether capability initialized | |
+IInteractionControlManager * | interaction_control_manager = nullptr |
IInteractionControlManager instance for using interaction control management. | |
+IPlaySyncManager * | playsync_manager = nullptr |
IPlaySyncManager instance for using playsync management. | |
+IRoutineManager * | routine_manager = nullptr |
IRoutineManager instance for using routine management. | |
+ISessionManager * | session_manager = nullptr |
ISessionManager instance for using session management. | |
+SuspendPolicy | suspend_policy = SuspendPolicy::STOP |
SuspendPolicy variable for deciding suspend action (default:STOP) | |
+bool | suspended = false |
whether capability suspend | |
+Additional Inherited Members | |
Public Types inherited from NuguClientKit::ICapabilityInterface | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
+
|
+ +overridevirtual | +
Set INuguCoreContainer for using functions in NuguCore.
+[in] | core_container | NuguCoreContainer instance |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +overridevirtual | +
Set capability suspend policy.
+[in] | policy | suspend policy |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +overridevirtual | +
Add event result callback for error handling.
+[in] | ename | event name |
[in] | callback | event result callback |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +overridevirtual | +
Remove event result callback.
+[in] | ename | event name |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +overridevirtual | +
Notify event result.
+[in] | event_desc | event result description (format: 'cname.ename.msgid.dialogid.success.code') |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +overridevirtual | +
Notify event response info.
+[in] | msg_id | message id which is sent with event |
[in] | data | raw data which is received from server about event (json format) |
[in] | success | whether receive event response |
Implements NuguClientKit::ICapabilityInterface.
+ +void NuguClientKit::Capability::addReferrerEvents | +( | +const std::string & | +ename, | +
+ | + | const std::string & | +dname | +
+ | ) | ++ |
Add event name and directive name for referred dialog request id.
+[in] | ename | event name |
[in] | dname | directive name |
void NuguClientKit::Capability::addBlockingPolicy | +( | +const std::string & | +dname, | +
+ | + | BlockingPolicy | +policy | +
+ | ) | ++ |
Add blocking policy for directive name.
+[in] | dname | directive name |
[in] | policy | BlockingPolicy information |
std::string NuguClientKit::Capability::getReferrerDialogRequestId | +( | +const std::string & | +ename | ) | ++ |
Get referred dialog request id.
+[in] | ename | event name |
void NuguClientKit::Capability::setReferrerDialogRequestId | +( | +const std::string & | +dname, | +
+ | + | const std::string & | +id | +
+ | ) | ++ |
Set referred dialog request id.
+[in] | dname | directive name |
[in] | id | referred dialog request id |
void NuguClientKit::Capability::setName | +( | +const std::string & | +name | ) | ++ |
Set the capability name of the current object.
+[in] | name | capability name |
+
|
+ +overridevirtual | +
Get the capability name of the current object.
+Implements NuguClientKit::ICapabilityInterface.
+ +void NuguClientKit::Capability::setVersion | +( | +const std::string & | +ver | ) | ++ |
Set the capability version of the current object.
+[in] | ver | capability version |
+
|
+ +overridevirtual | +
Get the capability version of the current object.
+Implements NuguClientKit::ICapabilityInterface.
+ +std::string NuguClientKit::Capability::getPlayServiceIdInStackControl | +( | +const NJson::Value & | +playstack_control | ) | ++ |
Get play service id which is managed by play stack control.
+[in] | playstack_control | json object which has playStackControl field |
std::string NuguClientKit::Capability::getPlayServiceIdInStackControl | +( | +const char * | +payload | ) | ++ |
Get play service id which is managed by play stack control.
+[in] | payload | raw json data |
InteractionMode NuguClientKit::Capability::getInteractionMode | +( | +const NJson::Value & | +interaction_control | ) | ++ |
Get interaction mode which is included in interactionControl.
+
+
|
+ +overridevirtual | +
Receive a directive preprocessing request from Directive sequencer.
+[in] | ndir | directive |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +overridevirtual | +
Receive a directive cancellation from the Directive sequencer.
+[in] | ndir | directive |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +finaloverridevirtual | +
Receive a directive processing request from Directive sequencer.
+[in] | ndir | directive |
Implements NuguClientKit::ICapabilityInterface.
+ +void NuguClientKit::Capability::destroyDirective | +( | +NuguDirective * | +ndir, | +
+ | + | bool | +is_cancel = false |
+
+ | ) | ++ |
Destroy directive received from Directive Sequencer.
+[in] | ndir | directive |
[in] | is_cancel | whether to destroy by cancel |
NuguDirective* NuguClientKit::Capability::getNuguDirective | +( | +) | ++ |
Get directive received from Directive Sequencer.
+std::string NuguClientKit::Capability::sendEvent | +( | +const std::string & | +name, | +
+ | + | const std::string & | +context, | +
+ | + | const std::string & | +payload, | +
+ | + | EventResultCallback | +cb = nullptr |
+
+ | ) | ++ |
Send event to server.
+[in] | name | event name |
[in] | context | context info |
[in] | payload | payload info |
void NuguClientKit::Capability::sendEvent | +( | +CapabilityEvent * | +event, | +
+ | + | const std::string & | +context, | +
+ | + | const std::string & | +payload, | +
+ | + | EventResultCallback | +cb = nullptr |
+
+ | ) | ++ |
Send event to server.
+[in] | event | CapabilityEvent instance |
[in] | context | context info |
[in] | payload | payload info |
void NuguClientKit::Capability::sendAttachmentEvent | +( | +CapabilityEvent * | +event, | +
+ | + | bool | +is_end, | +
+ | + | size_t | +size, | +
+ | + | unsigned char * | +data | +
+ | ) | ++ |
Send attachment event to server.
+[in] | event | CapabilityEvent instance |
[in] | is_end | whether final attachment event |
[in] | size | attachment data size |
[in] | data | attachment data |
+
|
+ +overridevirtual | +
It is possible to share own property value among objects.
+[in] | property | capability property |
[in] | value | capability property value |
true | The property is valid |
false | The property is invalid |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +overridevirtual | +
It is possible to share own property values among objects.
+[in] | property | capability property |
[in] | values | capability property values |
true | The property is valid |
false | The property is invalid |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +overridevirtual | +
Set the listener object.
+[in] | clistener | listener |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +overridevirtual | +
Set directive cancel policy.
+[in] | cancel_previous_dialog | whether canceling previous dialog or not |
[in] | cancel_policy | policy object |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +overridevirtual | +
Process command from other objects.
+[in] | from | capability who send the command |
[in] | command | command |
[in] | param | command parameter |
true | The command is valid |
false | The command is invalid |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +overridevirtual | +
Process command received from capability manager.
+[in] | command | command |
[in] | param | command parameter |
Implements NuguClientKit::ICapabilityInterface.
+ +
+
|
+ +virtual | +
Parsing directive and do the required action.
+[in] | dname | directive name |
[in] | message | directive data |
+
|
+ +virtual | +
Get current context info.
+
+
|
+ +overridevirtual | +
Update the compact context information of the capability agent.
+[in] | ctx | capability agent's context |
Implements NuguClientKit::ICapabilityInterface.
+ +ICapabilityHelper* NuguClientKit::Capability::getCapabilityHelper | +( | +) | ++ |
Get ICapabilityHelper instance for using NuguCore functions.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::CapabilityEvent, including all inherited members.
+CapabilityEvent(const std::string &name, Capability *cap) (defined in NuguClientKit::CapabilityEvent) | NuguClientKit::CapabilityEvent | explicit |
forceClose() | NuguClientKit::CapabilityEvent | |
getDialogRequestId() | NuguClientKit::CapabilityEvent | |
getMessageId() | NuguClientKit::CapabilityEvent | |
getName() | NuguClientKit::CapabilityEvent | |
sendAttachmentEvent(bool is_end, size_t size, unsigned char *data) | NuguClientKit::CapabilityEvent | |
sendEvent(const std::string &context, const std::string &payload) | NuguClientKit::CapabilityEvent | |
setDialogRequestId(const std::string &id) | NuguClientKit::CapabilityEvent | |
setMimeType(const std::string &type) | NuguClientKit::CapabilityEvent | |
setType(enum nugu_event_type type) | NuguClientKit::CapabilityEvent | |
~CapabilityEvent() (defined in NuguClientKit::CapabilityEvent) | NuguClientKit::CapabilityEvent | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <capability.hh>
+Public Member Functions | |
+ | CapabilityEvent (const std::string &name, Capability *cap) |
+void | forceClose () |
Close event forcibly. | |
std::string | getDialogRequestId () |
Get dialog request id. More... | |
std::string | getMessageId () |
Get message id. More... | |
std::string | getName () |
Get event name. More... | |
void | sendAttachmentEvent (bool is_end, size_t size, unsigned char *data) |
Send attachment event to server. More... | |
void | sendEvent (const std::string &context, const std::string &payload) |
Send event to server. More... | |
void | setDialogRequestId (const std::string &id) |
Set dialog request id. More... | |
void | setMimeType (const std::string &type) |
Set mime type. More... | |
void | setType (enum nugu_event_type type) |
Set event type. More... | |
std::string NuguClientKit::CapabilityEvent::getName | +( | +) | ++ |
Get event name.
+std::string NuguClientKit::CapabilityEvent::getDialogRequestId | +( | +) | ++ |
Get dialog request id.
+std::string NuguClientKit::CapabilityEvent::getMessageId | +( | +) | ++ |
Get message id.
+void NuguClientKit::CapabilityEvent::setDialogRequestId | +( | +const std::string & | +id | ) | ++ |
Set dialog request id.
+[in] | id | dialog request id |
void NuguClientKit::CapabilityEvent::setType | +( | +enum nugu_event_type | +type | ) | ++ |
Set event type.
+[in] | type | event type |
void NuguClientKit::CapabilityEvent::setMimeType | +( | +const std::string & | +type | ) | ++ |
Set mime type.
+[in] | type | mime type |
void NuguClientKit::CapabilityEvent::sendEvent | +( | +const std::string & | +context, | +
+ | + | const std::string & | +payload | +
+ | ) | ++ |
Send event to server.
+[in] | context | context info |
[in] | payload | payload info |
void NuguClientKit::CapabilityEvent::sendAttachmentEvent | +( | +bool | +is_end, | +
+ | + | size_t | +size, | +
+ | + | unsigned char * | +data | +
+ | ) | ++ |
Send attachment event to server.
+[in] | is_end | whether final attachment event |
[in] | size | attachment data size |
[in] | data | attachment data |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::ICapabilityHelper, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
CapabilityHelper interface. + More...
+ +#include <capability_helper_interface.hh>
+Public Member Functions | |
virtual bool | getCapabilityProperties (const std::string &cap, const std::string &property, std::list< std::string > &values)=0 |
Get properties from CapabilityAgent. More... | |
virtual bool | getCapabilityProperty (const std::string &cap, const std::string &property, std::string &value)=0 |
Get property from CapabilityAgent. More... | |
virtual IDirectiveSequencer * | getDirectiveSequencer ()=0 |
Get IDirectiveSequencer instance. More... | |
virtual IFocusManager * | getFocusManager ()=0 |
Get IFocusManager instance. More... | |
virtual IInteractionControlManager * | getInteractionControlManager ()=0 |
Get IInteractionControlManager instance. More... | |
virtual IPlaySyncManager * | getPlaySyncManager ()=0 |
Get IPlaySyncManager instance. More... | |
virtual IRoutineManager * | getRoutineManager ()=0 |
Get IRoutineManager instance. More... | |
virtual ISessionManager * | getSessionManager ()=0 |
Get ISessionManager instance. More... | |
+virtual std::string | getWakeupWord ()=0 |
Get wakeup keyword for detection. | |
+virtual std::string | makeAllContextInfo ()=0 |
Get context info from All CapabilityAgents. | |
virtual std::string | makeContextInfo (const std::string &cname, NJson::Value &ctx)=0 |
Get context info. More... | |
virtual void | requestEventResult (NuguEvent *event)=0 |
Request to send event result via CapabilityManager. More... | |
+virtual void | restoreAll ()=0 |
Restore previous suspended capability action. | |
virtual bool | sendCommand (const std::string &from, const std::string &to, const std::string &command, const std::string ¶m)=0 |
Send command between CapabilityAgents. More... | |
virtual bool | setMute (bool mute)=0 |
Set Audio Recorder mute/unmute. More... | |
+virtual void | suspendAll ()=0 |
Suspend all current capability action. | |
CapabilityHelper interface.
+
+
|
+ +pure virtual | +
Get IPlaySyncManager instance.
+
+
|
+ +pure virtual | +
Get IFocusManager instance.
+
+
|
+ +pure virtual | +
Get ISessionManager instance.
+
+
|
+ +pure virtual | +
Get IInteractionControlManager instance.
+
+
|
+ +pure virtual | +
Get IDirectiveSequencer instance.
+
+
|
+ +pure virtual | +
Get IRoutineManager instance.
+
+
|
+ +pure virtual | +
Set Audio Recorder mute/unmute.
+[in] | mute | mute/unmute |
+
|
+ +pure virtual | +
Send command between CapabilityAgents.
+[in] | from | source CapabilityAgent |
[in] | to | target CapabilityAgent |
[in] | command | command |
[in] | param | parameter |
true | CapabilityAgent and command are valid |
false | CapabilityAgent or command is invalid |
+
|
+ +pure virtual | +
Request to send event result via CapabilityManager.
+[in] | event | event for monitoring result |
+
|
+ +pure virtual | +
Get property from CapabilityAgent.
+[in] | cap | CapabilityAgent |
[in] | property | property key |
[in] | value | property value |
true | CapabilityAgent and property are valid |
false | CapabilityAgent or property is invalid |
+
|
+ +pure virtual | +
Get properties from CapabilityAgent.
+[in] | cap | CapabilityAgent |
[in] | property | property key |
[in] | values | property values |
true | CapabilityAgent and property are valid |
false | CapabilityAgent or property is invalid |
+
|
+ +pure virtual | +
Get context info.
+[in] | cname | The name of the capability requesting the context |
[in] | ctx | reference object for storing context info |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::ICapabilityInterface, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
capability interface + More...
+ +#include <capability_interface.hh>
+Public Types | |
using | EventResultCallback = std::function< void(const std::string &, const std::string &, const std::string &, int, int)> |
Event result callback for error handling. More... | |
enum class | SuspendPolicy { STOP +, PAUSE + } |
Capability suspend policy. More... | |
+Public Member Functions | |
virtual void | addEventResultCallback (const std::string &ename, EventResultCallback callback)=0 |
Add event result callback for error handling. More... | |
virtual void | cancelDirective (NuguDirective *ndir)=0 |
Receive a directive cancellation from the Directive sequencer. More... | |
+virtual void | deInitialize ()=0 |
Deinitialize the current object. | |
virtual std::string | getName ()=0 |
Get the capability name of the current object. More... | |
virtual bool | getProperties (const std::string &property, std::list< std::string > &values)=0 |
It is possible to share own property values among objects. More... | |
virtual bool | getProperty (const std::string &property, std::string &value)=0 |
It is possible to share own property value among objects. More... | |
virtual std::string | getVersion ()=0 |
Get the capability version of the current object. More... | |
+virtual void | initialize ()=0 |
Initialize the current object. | |
virtual void | notifyEventResponse (const std::string &msg_id, const std::string &data, bool success)=0 |
Notify event response info. More... | |
virtual void | notifyEventResult (const std::string &event_desc)=0 |
Notify event result. More... | |
virtual void | preprocessDirective (NuguDirective *ndir)=0 |
Receive a directive preprocessing request from Directive sequencer. More... | |
virtual void | processDirective (NuguDirective *ndir)=0 |
Receive a directive processing request from Directive sequencer. More... | |
virtual bool | receiveCommand (const std::string &from, const std::string &command, const std::string ¶m)=0 |
Process command from other objects. More... | |
virtual void | receiveCommandAll (const std::string &command, const std::string ¶m)=0 |
Process command received from capability manager. More... | |
virtual void | removeEventResultCallback (const std::string &ename)=0 |
Remove event result callback. More... | |
+virtual void | restore ()=0 |
Restore previous suspended action. | |
virtual void | setCancelPolicy (bool cancel_previous_dialog, DirectiveCancelPolicy &&cancel_policy={ true })=0 |
Set directive cancel policy. More... | |
virtual void | setCapabilityListener (ICapabilityListener *clistener)=0 |
Set the listener object. More... | |
virtual void | setNuguCoreContainer (INuguCoreContainer *core_container)=0 |
Set INuguCoreContainer for using functions in NuguCore. More... | |
virtual void | setSuspendPolicy (SuspendPolicy policy=SuspendPolicy::STOP)=0 |
Set capability suspend policy. More... | |
+virtual void | suspend ()=0 |
Suspend current action. | |
virtual void | updateCompactContext (NJson::Value &ctx)=0 |
Update the compact context information of the capability agent. More... | |
virtual void | updateInfoForContext (NJson::Value &ctx)=0 |
Update the current context information of the capability agent. More... | |
capability interface
+using NuguClientKit::ICapabilityInterface::EventResultCallback = std::function<void(const std::string&, const std::string&, const std::string&, int, int)> | +
Event result callback for error handling.
+[in] | ename | event name |
[in] | msg_id | event message id |
[in] | dialog_id | event request dialog id |
[in] | success | event result |
[in] | code | event result code (similar to http status code) |
+
|
+ +strong | +
Capability suspend policy.
+Enumerator | |
---|---|
STOP | Stop current action unconditionally + |
PAUSE | Pause current action. It could resume later + |
+
|
+ +pure virtual | +
Set INuguCoreContainer for using functions in NuguCore.
+[in] | core_container | NuguCoreContainer instance |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Set capability suspend policy.
+[in] | policy | suspend policy |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Add event result callback for error handling.
+[in] | ename | event name |
[in] | callback | event result callback |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Remove event result callback.
+[in] | ename | event name |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Notify event result.
+[in] | event_desc | event result description (format: 'cname.ename.msgid.dialogid.success.code') |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Notify event response info.
+[in] | msg_id | message id which is sent with event |
[in] | data | raw data which is received from server about event (json format) |
[in] | success | whether receive event response |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Get the capability name of the current object.
+Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Get the capability version of the current object.
+Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Receive a directive preprocessing request from Directive sequencer.
+[in] | ndir | directive |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Receive a directive cancellation from the Directive sequencer.
+[in] | ndir | directive |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Receive a directive processing request from Directive sequencer.
+[in] | ndir | directive |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Update the current context information of the capability agent.
+[in] | ctx | capability agent's context |
+
|
+ +pure virtual | +
Update the compact context information of the capability agent.
+[in] | ctx | capability agent's context |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Process command from other objects.
+[in] | from | capability who send the command |
[in] | command | command |
[in] | param | command parameter |
true | The command is valid |
false | The command is invalid |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Process command received from capability manager.
+[in] | command | command |
[in] | param | command parameter |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
It is possible to share own property value among objects.
+[in] | property | capability property |
[in] | value | capability property value |
true | The property is valid |
false | The property is invalid |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
It is possible to share own property values among objects.
+[in] | property | capability property |
[in] | values | capability property values |
true | The property is valid |
false | The property is invalid |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Set the listener object.
+[in] | clistener | listener |
Implemented in NuguClientKit::Capability.
+ +
+
|
+ +pure virtual | +
Set directive cancel policy.
+[in] | cancel_previous_dialog | whether canceling previous dialog or not |
[in] | cancel_policy | policy object |
Implemented in NuguClientKit::Capability.
+ +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::ICapabilityListener, including all inherited members.
+getCapabilityHandler() | NuguClientKit::ICapabilityListener | virtual |
setCapabilityHandler(ICapabilityInterface *handler) | NuguClientKit::ICapabilityListener | virtual |
~ICapabilityListener()=default (defined in NuguClientKit::ICapabilityListener) | NuguClientKit::ICapabilityListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
capability listener interface + More...
+ +#include <capability_interface.hh>
+Public Member Functions | |
virtual ICapabilityInterface * | getCapabilityHandler () |
Get capability interface object. More... | |
virtual void | setCapabilityHandler (ICapabilityInterface *handler) |
Set capability interface object. More... | |
capability listener interface
+
+
|
+ +virtual | +
Set capability interface object.
+[in] | handler | capability interface object |
+
|
+ +virtual | +
Get capability interface object.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IDialogUXStateAggregatorListener, including all inherited members.
+onASRResult(const std::string &text) | NuguClientKit::IDialogUXStateAggregatorListener | virtual |
onStateChanged(DialogUXState state, bool multi_turn, const ChipsInfo &chips, bool session_active) | NuguClientKit::IDialogUXStateAggregatorListener | virtual |
~IDialogUXStateAggregatorListener()=default (defined in NuguClientKit::IDialogUXStateAggregatorListener) | NuguClientKit::IDialogUXStateAggregatorListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
IDialogUXStateAggregatorListener interface. + More...
+ +#include <dialog_ux_state_aggregator_interface.hh>
+Public Member Functions | |
virtual void | onASRResult (const std::string &text) |
Receive ASR result. More... | |
virtual void | onStateChanged (DialogUXState state, bool multi_turn, const ChipsInfo &chips, bool session_active) |
Receive current DialogUXState and additional infos. More... | |
IDialogUXStateAggregatorListener interface.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IDirectiveSequencer, including all inherited members.
+add(NuguDirective *ndir)=0 | NuguClientKit::IDirectiveSequencer | pure virtual |
addListener(const std::string &name_space, IDirectiveSequencerListener *listener)=0 | NuguClientKit::IDirectiveSequencer | pure virtual |
addPolicy(const std::string &name_space, const std::string &name, BlockingPolicy policy)=0 | NuguClientKit::IDirectiveSequencer | pure virtual |
cancel(const std::string &dialog_id, bool cancel_active_directive=true)=0 | NuguClientKit::IDirectiveSequencer | pure virtual |
cancel(const std::string &dialog_id, std::set< std::string > groups)=0 | NuguClientKit::IDirectiveSequencer | pure virtual |
cancelAll(bool cancel_active_directive=true)=0 | NuguClientKit::IDirectiveSequencer | pure virtual |
complete(NuguDirective *ndir)=0 | NuguClientKit::IDirectiveSequencer | pure virtual |
findPending(const std::string &name_space, const std::string &name)=0 | NuguClientKit::IDirectiveSequencer | pure virtual |
getCanceledDialogId()=0 | NuguClientKit::IDirectiveSequencer | pure virtual |
getPolicy(const std::string &name_space, const std::string &name)=0 | NuguClientKit::IDirectiveSequencer | pure virtual |
removeListener(const std::string &name_space, IDirectiveSequencerListener *listener)=0 | NuguClientKit::IDirectiveSequencer | pure virtual |
~IDirectiveSequencer()=default (defined in NuguClientKit::IDirectiveSequencer) | NuguClientKit::IDirectiveSequencer | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
IDirectiveSequencer. + More...
+ +#include <directive_sequencer_interface.hh>
+Public Member Functions | |
virtual bool | add (NuguDirective *ndir)=0 |
Add new directive to sequencer. More... | |
virtual void | addListener (const std::string &name_space, IDirectiveSequencerListener *listener)=0 |
Add the Listener object. More... | |
virtual bool | addPolicy (const std::string &name_space, const std::string &name, BlockingPolicy policy)=0 |
Add the BlockingPolicy. More... | |
virtual bool | cancel (const std::string &dialog_id, bool cancel_active_directive=true)=0 |
Cancel all pending directives related to the dialog_id. The canceled directives are freed. More... | |
virtual bool | cancel (const std::string &dialog_id, std::set< std::string > groups)=0 |
Cancels specific pending directives related to the dialog_id. The canceled directives are freed. More... | |
virtual bool | cancelAll (bool cancel_active_directive=true)=0 |
Cancels all pending directives. The canceled directives are freed. More... | |
virtual bool | complete (NuguDirective *ndir)=0 |
Complete the blocking directive. The NuguDirective object will be destroyed. If there are pending directives, those directives will be processed at the next idle time. More... | |
virtual const NuguDirective * | findPending (const std::string &name_space, const std::string &name)=0 |
Find directive from pending list. More... | |
virtual const std::string & | getCanceledDialogId ()=0 |
Get the last canceled dialog_id. More... | |
virtual BlockingPolicy | getPolicy (const std::string &name_space, const std::string &name)=0 |
Get the BlockingPolicy for namespace.name. More... | |
virtual void | removeListener (const std::string &name_space, IDirectiveSequencerListener *listener)=0 |
Remove the Listener object. More... | |
+
|
+ +pure virtual | +
Add the Listener object.
+[in] | name_space | directive namespace |
[in] | listener | listener object |
+
|
+ +pure virtual | +
Remove the Listener object.
+[in] | name_space | directive namespace |
[in] | listener | listener object |
+
|
+ +pure virtual | +
Add the BlockingPolicy.
+[in] | name_space | directive namespace |
[in] | name | directive name |
[in] | policy | BlockingPolicy |
true | success |
false | failure |
+
|
+ +pure virtual | +
Get the BlockingPolicy for namespace.name.
+[in] | name_space | directive namespace |
[in] | name | directive name |
+
|
+ +pure virtual | +
Cancel all pending directives related to the dialog_id. The canceled directives are freed.
+[in] | dialog_id | dialog-request-id |
[in] | cancel_active_directive | cancel including currently active directives |
true | success |
false | failure |
+
|
+ +pure virtual | +
Cancels specific pending directives related to the dialog_id. The canceled directives are freed.
+[in] | dialog_id | dialog-request-id |
[in] | groups | list of directives('{Namespace}.{Name}') |
true | success |
false | failure |
+
|
+ +pure virtual | +
Cancels all pending directives. The canceled directives are freed.
+[in] | cancel_active_directive | cancel including currently active directives |
true | success |
false | failure |
+
|
+ +pure virtual | +
Complete the blocking directive. The NuguDirective object will be destroyed. If there are pending directives, those directives will be processed at the next idle time.
+[in] | ndir | NuguDirective object |
true | success |
false | failure |
+
|
+ +pure virtual | +
Add new directive to sequencer.
+[in] | ndir | NuguDirective object |
true | success |
false | failure |
+
|
+ +pure virtual | +
Get the last canceled dialog_id.
+
+
|
+ +pure virtual | +
Find directive from pending list.
+[in] | name_space | directive namespace |
[in] | name | directive name |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IDirectiveSequencerListener, including all inherited members.
+onCancelDirective(NuguDirective *ndir)=0 | NuguClientKit::IDirectiveSequencerListener | pure virtual |
onHandleDirective(NuguDirective *ndir)=0 | NuguClientKit::IDirectiveSequencerListener | pure virtual |
onPreHandleDirective(NuguDirective *ndir)=0 | NuguClientKit::IDirectiveSequencerListener | pure virtual |
~IDirectiveSequencerListener()=default (defined in NuguClientKit::IDirectiveSequencerListener) | NuguClientKit::IDirectiveSequencerListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
IDirectiveSequencerListener. + More...
+ +#include <directive_sequencer_interface.hh>
+Public Member Functions | |
virtual void | onCancelDirective (NuguDirective *ndir)=0 |
Notify the directive to cancel. More... | |
virtual bool | onHandleDirective (NuguDirective *ndir)=0 |
Notify the directive to handle. More... | |
virtual bool | onPreHandleDirective (NuguDirective *ndir)=0 |
Notify the directive to handle in advance. More... | |
+
|
+ +pure virtual | +
Notify the directive to handle in advance.
+[in] | ndir | NuguDirective object |
true | The directive is handled. Stop propagating to other listeners. |
false | The directive is not handled. |
+
|
+ +pure virtual | +
Notify the directive to handle.
+[in] | ndir | NuguDirective object |
true | The directives were handled normally. |
false | There was a problem with the directive processing. |
+
|
+ +pure virtual | +
Notify the directive to cancel.
+[in] | ndir | NuguDirective object |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IFocusManager, including all inherited members.
+addObserver(IFocusManagerObserver *observer)=0 | NuguClientKit::IFocusManager | pure virtual |
convertToFocusState(const std::string &state_text)=0 | NuguClientKit::IFocusManager | pure virtual |
getStateString(FocusState state)=0 | NuguClientKit::IFocusManager | pure virtual |
holdFocus(const std::string &type)=0 | NuguClientKit::IFocusManager | pure virtual |
releaseFocus(const std::string &type, const std::string &name)=0 | NuguClientKit::IFocusManager | pure virtual |
removeObserver(IFocusManagerObserver *observer)=0 | NuguClientKit::IFocusManager | pure virtual |
requestFocus(const std::string &type, const std::string &name, IFocusResourceListener *listener)=0 | NuguClientKit::IFocusManager | pure virtual |
setConfigurations(std::vector< FocusConfiguration > &request, std::vector< FocusConfiguration > &release)=0 | NuguClientKit::IFocusManager | pure virtual |
stopAllFocus()=0 | NuguClientKit::IFocusManager | pure virtual |
stopForegroundFocus()=0 | NuguClientKit::IFocusManager | pure virtual |
unholdFocus(const std::string &type)=0 | NuguClientKit::IFocusManager | pure virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <focus_manager_interface.hh>
+Public Member Functions | |
virtual void | addObserver (IFocusManagerObserver *observer)=0 |
Add the Observer object. More... | |
virtual FocusState | convertToFocusState (const std::string &state_text)=0 |
Convert state text to matched FocusState enum. More... | |
virtual std::string | getStateString (FocusState state)=0 |
Get state string. More... | |
virtual bool | holdFocus (const std::string &type)=0 |
Hold focus. If requested to hold focus, the low priority focus is not preempted. More... | |
virtual bool | releaseFocus (const std::string &type, const std::string &name)=0 |
Release focus. More... | |
virtual void | removeObserver (IFocusManagerObserver *observer)=0 |
Remove the Observer object. More... | |
virtual bool | requestFocus (const std::string &type, const std::string &name, IFocusResourceListener *listener)=0 |
Request Focus. More... | |
virtual void | setConfigurations (std::vector< FocusConfiguration > &request, std::vector< FocusConfiguration > &release)=0 |
Set focus configurations. More... | |
+virtual void | stopAllFocus ()=0 |
Stop all focus. | |
+virtual void | stopForegroundFocus ()=0 |
Stop highest priority of focus that is foreground state. | |
virtual bool | unholdFocus (const std::string &type)=0 |
Unhold focus. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IFocusManagerObserver, including all inherited members.
+onFocusChanged(const FocusConfiguration &configuration, FocusState state, const std::string &name)=0 | NuguClientKit::IFocusManagerObserver | pure virtual |
~IFocusManagerObserver()=default (defined in NuguClientKit::IFocusManagerObserver) | NuguClientKit::IFocusManagerObserver | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
IFocusManagerObserver. + More...
+ +#include <focus_manager_interface.hh>
+Public Member Functions | |
virtual void | onFocusChanged (const FocusConfiguration &configuration, FocusState state, const std::string &name)=0 |
Support to monitor the change of focus state for all resources. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IFocusResourceListener, including all inherited members.
+onFocusChanged(FocusState state)=0 | NuguClientKit::IFocusResourceListener | pure virtual |
~IFocusResourceListener()=default (defined in NuguClientKit::IFocusResourceListener) | NuguClientKit::IFocusResourceListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
IFocusResourceListener. + More...
+ +#include <focus_manager_interface.hh>
+Public Member Functions | |
virtual void | onFocusChanged (FocusState state)=0 |
Notify the resource of focus state change. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IInteractionControlManager, including all inherited members.
+addListener(IInteractionControlManagerListener *listener)=0 | NuguClientKit::IInteractionControlManager | pure virtual |
clear()=0 | NuguClientKit::IInteractionControlManager | pure virtual |
finish(InteractionMode mode, const std::string &requester)=0 | NuguClientKit::IInteractionControlManager | pure virtual |
isMultiTurnActive()=0 | NuguClientKit::IInteractionControlManager | pure virtual |
notifyHasMultiTurn()=0 | NuguClientKit::IInteractionControlManager | pure virtual |
removeListener(IInteractionControlManagerListener *listener)=0 | NuguClientKit::IInteractionControlManager | pure virtual |
start(InteractionMode mode, const std::string &requester)=0 | NuguClientKit::IInteractionControlManager | pure virtual |
~IInteractionControlManager()=default (defined in NuguClientKit::IInteractionControlManager) | NuguClientKit::IInteractionControlManager | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
InteractionControlManager interface. + More...
+ +#include <interaction_control_manager_interface.hh>
+Public Member Functions | |
virtual void | addListener (IInteractionControlManagerListener *listener)=0 |
Add IInteractionControlManagerListener. More... | |
+virtual void | clear ()=0 |
Clear all about interaction mode. | |
virtual void | finish (InteractionMode mode, const std::string &requester)=0 |
Finish specific interaction mode. More... | |
+virtual bool | isMultiTurnActive ()=0 |
Check whether multi-turn is active. | |
+virtual void | notifyHasMultiTurn ()=0 |
Notify the current directive has multi-turn. | |
virtual void | removeListener (IInteractionControlManagerListener *listener)=0 |
Remove IInteractionControlManagerListener. More... | |
virtual void | start (InteractionMode mode, const std::string &requester)=0 |
Start specific interaction mode. More... | |
InteractionControlManager interface.
+ +
+
|
+ +pure virtual | +
Add IInteractionControlManagerListener.
+[in] | listener | IInteractionControlManagerListener instance |
+
|
+ +pure virtual | +
Remove IInteractionControlManagerListener.
+[in] | listener | IInteractionControlManagerListener instance |
+
|
+ +pure virtual | +
Start specific interaction mode.
+[in] | mode | a kind of interaction mode |
[in] | requester | a object which request interaction mode |
+
|
+ +pure virtual | +
Finish specific interaction mode.
+[in] | mode | a kind of interaction mode |
[in] | requester | a object which request interaction mode |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IInteractionControlManagerListener, including all inherited members.
+onHasMultiTurn()=0 | NuguClientKit::IInteractionControlManagerListener | pure virtual |
onModeChanged(bool is_multi_turn)=0 | NuguClientKit::IInteractionControlManagerListener | pure virtual |
~IInteractionControlManagerListener()=default (defined in NuguClientKit::IInteractionControlManagerListener) | NuguClientKit::IInteractionControlManagerListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
IInteractionControlManagerListener interface. + More...
+ +#include <interaction_control_manager_interface.hh>
+Public Member Functions | |
+virtual void | onHasMultiTurn ()=0 |
Receive callback when the current directive has multi-turn. | |
virtual void | onModeChanged (bool is_multi_turn)=0 |
Receive callback when the interaction mode is changed. More... | |
IInteractionControlManagerListener interface.
+
+
|
+ +pure virtual | +
Receive callback when the interaction mode is changed.
+[in] | is_multi_turn | whether current mode is multi-turn or not |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IMediaPlayer, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
mediaplayer interface + More...
+ +#include <media_player_interface.hh>
+Public Member Functions | |
virtual void | addListener (IMediaPlayerListener *listener)=0 |
Add the Listener object. More... | |
virtual int | duration ()=0 |
Get duration information of the media content from the media player. More... | |
virtual bool | isPlaying ()=0 |
Check whether the media player is playing media content. More... | |
virtual bool | loop ()=0 |
Get loop information of the media content from the media player. More... | |
virtual bool | mute ()=0 |
Get mute information of the media content from the media player. More... | |
+virtual bool | pause ()=0 |
Request media player to pause the media content. | |
+virtual bool | play ()=0 |
Request media player to play the media content. | |
virtual int | position ()=0 |
Get current position information of the media content from the media player. More... | |
virtual void | removeListener (IMediaPlayerListener *listener)=0 |
Remove the Listener object. More... | |
+virtual bool | resume ()=0 |
Request media player to resume the media content. | |
virtual bool | seek (int sec)=0 |
Request the media player to move the current content section. More... | |
virtual void | setAudioAttribute (NuguAudioAttribute attr)=0 |
Sets the audio attribute in the media player. More... | |
virtual bool | setDuration (int duration)=0 |
Set duration of the media content to the media player. More... | |
virtual void | setLoop (bool loop)=0 |
Set loop of the media content to the media player. More... | |
virtual bool | setMute (bool mute)=0 |
Set mute of the media content to the media player. More... | |
virtual bool | setPosition (int position)=0 |
Set current position of the media content to the media player. More... | |
virtual bool | setSource (const std::string &url)=0 |
Sets the playurl of the media content to play in the media player. More... | |
virtual bool | setState (MediaPlayerState state)=0 |
Set state of the media player. More... | |
virtual bool | setVolume (int volume)=0 |
Set volume of the media content to the media player. More... | |
virtual MediaPlayerState | state ()=0 |
Get state of the media player. More... | |
virtual std::string | stateString (MediaPlayerState state)=0 |
Get state name of the media player. More... | |
+virtual bool | stop ()=0 |
Request media player to stop the media content. | |
virtual std::string | url ()=0 |
Get url of media content from the media player. More... | |
virtual int | volume ()=0 |
Get volume information of the media content from the media player. More... | |
mediaplayer interface
+
+
|
+ +pure virtual | +
Add the Listener object.
+[in] | listener | listener object |
+
|
+ +pure virtual | +
Remove the Listener object.
+[in] | listener | listener object |
+
|
+ +pure virtual | +
Sets the audio attribute in the media player.
+[in] | attr | audio attribute |
+
|
+ +pure virtual | +
Sets the playurl of the media content to play in the media player.
+[in] | url | media content url |
+
|
+ +pure virtual | +
Request the media player to move the current content section.
+[in] | sec | content's position. It is moved from the current media position. |
+
|
+ +pure virtual | +
Get current position information of the media content from the media player.
+
+
|
+ +pure virtual | +
Set current position of the media content to the media player.
+[in] | position | media content's position. |
+
|
+ +pure virtual | +
Get loop information of the media content from the media player.
+
+
|
+ +pure virtual | +
Set loop of the media content to the media player.
+[in] | loop | media content's loop |
+
|
+ +pure virtual | +
Get duration information of the media content from the media player.
+
+
|
+ +pure virtual | +
Set duration of the media content to the media player.
+[in] | duration | media content's duration. |
+
|
+ +pure virtual | +
Get volume information of the media content from the media player.
+
+
|
+ +pure virtual | +
Set volume of the media content to the media player.
+[in] | volume | media content's volume. |
+
|
+ +pure virtual | +
Get mute information of the media content from the media player.
+
+
|
+ +pure virtual | +
Set mute of the media content to the media player.
+[in] | mute | media content's mute. |
+
|
+ +pure virtual | +
Check whether the media player is playing media content.
+
+
|
+ +pure virtual | +
Get state of the media player.
+
+
|
+ +pure virtual | +
Set state of the media player.
+[in] | state | media player's state |
+
|
+ +pure virtual | +
Get state name of the media player.
+[in] | state | media player's state |
+
|
+ +pure virtual | +
Get url of media content from the media player.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IMediaPlayerListener, including all inherited members.
+durationChanged(int duration)=0 | NuguClientKit::IMediaPlayerListener | pure virtual |
mediaChanged(const std::string &url)=0 | NuguClientKit::IMediaPlayerListener | pure virtual |
mediaEventReport(MediaPlayerEvent event)=0 | NuguClientKit::IMediaPlayerListener | pure virtual |
mediaStateChanged(MediaPlayerState state)=0 | NuguClientKit::IMediaPlayerListener | pure virtual |
muteChanged(int mute)=0 | NuguClientKit::IMediaPlayerListener | pure virtual |
positionChanged(int position)=0 | NuguClientKit::IMediaPlayerListener | pure virtual |
volumeChanged(int volume)=0 | NuguClientKit::IMediaPlayerListener | pure virtual |
~IMediaPlayerListener()=default (defined in NuguClientKit::IMediaPlayerListener) | NuguClientKit::IMediaPlayerListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
mediaplayer listener interface + More...
+ +#include <media_player_interface.hh>
+Public Member Functions | |
virtual void | durationChanged (int duration)=0 |
The media player reports the changed duration of the media content. More... | |
virtual void | mediaChanged (const std::string &url)=0 |
The media player reports that the media content has changed. More... | |
virtual void | mediaEventReport (MediaPlayerEvent event)=0 |
Report an event occurred during mediaplayer playback to the user. More... | |
virtual void | mediaStateChanged (MediaPlayerState state)=0 |
Report changes in the mediaplayer state to the user. More... | |
virtual void | muteChanged (int mute)=0 |
The media player reports the changed mute of the media content. More... | |
virtual void | positionChanged (int position)=0 |
The media player reports the changed position of the media content. More... | |
virtual void | volumeChanged (int volume)=0 |
The media player reports the changed volume of the media content. More... | |
mediaplayer listener interface
+
+
|
+ +pure virtual | +
Report changes in the mediaplayer state to the user.
+[in] | state | mediaplayer state |
+
|
+ +pure virtual | +
Report an event occurred during mediaplayer playback to the user.
+[in] | event | mediaplayer playback event |
+
|
+ +pure virtual | +
The media player reports that the media content has changed.
+[in] | url | changed media content url |
+
|
+ +pure virtual | +
The media player reports the changed duration of the media content.
+[in] | duration | duration of the media content |
+
|
+ +pure virtual | +
The media player reports the changed position of the media content.
+[in] | position | position of the media content |
+
|
+ +pure virtual | +
The media player reports the changed volume of the media content.
+[in] | volume | volume of the media content |
+
|
+ +pure virtual | +
The media player reports the changed mute of the media content.
+[in] | mute | mute of the media content. |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::INetworkManager, including all inherited members.
+addListener(INetworkManagerListener *listener)=0 | NuguClientKit::INetworkManager | pure virtual |
connect()=0 | NuguClientKit::INetworkManager | pure virtual |
disconnect()=0 | NuguClientKit::INetworkManager | pure virtual |
removeListener(INetworkManagerListener *listener)=0 | NuguClientKit::INetworkManager | pure virtual |
setRegistryUrl(const std::string &url)=0 | NuguClientKit::INetworkManager | pure virtual |
setToken(const std::string &token)=0 | NuguClientKit::INetworkManager | pure virtual |
setUserAgent(const std::string &app_version, const std::string &additional_info="")=0 | NuguClientKit::INetworkManager | pure virtual |
~INetworkManager()=default (defined in NuguClientKit::INetworkManager) | NuguClientKit::INetworkManager | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
network manager interface + More...
+ +#include <network_manager_interface.hh>
+Public Member Functions | |
virtual void | addListener (INetworkManagerListener *listener)=0 |
Add the Listener object. More... | |
virtual bool | connect ()=0 |
Request a connection with the NUGU server. More... | |
virtual bool | disconnect ()=0 |
Request a disconnection with the NUGU server. More... | |
virtual void | removeListener (INetworkManagerListener *listener)=0 |
Remove the Listener object. More... | |
virtual bool | setRegistryUrl (const std::string &url)=0 |
Set the device gateway registry url. More... | |
virtual bool | setToken (const std::string &token)=0 |
Set the access token value. The connection type is automatically set through token analysis. More... | |
virtual bool | setUserAgent (const std::string &app_version, const std::string &additional_info="")=0 |
Set the HTTP header UserAgent information. More... | |
network manager interface
+
+
|
+ +pure virtual | +
Add the Listener object.
+[in] | listener | listener object |
+
|
+ +pure virtual | +
Remove the Listener object.
+[in] | listener | listener object |
+
|
+ +pure virtual | +
Request a connection with the NUGU server.
+0 | success |
-1 | failure |
+
|
+ +pure virtual | +
Request a disconnection with the NUGU server.
+0 | success |
-1 | failure |
+
|
+ +pure virtual | +
Set the access token value. The connection type is automatically set through token analysis.
+[in] | token | access token |
0 | success |
-1 | failure |
+
|
+ +pure virtual | +
Set the device gateway registry url.
+[in] | url | registry url |
0 | success |
-1 | failure |
+
|
+ +pure virtual | +
Set the HTTP header UserAgent information.
+[in] | app_version | application version (e.g. "0.1.0") |
[in] | additional_info | additional information or "" |
0 | success |
-1 | failure |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::INetworkManagerListener, including all inherited members.
+onError(NetworkError error) | NuguClientKit::INetworkManagerListener | virtual |
onEventAttachmentSend(NuguEvent *nev, int seq, bool is_end, size_t length, unsigned char *data) | NuguClientKit::INetworkManagerListener | virtual |
onEventResponse(const char *msg_id, const char *data, bool success) | NuguClientKit::INetworkManagerListener | virtual |
onEventSend(NuguEvent *nev) | NuguClientKit::INetworkManagerListener | virtual |
onEventSendResult(const char *msg_id, bool success, int code) | NuguClientKit::INetworkManagerListener | virtual |
onStatusChanged(NetworkStatus status) | NuguClientKit::INetworkManagerListener | virtual |
~INetworkManagerListener()=default (defined in NuguClientKit::INetworkManagerListener) | NuguClientKit::INetworkManagerListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
network manager listener interface + More...
+ +#include <network_manager_interface.hh>
+Public Member Functions | |
virtual void | onError (NetworkError error) |
Report an error while communicating with the NUGU server. More... | |
virtual void | onEventAttachmentSend (NuguEvent *nev, int seq, bool is_end, size_t length, unsigned char *data) |
Report that the attachment will be sent to the server. More... | |
virtual void | onEventResponse (const char *msg_id, const char *data, bool success) |
Report the response data received from the server. More... | |
virtual void | onEventSend (NuguEvent *nev) |
Report that the event will be sent to the server. More... | |
virtual void | onEventSendResult (const char *msg_id, bool success, int code) |
Report the result of sending an event from the server. More... | |
virtual void | onStatusChanged (NetworkStatus status) |
Report the connection status with the NUGU server. More... | |
network manager listener interface
+
+
|
+ +virtual | +
Report the connection status with the NUGU server.
+[in] | status | network status |
+
|
+ +virtual | +
Report an error while communicating with the NUGU server.
+[in] | error | network error |
+
|
+ +virtual | +
Report that the event will be sent to the server.
+[in] | nev | NuguEvent object |
+
|
+ +virtual | +
Report that the attachment will be sent to the server.
+[in] | nev | NuguEvent object |
+
|
+ +virtual | +
Report the result of sending an event from the server.
+[in] | msg_id | event message id |
[in] | success | event result |
[in] | code | event result code (similar to http status code) |
+
|
+ +virtual | +
Report the response data received from the server.
+[in] | msg_id | event message id |
[in] | data | response raw data (format json) |
[in] | success | event result |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::INuguCoreContainer, including all inherited members.
+createMediaPlayer()=0 | NuguClientKit::INuguCoreContainer | pure virtual |
createNuguTimer(bool singleshot=false)=0 | NuguClientKit::INuguCoreContainer | pure virtual |
createSpeechRecognizer(const std::string &model_path="", const EpdAttribute &epd_attr={})=0 | NuguClientKit::INuguCoreContainer | pure virtual |
createTTSPlayer()=0 | NuguClientKit::INuguCoreContainer | pure virtual |
createWakeupHandler(const WakeupModelFile &model_file)=0 | NuguClientKit::INuguCoreContainer | pure virtual |
getCapabilityHelper()=0 | NuguClientKit::INuguCoreContainer | pure virtual |
~INuguCoreContainer()=default (defined in NuguClientKit::INuguCoreContainer) | NuguClientKit::INuguCoreContainer | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
NuguCoreContainer interface. + More...
+ +#include <nugu_core_container_interface.hh>
+Public Member Functions | |
+virtual IMediaPlayer * | createMediaPlayer ()=0 |
Create MediaPlayer instance. | |
virtual INuguTimer * | createNuguTimer (bool singleshot=false)=0 |
Create NuguTimer instance. More... | |
virtual ISpeechRecognizer * | createSpeechRecognizer (const std::string &model_path="", const EpdAttribute &epd_attr={})=0 |
Create SpeechRecognizer instance. More... | |
+virtual ITTSPlayer * | createTTSPlayer ()=0 |
Create TTSPlayer instance. | |
virtual IWakeupHandler * | createWakeupHandler (const WakeupModelFile &model_file)=0 |
Create WakeupHandler instance. More... | |
+virtual ICapabilityHelper * | getCapabilityHelper ()=0 |
Get CapabilityHelper instance. | |
NuguCoreContainer interface.
+
+
|
+ +pure virtual | +
Create WakeupHandler instance.
+[in] | model_file | WakeupModelFile object |
+
|
+ +pure virtual | +
Create SpeechRecognizer instance.
+[in] | model_path | required model file path |
[in] | epd_attr | epd attribute like timeout, max duration |
+
|
+ +pure virtual | +
Create NuguTimer instance.
+[in] | singleshot | By setting the singleshot to true, you can trigger the timer only once. The default value of singleshot is false, and the timer runs repeatedly. |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::INuguTimer, including all inherited members.
+getInterval()=0 | NuguClientKit::INuguTimer | pure virtual |
getSingleShot()=0 | NuguClientKit::INuguTimer | pure virtual |
restart(unsigned int msec=0)=0 | NuguClientKit::INuguTimer | pure virtual |
setCallback(timer_callback cb)=0 | NuguClientKit::INuguTimer | pure virtual |
setInterval(unsigned int msec)=0 | NuguClientKit::INuguTimer | pure virtual |
setSingleShot(bool singleshot)=0 | NuguClientKit::INuguTimer | pure virtual |
start(unsigned int msec=0)=0 | NuguClientKit::INuguTimer | pure virtual |
stop()=0 | NuguClientKit::INuguTimer | pure virtual |
timer_callback typedef | NuguClientKit::INuguTimer | |
~INuguTimer()=default (defined in NuguClientKit::INuguTimer) | NuguClientKit::INuguTimer | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
nugu timer interface + More...
+ +#include <nugu_timer_interface.hh>
+Public Types | |
+typedef std::function< void()> | timer_callback |
Timer Callback. | |
+Public Member Functions | |
virtual unsigned int | getInterval ()=0 |
Get timer's timeout interval. More... | |
virtual bool | getSingleShot ()=0 |
Get timer single shot property. More... | |
virtual void | restart (unsigned int msec=0)=0 |
Request re-start timer with new interval. More... | |
virtual void | setCallback (timer_callback cb)=0 |
Request set timeout callback. More... | |
virtual void | setInterval (unsigned int msec)=0 |
Set timer's timeout interval. More... | |
virtual void | setSingleShot (bool singleshot)=0 |
Set timer running single shot. More... | |
virtual void | start (unsigned int msec=0)=0 |
Request start timer with new interval. More... | |
+virtual void | stop ()=0 |
Request stop timer. | |
nugu timer interface
+
+
|
+ +pure virtual | +
Set timer's timeout interval.
+[in] | msec | timeout (unit: msec) |
+
|
+ +pure virtual | +
Get timer's timeout interval.
+
+
|
+ +pure virtual | +
Set timer running single shot.
+[in] | singleshot | singleshot |
+
|
+ +pure virtual | +
Get timer single shot property.
+
+
|
+ +pure virtual | +
Request start timer with new interval.
+[in] | msec | timeout interval. The timer works with internal interval if msec is 0. |
+
|
+ +pure virtual | +
Request re-start timer with new interval.
+[in] | msec | timeout interval. The timer works with internal interval if msec is 0. |
+
|
+ +pure virtual | +
Request set timeout callback.
+[in] | cb | timeout callback |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IPlaySyncManager, including all inherited members.
+addListener(const std::string &requester, IPlaySyncManagerListener *listener)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
adjustPlayStackHoldTime(unsigned int time)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
cancelSync(const std::string &ps_id, const std::string &requester)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
clear()=0 | NuguClientKit::IPlaySyncManager | pure virtual |
clearHolding()=0 | NuguClientKit::IPlaySyncManager | pure virtual |
continueRelease()=0 | NuguClientKit::IPlaySyncManager | pure virtual |
getAllPlayStackItems()=0 | NuguClientKit::IPlaySyncManager | pure virtual |
hasActivity(const std::string &ps_id, PlayStackActivity activity)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
hasNextPlayStack()=0 | NuguClientKit::IPlaySyncManager | pure virtual |
isConditionToHandlePrevDialog(NuguDirective *prev_ndir, NuguDirective *cur_ndir)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
PlayStacks typedef (defined in NuguClientKit::IPlaySyncManager) | NuguClientKit::IPlaySyncManager | |
PlaySyncContainer typedef (defined in NuguClientKit::IPlaySyncManager) | NuguClientKit::IPlaySyncManager | |
postPoneRelease()=0 | NuguClientKit::IPlaySyncManager | pure virtual |
prepareSync(const std::string &ps_id, NuguDirective *ndir)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
registerCapabilityForSync(const std::string &capability_name)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
releaseSync(const std::string &ps_id, const std::string &requester)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
releaseSyncImmediately(const std::string &ps_id, const std::string &requester)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
releaseSyncLater(const std::string &ps_id, const std::string &requester)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
releaseSyncUnconditionally(const std::string &ps_id="")=0 | NuguClientKit::IPlaySyncManager | pure virtual |
removeListener(const std::string &requester)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
replacePlayStack(const std::string &prev_ps_id, const std::string &new_ps_id, std::pair< std::string, void * > extra_data={})=0 | NuguClientKit::IPlaySyncManager | pure virtual |
resetHolding()=0 | NuguClientKit::IPlaySyncManager | pure virtual |
restartHolding()=0 | NuguClientKit::IPlaySyncManager | pure virtual |
setDefaultPlayStackHoldTime(unsigned int time)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
startSync(const std::string &ps_id, const std::string &requester, void *extra_data=nullptr)=0 | NuguClientKit::IPlaySyncManager | pure virtual |
stopHolding()=0 | NuguClientKit::IPlaySyncManager | pure virtual |
~IPlaySyncManager()=default (defined in NuguClientKit::IPlaySyncManager) | NuguClientKit::IPlaySyncManager | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
IPlaySyncManager interface. + More...
+ +#include <playsync_manager_interface.hh>
+Public Types | |
+using | PlayStacks = std::map< std::string, PlaySyncContainer > |
+using | PlaySyncContainer = std::map< std::string, std::pair< PlaySyncState, void * > > |
+Public Member Functions | |
virtual void | addListener (const std::string &requester, IPlaySyncManagerListener *listener)=0 |
Add IPlaySyncManagerListener. More... | |
virtual void | adjustPlayStackHoldTime (unsigned int time)=0 |
Adjust playstack hold time. More... | |
virtual void | cancelSync (const std::string &ps_id, const std::string &requester)=0 |
Cancel sync specific capability agent which was synced. More... | |
+virtual void | clear ()=0 |
Clear all playstack info. | |
+virtual void | clearHolding ()=0 |
Clear timer for releasing sync. | |
+virtual void | continueRelease ()=0 |
Continue pending release if exist. | |
virtual std::vector< std::string > | getAllPlayStackItems ()=0 |
Get all items which are stored in playstack. More... | |
virtual bool | hasActivity (const std::string &ps_id, PlayStackActivity activity)=0 |
Check whether the specific playstack activity exist. More... | |
virtual bool | hasNextPlayStack ()=0 |
Check whether the next playstack to handle exists. More... | |
virtual bool | isConditionToHandlePrevDialog (NuguDirective *prev_ndir, NuguDirective *cur_ndir)=0 |
Check whether the previous dialog has to be handled or not. More... | |
+virtual void | postPoneRelease ()=0 |
Postpone already started release if exist. | |
virtual void | prepareSync (const std::string &ps_id, NuguDirective *ndir)=0 |
Prepare sync capability agents which are included in directive. More... | |
virtual void | registerCapabilityForSync (const std::string &capability_name)=0 |
Register capability agent for sync (default:TTS, AudioPlayer, Display) More... | |
virtual void | releaseSync (const std::string &ps_id, const std::string &requester)=0 |
Release sync all capability agents. (Actually, it release sync after context holding time.) More... | |
virtual void | releaseSyncImmediately (const std::string &ps_id, const std::string &requester)=0 |
Release sync all capability agents immediately. More... | |
virtual void | releaseSyncLater (const std::string &ps_id, const std::string &requester)=0 |
Release sync all capability agents after long time elapsed. More... | |
virtual void | releaseSyncUnconditionally (const std::string &ps_id="")=0 |
Release sync all capability agents unconditionally. If it's not specify the play service id, it would remove all playstacks. More... | |
virtual void | removeListener (const std::string &requester)=0 |
Remove IPlayStackManagerListener. More... | |
virtual void | replacePlayStack (const std::string &prev_ps_id, const std::string &new_ps_id, std::pair< std::string, void * > extra_data={})=0 |
Replace current playstack to new one. (It only replace playstack not notifying related callbacks.) More... | |
+virtual void | resetHolding ()=0 |
Reset timer for releasing sync. | |
+virtual void | restartHolding ()=0 |
Restart timer for releasing sync. | |
virtual void | setDefaultPlayStackHoldTime (unsigned int time)=0 |
Set default playstack hold time. More... | |
virtual void | startSync (const std::string &ps_id, const std::string &requester, void *extra_data=nullptr)=0 |
Start sync specific capability agent which was prepared. More... | |
+virtual void | stopHolding ()=0 |
Stop timer for releasing sync. | |
IPlaySyncManager interface.
+
+
|
+ +pure virtual | +
Register capability agent for sync (default:TTS, AudioPlayer, Display)
+[in] | capability_name | capability agent name |
+
|
+ +pure virtual | +
[in] | requester | capability agent name |
[in] | listener | IPlaySyncManagerListener instance |
+
|
+ +pure virtual | +
Remove IPlayStackManagerListener.
+[in] | requester | capability agent name |
+
|
+ +pure virtual | +
Prepare sync capability agents which are included in directive.
+[in] | ps_id | play service id |
[in] | ndir | directive |
+
|
+ +pure virtual | +
Start sync specific capability agent which was prepared.
+[in] | ps_id | play service id |
[in] | requester | capability agent name |
[in] | extra_data | an extra_data which is used after synced |
+
|
+ +pure virtual | +
Cancel sync specific capability agent which was synced.
+[in] | ps_id | play service id |
[in] | requester | capability agent name |
+
|
+ +pure virtual | +
Release sync all capability agents. (Actually, it release sync after context holding time.)
+[in] | ps_id | play service id |
[in] | requester | capability agent name |
+
|
+ +pure virtual | +
Release sync all capability agents after long time elapsed.
+[in] | ps_id | play service id |
[in] | requester | capability agent name |
+
|
+ +pure virtual | +
Release sync all capability agents immediately.
+[in] | ps_id | play service id |
[in] | requester | capability agent name |
+
|
+ +pure virtual | +
Release sync all capability agents unconditionally. If it's not specify the play service id, it would remove all playstacks.
+[in] | ps_id | play service id |
+
|
+ +pure virtual | +
Check whether the previous dialog has to be handled or not.
+[in] | prev_ndir | previous directive |
[in] | cur_ndir | current directive |
+
|
+ +pure virtual | +
Check whether the specific playstack activity exist.
+[in] | ps_id | play service id |
[in] | activity | playstack activity |
+
|
+ +pure virtual | +
Check whether the next playstack to handle exists.
+
+
|
+ +pure virtual | +
Get all items which are stored in playstack.
+
+
|
+ +pure virtual | +
Adjust playstack hold time.
+[in] | time | playstack hold time (unit: second) |
+
|
+ +pure virtual | +
Set default playstack hold time.
+[in] | time | playstack hold time (unit: second) |
+
|
+ +pure virtual | +
Replace current playstack to new one. (It only replace playstack not notifying related callbacks.)
+[in] | prev_ps_id | current exist play service id |
[in] | new_ps_id | play service id for replacing |
[in] | extra_data | additional data composed by requester and data |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IPlaySyncManagerListener, including all inherited members.
+onDataChanged(const std::string &ps_id, std::pair< void *, void * > extra_datas) | NuguClientKit::IPlaySyncManagerListener | virtual |
onStackChanged(const std::pair< std::string, std::string > &ps_ids) | NuguClientKit::IPlaySyncManagerListener | virtual |
onSyncState(const std::string &ps_id, PlaySyncState state, void *extra_data) | NuguClientKit::IPlaySyncManagerListener | virtual |
~IPlaySyncManagerListener()=default (defined in NuguClientKit::IPlaySyncManagerListener) | NuguClientKit::IPlaySyncManagerListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
IPlaySyncManagerListener interface. + More...
+ +#include <playsync_manager_interface.hh>
+Public Member Functions | |
virtual void | onDataChanged (const std::string &ps_id, std::pair< void *, void * > extra_datas) |
Receive callback when the extra data is changed. More... | |
virtual void | onStackChanged (const std::pair< std::string, std::string > &ps_ids) |
Receive callback when the play stack is changed. More... | |
virtual void | onSyncState (const std::string &ps_id, PlaySyncState state, void *extra_data) |
Receive callback when sync state is changed. More... | |
IPlaySyncManagerListener interface.
+
+
|
+ +virtual | +
Receive callback when sync state is changed.
+[in] | ps_id | play service id |
[in] | state | play sync state |
[in] | extra_data | an extra_data which is sent at starting sync |
+
|
+ +virtual | +
Receive callback when the extra data is changed.
+[in] | ps_id | play service id |
[in] | extra_datas | the extra_datas which are composed by previous and new |
+
|
+ +virtual | +
Receive callback when the play stack is changed.
+[in] | ps_ids | play service ids (first:added stack, second:removed stack) |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IRoutineManager, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
IRoutineManager interface. + More...
+ +#include <routine_manager_interface.hh>
+Public Member Functions | |
virtual void | addListener (IRoutineManagerListener *listener)=0 |
Add IRoutineManagerListener. More... | |
+virtual void | finish ()=0 |
Finish action. | |
virtual unsigned int | getCountableActionIndex ()=0 |
Get index of current countable action. More... | |
virtual unsigned int | getCountableActionSize ()=0 |
Get size of countable actions. More... | |
virtual unsigned int | getCurrentActionIndex ()=0 |
Get index of current active action. More... | |
virtual std::string | getCurrentActionToken ()=0 |
Get token of current active action. More... | |
virtual bool | hasRoutineDirective (const NuguDirective *ndir)=0 |
Check whether routine directive exist in NuguDirective. More... | |
virtual bool | hasToSkipMedia (const std::string &dialog_id)=0 |
Check whether current condition should skip media play. More... | |
+virtual void | interrupt ()=0 |
Interrupt routine. | |
virtual bool | isActionProgress (const std::string &dialog_id)=0 |
Check whether action is in progress currently. More... | |
virtual bool | isActionValid (const NJson::Value &action)=0 |
Check whether the action is valid. More... | |
virtual bool | isConditionToCancel (const NuguDirective *ndir)=0 |
Check whether current condition is to cancel directive. More... | |
virtual bool | isConditionToFinishAction (const NuguDirective *ndir)=0 |
Check whether current condition is possible to finish progressing action. More... | |
virtual bool | isConditionToStop (const NuguDirective *ndir)=0 |
Check whether current condition is to stop routine. More... | |
virtual bool | isMuteDelayed ()=0 |
Check whether mute delay is processed. More... | |
virtual bool | isRoutineAlive ()=0 |
Check whether routine has remained action to execute. More... | |
virtual bool | isRoutineProgress ()=0 |
Check whether routine is in progress currently. More... | |
virtual bool | move (unsigned int index)=0 |
Move to the specific action and process. More... | |
+virtual void | presetActionTimeout ()=0 |
Set default time (5 sec) when action timeout is not set. | |
virtual void | removeListener (IRoutineManagerListener *listener)=0 |
Remove IRoutineManagerListener. More... | |
+virtual void | resume ()=0 |
Resume routine. | |
virtual void | setDataRequester (DataRequester requester)=0 |
Set DataRequester delegate for handling data type action. More... | |
virtual void | setPendingStop (const NuguDirective *ndir)=0 |
Set pending stop after checking whether Routine.Stop directive exists. More... | |
virtual void | setTextRequester (TextRequester requester)=0 |
Set TextRequester delegate for handling text type action. More... | |
virtual bool | start (const std::string &token, const NJson::Value &actions)=0 |
Start routine. More... | |
+virtual void | stop ()=0 |
Stop routine. | |
IRoutineManager interface.
+
+
|
+ +pure virtual | +
[in] | listener | IRoutineManagerListener instance |
+
|
+ +pure virtual | +
Remove IRoutineManagerListener.
+[in] | listener | IRoutineManagerListener instance |
+
|
+ +pure virtual | +
Set TextRequester delegate for handling text type action.
+[in] | requester | TextRequester delegate |
+
|
+ +pure virtual | +
Set DataRequester delegate for handling data type action.
+[in] | requester | DataRequester delegate |
+
|
+ +pure virtual | +
Start routine.
+[in] | token | token which is delivered from routine play |
[in] | actions | action list |
+
|
+ +pure virtual | +
Move to the specific action and process.
+[in] | index | action index |
true | succeed to move and process |
false | fail to move and process |
+
|
+ +pure virtual | +
Get token of current active action.
+
+
|
+ +pure virtual | +
Get index of current active action.
+
+
|
+ +pure virtual | +
Get size of countable actions.
+
+
|
+ +pure virtual | +
Get index of current countable action.
+
+
|
+ +pure virtual | +
Check whether the action is valid.
+
+
|
+ +pure virtual | +
Check whether routine is in progress currently.
+
+
|
+ +pure virtual | +
Check whether routine has remained action to execute.
+
+
|
+ +pure virtual | +
Check whether action is in progress currently.
+[in] | dialog_id | dialog id of action |
+
|
+ +pure virtual | +
Check whether routine directive exist in NuguDirective.
+[in] | ndir | NuguDirective object |
+
|
+ +pure virtual | +
Check whether current condition is to stop routine.
+[in] | ndir | NuguDirective object |
+
|
+ +pure virtual | +
Check whether current condition is possible to finish progressing action.
+[in] | ndir | NuguDirective object |
+
|
+ +pure virtual | +
Check whether current condition is to cancel directive.
+[in] | ndir | NuguDirective object |
+
|
+ +pure virtual | +
Check whether mute delay is processed.
+true | in progress |
false | not in progress |
+
|
+ +pure virtual | +
Set pending stop after checking whether Routine.Stop directive exists.
+[in] | ndir | NuguDirective object |
+
|
+ +pure virtual | +
Check whether current condition should skip media play.
+[in] | dialog_id | dialog id |
true | skip |
false | not skip |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IRoutineManagerListener, including all inherited members.
+onActionTimeout(bool last_action=false)=0 | NuguClientKit::IRoutineManagerListener | pure virtual |
onActivity(RoutineActivity activity)=0 | NuguClientKit::IRoutineManagerListener | pure virtual |
~IRoutineManagerListener()=default (defined in NuguClientKit::IRoutineManagerListener) | NuguClientKit::IRoutineManagerListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
IRoutineManagerListener interface. + More...
+ +#include <routine_manager_interface.hh>
+Public Member Functions | |
virtual void | onActionTimeout (bool last_action=false)=0 |
Receive callback when the action timeout is ended. More... | |
virtual void | onActivity (RoutineActivity activity)=0 |
Receive callback when the routine activity state is changed. More... | |
IRoutineManagerListener interface.
+
+
|
+ +pure virtual | +
Receive callback when the routine activity state is changed.
+[in] | activity | current routine activity state |
+
|
+ +pure virtual | +
Receive callback when the action timeout is ended.
+[in] | last_action | whether it was processed as the last action |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::ISessionManager, including all inherited members.
+activate(const std::string &dialog_id)=0 | NuguClientKit::ISessionManager | pure virtual |
addListener(ISessionManagerListener *listener)=0 | NuguClientKit::ISessionManager | pure virtual |
clear()=0 | NuguClientKit::ISessionManager | pure virtual |
deactivate(const std::string &dialog_id)=0 | NuguClientKit::ISessionManager | pure virtual |
getActiveSessionInfo()=0 | NuguClientKit::ISessionManager | pure virtual |
removeListener(ISessionManagerListener *listener)=0 | NuguClientKit::ISessionManager | pure virtual |
set(const std::string &dialog_id, Session &&session)=0 | NuguClientKit::ISessionManager | pure virtual |
~ISessionManager()=default (defined in NuguClientKit::ISessionManager) | NuguClientKit::ISessionManager | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
SessionManager interface. + More...
+ +#include <session_manager_interface.hh>
+Public Member Functions | |
virtual void | activate (const std::string &dialog_id)=0 |
Activate Session which is mapped with dialog request id. More... | |
virtual void | addListener (ISessionManagerListener *listener)=0 |
Add ISessionManagerListener. More... | |
+virtual void | clear ()=0 |
Clear all session info. | |
virtual void | deactivate (const std::string &dialog_id)=0 |
Deactivate Session which is mapped with dialog request id. More... | |
virtual NJson::Value | getActiveSessionInfo ()=0 |
Get current active session info which is composed by session list. More... | |
virtual void | removeListener (ISessionManagerListener *listener)=0 |
Remove ISessionManagerListener. More... | |
virtual void | set (const std::string &dialog_id, Session &&session)=0 |
Set Session object which is received by Session Interface. More... | |
SessionManager interface.
+
+
|
+ +pure virtual | +
[in] | listener | ISessionManagerListener instance |
+
|
+ +pure virtual | +
Remove ISessionManagerListener.
+[in] | listener | ISessionManagerListener instance |
+
|
+ +pure virtual | +
Set Session object which is received by Session Interface.
+[in] | dialog_id | dialog request id for mapping Session object |
[in] | session | Session object |
+
|
+ +pure virtual | +
Activate Session which is mapped with dialog request id.
+[in] | dialog_id | dialog request id for Session |
+
|
+ +pure virtual | +
Deactivate Session which is mapped with dialog request id.
+[in] | dialog_id | dialog request id for Session |
+
|
+ +pure virtual | +
Get current active session info which is composed by session list.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::ISessionManagerListener, including all inherited members.
+activated(const std::string &dialog_id, Session session)=0 | NuguClientKit::ISessionManagerListener | pure virtual |
deactivated(const std::string &dialog_id)=0 | NuguClientKit::ISessionManagerListener | pure virtual |
~ISessionManagerListener()=default (defined in NuguClientKit::ISessionManagerListener) | NuguClientKit::ISessionManagerListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
ISessionManagerListener interface. + More...
+ +#include <session_manager_interface.hh>
+Public Member Functions | |
virtual void | activated (const std::string &dialog_id, Session session)=0 |
Receive callback when the session is activated. More... | |
virtual void | deactivated (const std::string &dialog_id)=0 |
Receive callback when the session is deactivated. More... | |
ISessionManagerListener interface.
+
+
|
+ +pure virtual | +
Receive callback when the session is activated.
+[in] | dialog_id | dialog request id for Session |
[in] | session | Session object |
+
|
+ +pure virtual | +
Receive callback when the session is deactivated.
+[in] | dialog_id | dialog request id for Session |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::ISpeechRecognizer, including all inherited members.
+finishListening()=0 | NuguClientKit::ISpeechRecognizer | pure virtual |
getCodec()=0 | NuguClientKit::ISpeechRecognizer | pure virtual |
getEpdAttribute()=0 | NuguClientKit::ISpeechRecognizer | pure virtual |
getMimeType()=0 | NuguClientKit::ISpeechRecognizer | pure virtual |
isMute()=0 | NuguClientKit::ISpeechRecognizer | pure virtual |
setEpdAttribute(const EpdAttribute &attribute)=0 | NuguClientKit::ISpeechRecognizer | pure virtual |
setListener(ISpeechRecognizerListener *listener)=0 | NuguClientKit::ISpeechRecognizer | pure virtual |
startListening(const std::string &id)=0 | NuguClientKit::ISpeechRecognizer | pure virtual |
stopListening()=0 | NuguClientKit::ISpeechRecognizer | pure virtual |
~ISpeechRecognizer()=default (defined in NuguClientKit::ISpeechRecognizer) | NuguClientKit::ISpeechRecognizer | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
SpeechRecognizer interface. + More...
+ +#include <speech_recognizer_interface.hh>
+Public Member Functions | |
+virtual void | finishListening ()=0 |
finish listening speech | |
virtual std::string | getCodec ()=0 |
Get codec information of recorder. More... | |
virtual EpdAttribute | getEpdAttribute ()=0 |
Get EPD attribute. More... | |
virtual std::string | getMimeType ()=0 |
Get mime type information of recorder. More... | |
virtual bool | isMute ()=0 |
Get audio recorder's mute. More... | |
virtual void | setEpdAttribute (const EpdAttribute &attribute)=0 |
Set EPD attribute. More... | |
virtual void | setListener (ISpeechRecognizerListener *listener)=0 |
Set SpeechRecognizer listener object. More... | |
virtual bool | startListening (const std::string &id)=0 |
Start listening speech. More... | |
+virtual void | stopListening ()=0 |
Stop listening speech. | |
SpeechRecognizer interface.
+
+
|
+ +pure virtual | +
Set SpeechRecognizer listener object.
+[in] | listener | ISpeechRecognizerListener object |
+
|
+ +pure virtual | +
Start listening speech.
+[in] | id | listening id |
+
|
+ +pure virtual | +
Set EPD attribute.
+[in] | attribute | EPD attribute |
+
|
+ +pure virtual | +
Get EPD attribute.
+
+
|
+ +pure virtual | +
Get audio recorder's mute.
+
+
|
+ +pure virtual | +
Get codec information of recorder.
+
+
|
+ +pure virtual | +
Get mime type information of recorder.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::ISpeechRecognizerAggregator, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
SpeechRecognizerAggregator interface. + More...
+ +#include <speech_recognizer_aggregator_interface.hh>
+Public Member Functions | |
virtual void | addListener (ISpeechRecognizerAggregatorListener *listener)=0 |
Add the ISpeechRecognizerAggregatorListener object. More... | |
+virtual void | finishListening ()=0 |
finish listening speech | |
virtual void | removeListener (ISpeechRecognizerAggregatorListener *listener)=0 |
Remove the ISpeechRecognizerAggregatorListener object. More... | |
virtual void | setWakeupHandler (const std::shared_ptr< IWakeupHandler > &wakeup_handler)=0 |
Set the IWakeupHandler object. More... | |
virtual bool | setWakeupModel (const WakeupModelFile &model_file)=0 |
Set wakeup model file. More... | |
virtual void | startListening (float power_noise=0, float power_speech=0, ASRInitiator initiator=ASRInitiator::TAP)=0 |
Start recognizing speech. More... | |
+virtual void | startListeningWithTrigger ()=0 |
Start detecting wakeup and progress recognizing speech after wakeup detected. | |
virtual void | stopListening (bool cancel=false)=0 |
Stop both recognizing speech and detecting wakeup. More... | |
SpeechRecognizerAggregator interface.
+ +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::ISpeechRecognizerAggregatorListener, including all inherited members.
+onASRState(ASRState state, const std::string &dialog_id, ASRInitiator initiator)=0 | NuguClientKit::ISpeechRecognizerAggregatorListener | pure virtual |
onResult(const RecognitionResult &result, const std::string &dialog_id)=0 | NuguClientKit::ISpeechRecognizerAggregatorListener | pure virtual |
onWakeupState(WakeupDetectState state, float power_noise, float power_speech)=0 | NuguClientKit::ISpeechRecognizerAggregatorListener | pure virtual |
~ISpeechRecognizerAggregatorListener()=default (defined in NuguClientKit::ISpeechRecognizerAggregatorListener) | NuguClientKit::ISpeechRecognizerAggregatorListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
SpeechRecognizerAggregator listener interface. + More...
+ +#include <speech_recognizer_aggregator_interface.hh>
+Public Member Functions | |
virtual void | onASRState (ASRState state, const std::string &dialog_id, ASRInitiator initiator)=0 |
Notify to user the asr state changed. More... | |
virtual void | onResult (const RecognitionResult &result, const std::string &dialog_id)=0 |
Notify to user the recognition result. More... | |
virtual void | onWakeupState (WakeupDetectState state, float power_noise, float power_speech)=0 |
Notify to user the wakeup detection state changed. More... | |
SpeechRecognizerAggregator listener interface.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::ISpeechRecognizerListener, including all inherited members.
+onListeningState(ListeningState state, const std::string &id)=0 | NuguClientKit::ISpeechRecognizerListener | pure virtual |
onRecordData(unsigned char *buf, int length, bool is_end)=0 | NuguClientKit::ISpeechRecognizerListener | pure virtual |
~ISpeechRecognizerListener()=default (defined in NuguClientKit::ISpeechRecognizerListener) | NuguClientKit::ISpeechRecognizerListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
SpeechRecognizer listener interface. + More...
+ +#include <speech_recognizer_interface.hh>
+Public Member Functions | |
virtual void | onListeningState (ListeningState state, const std::string &id)=0 |
Report to the user listening state changed. More... | |
virtual void | onRecordData (unsigned char *buf, int length, bool is_end)=0 |
Get current audio input stream. More... | |
SpeechRecognizer listener interface.
+
+
|
+ +pure virtual | +
Report to the user listening state changed.
+[in] | state | listening state |
[in] | id | listening id |
+
|
+ +pure virtual | +
Get current audio input stream.
+[in] | buf | audio input data |
[in] | length | audio input length |
[in] | is_end | whether final data |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::ITTSPlayer, including all inherited members.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
ttsplayer interface + More...
+ +#include <media_player_interface.hh>
+Public Member Functions | |
virtual bool | writeAudio (const char *data, int size)=0 |
Write audio samples to the tts player. The player decodes it using opus. More... | |
+virtual void | writeDone ()=0 |
Notify to write done to the tts player. | |
Public Member Functions inherited from NuguClientKit::IMediaPlayer | |
virtual void | addListener (IMediaPlayerListener *listener)=0 |
Add the Listener object. More... | |
virtual int | duration ()=0 |
Get duration information of the media content from the media player. More... | |
virtual bool | isPlaying ()=0 |
Check whether the media player is playing media content. More... | |
virtual bool | loop ()=0 |
Get loop information of the media content from the media player. More... | |
virtual bool | mute ()=0 |
Get mute information of the media content from the media player. More... | |
+virtual bool | pause ()=0 |
Request media player to pause the media content. | |
+virtual bool | play ()=0 |
Request media player to play the media content. | |
virtual int | position ()=0 |
Get current position information of the media content from the media player. More... | |
virtual void | removeListener (IMediaPlayerListener *listener)=0 |
Remove the Listener object. More... | |
+virtual bool | resume ()=0 |
Request media player to resume the media content. | |
virtual bool | seek (int sec)=0 |
Request the media player to move the current content section. More... | |
virtual void | setAudioAttribute (NuguAudioAttribute attr)=0 |
Sets the audio attribute in the media player. More... | |
virtual bool | setDuration (int duration)=0 |
Set duration of the media content to the media player. More... | |
virtual void | setLoop (bool loop)=0 |
Set loop of the media content to the media player. More... | |
virtual bool | setMute (bool mute)=0 |
Set mute of the media content to the media player. More... | |
virtual bool | setPosition (int position)=0 |
Set current position of the media content to the media player. More... | |
virtual bool | setSource (const std::string &url)=0 |
Sets the playurl of the media content to play in the media player. More... | |
virtual bool | setState (MediaPlayerState state)=0 |
Set state of the media player. More... | |
virtual bool | setVolume (int volume)=0 |
Set volume of the media content to the media player. More... | |
virtual MediaPlayerState | state ()=0 |
Get state of the media player. More... | |
virtual std::string | stateString (MediaPlayerState state)=0 |
Get state name of the media player. More... | |
+virtual bool | stop ()=0 |
Request media player to stop the media content. | |
virtual std::string | url ()=0 |
Get url of media content from the media player. More... | |
virtual int | volume ()=0 |
Get volume information of the media content from the media player. More... | |
ttsplayer interface
+
+
|
+ +pure virtual | +
Write audio samples to the tts player. The player decodes it using opus.
+[in] | data | raw audio data |
[in] | size | data size |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IWakeupHandler, including all inherited members.
+changeModel(const WakeupModelFile &model_file)=0 | NuguClientKit::IWakeupHandler | pure virtual |
setListener(IWakeupListener *listener)=0 | NuguClientKit::IWakeupHandler | pure virtual |
startWakeup()=0 | NuguClientKit::IWakeupHandler | pure virtual |
stopWakeup()=0 | NuguClientKit::IWakeupHandler | pure virtual |
~IWakeupHandler()=default (defined in NuguClientKit::IWakeupHandler) | NuguClientKit::IWakeupHandler | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Wakeup handler interface. + More...
+ +#include <wakeup_interface.hh>
+Public Member Functions | |
virtual void | changeModel (const WakeupModelFile &model_file)=0 |
Change wakeup word model. More... | |
virtual void | setListener (IWakeupListener *listener)=0 |
Set the Listener object. More... | |
virtual bool | startWakeup ()=0 |
Start the wakeup detection. More... | |
+virtual void | stopWakeup ()=0 |
Stop the wakeup detection. | |
Wakeup handler interface.
+
+
|
+ +pure virtual | +
Set the Listener object.
+[in] | listener | listener object |
+
|
+ +pure virtual | +
Start the wakeup detection.
+
+
|
+ +pure virtual | +
Change wakeup word model.
+[in] | model_file | WakeupModelFile object |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::IWakeupListener, including all inherited members.
+onWakeupState(WakeupDetectState state, float power_noise, float power_speech)=0 | NuguClientKit::IWakeupListener | pure virtual |
~IWakeupListener()=default (defined in NuguClientKit::IWakeupListener) | NuguClientKit::IWakeupListener | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Wakeup listener interface. + More...
+ +#include <wakeup_interface.hh>
+Public Member Functions | |
virtual void | onWakeupState (WakeupDetectState state, float power_noise, float power_speech)=0 |
Report to the user wakeup detection state changed. More... | |
Wakeup listener interface.
+
+
|
+ +pure virtual | +
Report to the user wakeup detection state changed.
+[in] | state | wakeup detection state |
[in] | power_noise | min power value |
[in] | power_speech | max power value |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::NuguAuth, including all inherited members.
+discovery(struct AuthResponse *response=nullptr) | NuguClientKit::NuguAuth | |
discovery(const std::function< void(bool success, const struct AuthResponse *response)> &cb) | NuguClientKit::NuguAuth | |
generateAuthorizeUrl(const std::string &device_serial) | NuguClientKit::NuguAuth | |
getAuthorizationCodeToken(const std::string &code, const std::string &device_serial, struct AuthResponse *response=nullptr) | NuguClientKit::NuguAuth | |
getClientCredentialsToken(const std::string &device_serial, struct AuthResponse *response=nullptr) | NuguClientKit::NuguAuth | |
getGatewayRegistryUri() | NuguClientKit::NuguAuth | |
getRemainExpireTime(const NuguToken *token, time_t base_time=0) | NuguClientKit::NuguAuth | |
getTemplateServerUri() | NuguClientKit::NuguAuth | |
isExpired(const NuguToken *token, time_t base_time=0) | NuguClientKit::NuguAuth | |
isSupport(const GrantType >ype) | NuguClientKit::NuguAuth | |
NuguAuth(const NuguDeviceConfig &config) (defined in NuguClientKit::NuguAuth) | NuguClientKit::NuguAuth | explicit |
parseAccessToken(NuguToken *token) | NuguClientKit::NuguAuth | |
refresh(NuguToken *token, const std::string &device_serial="", struct AuthResponse *response=nullptr) | NuguClientKit::NuguAuth | |
~NuguAuth() (defined in NuguClientKit::NuguAuth) | NuguClientKit::NuguAuth |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <nugu_auth.hh>
+Public Member Functions | |
bool | discovery (const std::function< void(bool success, const struct AuthResponse *response)> &cb) |
Async OAuth2 discovery to get OAuth2 end-point and server url. More... | |
bool | discovery (struct AuthResponse *response=nullptr) |
OAuth2 discovery to get OAuth2 end-point and server url. More... | |
std::string | generateAuthorizeUrl (const std::string &device_serial) |
Get OAuth2 authorization url. More... | |
NuguToken * | getAuthorizationCodeToken (const std::string &code, const std::string &device_serial, struct AuthResponse *response=nullptr) |
Get the token using authorization code (token exchange) More... | |
NuguToken * | getClientCredentialsToken (const std::string &device_serial, struct AuthResponse *response=nullptr) |
Get the token using client credentials. More... | |
std::string | getGatewayRegistryUri () |
Get uri for device gateway registry. More... | |
time_t | getRemainExpireTime (const NuguToken *token, time_t base_time=0) |
Get remaining expiration time based on base_time. More... | |
std::string | getTemplateServerUri () |
Get uri for template server. More... | |
bool | isExpired (const NuguToken *token, time_t base_time=0) |
Check the token is expired or not. More... | |
bool | isSupport (const GrantType >ype) |
Check whether the requested grant type is supported for the client. More... | |
+ | NuguAuth (const NuguDeviceConfig &config) |
bool | parseAccessToken (NuguToken *token) |
Parsing the JWT access_token and fill the token information. More... | |
bool | refresh (NuguToken *token, const std::string &device_serial="", struct AuthResponse *response=nullptr) |
Refresh the access_token and update the token information. More... | |
bool NuguClientKit::NuguAuth::discovery | +( | +struct AuthResponse * | +response = nullptr | ) | ++ |
OAuth2 discovery to get OAuth2 end-point and server url.
+[out] | response | HTTP response data |
true | success |
false | failure |
bool NuguClientKit::NuguAuth::discovery | +( | +const std::function< void(bool success, const struct AuthResponse *response)> & | +cb | ) | ++ |
Async OAuth2 discovery to get OAuth2 end-point and server url.
+[in] | cb | callback function to receive response |
true | success |
false | failure |
bool NuguClientKit::NuguAuth::isSupport | +( | +const GrantType & | +gtype | ) | ++ |
Check whether the requested grant type is supported for the client.
+[in] | gtype | grant type |
true | supported |
false | not supported |
std::string NuguClientKit::NuguAuth::generateAuthorizeUrl | +( | +const std::string & | +device_serial | ) | ++ |
Get OAuth2 authorization url.
+[in] | device_serial | device serial info |
NuguToken* NuguClientKit::NuguAuth::getAuthorizationCodeToken | +( | +const std::string & | +code, | +
+ | + | const std::string & | +device_serial, | +
+ | + | struct AuthResponse * | +response = nullptr |
+
+ | ) | ++ |
Get the token using authorization code (token exchange)
+[in] | code | OAuth2 authorization code |
[in] | device_serial | device serial info |
[out] | response | HTTP response data |
NuguToken* NuguClientKit::NuguAuth::getClientCredentialsToken | +( | +const std::string & | +device_serial, | +
+ | + | struct AuthResponse * | +response = nullptr |
+
+ | ) | ++ |
Get the token using client credentials.
+[in] | device_serial | device serial info |
[out] | response | HTTP response data |
bool NuguClientKit::NuguAuth::parseAccessToken | +( | +NuguToken * | +token | ) | ++ |
Parsing the JWT access_token and fill the token information.
+[in,out] | token | token information |
bool NuguClientKit::NuguAuth::refresh | +( | +NuguToken * | +token, | +
+ | + | const std::string & | +device_serial = "" , |
+
+ | + | struct AuthResponse * | +response = nullptr |
+
+ | ) | ++ |
Refresh the access_token and update the token information.
+[in,out] | token | token information |
[in] | device_serial | device serial info |
[out] | response | HTTP response data |
bool NuguClientKit::NuguAuth::isExpired | +( | +const NuguToken * | +token, | +
+ | + | time_t | +base_time = 0 |
+
+ | ) | ++ |
Check the token is expired or not.
+token[in] | token information |
base_time[in] | base timestamp(secs), '0' means the current timestamp |
time_t NuguClientKit::NuguAuth::getRemainExpireTime | +( | +const NuguToken * | +token, | +
+ | + | time_t | +base_time = 0 |
+
+ | ) | ++ |
Get remaining expiration time based on base_time.
+token[in] | token information |
base_time[in] | base timestamp(secs), '0' means the current timestamp |
std::string NuguClientKit::NuguAuth::getGatewayRegistryUri | +( | +) | ++ |
Get uri for device gateway registry.
+std::string NuguClientKit::NuguAuth::getTemplateServerUri | +( | +) | ++ |
Get uri for template server.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::NuguClient, including all inherited members.
+addDialogUXStateListener(IDialogUXStateAggregatorListener *listener) | NuguClientKit::NuguClient | |
deInitialize(void) | NuguClientKit::NuguClient | |
getCapabilityBuilder() | NuguClientKit::NuguClient | |
getCapabilityHandler(const std::string &cname) | NuguClientKit::NuguClient | |
getFocusManager() | NuguClientKit::NuguClient | |
getNetworkManager() | NuguClientKit::NuguClient | |
getNuguCoreContainer() | NuguClientKit::NuguClient | |
getSpeechRecognizerAggregator() | NuguClientKit::NuguClient | |
initialize(void) | NuguClientKit::NuguClient | |
loadPlugins(const std::string &path="") | NuguClientKit::NuguClient | |
NuguClient() (defined in NuguClientKit::NuguClient) | NuguClientKit::NuguClient | |
removeDialogUXStateListener(IDialogUXStateAggregatorListener *listener) | NuguClientKit::NuguClient | |
setWakeupWord(const std::string &wakeup_word) | NuguClientKit::NuguClient | |
unloadPlugins(void) | NuguClientKit::NuguClient | |
~NuguClient() (defined in NuguClientKit::NuguClient) | NuguClientKit::NuguClient |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
NUGU Client. + More...
+ +#include <nugu_client.hh>
+Classes | |
class | CapabilityBuilder |
CapabilityBuilder. More... | |
+Public Member Functions | |
+void | addDialogUXStateListener (IDialogUXStateAggregatorListener *listener) |
Add DialogUXStateAggregatorListener. | |
+void | deInitialize (void) |
Request NUGU SDK deinitialization. | |
CapabilityBuilder * | getCapabilityBuilder () |
Get CapabilityBuilder object. More... | |
ICapabilityInterface * | getCapabilityHandler (const std::string &cname) |
Get instance of CapabilityAgent. More... | |
IFocusManager * | getFocusManager () |
Get instance of FocusManager. More... | |
INetworkManager * | getNetworkManager () |
Get NetworkManager object. More... | |
INuguCoreContainer * | getNuguCoreContainer () |
Get NuguCoreContainer object. More... | |
ISpeechRecognizerAggregator * | getSpeechRecognizerAggregator () |
Get instance of SpeechRecognizerAggregator. More... | |
+bool | initialize (void) |
Request NUGU SDK initialization. | |
bool | loadPlugins (const std::string &path="") |
Request NUGU SDK to load all plugins from directory. If this function is not called directly, it is called automatically by initialize(). More... | |
+void | removeDialogUXStateListener (IDialogUXStateAggregatorListener *listener) |
Remove DialogUXStateAggregatorListener. | |
void | setWakeupWord (const std::string &wakeup_word) |
Set wakeup word. More... | |
+void | unloadPlugins (void) |
Request NUGU SDK to unload all plugins. | |
NUGU Client.
+void NuguClientKit::NuguClient::setWakeupWord | +( | +const std::string & | +wakeup_word | ) | ++ |
Set wakeup word.
+[in] | wakeup_word | wakeup word text |
CapabilityBuilder* NuguClientKit::NuguClient::getCapabilityBuilder | +( | +) | ++ |
Get CapabilityBuilder object.
+bool NuguClientKit::NuguClient::loadPlugins | +( | +const std::string & | +path = "" | ) | ++ |
Request NUGU SDK to load all plugins from directory. If this function is not called directly, it is called automatically by initialize().
+[in] | path | Plugin directory path. If empty, the default directory is used. |
INuguCoreContainer* NuguClientKit::NuguClient::getNuguCoreContainer | +( | +) | ++ |
Get NuguCoreContainer object.
+INetworkManager* NuguClientKit::NuguClient::getNetworkManager | +( | +) | ++ |
Get NetworkManager object.
+ICapabilityInterface* NuguClientKit::NuguClient::getCapabilityHandler | +( | +const std::string & | +cname | ) | ++ |
Get instance of CapabilityAgent.
+IFocusManager* NuguClientKit::NuguClient::getFocusManager | +( | +) | ++ |
Get instance of FocusManager.
+ISpeechRecognizerAggregator* NuguClientKit::NuguClient::getSpeechRecognizerAggregator | +( | +) | ++ |
Get instance of SpeechRecognizerAggregator.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::NuguClient::CapabilityBuilder, including all inherited members.
+add(ICapabilityInterface *cap_instance) | NuguClientKit::NuguClient::CapabilityBuilder | |
construct() | NuguClientKit::NuguClient::CapabilityBuilder | |
NuguClient (defined in NuguClientKit::NuguClient::CapabilityBuilder) | NuguClientKit::NuguClient::CapabilityBuilder | friend |
setWakeupModel(const WakeupModelFile &model_file) | NuguClientKit::NuguClient::CapabilityBuilder |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <nugu_client.hh>
+Public Member Functions | |
CapabilityBuilder * | add (ICapabilityInterface *cap_instance) |
Add capability instance. It could create from CapabilityFactory or by self as inhering ICapabilityInterface. More... | |
bool | construct () |
Construct with capabilities added to CapabilityBuilder. More... | |
CapabilityBuilder * | setWakeupModel (const WakeupModelFile &model_file) |
Set wakeup model file for composing SpeechRecognizerAggregator. More... | |
+Friends | |
+class | NuguClient |
CapabilityBuilder* NuguClientKit::NuguClient::CapabilityBuilder::add | +( | +ICapabilityInterface * | +cap_instance | ) | ++ |
Add capability instance. It could create from CapabilityFactory or by self as inhering ICapabilityInterface.
+[in] | cap_instance | capability interface |
CapabilityBuilder* NuguClientKit::NuguClient::CapabilityBuilder::setWakeupModel | +( | +const WakeupModelFile & | +model_file | ) | ++ |
Set wakeup model file for composing SpeechRecognizerAggregator.
+[in] | model_file | wakeup model file |
bool NuguClientKit::NuguClient::CapabilityBuilder::construct | +( | +) | ++ |
Construct with capabilities added to CapabilityBuilder.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::NuguHttpRest, including all inherited members.
+addHeader(const std::string &key, const std::string &value) | NuguClientKit::NuguHttpRest | |
del(const std::string &path, const NuguHttpHeader *additional_header=nullptr) | NuguClientKit::NuguHttpRest | |
del(const std::string &path, ResponseCallback cb) | NuguClientKit::NuguHttpRest | |
del(const std::string &path, const NuguHttpHeader *additional_header, ResponseCallback cb) | NuguClientKit::NuguHttpRest | |
findHeader(const std::string &key) | NuguClientKit::NuguHttpRest | |
get(const std::string &path, const NuguHttpHeader *additional_header=nullptr) | NuguClientKit::NuguHttpRest | |
get(const std::string &path, ResponseCallback cb) | NuguClientKit::NuguHttpRest | |
get(const std::string &path, const NuguHttpHeader *additional_header, ResponseCallback cb) | NuguClientKit::NuguHttpRest | |
getUrl() | NuguClientKit::NuguHttpRest | |
NuguHttpRest(const std::string &url) (defined in NuguClientKit::NuguHttpRest) | NuguClientKit::NuguHttpRest | explicit |
post(const std::string &path, const std::string &body, const NuguHttpHeader *additional_header=nullptr) | NuguClientKit::NuguHttpRest | |
post(const std::string &path, const std::string &body, ResponseCallback cb) | NuguClientKit::NuguHttpRest | |
post(const std::string &path, const std::string &body, const NuguHttpHeader *additional_header, ResponseCallback cb) | NuguClientKit::NuguHttpRest | |
put(const std::string &path, const std::string &body, const NuguHttpHeader *additional_header=nullptr) | NuguClientKit::NuguHttpRest | |
put(const std::string &path, const std::string &body, ResponseCallback cb) | NuguClientKit::NuguHttpRest | |
put(const std::string &path, const std::string &body, const NuguHttpHeader *additional_header, ResponseCallback cb) | NuguClientKit::NuguHttpRest | |
removeHeader(const std::string &key) | NuguClientKit::NuguHttpRest | |
ResponseCallback typedef | NuguClientKit::NuguHttpRest | |
setConnectionTimeout(long msecs) | NuguClientKit::NuguHttpRest | |
setTimeout(long msecs) | NuguClientKit::NuguHttpRest | |
~NuguHttpRest() (defined in NuguClientKit::NuguHttpRest) | NuguClientKit::NuguHttpRest | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
NUGU HTTP Rest. + More...
+ +#include <nugu_http_rest.hh>
+Public Types | |
+typedef std::function< void(const NuguHttpResponse *resp)> | ResponseCallback |
Callback prototype for receiving async response. | |
+Public Member Functions | |
bool | addHeader (const std::string &key, const std::string &value) |
Add a key-value string to common header. More... | |
bool | del (const std::string &path, const NuguHttpHeader *additional_header, ResponseCallback cb) |
HTTP DELETE async requests. More... | |
NuguHttpResponse * | del (const std::string &path, const NuguHttpHeader *additional_header=nullptr) |
HTTP DELETE requests. More... | |
bool | del (const std::string &path, ResponseCallback cb) |
HTTP DELETE async requests. More... | |
std::string | findHeader (const std::string &key) |
Find a value for key from common header. More... | |
bool | get (const std::string &path, const NuguHttpHeader *additional_header, ResponseCallback cb) |
HTTP GET async requests. More... | |
NuguHttpResponse * | get (const std::string &path, const NuguHttpHeader *additional_header=nullptr) |
HTTP GET requests. More... | |
bool | get (const std::string &path, ResponseCallback cb) |
HTTP GET async requests. More... | |
std::string | getUrl () |
Get the url of host. More... | |
+ | NuguHttpRest (const std::string &url) |
bool | post (const std::string &path, const std::string &body, const NuguHttpHeader *additional_header, ResponseCallback cb) |
HTTP POST async requests. More... | |
NuguHttpResponse * | post (const std::string &path, const std::string &body, const NuguHttpHeader *additional_header=nullptr) |
HTTP POST requests. More... | |
bool | post (const std::string &path, const std::string &body, ResponseCallback cb) |
HTTP POST async requests. More... | |
bool | put (const std::string &path, const std::string &body, const NuguHttpHeader *additional_header, ResponseCallback cb) |
HTTP PUT async requests. More... | |
NuguHttpResponse * | put (const std::string &path, const std::string &body, const NuguHttpHeader *additional_header=nullptr) |
HTTP PUT requests. More... | |
bool | put (const std::string &path, const std::string &body, ResponseCallback cb) |
HTTP PUT async requests. More... | |
bool | removeHeader (const std::string &key) |
Remove a key-value from common header. More... | |
void | setConnectionTimeout (long msecs) |
Set connection timeout to host. More... | |
void | setTimeout (long msecs) |
Set timeout to host. More... | |
NUGU HTTP Rest.
+void NuguClientKit::NuguHttpRest::setTimeout | +( | +long | +msecs | ) | ++ |
Set timeout to host.
+[in] | msecs | millisecond |
void NuguClientKit::NuguHttpRest::setConnectionTimeout | +( | +long | +msecs | ) | ++ |
Set connection timeout to host.
+[in] | msecs | millisecond |
std::string NuguClientKit::NuguHttpRest::getUrl | +( | +) | ++ |
Get the url of host.
+bool NuguClientKit::NuguHttpRest::addHeader | +( | +const std::string & | +key, | +
+ | + | const std::string & | +value | +
+ | ) | ++ |
Add a key-value string to common header.
+[in] | key | key string, e.g. "Content-Type" |
[in] | value | value string, e.g. "application/json" |
true | success |
false | failure |
bool NuguClientKit::NuguHttpRest::removeHeader | +( | +const std::string & | +key | ) | ++ |
Remove a key-value from common header.
+[in] | key | key string, e.g. "Content-Type" |
true | success |
false | failure |
std::string NuguClientKit::NuguHttpRest::findHeader | +( | +const std::string & | +key | ) | ++ |
Find a value for key from common header.
+[in] | key | key string, e.g. "Content-Type" |
NuguHttpResponse* NuguClientKit::NuguHttpRest::get | +( | +const std::string & | +path, | +
+ | + | const NuguHttpHeader * | +additional_header = nullptr |
+
+ | ) | ++ |
HTTP GET requests.
+[in] | path | url path |
[in] | additional_header | additional header |
bool NuguClientKit::NuguHttpRest::get | +( | +const std::string & | +path, | +
+ | + | ResponseCallback | +cb | +
+ | ) | ++ |
HTTP GET async requests.
+[in] | path | url path |
[in] | cb | callback function to receive response |
true | success |
false | failure |
bool NuguClientKit::NuguHttpRest::get | +( | +const std::string & | +path, | +
+ | + | const NuguHttpHeader * | +additional_header, | +
+ | + | ResponseCallback | +cb | +
+ | ) | ++ |
HTTP GET async requests.
+[in] | path | url path |
[in] | additional_header | additional header |
[in] | cb | callback function to receive response |
true | success |
false | failure |
NuguHttpResponse* NuguClientKit::NuguHttpRest::post | +( | +const std::string & | +path, | +
+ | + | const std::string & | +body, | +
+ | + | const NuguHttpHeader * | +additional_header = nullptr |
+
+ | ) | ++ |
HTTP POST requests.
+[in] | path | url path |
[in] | body | body data to send |
[in] | additional_header | additional header |
bool NuguClientKit::NuguHttpRest::post | +( | +const std::string & | +path, | +
+ | + | const std::string & | +body, | +
+ | + | ResponseCallback | +cb | +
+ | ) | ++ |
HTTP POST async requests.
+[in] | path | url path |
[in] | body | body data to send |
[in] | cb | callback function to receive response |
true | success |
false | failure |
bool NuguClientKit::NuguHttpRest::post | +( | +const std::string & | +path, | +
+ | + | const std::string & | +body, | +
+ | + | const NuguHttpHeader * | +additional_header, | +
+ | + | ResponseCallback | +cb | +
+ | ) | ++ |
HTTP POST async requests.
+[in] | path | url path |
[in] | body | body data to send |
[in] | additional_header | additional header |
[in] | cb | callback function to receive response |
true | success |
false | failure |
NuguHttpResponse* NuguClientKit::NuguHttpRest::put | +( | +const std::string & | +path, | +
+ | + | const std::string & | +body, | +
+ | + | const NuguHttpHeader * | +additional_header = nullptr |
+
+ | ) | ++ |
HTTP PUT requests.
+[in] | path | url path |
[in] | body | body data to send |
[in] | additional_header | additional header |
bool NuguClientKit::NuguHttpRest::put | +( | +const std::string & | +path, | +
+ | + | const std::string & | +body, | +
+ | + | ResponseCallback | +cb | +
+ | ) | ++ |
HTTP PUT async requests.
+[in] | path | url path |
[in] | body | body data to send |
[in] | cb | callback function to receive response |
true | success |
false | failure |
bool NuguClientKit::NuguHttpRest::put | +( | +const std::string & | +path, | +
+ | + | const std::string & | +body, | +
+ | + | const NuguHttpHeader * | +additional_header, | +
+ | + | ResponseCallback | +cb | +
+ | ) | ++ |
HTTP PUT async requests.
+[in] | path | url path |
[in] | body | body data to send |
[in] | additional_header | additional header |
[in] | cb | callback function to receive response |
true | success |
false | failure |
NuguHttpResponse* NuguClientKit::NuguHttpRest::del | +( | +const std::string & | +path, | +
+ | + | const NuguHttpHeader * | +additional_header = nullptr |
+
+ | ) | ++ |
HTTP DELETE requests.
+[in] | path | url path |
[in] | additional_header | additional header |
bool NuguClientKit::NuguHttpRest::del | +( | +const std::string & | +path, | +
+ | + | ResponseCallback | +cb | +
+ | ) | ++ |
HTTP DELETE async requests.
+[in] | path | url path |
[in] | cb | callback function to receive response |
true | success |
false | failure |
bool NuguClientKit::NuguHttpRest::del | +( | +const std::string & | +path, | +
+ | + | const NuguHttpHeader * | +additional_header, | +
+ | + | ResponseCallback | +cb | +
+ | ) | ++ |
HTTP DELETE async requests.
+[in] | path | url path |
[in] | additional_header | additional header |
[in] | cb | callback function to receive response |
true | success |
false | failure |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This is the complete list of members for NuguClientKit::NuguRunner, including all inherited members.
+invokeMethod(const std::string &tag, request_method method, ExecuteType type=ExecuteType::Auto, int timeout=0) | NuguClientKit::NuguRunner | |
NuguRunner() (defined in NuguClientKit::NuguRunner) | NuguClientKit::NuguRunner | |
request_method typedef | NuguClientKit::NuguRunner | |
~NuguRunner() (defined in NuguClientKit::NuguRunner) | NuguClientKit::NuguRunner | virtual |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <nugu_runner.hh>
+Public Types | |
+typedef std::function< void()> | request_method |
The request method callback. | |
+Public Member Functions | |
bool | invokeMethod (const std::string &tag, request_method method, ExecuteType type=ExecuteType::Auto, int timeout=0) |
Request to execute method on nugu loop. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Go to the source code of this file.
++Classes | |
class | NuguClientKit::IDialogUXStateAggregatorListener |
IDialogUXStateAggregatorListener interface. More... | |
+Enumerations | |
enum class | NuguClientKit::DialogUXState { + Listening +, Recognizing +, Thinking +, Speaking +, + Idle + + } |
DialogUXState list. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
File in include/capability | Includes file in include/base |
---|---|
speaker_interface.hh | nugu_audio.h |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
File in include/clientkit | Includes file in include/capability |
---|---|
dialog_ux_state_aggregator_interface.hh | chips_interface.hh |
speech_recognizer_aggregator_interface.hh | asr_interface.hh |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
File in plugins | Includes file in include |
---|---|
dummy.c | base / nugu_log.h |
dummy.c | base / nugu_plugin.h |
filedump.c | base / nugu_decoder.h |
filedump.c | base / nugu_log.h |
filedump.c | base / nugu_pcm.h |
filedump.c | base / nugu_plugin.h |
filereader.c | base / nugu_log.h |
filereader.c | base / nugu_plugin.h |
filereader.c | base / nugu_recorder.h |
gstreamer.c | base / nugu_log.h |
gstreamer.c | base / nugu_player.h |
gstreamer.c | base / nugu_plugin.h |
gstreamer_pcm.c | base / nugu_log.h |
gstreamer_pcm.c | base / nugu_pcm.h |
gstreamer_pcm.c | base / nugu_plugin.h |
gstreamer_pcm.c | base / nugu_prof.h |
gstreamer_recorder.c | base / nugu_log.h |
gstreamer_recorder.c | base / nugu_plugin.h |
gstreamer_recorder.c | base / nugu_recorder.h |
opus.c | base / nugu_decoder.h |
opus.c | base / nugu_log.h |
opus.c | base / nugu_pcm.h |
opus.c | base / nugu_plugin.h |
opus_encoder.c | base / nugu_encoder.h |
opus_encoder.c | base / nugu_log.h |
opus_encoder.c | base / nugu_pcm.h |
opus_encoder.c | base / nugu_plugin.h |
portaudio.c | base / nugu_log.h |
portaudio.c | base / nugu_plugin.h |
portaudio_pcm_async.c | base / nugu_log.h |
portaudio_pcm_async.c | base / nugu_pcm.h |
portaudio_pcm_async.c | base / nugu_plugin.h |
portaudio_pcm_async.c | base / nugu_prof.h |
portaudio_pcm_sync.c | base / nugu_log.h |
portaudio_pcm_sync.c | base / nugu_pcm.h |
portaudio_pcm_sync.c | base / nugu_plugin.h |
portaudio_pcm_sync.c | base / nugu_prof.h |
portaudio_recorder.c | base / nugu_log.h |
portaudio_recorder.c | base / nugu_plugin.h |
portaudio_recorder.c | base / nugu_recorder.h |
speex.c | base / nugu_encoder.h |
speex.c | base / nugu_log.h |
speex.c | base / nugu_pcm.h |
speex.c | base / nugu_plugin.h |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
File in tests/mock | Includes file in include |
---|---|
media_player_mock.c | base / nugu_log.h |
media_player_mock.c | base / nugu_player.h |
media_player_mock.h | base / nugu_player.h |
nugu_timer_mock.c | base / nugu_log.h |
nugu_timer_mock.c | base / nugu_timer.h |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
File in tests/clientkit | Includes file in include |
---|---|
test_clientkit_auth.cc | clientkit / nugu_auth.hh |
test_clientkit_auth.cc | base / nugu_log.h |
test_clientkit_capability.cc | clientkit / capability.hh |
test_clientkit_capability.cc | clientkit / nugu_client.hh |
test_clientkit_dialog_ux_state_aggregator.cc | clientkit / nugu_client.hh |
test_clientkit_http_rest.cc | clientkit / nugu_http_rest.hh |
test_clientkit_http_rest.cc | base / nugu_log.h |
test_clientkit_nugu_runner.cc | clientkit / nugu_runner.hh |
test_clientkit_speech_recognizer_aggregator.cc | clientkit / capability.hh |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
File in tests/core | Includes file in include |
---|---|
test_core_directive_sequencer.cc | base / nugu_log.h |
test_core_media_player.cc | base / nugu_player.h |
test_core_nugu_timer.cc | base / nugu_timer.h |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+Files | |
file | capability.hh [code] |
file | capability_helper_interface.hh [code] |
file | capability_interface.hh [code] |
file | dialog_ux_state_aggregator_interface.hh [code] |
file | directive_sequencer_interface.hh [code] |
file | focus_manager_interface.hh [code] |
file | interaction_control_manager_interface.hh [code] |
file | media_player_interface.hh [code] |
file | network_manager_interface.hh [code] |
file | nugu_auth.hh [code] |
file | nugu_client.hh [code] |
file | nugu_core_container_interface.hh [code] |
file | nugu_http_rest.hh [code] |
file | nugu_runner.hh [code] |
file | nugu_timer_interface.hh [code] |
file | playsync_manager_interface.hh [code] |
file | routine_manager_interface.hh [code] |
file | session_manager_interface.hh [code] |
file | speech_recognizer_aggregator_interface.hh [code] |
file | speech_recognizer_interface.hh [code] |
file | wakeup_interface.hh [code] |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+Files | |
file | nugu_audio.h [code] |
file | nugu_buffer.h [code] |
file | nugu_decoder.h [code] |
file | nugu_directive.h [code] |
file | nugu_encoder.h [code] |
file | nugu_equeue.h [code] |
file | nugu_event.h [code] |
file | nugu_http.h [code] |
file | nugu_log.h [code] |
file | nugu_media.h [code] |
file | nugu_network_manager.h [code] |
file | nugu_pcm.h [code] |
file | nugu_player.h [code] |
file | nugu_plugin.h [code] |
file | nugu_prof.h [code] |
file | nugu_recorder.h [code] |
file | nugu_ringbuffer.h [code] |
file | nugu_timer.h [code] |
file | nugu_uuid.h [code] |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+Files | |
file | asr_interface.hh [code] |
file | audio_player_interface.hh [code] |
file | battery_interface.hh [code] |
file | bluetooth_interface.hh [code] |
file | capability_factory.hh [code] |
file | chips_interface.hh [code] |
file | display_interface.hh [code] |
file | extension_interface.hh [code] |
file | location_interface.hh [code] |
file | mic_interface.hh [code] |
file | nudge_interface.hh [code] |
file | phone_call_interface.hh [code] |
file | routine_interface.hh [code] |
file | session_interface.hh [code] |
file | sound_interface.hh [code] |
file | speaker_interface.hh [code] |
file | system_interface.hh [code] |
file | text_interface.hh [code] |
file | tts_interface.hh [code] |
file | utility_interface.hh [code] |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Go to the source code of this file.
++Classes | |
struct | NuguClientKit::_BlockingPolicy |
BlockingPolicy. More... | |
class | NuguClientKit::IDirectiveSequencer |
IDirectiveSequencer. More... | |
class | NuguClientKit::IDirectiveSequencerListener |
IDirectiveSequencerListener. More... | |
+Typedefs | |
+typedef struct NuguClientKit::_BlockingPolicy | NuguClientKit::BlockingPolicy |
BlockingPolicy. | |
+Enumerations | |
enum class | NuguClientKit::BlockingMedium { AUDIO = NUGU_DIRECTIVE_MEDIUM_AUDIO +, VISUAL = NUGU_DIRECTIVE_MEDIUM_VISUAL +, NONE = NUGU_DIRECTIVE_MEDIUM_NONE +, ANY = NUGU_DIRECTIVE_MEDIUM_ANY + } |
BlockingMedium. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <clientkit/capability_interface.hh>
Go to the source code of this file.
++Classes | |
struct | NuguCapability::_DisplayContextInfo |
Display Context Information. More... | |
class | NuguCapability::IDisplayHandler |
display handler interface More... | |
class | NuguCapability::IDisplayListener |
display listener interface More... | |
+Typedefs | |
+typedef struct NuguCapability::_DisplayContextInfo | NuguCapability::DisplayContextInfo |
Display Context Information. | |
+Enumerations | |
enum class | NuguCapability::ControlDirection { PREVIOUS +, NEXT + } |
enum class | NuguCapability::ControlType { Focus +, Scroll + } |
enum class | NuguCapability::TemplateControlType { TEMPLATE_PREVIOUS +, TEMPLATE_CLOSEALL + } |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <clientkit/capability_interface.hh>
Go to the source code of this file.
++Classes | |
class | NuguCapability::IExtensionHandler |
extension handler interface More... | |
class | NuguCapability::IExtensionListener |
extension listener interface More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <iostream>
#include <vector>
Go to the source code of this file.
++Classes | |
struct | NuguClientKit::_FocusConfiguration |
FocusConfiguration. More... | |
class | NuguClientKit::IFocusManager |
IFocusManager. More... | |
class | NuguClientKit::IFocusManagerObserver |
IFocusManagerObserver. More... | |
class | NuguClientKit::IFocusResourceListener |
IFocusResourceListener. More... | |
+Typedefs | |
+typedef struct NuguClientKit::_FocusConfiguration | NuguClientKit::FocusConfiguration |
FocusConfiguration. | |
+Enumerations | |
enum class | NuguClientKit::FocusState { FOREGROUND +, BACKGROUND +, NONE + } |
FocusState. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
This page explains how to interpret the graphs that are generated by doxygen.
+Consider the following example:
This will result in the following graph:
+The boxes in the above graph have the following meaning:
+The arrows have the following meaning:
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
ASR capability interface. +More...
++Classes | |
struct | NuguCapability::_ASRAttribute |
Attributes for setting ASR options. More... | |
class | NuguCapability::IASRHandler |
ASR handler interface. More... | |
class | NuguCapability::IASRListener |
ASR listener interface. More... | |
+Typedefs | |
typedef struct NuguCapability::_ASRAttribute | NuguCapability::ASRAttribute |
Attributes for setting ASR options. More... | |
+Enumerations | |
enum class | NuguCapability::ASRError { + RESPONSE_TIMEOUT +, LISTEN_TIMEOUT +, LISTEN_FAILED +, RECOGNIZE_ERROR +, + UNKNOWN + + } |
ASR error list. More... | |
enum class | NuguCapability::ASRInitiator { + WAKE_UP_WORD +, PRESS_AND_HOLD +, TAP +, EXPECT_SPEECH +, + EARSET + + } |
ASR initiator list. More... | |
enum class | NuguCapability::ASRState { + IDLE +, EXPECTING_SPEECH +, LISTENING +, RECOGNIZING +, + BUSY + + } |
ASR state list. More... | |
ASR capability interface.
+ASR (AutomaticSpeechRecognition) is responsible for recording the audio and delivering it to the server and receiving the result of speech recognition.
+typedef struct NuguCapability::_ASRAttribute NuguCapability::ASRAttribute | +
Attributes for setting ASR options.
+
+
|
+ +strong | +
ASR state list.
+
+
|
+ +strong | +
ASR initiator list.
+
+
|
+ +strong | +
ASR error list.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
AudioPlayer capability interface. +More...
++Classes | |
class | NuguCapability::IAudioPlayerDisplayListener |
audioplayer's display listener interface More... | |
class | NuguCapability::IAudioPlayerHandler |
audioplayer handler interface More... | |
class | NuguCapability::IAudioPlayerListener |
audioplayer listener interface More... | |
+Enumerations | |
enum class | NuguCapability::AudioPlayerEvent { + UNDERRUN +, LOAD_FAILED +, LOAD_DONE +, INVALID_URL +, + PAUSE_BY_DIRECTIVE +, PAUSE_BY_FOCUS +, PAUSE_BY_APPLICATION + + } |
AudioPlayerEvent. More... | |
enum class | NuguCapability::AudioPlayerState { + IDLE +, PLAYING +, STOPPED +, PAUSED +, + FINISHED + + } |
AudioPlayerState. More... | |
enum class | NuguCapability::RepeatType { NONE +, ONE +, ALL + } |
RepeatType. More... | |
AudioPlayer capability interface.
+Processes the media service request to control the content and sends the current operation status of the content to the server.
+
+
|
+ +strong | +
+
|
+ +strong | +
AudioPlayerEvent.
+
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Battery capability interface. +More...
++Classes | |
struct | NuguCapability::_BatteryInfo |
Battery Information. More... | |
class | NuguCapability::IBatteryHandler |
battery handler interface More... | |
class | NuguCapability::IBatteryListener |
battery listener interface More... | |
+Typedefs | |
+typedef struct NuguCapability::_BatteryInfo | NuguCapability::BatteryInfo |
Battery Information. | |
Battery capability interface.
+It's used to handle battery information which is collected from device.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Bluetooth capability interface. +More...
++Classes | |
struct | NuguCapability::_BTDeviceInfo |
Bluetooth device information. More... | |
struct | NuguCapability::_BTProfile |
Bluetooth profiles information. More... | |
class | NuguCapability::IBluetoothHandler |
bluetooth handler interface More... | |
class | NuguCapability::IBluetoothListener |
bluetooth listener interface More... | |
+Typedefs | |
typedef struct NuguCapability::_BTDeviceInfo | NuguCapability::BTDeviceInfo |
Bluetooth device information. More... | |
typedef struct NuguCapability::_BTProfile | NuguCapability::BTProfile |
Bluetooth profiles information. More... | |
Bluetooth capability interface.
+It handle directives for bluetooth control
+typedef struct NuguCapability::_BTProfile NuguCapability::BTProfile | +
Bluetooth profiles information.
+typedef struct NuguCapability::_BTDeviceInfo NuguCapability::BTDeviceInfo | +
Bluetooth device information.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Buffer manipulation functions. +More...
++Macros | |
#define | NUGU_BUFFER_NOT_FOUND ((size_t)-1) |
Not found return type of nugu_buffer_find_byte() More... | |
+Typedefs | |
+typedef struct _nugu_buffer | NuguBuffer |
Buffer object. | |
+Functions | |
size_t | nugu_buffer_add (NuguBuffer *buf, const void *data, size_t data_len) |
Append the data to buffer object. More... | |
size_t | nugu_buffer_add_byte (NuguBuffer *buf, unsigned char byte) |
Append the data to buffer object. More... | |
int | nugu_buffer_clear (NuguBuffer *buf) |
Clear the buffer. More... | |
int | nugu_buffer_clear_from (NuguBuffer *buf, size_t pos) |
Clear data from a specific position to the end. More... | |
size_t | nugu_buffer_find_byte (NuguBuffer *buf, unsigned char want) |
Get the position of the data you want to find. More... | |
void * | nugu_buffer_free (NuguBuffer *buf, int is_data_free) |
Destroy the buffer object. More... | |
size_t | nugu_buffer_get_alloc_size (NuguBuffer *buf) |
Gets the size of the entire data allocated for the buffer. More... | |
size_t | nugu_buffer_get_size (NuguBuffer *buf) |
Gets the size of the entire data added to the buffer. More... | |
NuguBuffer * | nugu_buffer_new (size_t default_size) |
Create new buffer object. More... | |
const void * | nugu_buffer_peek (NuguBuffer *buf) |
Get the internal buffer. More... | |
unsigned char | nugu_buffer_peek_byte (NuguBuffer *buf, size_t pos) |
Get data at a specific position. More... | |
void * | nugu_buffer_pop (NuguBuffer *buf, size_t size) |
Extract data by a certain size. More... | |
int | nugu_buffer_set_byte (NuguBuffer *buf, size_t pos, unsigned char byte) |
Append the data to buffer object. More... | |
int | nugu_buffer_shift_left (NuguBuffer *buf, size_t size) |
Delete a certain amount of data and move the remaining data forward. More... | |
Buffer manipulation functions.
+The Buffer module makes it easy to add, delete, and move data in byte units.
+The Buffer object allocates and uses a single flat buffer inside, and adjusts its size flexibly as needed.
+The Buffer object is not thread safe.
+#define NUGU_BUFFER_NOT_FOUND ((size_t)-1) | +
Not found return type of nugu_buffer_find_byte()
+NuguBuffer* nugu_buffer_new | +( | +size_t | +default_size | ) | ++ |
Create new buffer object.
+[in] | default_size | default allocation size of buffer (0 is default size) |
void* nugu_buffer_free | +( | +NuguBuffer * | +buf, | +
+ | + | int | +is_data_free | +
+ | ) | ++ |
Destroy the buffer object.
+[in] | buf | buffer object |
[in] | data_free | If 1, the internal buffer is also freed. If 0, only the buffer object is freed, not the internal buffer. |
size_t nugu_buffer_add | +( | +NuguBuffer * | +buf, | +
+ | + | const void * | +data, | +
+ | + | size_t | +data_len | +
+ | ) | ++ |
Append the data to buffer object.
+[in] | buf | buffer object |
[in] | data | The data to add to the buffer. |
[in] | data_len | Length of the data |
size_t nugu_buffer_add_byte | +( | +NuguBuffer * | +buf, | +
+ | + | unsigned char | +byte | +
+ | ) | ++ |
Append the data to buffer object.
+[in] | buf | buffer object |
[in] | byte | The data to add to the buffer. |
int nugu_buffer_set_byte | +( | +NuguBuffer * | +buf, | +
+ | + | size_t | +pos, | +
+ | + | unsigned char | +byte | +
+ | ) | ++ |
Append the data to buffer object.
+[in] | buf | buffer object |
[in] | pos | position |
[in] | byte | The data to add to the buffer. |
0 | success |
-1 | failure |
const void* nugu_buffer_peek | +( | +NuguBuffer * | +buf | ) | ++ |
Get the internal buffer.
+[in] | buf | buffer object |
size_t nugu_buffer_get_size | +( | +NuguBuffer * | +buf | ) | ++ |
Gets the size of the entire data added to the buffer.
+[in] | buf | buffer object |
size_t nugu_buffer_get_alloc_size | +( | +NuguBuffer * | +buf | ) | ++ |
Gets the size of the entire data allocated for the buffer.
+[in] | buf | buffer object |
size_t nugu_buffer_find_byte | +( | +NuguBuffer * | +buf, | +
+ | + | unsigned char | +want | +
+ | ) | ++ |
Get the position of the data you want to find.
+[in] | buf | buffer object |
[in] | want | byte data you want to find |
unsigned char nugu_buffer_peek_byte | +( | +NuguBuffer * | +buf, | +
+ | + | size_t | +pos | +
+ | ) | ++ |
Get data at a specific position.
+[in] | buf | buffer object |
[in] | pos | position |
int nugu_buffer_clear | +( | +NuguBuffer * | +buf | ) | ++ |
Clear the buffer.
+[in] | buf | buffer object |
0 | success |
-1 | failure |
int nugu_buffer_clear_from | +( | +NuguBuffer * | +buf, | +
+ | + | size_t | +pos | +
+ | ) | ++ |
Clear data from a specific position to the end.
+[in] | buf | buffer object |
[in] | pos | position |
0 | success |
-1 | failure |
int nugu_buffer_shift_left | +( | +NuguBuffer * | +buf, | +
+ | + | size_t | +size | +
+ | ) | ++ |
Delete a certain amount of data and move the remaining data forward.
+[in] | buf | buffer object |
[in] | size | size to delete. |
0 | success |
-1 | failure |
void* nugu_buffer_pop | +( | +NuguBuffer * | +buf, | +
+ | + | size_t | +size | +
+ | ) | ++ |
Extract data by a certain size.
+[in] | buf | buffer object |
[in] | size | size to extract |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
base capability class +More...
++Classes | |
class | NuguClientKit::Capability |
Capability. More... | |
class | NuguClientKit::CapabilityEvent |
CapabilityEvent. More... | |
base capability class
+A base class of all capability agents which inherit ICapabilityInterface and implements required functions basically.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+Classes | |
class | NuguCapability::CapabilityFactory |
CapabilityFactory. More... | |
It's a factory for creating each capability instance. Even if it create CapabilityAgent instance itself, it return the related, abstracted handler for encapsulating implements.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
CapabilityHelper Interface. +More...
++Classes | |
class | NuguClientKit::ICapabilityHelper |
CapabilityHelper interface. More... | |
CapabilityHelper Interface.
+Helper for using required functions in CapabilityManager or NuguCore Components
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
capability interface +More...
++Classes | |
struct | NuguClientKit::_DirectiveCancelPolicy |
Policy about canceling directives which are belong to the specific dialog id. More... | |
class | NuguClientKit::ICapabilityInterface |
capability interface More... | |
class | NuguClientKit::ICapabilityListener |
capability listener interface More... | |
+Typedefs | |
+typedef struct NuguClientKit::_DirectiveCancelPolicy | NuguClientKit::DirectiveCancelPolicy |
Policy about canceling directives which are belong to the specific dialog id. | |
capability interface
+An abstract object that a capability agent must perform in common.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Chips capability interface. +More...
++Classes | |
struct | NuguCapability::_ChipsInfo |
Model for holding chips Info. More... | |
class | NuguCapability::IChipsHandler |
chips handler interface More... | |
class | NuguCapability::IChipsListener |
chips listener interface More... | |
+Typedefs | |
typedef struct NuguCapability::_ChipsInfo | NuguCapability::ChipsInfo |
Model for holding chips Info. More... | |
+Enumerations | |
enum class | NuguCapability::ChipsTarget { DM +, LISTEN +, SPEAKING + } |
Chips Target. More... | |
enum class | NuguCapability::ChipsType { NUDGE +, ACTION +, GENERAL + } |
Chips Type. More... | |
Chips capability interface.
+It's used for rendering voice command guide which is displayed on voice chrome in DM situation.
+typedef struct NuguCapability::_ChipsInfo NuguCapability::ChipsInfo | +
Model for holding chips Info.
+
+
|
+ +strong | +
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
DialogUXStateAggregator Interface. +More...
++Classes | |
class | NuguClientKit::IDialogUXStateAggregatorListener |
IDialogUXStateAggregatorListener interface. More... | |
+Enumerations | |
enum class | NuguClientKit::DialogUXState { + Listening +, Recognizing +, Thinking +, Speaking +, + Idle + + } |
DialogUXState list. More... | |
+Functions | |
virtual void | NuguClientKit::IDialogUXStateAggregatorListener::onASRResult (const std::string &text) |
Receive ASR result. More... | |
virtual void | NuguClientKit::IDialogUXStateAggregatorListener::onStateChanged (DialogUXState state, bool multi_turn, const ChipsInfo &chips, bool session_active) |
Receive current DialogUXState and additional infos. More... | |
DialogUXStateAggregator Interface.
+Interface of DialogUXStateAggregator for receiving DialogUXState which is composed by combination of ASR, TTS, Chips info.
+
+
|
+ +strong | +
+
|
+ +virtual | +
Receive current DialogUXState and additional infos.
+[in] | state | current DialogUXState |
[in] | multi_turn | whether current dialog mode is multi-turn or not |
[in] | chips | chips info |
[in] | session_active | whether session is activated or not |
+
|
+ +virtual | +
Receive ASR result.
+[in] | text | result text |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Directive Sequencer Interface. +More...
++Classes | |
struct | NuguClientKit::_BlockingPolicy |
BlockingPolicy. More... | |
class | NuguClientKit::IDirectiveSequencer |
IDirectiveSequencer. More... | |
class | NuguClientKit::IDirectiveSequencerListener |
IDirectiveSequencerListener. More... | |
+Typedefs | |
+typedef struct NuguClientKit::_BlockingPolicy | NuguClientKit::BlockingPolicy |
BlockingPolicy. | |
+Enumerations | |
enum class | NuguClientKit::BlockingMedium { AUDIO = NUGU_DIRECTIVE_MEDIUM_AUDIO +, VISUAL = NUGU_DIRECTIVE_MEDIUM_VISUAL +, NONE = NUGU_DIRECTIVE_MEDIUM_NONE +, ANY = NUGU_DIRECTIVE_MEDIUM_ANY + } |
BlockingMedium. More... | |
Directive Sequencer Interface.
+DirectiveSequencer delivers the directives received from the network to the CapabilityAgent according to the dialog-id and blocking policy.
+
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Display capability interface. +More...
++Classes | |
struct | NuguCapability::_DisplayContextInfo |
Display Context Information. More... | |
class | NuguCapability::IDisplayHandler |
display handler interface More... | |
class | NuguCapability::IDisplayListener |
display listener interface More... | |
+Typedefs | |
+typedef struct NuguCapability::_DisplayContextInfo | NuguCapability::DisplayContextInfo |
Display Context Information. | |
+Enumerations | |
enum class | NuguCapability::ControlDirection { PREVIOUS +, NEXT + } |
enum class | NuguCapability::ControlType { Focus +, Scroll + } |
enum class | NuguCapability::TemplateControlType { TEMPLATE_PREVIOUS +, TEMPLATE_CLOSEALL + } |
Display capability interface.
+Manage rendering and erasing according to metadata delivery and context management policies to show the graphical user interface (GUI) on devices with displays.
+
+
|
+ +strong | +
+
|
+ +strong | +
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Extension capability interface. +More...
++Classes | |
class | NuguCapability::IExtensionHandler |
extension handler interface More... | |
class | NuguCapability::IExtensionListener |
extension listener interface More... | |
Extension capability interface.
+It handle directives which are not defined in other capability agents.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Focus Manager Interface. +More...
++Classes | |
struct | NuguClientKit::_FocusConfiguration |
FocusConfiguration. More... | |
class | NuguClientKit::IFocusManager |
IFocusManager. More... | |
class | NuguClientKit::IFocusManagerObserver |
IFocusManagerObserver. More... | |
class | NuguClientKit::IFocusResourceListener |
IFocusResourceListener. More... | |
+Typedefs | |
+typedef struct NuguClientKit::_FocusConfiguration | NuguClientKit::FocusConfiguration |
FocusConfiguration. | |
+Enumerations | |
enum class | NuguClientKit::FocusState { FOREGROUND +, BACKGROUND +, NONE + } |
FocusState. More... | |
+Functions | |
virtual void | NuguClientKit::IFocusManager::addObserver (IFocusManagerObserver *observer)=0 |
Add the Observer object. More... | |
virtual FocusState | NuguClientKit::IFocusManager::convertToFocusState (const std::string &state_text)=0 |
Convert state text to matched FocusState enum. More... | |
virtual std::string | NuguClientKit::IFocusManager::getStateString (FocusState state)=0 |
Get state string. More... | |
virtual bool | NuguClientKit::IFocusManager::holdFocus (const std::string &type)=0 |
Hold focus. If requested to hold focus, the low priority focus is not preempted. More... | |
virtual void | NuguClientKit::IFocusManagerObserver::onFocusChanged (const FocusConfiguration &configuration, FocusState state, const std::string &name)=0 |
Support to monitor the change of focus state for all resources. More... | |
virtual void | NuguClientKit::IFocusResourceListener::onFocusChanged (FocusState state)=0 |
Notify the resource of focus state change. More... | |
virtual bool | NuguClientKit::IFocusManager::releaseFocus (const std::string &type, const std::string &name)=0 |
Release focus. More... | |
virtual void | NuguClientKit::IFocusManager::removeObserver (IFocusManagerObserver *observer)=0 |
Remove the Observer object. More... | |
virtual bool | NuguClientKit::IFocusManager::requestFocus (const std::string &type, const std::string &name, IFocusResourceListener *listener)=0 |
Request Focus. More... | |
virtual void | NuguClientKit::IFocusManager::setConfigurations (std::vector< FocusConfiguration > &request, std::vector< FocusConfiguration > &release)=0 |
Set focus configurations. More... | |
+virtual void | NuguClientKit::IFocusManager::stopAllFocus ()=0 |
Stop all focus. | |
+virtual void | NuguClientKit::IFocusManager::stopForegroundFocus ()=0 |
Stop highest priority of focus that is foreground state. | |
virtual bool | NuguClientKit::IFocusManager::unholdFocus (const std::string &type)=0 |
Unhold focus. More... | |
+Variables | |
int | NuguClientKit::_FocusConfiguration::priority |
std::string | NuguClientKit::_FocusConfiguration::type |
Focus Manager Interface.
+FocusManager manage focus configuration and focus can be requested or released.
+
+
|
+ +strong | +
+
|
+ +pure virtual | +
Notify the resource of focus state change.
+[in] | state | resource's new state |
+
|
+ +pure virtual | +
Support to monitor the change of focus state for all resources.
+[in] | configuration | focus configuration |
[in] | state | resource's new state |
[in] | name | focus name |
+
|
+ +pure virtual | +
Request Focus.
+[in] | type | focus type |
[in] | name | focus name |
[in] | listener | listener object |
+
|
+ +pure virtual | +
Release focus.
+[in] | type | focus type |
[in] | name | focus name |
+
|
+ +pure virtual | +
Hold focus. If requested to hold focus, the low priority focus is not preempted.
+[in] | type | focus type |
+
|
+ +pure virtual | +
Unhold focus.
+[in] | type | focus type |
+
|
+ +pure virtual | +
Set focus configurations.
+[in] | request | configurations for focus request |
[in] | release | configurations for focus release |
+
|
+ +pure virtual | +
Get state string.
+[in] | state | focus state |
+
|
+ +pure virtual | +
Convert state text to matched FocusState enum.
+[in] | state_text | state text |
std::out_of_range | exception thrown if matched FocusState not exist |
+
|
+ +pure virtual | +
Add the Observer object.
+[in] | observer | observer object |
+
|
+ +pure virtual | +
Remove the Observer object.
+[in] | observer | observer object |
std::string NuguClientKit::_FocusConfiguration::type | +
focus type
+ +int NuguClientKit::_FocusConfiguration::priority | +
focus priority
+ +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
InteractionControlManager Interface. +More...
++Classes | |
class | NuguClientKit::IInteractionControlManager |
InteractionControlManager interface. More... | |
class | NuguClientKit::IInteractionControlManagerListener |
IInteractionControlManagerListener interface. More... | |
+Enumerations | |
enum class | NuguClientKit::InteractionMode { NONE +, MULTI_TURN + } |
Interaction Mode. More... | |
InteractionControlManager Interface.
+Interface of InteractionControlManager which manages multi-turn maintaining situation.
+
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Location capability interface. +More...
++Classes | |
struct | NuguCapability::_LocationInfo |
Location Information. More... | |
class | NuguCapability::ILocationHandler |
location handler interface More... | |
class | NuguCapability::ILocationListener |
location listener interface More... | |
+Typedefs | |
+typedef struct NuguCapability::_LocationInfo | NuguCapability::LocationInfo |
Location Information. | |
Location capability interface.
+It's used to handle location information which is collected from device.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Log functions. +More...
++Macros | |
+#define | __FILENAME__ __FILE__ |
+#define | NUGU_ANSI_COLOR_BLACK "\e[0;30m" |
+#define | NUGU_ANSI_COLOR_BLUE "\e[0;34m" |
+#define | NUGU_ANSI_COLOR_BROWN "\e[0;33m" |
+#define | NUGU_ANSI_COLOR_CYAN "\e[0;36m" |
+#define | NUGU_ANSI_COLOR_DARKGRAY "\e[1;30m" |
+#define | NUGU_ANSI_COLOR_GREEN "\e[0;32m" |
+#define | NUGU_ANSI_COLOR_LIGHTBLUE "\e[1;34m" |
+#define | NUGU_ANSI_COLOR_LIGHTCYAN "\e[1;36m" |
+#define | NUGU_ANSI_COLOR_LIGHTGRAY "\e[0;37m" |
+#define | NUGU_ANSI_COLOR_LIGHTGREEN "\e[1;32m" |
+#define | NUGU_ANSI_COLOR_LIGHTMAGENTA "\e[1;35m" |
+#define | NUGU_ANSI_COLOR_LIGHTRED "\e[1;31m" |
+#define | NUGU_ANSI_COLOR_MAGENTA "\e[0;35m" |
+#define | NUGU_ANSI_COLOR_NORMAL "" |
+#define | NUGU_ANSI_COLOR_RECV "" |
+#define | NUGU_ANSI_COLOR_RED "\e[0;31m" |
+#define | NUGU_ANSI_COLOR_SEND "" |
+#define | NUGU_ANSI_COLOR_WHITE "\e[1;37m" |
+#define | NUGU_ANSI_COLOR_YELLOW "\e[1;33m" |
#define | nugu_dbg(fmt, ...) nugu_log(NUGU_LOG_MODULE, NUGU_LOG_LEVEL_DEBUG, fmt, ##__VA_ARGS__) |
Debug level error message. More... | |
#define | nugu_error(fmt, ...) nugu_log(NUGU_LOG_MODULE, NUGU_LOG_LEVEL_ERROR, fmt, ##__VA_ARGS__) |
Error level error message. More... | |
#define | nugu_error_nomem() nugu_error("Not enough memory") |
Default error message for 'Not enough memory'. More... | |
#define | nugu_info(fmt, ...) nugu_log(NUGU_LOG_MODULE, NUGU_LOG_LEVEL_INFO, fmt, ##__VA_ARGS__) |
Information level error message. More... | |
#define | nugu_log(module, level, fmt, ...) |
Convenient macro to fill file, function and line information. More... | |
+#define | NUGU_LOG_MARK_RECV "<-- " |
+#define | NUGU_LOG_MARK_SEND "--> " |
#define | NUGU_LOG_MODULE NUGU_LOG_MODULE_DEFAULT |
Set default log module. More... | |
#define | nugu_log_protocol_recv(level, fmt, ...) |
Protocol log message for receiving. More... | |
#define | nugu_log_protocol_send(level, fmt, ...) |
Protocol log message for sending. More... | |
#define | nugu_warn(fmt, ...) nugu_log(NUGU_LOG_MODULE, NUGU_LOG_LEVEL_WARNING, fmt, ##__VA_ARGS__) |
Warning level error message. More... | |
+Typedefs | |
typedef void(* | nugu_log_handler) (enum nugu_log_module module, enum nugu_log_level level, const char *prefix, const char *msg, void *user_data) |
Custom log hook handler. More... | |
+Functions | |
void | nugu_hexdump (enum nugu_log_module module, const uint8_t *data, size_t data_size, const char *header, const char *footer, const char *lineindent) |
Hexdump the specific data to stderr. More... | |
enum nugu_log_level | nugu_log_get_level (void) |
Get log level. More... | |
unsigned int | nugu_log_get_modules (void) |
Get the bitset of modules. More... | |
enum nugu_log_prefix | nugu_log_get_prefix_fields (void) |
Get the additional information fields. More... | |
int | nugu_log_get_protocol_line_limit (void) |
Get the maximum length of each protocol log line. More... | |
enum nugu_log_system | nugu_log_get_system (void) |
Get logging backend system. More... | |
void | nugu_log_print (enum nugu_log_module module, enum nugu_log_level level, const char *filename, const char *funcname, int line, const char *format,...) |
logging function More... | |
int | nugu_log_set_handler (nugu_log_handler handler, void *user_data) |
Set custom log handler. More... | |
void | nugu_log_set_level (enum nugu_log_level level) |
Set minimum log level(debug, info, warning, error) For example, if set the level to info, debug is discarded, and only logs with info, warning, and error levels are displayed. More... | |
void | nugu_log_set_modules (unsigned int bitset) |
Set the bitset of modules. More... | |
void | nugu_log_set_prefix_fields (enum nugu_log_prefix field_set) |
Set the additional information fields. More... | |
void | nugu_log_set_protocol_line_limit (int length) |
Set the maximum length of each protocol log line. More... | |
int | nugu_log_set_system (enum nugu_log_system log_system) |
Set logging backend system. More... | |
Log functions.
+The log function supports standard error output and the syslog system, and you can set the handler you want if necessary.
+Supported features:
The log function also supports setting logs at runtime using the environment variables below.
#define NUGU_LOG_MODULE NUGU_LOG_MODULE_DEFAULT | +
Set default log module.
+#define nugu_log | +( | ++ | module, | +
+ | + | + | level, | +
+ | + | + | fmt, | +
+ | + | + | ... | +
+ | ) | ++ |
Convenient macro to fill file, function and line information.
+[in] | module | log module name |
[in] | level | logging level |
[in] | fmt | printf format string |
#define nugu_dbg | +( | ++ | fmt, | +
+ | + | + | ... | +
+ | ) | +nugu_log(NUGU_LOG_MODULE, NUGU_LOG_LEVEL_DEBUG, fmt, ##__VA_ARGS__) | +
Debug level error message.
+[in] | fmt | printf format string |
#define nugu_info | +( | ++ | fmt, | +
+ | + | + | ... | +
+ | ) | +nugu_log(NUGU_LOG_MODULE, NUGU_LOG_LEVEL_INFO, fmt, ##__VA_ARGS__) | +
Information level error message.
+[in] | fmt | printf format string |
#define nugu_warn | +( | ++ | fmt, | +
+ | + | + | ... | +
+ | ) | +nugu_log(NUGU_LOG_MODULE, NUGU_LOG_LEVEL_WARNING, fmt, ##__VA_ARGS__) | +
Warning level error message.
+[in] | fmt | printf format string |
#define nugu_error | +( | ++ | fmt, | +
+ | + | + | ... | +
+ | ) | +nugu_log(NUGU_LOG_MODULE, NUGU_LOG_LEVEL_ERROR, fmt, ##__VA_ARGS__) | +
Error level error message.
+[in] | fmt | printf format string |
#define nugu_log_protocol_send | +( | ++ | level, | +
+ | + | + | fmt, | +
+ | + | + | ... | +
+ | ) | ++ |
Protocol log message for sending.
+[in] | level | logging level |
[in] | fmt | printf format string |
#define nugu_log_protocol_recv | +( | ++ | level, | +
+ | + | + | fmt, | +
+ | + | + | ... | +
+ | ) | ++ |
Protocol log message for receiving.
+[in] | level | logging level |
[in] | fmt | printf format string |
#define nugu_error_nomem | +( | +) | +nugu_error("Not enough memory") | +
Default error message for 'Not enough memory'.
+typedef void(* nugu_log_handler) (enum nugu_log_module module, enum nugu_log_level level, const char *prefix, const char *msg, void *user_data) | +
Custom log hook handler.
+[in] | module | log module |
[in] | level | log level |
[in] | prefix | generated additional information (e.g. timestamp, line number) |
[in] | msg | original log message |
[in] | user_data | The user data passed from the callback function |
enum nugu_log_level | +
log levels.
+When building in release mode, logs at the warning, info, and debug levels are all ignored.
+Enumerator | |
---|---|
NUGU_LOG_LEVEL_ERROR | Error level + |
NUGU_LOG_LEVEL_WARNING | Warning level + |
NUGU_LOG_LEVEL_INFO | Information level + |
NUGU_LOG_LEVEL_DEBUG | Debug level + |
enum nugu_log_system | +
Back-end system that supports log output.
+enum nugu_log_prefix | +
logging prefix
+enum nugu_log_module | +
logging modules
+void nugu_log_print | +( | +enum nugu_log_module | +module, | +
+ | + | enum nugu_log_level | +level, | +
+ | + | const char * | +filename, | +
+ | + | const char * | +funcname, | +
+ | + | int | +line, | +
+ | + | const char * | +format, | +
+ | + | + | ... | +
+ | ) | ++ |
logging function
+[in] | module | log module |
[in] | level | log level |
[in] | filename | source file name (e.g. FILE) |
[in] | funcname | function name (e.g. FUNCTION) |
[in] | line | source file line number |
[in] | format | printf format string |
int nugu_log_set_system | +( | +enum nugu_log_system | +log_system | ) | ++ |
Set logging backend system.
+enum nugu_log_system nugu_log_get_system | +( | +void | +) | ++ |
Get logging backend system.
+int nugu_log_set_handler | +( | +nugu_log_handler | +handler, | +
+ | + | void * | +user_data | +
+ | ) | ++ |
Set custom log handler.
+[in] | handler | callback |
[in] | user_data | The user data to be passed to the callback function |
void nugu_log_set_prefix_fields | +( | +enum nugu_log_prefix | +field_set | ) | ++ |
Set the additional information fields.
+[in] | field_set | bitmask by enum nugu_log_prefix |
enum nugu_log_prefix nugu_log_get_prefix_fields | +( | +void | +) | ++ |
Get the additional information fields.
+void nugu_log_set_modules | +( | +unsigned int | +bitset | ) | ++ |
Set the bitset of modules.
+[in] | bitset | bitmask by enum nugu_log_prefix |
unsigned int nugu_log_get_modules | +( | +void | +) | ++ |
Get the bitset of modules.
+void nugu_log_set_level | +( | +enum nugu_log_level | +level | ) | ++ |
Set minimum log level(debug, info, warning, error) For example, if set the level to info, debug is discarded, and only logs with info, warning, and error levels are displayed.
+[in] | level | log level |
enum nugu_log_level nugu_log_get_level | +( | +void | +) | ++ |
Get log level.
+void nugu_log_set_protocol_line_limit | +( | +int | +length | ) | ++ |
Set the maximum length of each protocol log line.
+[in] | length | line length. -1 means unlimited. |
int nugu_log_get_protocol_line_limit | +( | +void | +) | ++ |
Get the maximum length of each protocol log line.
+void nugu_hexdump | +( | +enum nugu_log_module | +module, | +
+ | + | const uint8_t * | +data, | +
+ | + | size_t | +data_size, | +
+ | + | const char * | +header, | +
+ | + | const char * | +footer, | +
+ | + | const char * | +lineindent | +
+ | ) | ++ |
Hexdump the specific data to stderr.
+[in] | module | log module |
[in] | data | memory address to hexdump |
[in] | data_size | size |
[in] | header | message to be printed at the top of hexdump |
[in] | footer | message to be printed at the bottom of hexdump |
[in] | lineindent | message to be printed at the beginning of each line |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
media management +More...
++Macros | |
+#define | NUGU_SET_LOADING_TIMEOUT 5 |
Default value of loading timeout. | |
+#define | NUGU_SET_VOLUME_DEFAULT 50 |
Default value of volume. | |
+#define | NUGU_SET_VOLUME_MAX 100 |
Default value of maximum volume. | |
+#define | NUGU_SET_VOLUME_MIN 0 |
Default value of minimum volume. | |
+Typedefs | |
+typedef void(* | NuguMediaEventCallback) (enum nugu_media_event event, void *userdata) |
Callback type for media event. | |
+typedef void(* | NuguMediaStatusCallback) (enum nugu_media_status status, void *userdata) |
Callback type for media status. | |
+Enumerations | |
enum | nugu_media_event { + NUGU_MEDIA_EVENT_MEDIA_SOURCE_CHANGED +, NUGU_MEDIA_EVENT_MEDIA_INVALID +, NUGU_MEDIA_EVENT_MEDIA_LOAD_FAILED +, NUGU_MEDIA_EVENT_MEDIA_LOADED +, + NUGU_MEDIA_EVENT_MEDIA_UNDERRUN +, NUGU_MEDIA_EVENT_MEDIA_BUFFER_FULL +, NUGU_MEDIA_EVENT_END_OF_STREAM +, NUGU_MEDIA_EVENT_MAX + + } |
media event type More... | |
enum | nugu_media_status { NUGU_MEDIA_STATUS_STOPPED +, NUGU_MEDIA_STATUS_READY +, NUGU_MEDIA_STATUS_PLAYING +, NUGU_MEDIA_STATUS_PAUSED + } |
media status More... | |
media management
+enum nugu_media_status | +
enum nugu_media_event | +
media event type
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Media Player Interface. +More...
++Classes | |
class | NuguClientKit::IMediaPlayer |
mediaplayer interface More... | |
class | NuguClientKit::IMediaPlayerListener |
mediaplayer listener interface More... | |
class | NuguClientKit::ITTSPlayer |
ttsplayer interface More... | |
+Enumerations | |
enum class | NuguClientKit::MediaPlayerEvent { + INVALID_MEDIA_URL +, LOADING_MEDIA_FAILED +, LOADING_MEDIA_SUCCESS +, PLAYING_MEDIA_FINISHED +, + PLAYING_MEDIA_UNDERRUN + + } |
MediaPlayerEvent. More... | |
enum class | NuguClientKit::MediaPlayerState { + IDLE +, PREPARE +, READY +, PLAYING +, + PAUSED +, STOPPED + + } |
MediaPlayerState. More... | |
Media Player Interface.
+Playback media content and receive content information through the media player interface.
+
+
|
+ +strong | +
+
|
+ +strong | +
MediaPlayerEvent.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Message capability interface. +More...
++Classes | |
class | NuguCapability::IMessageHandler |
message handler interface More... | |
class | NuguCapability::IMessageListener |
message listener interface More... | |
+Enumerations | |
enum class | NuguCapability::MessageState { MESSAGE_SPEECH_START +, MESSAGE_SPEECH_STOP +, MESSAGE_SPEECH_FINISH + } |
MessageState. More... | |
Message capability interface.
+Read and send message.
+
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
MIC capability interface. +More...
++Classes | |
class | NuguCapability::IMicHandler |
mic handler interface More... | |
class | NuguCapability::IMicListener |
mic listener interface More... | |
+Enumerations | |
enum class | NuguCapability::MicStatus { ON +, OFF + } |
MicStatus. More... | |
MIC capability interface.
+Control the microphone on or off via button or mobile nugu application.
+
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Network Manager interface. +More...
++Classes | |
class | NuguClientKit::INetworkManager |
network manager interface More... | |
class | NuguClientKit::INetworkManagerListener |
network manager listener interface More... | |
+Enumerations | |
enum class | NuguClientKit::NetworkError { FAILED +, TOKEN_ERROR +, UNKNOWN + } |
enum class | NuguClientKit::NetworkStatus { DISCONNECTED +, CONNECTING +, READY +, CONNECTED + } |
Network Manager interface.
+The network manager controls the NUGU server connection and disconnection and reports events for server connections.
+
+
|
+ +strong | +
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Nudge capability interface. +More...
++Classes | |
class | NuguCapability::INudgeHandler |
nudge handler interface More... | |
class | NuguCapability::INudgeListener |
nudge listener interface More... | |
Nudge capability interface.
+It's for managing the state and context of nudge dux
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Authentication management. +More...
++Classes | |
struct | NuguClientKit::AuthResponse |
AuthResponse. More... | |
class | NuguClientKit::NuguAuth |
NuguAuth. More... | |
struct | NuguClientKit::NuguDeviceConfig |
NuguDeviceConfig. More... | |
struct | NuguClientKit::NuguToken |
NuguToken. More... | |
+Enumerations | |
enum | NuguClientKit::GrantType { AUTHORIZATION_CODE = 0x1 +, CLIENT_CREDENTIALS = 0x2 +, REFRESH_TOKEN = 0x4 +, DEVICE_CODE = 0x8 + } |
GrantType. | |
Authentication management.
+The NuguAuth handles OAuth2 authentication.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Nugu Client. +More...
++Classes | |
class | NuguClientKit::NuguClient |
NUGU Client. More... | |
Nugu Client.
+The NUGU client has access to the capability builder, config management, and handler for each capability agent, making it easier to use the NUGU SDK.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
NuguCoreContainer Interface. +More...
++Classes | |
class | NuguClientKit::INuguCoreContainer |
NuguCoreContainer interface. More... | |
NuguCoreContainer Interface.
+Container which have components factory and methods for manipulating NuguCore
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Decoder functions. +More...
++Typedefs | |
+typedef struct _nugu_decoder | NuguDecoder |
decoder object | |
+Functions | |
void * | nugu_decoder_decode (NuguDecoder *dec, const void *data, size_t data_len, size_t *output_len) |
Decode the encoded data. More... | |
int | nugu_decoder_free (NuguDecoder *dec) |
Destroy the decoder object. More... | |
void * | nugu_decoder_get_driver_data (NuguDecoder *dec) |
Get custom data for driver. More... | |
NuguPcm * | nugu_decoder_get_pcm (NuguDecoder *dec) |
Get pcm(sink) object. More... | |
NuguDecoder * | nugu_decoder_new (NuguDecoderDriver *driver, NuguPcm *sink) |
Create new decoder object. More... | |
int | nugu_decoder_play (NuguDecoder *dec, const void *data, size_t data_len) |
Decode the encoded data and pass the result to sink. More... | |
int | nugu_decoder_set_driver_data (NuguDecoder *dec, void *data) |
Set custom data for driver. More... | |
Decoder functions.
+The decoder object decodes the encoded data. It also serves to pass the decoded result to the PCM sink.
+NuguDecoder* nugu_decoder_new | +( | +NuguDecoderDriver * | +driver, | +
+ | + | NuguPcm * | +sink | +
+ | ) | ++ |
Create new decoder object.
+[in] | driver | decoder driver |
[in] | sink | pcm object |
int nugu_decoder_free | +( | +NuguDecoder * | +dec | ) | ++ |
Destroy the decoder object.
+[in] | dec | decoder object |
0 | success |
-1 | failure |
int nugu_decoder_play | +( | +NuguDecoder * | +dec, | +
+ | + | const void * | +data, | +
+ | + | size_t | +data_len | +
+ | ) | ++ |
Decode the encoded data and pass the result to sink.
+[in] | dec | decoder object |
[in] | data | encoded data |
[in] | data_len | encoded data length |
0 | success |
-1 | failure |
int nugu_decoder_set_driver_data | +( | +NuguDecoder * | +dec, | +
+ | + | void * | +data | +
+ | ) | ++ |
Set custom data for driver.
+[in] | dec | decoder object |
[in] | data | custom data managed by driver |
0 | success |
-1 | failure |
void* nugu_decoder_get_driver_data | +( | +NuguDecoder * | +dec | ) | ++ |
Get custom data for driver.
+[in] | dec | decoder object |
void* nugu_decoder_decode | +( | +NuguDecoder * | +dec, | +
+ | + | const void * | +data, | +
+ | + | size_t | +data_len, | +
+ | + | size_t * | +output_len | +
+ | ) | ++ |
Decode the encoded data.
+[in] | dec | decoder object |
[in] | data | encoded data |
[in] | data_len | encoded data length |
[out] | output_len | output buffer length |
NuguPcm* nugu_decoder_get_pcm | +( | +NuguDecoder * | +dec | ) | ++ |
Get pcm(sink) object.
+[in] | dec | decoder object |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Decoder driver. +More...
++Classes | |
struct | nugu_decoder_driver_ops |
decoder driver operations More... | |
+Typedefs | |
+typedef struct _nugu_decoder_driver | NuguDecoderDriver |
decoder driver object | |
+Enumerations | |
enum | nugu_decoder_type { NUGU_DECODER_TYPE_OPUS +, NUGU_DECODER_TYPE_CUSTOM = 99 + } |
decoder type More... | |
+Functions | |
NuguDecoderDriver * | nugu_decoder_driver_find (const char *name) |
Find a driver by name in the driver list. More... | |
NuguDecoderDriver * | nugu_decoder_driver_find_bytype (enum nugu_decoder_type type) |
Find a driver by type in the driver list. More... | |
int | nugu_decoder_driver_free (NuguDecoderDriver *driver) |
Destroy the decoder driver. More... | |
NuguDecoderDriver * | nugu_decoder_driver_new (const char *name, enum nugu_decoder_type type, struct nugu_decoder_driver_ops *ops) |
Create new decoder driver. More... | |
int | nugu_decoder_driver_register (NuguDecoderDriver *driver) |
Register the driver to driver list. More... | |
int | nugu_decoder_driver_remove (NuguDecoderDriver *driver) |
Remove the driver from driver list. More... | |
Decoder driver.
+The decoder driver performs a function of decoding the received encoded data.
+enum nugu_decoder_type | +
decoder type
+Enumerator | |
---|---|
NUGU_DECODER_TYPE_OPUS | OPUS + |
NUGU_DECODER_TYPE_CUSTOM | Custom type + |
NuguDecoderDriver* nugu_decoder_driver_new | +( | +const char * | +name, | +
+ | + | enum nugu_decoder_type | +type, | +
+ | + | struct nugu_decoder_driver_ops * | +ops | +
+ | ) | ++ |
Create new decoder driver.
+[in] | name | driver name |
[in] | type | decoder type |
[in] | ops | operation table |
int nugu_decoder_driver_free | +( | +NuguDecoderDriver * | +driver | ) | ++ |
Destroy the decoder driver.
+[in] | driver | decoder driver object |
0 | success |
-1 | failure |
int nugu_decoder_driver_register | +( | +NuguDecoderDriver * | +driver | ) | ++ |
Register the driver to driver list.
+[in] | driver | decoder driver object |
0 | success |
-1 | failure |
int nugu_decoder_driver_remove | +( | +NuguDecoderDriver * | +driver | ) | ++ |
Remove the driver from driver list.
+[in] | driver | decoder driver object |
0 | success |
-1 | failure |
NuguDecoderDriver* nugu_decoder_driver_find | +( | +const char * | +name | ) | ++ |
Find a driver by name in the driver list.
+[in] | name | decoder driver name |
NuguDecoderDriver* nugu_decoder_driver_find_bytype | +( | +enum nugu_decoder_type | +type | ) | ++ |
Find a driver by type in the driver list.
+[in] | type | decoder driver type |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
The message object received from the server. +More...
++Typedefs | |
+typedef struct _nugu_directive | NuguDirective |
Directive object. | |
+typedef void(* | NuguDirectiveDataCallback) (NuguDirective *ndir, int seq, void *userdata) |
Callback prototype for receiving an attachment. | |
+Enumerations | |
enum | nugu_directive_medium { + NUGU_DIRECTIVE_MEDIUM_AUDIO = 0 +, NUGU_DIRECTIVE_MEDIUM_VISUAL = 1 +, NUGU_DIRECTIVE_MEDIUM_NONE = 2 +, NUGU_DIRECTIVE_MEDIUM_ANY = 3 +, + NUGU_DIRECTIVE_MEDIUM_MAX + + } |
event types More... | |
+Functions | |
int | nugu_directive_add_data (NuguDirective *ndir, size_t length, const unsigned char *data) |
Add attachment data to directive. (e.g. TTS payload) More... | |
int | nugu_directive_close_data (NuguDirective *ndir) |
Set the attachment data status to "Received all data". More... | |
enum nugu_directive_medium | nugu_directive_get_blocking_medium (const NuguDirective *ndir) |
Get the medium of BlockingPolicy for the directive. More... | |
const char * | nugu_directive_get_blocking_medium_string (const NuguDirective *ndir) |
Get the medium string of BlockingPolicy for the directive. More... | |
unsigned char * | nugu_directive_get_data (NuguDirective *ndir, size_t *length) |
Get the attachment data received so far. When this function is called, the internal receive buffer is cleared. More... | |
size_t | nugu_directive_get_data_size (const NuguDirective *ndir) |
Get the size of attachment data received so far. More... | |
int | nugu_directive_is_active (const NuguDirective *ndir) |
Get the active status of directive. "active" means the directive is added to the directive sequencer. More... | |
int | nugu_directive_is_blocking (const NuguDirective *ndir) |
Get the blocking status of BlockingPolicy for the directive. More... | |
int | nugu_directive_is_data_end (const NuguDirective *ndir) |
Get the attachment data status. More... | |
NuguDirective * | nugu_directive_new (const char *name_space, const char *name, const char *version, const char *msg_id, const char *dialog_id, const char *referrer_id, const char *json, const char *groups) |
Create new directive object. More... | |
const char * | nugu_directive_peek_dialog_id (const NuguDirective *ndir) |
Get the dialog-request-id of directive. More... | |
const char * | nugu_directive_peek_groups (const NuguDirective *ndir) |
Get the group of directive. More... | |
const char * | nugu_directive_peek_json (const NuguDirective *ndir) |
Get the payload of directive. More... | |
const char * | nugu_directive_peek_media_type (const NuguDirective *ndir) |
Get the attachment mime type. More... | |
const char * | nugu_directive_peek_msg_id (const NuguDirective *ndir) |
Get the message-id of directive. More... | |
const char * | nugu_directive_peek_name (const NuguDirective *ndir) |
Get the name of directive. More... | |
const char * | nugu_directive_peek_namespace (const NuguDirective *ndir) |
Get the namespace of directive. More... | |
const char * | nugu_directive_peek_referrer_id (const NuguDirective *ndir) |
Get the referer-dialog-request-id of directive. More... | |
const char * | nugu_directive_peek_version (const NuguDirective *ndir) |
Get the version of directive. More... | |
void | nugu_directive_ref (NuguDirective *ndir) |
Increment the reference count of the directive object. More... | |
int | nugu_directive_remove_data_callback (NuguDirective *ndir) |
Remove attachment received event callback. More... | |
int | nugu_directive_set_active (NuguDirective *ndir, int flag) |
Set the active status of directive. More... | |
int | nugu_directive_set_blocking_policy (NuguDirective *ndir, enum nugu_directive_medium medium, int is_block) |
Set the medium of BlockingPolicy for the directive. More... | |
int | nugu_directive_set_data_callback (NuguDirective *ndir, NuguDirectiveDataCallback callback, void *userdata) |
Set attachment received event callback. More... | |
int | nugu_directive_set_media_type (NuguDirective *ndir, const char *type) |
Set the attachment mime type. More... | |
void | nugu_directive_unref (NuguDirective *ndir) |
Decrement the reference count of the directive object. More... | |
The message object received from the server.
+The directive refers to a message received from the server and consists of the following elements.
enum nugu_directive_medium | +
event types
+NuguDirective* nugu_directive_new | +( | +const char * | +name_space, | +
+ | + | const char * | +name, | +
+ | + | const char * | +version, | +
+ | + | const char * | +msg_id, | +
+ | + | const char * | +dialog_id, | +
+ | + | const char * | +referrer_id, | +
+ | + | const char * | +json, | +
+ | + | const char * | +groups | +
+ | ) | ++ |
Create new directive object.
+[in] | name_space | capability name space (e.g. "TTS") |
[in] | name | capability name (e.g. "Speak") |
[in] | version | version string (e.g. "1.0") |
[in] | msg_id | unique message-id |
[in] | dialog_id | unique dialog-request-id |
[in] | referrer_id | referrer-dialog-request-id |
[in] | json | payload |
[in] | groups | groups |
void nugu_directive_ref | +( | +NuguDirective * | +ndir | ) | ++ |
Increment the reference count of the directive object.
+[in] | ndir | directive object |
void nugu_directive_unref | +( | +NuguDirective * | +ndir | ) | ++ |
Decrement the reference count of the directive object.
+[in] | ndir | directive object |
const char* nugu_directive_peek_namespace | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the namespace of directive.
+[in] | ndir | directive object |
const char* nugu_directive_peek_name | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the name of directive.
+[in] | ndir | directive object |
const char* nugu_directive_peek_groups | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the group of directive.
+[in] | ndir | directive object |
const char* nugu_directive_peek_version | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the version of directive.
+[in] | ndir | directive object |
const char* nugu_directive_peek_msg_id | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the message-id of directive.
+[in] | ndir | directive object |
const char* nugu_directive_peek_dialog_id | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the dialog-request-id of directive.
+[in] | ndir | directive object |
const char* nugu_directive_peek_referrer_id | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the referer-dialog-request-id of directive.
+[in] | ndir | directive object |
const char* nugu_directive_peek_json | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the payload of directive.
+[in] | ndir | directive object |
int nugu_directive_is_active | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the active status of directive. "active" means the directive is added to the directive sequencer.
+[in] | ndir | directive object |
1 | active |
0 | not active |
-1 | failure |
int nugu_directive_set_active | +( | +NuguDirective * | +ndir, | +
+ | + | int | +flag | +
+ | ) | ++ |
Set the active status of directive.
+[in] | ndir | directive object |
[in] | flag | active status(1 = active, 0 = not active) |
0 | success |
-1 | failure |
int nugu_directive_add_data | +( | +NuguDirective * | +ndir, | +
+ | + | size_t | +length, | +
+ | + | const unsigned char * | +data | +
+ | ) | ++ |
Add attachment data to directive. (e.g. TTS payload)
+[in] | ndir | directive object |
[in] | length | length of data |
[in] | data | data |
0 | success |
-1 | failure |
int nugu_directive_close_data | +( | +NuguDirective * | +ndir | ) | ++ |
Set the attachment data status to "Received all data".
+[in] | ndir | directive object |
0 | success |
-1 | failure |
int nugu_directive_is_data_end | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the attachment data status.
+[in] | ndir | directive object |
0 | Data receiving is not yet completed. |
1 | Received all data |
-1 | failure |
int nugu_directive_set_media_type | +( | +NuguDirective * | +ndir, | +
+ | + | const char * | +type | +
+ | ) | ++ |
Set the attachment mime type.
+[in] | ndir | directive object |
[in] | type | mime type |
0 | success |
-1 | failure |
const char* nugu_directive_peek_media_type | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the attachment mime type.
+[in] | ndir | directive object |
unsigned char* nugu_directive_get_data | +( | +NuguDirective * | +ndir, | +
+ | + | size_t * | +length | +
+ | ) | ++ |
Get the attachment data received so far. When this function is called, the internal receive buffer is cleared.
+[in] | ndir | directive object |
[out] | length | attachment length |
size_t nugu_directive_get_data_size | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the size of attachment data received so far.
+[in] | ndir | directive object |
int nugu_directive_set_blocking_policy | +( | +NuguDirective * | +ndir, | +
+ | + | enum nugu_directive_medium | +medium, | +
+ | + | int | +is_block | +
+ | ) | ++ |
Set the medium of BlockingPolicy for the directive.
+[in] | ndir | directive object |
[in] | medium | medium of BlockingPolicy |
[in] | is_block | blocking status (1 = block, 0 = non-block) |
0 | success |
-1 | failure |
enum nugu_directive_medium nugu_directive_get_blocking_medium | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the medium of BlockingPolicy for the directive.
+[in] | ndir | directive object |
const char* nugu_directive_get_blocking_medium_string | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the medium string of BlockingPolicy for the directive.
+[in] | ndir | directive object |
int nugu_directive_is_blocking | +( | +const NuguDirective * | +ndir | ) | ++ |
Get the blocking status of BlockingPolicy for the directive.
+[in] | ndir | directive object |
0 | non-block |
1 | block |
-1 | failure |
int nugu_directive_set_data_callback | +( | +NuguDirective * | +ndir, | +
+ | + | NuguDirectiveDataCallback | +callback, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set attachment received event callback.
+[in] | ndir | directive object |
[in] | callback | callback function |
[in] | userdata | data to pass to the user callback |
0 | success |
-1 | failure |
int nugu_directive_remove_data_callback | +( | +NuguDirective * | +ndir | ) | ++ |
Remove attachment received event callback.
+[in] | ndir | directive object |
0 | success |
-1 | failure |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Encoder functions. +More...
++Typedefs | |
+typedef struct _nugu_encoder | NuguEncoder |
encoder object | |
+Functions | |
void * | nugu_encoder_encode (NuguEncoder *enc, int is_last, const void *data, size_t data_len, size_t *output_len) |
Encode the encoded data. More... | |
int | nugu_encoder_free (NuguEncoder *enc) |
Destroy the encoder object. More... | |
const char * | nugu_encoder_get_codec (NuguEncoder *enc) |
Get encoder codec. e.g. "OGG_OPUS" or "SPEEX". More... | |
void * | nugu_encoder_get_driver_data (NuguEncoder *enc) |
Get custom data for driver. More... | |
const char * | nugu_encoder_get_mime_type (NuguEncoder *enc) |
Get encoder mime type. More... | |
NuguEncoder * | nugu_encoder_new (NuguEncoderDriver *driver, NuguAudioProperty property) |
Create new encoder object. More... | |
int | nugu_encoder_set_driver_data (NuguEncoder *enc, void *data) |
Set custom data for driver. More... | |
Encoder functions.
+The encoder object encodes the pcm data to specific encoded data.
+NuguEncoder* nugu_encoder_new | +( | +NuguEncoderDriver * | +driver, | +
+ | + | NuguAudioProperty | +property | +
+ | ) | ++ |
Create new encoder object.
+[in] | driver | encoder driver |
[in] | property | audio property(channel,type,sample-rate) |
int nugu_encoder_free | +( | +NuguEncoder * | +enc | ) | ++ |
Destroy the encoder object.
+[in] | enc | encoder object |
0 | success |
-1 | failure |
int nugu_encoder_set_driver_data | +( | +NuguEncoder * | +enc, | +
+ | + | void * | +data | +
+ | ) | ++ |
Set custom data for driver.
+[in] | enc | encoder object |
[in] | data | custom data managed by driver |
0 | success |
-1 | failure |
void* nugu_encoder_get_driver_data | +( | +NuguEncoder * | +enc | ) | ++ |
Get custom data for driver.
+[in] | enc | encoder object |
void* nugu_encoder_encode | +( | +NuguEncoder * | +enc, | +
+ | + | int | +is_last, | +
+ | + | const void * | +data, | +
+ | + | size_t | +data_len, | +
+ | + | size_t * | +output_len | +
+ | ) | ++ |
Encode the encoded data.
+[in] | enc | encoder object |
[in] | is_last | last data hint (1 = last, 0 = not last) |
[in] | data | pcm data |
[in] | data_len | pcm data length |
[out] | output_len | output buffer length |
const char* nugu_encoder_get_codec | +( | +NuguEncoder * | +enc | ) | ++ |
Get encoder codec. e.g. "OGG_OPUS" or "SPEEX".
+[in] | enc | encoder object |
const char* nugu_encoder_get_mime_type | +( | +NuguEncoder * | +enc | ) | ++ |
Get encoder mime type.
+[in] | enc | encoder object |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Encoder driver. +More...
++Classes | |
struct | nugu_encoder_driver_ops |
encoder driver operations More... | |
+Typedefs | |
+typedef struct _nugu_encoder_driver | NuguEncoderDriver |
encoder driver object | |
+Enumerations | |
enum | nugu_encoder_type { NUGU_ENCODER_TYPE_SPEEX +, NUGU_ENCODER_TYPE_OPUS +, NUGU_ENCODER_TYPE_CUSTOM = 99 + } |
encoder type More... | |
+Functions | |
NuguEncoderDriver * | nugu_encoder_driver_find (const char *name) |
Find a driver by name in the driver list. More... | |
NuguEncoderDriver * | nugu_encoder_driver_find_bytype (enum nugu_encoder_type type) |
Find a driver by type in the driver list. More... | |
int | nugu_encoder_driver_free (NuguEncoderDriver *driver) |
Destroy the encoder driver. More... | |
NuguEncoderDriver * | nugu_encoder_driver_new (const char *name, enum nugu_encoder_type type, struct nugu_encoder_driver_ops *ops) |
Create new encoder driver. More... | |
int | nugu_encoder_driver_register (NuguEncoderDriver *driver) |
Register the driver to driver list. More... | |
int | nugu_encoder_driver_remove (NuguEncoderDriver *driver) |
Remove the driver from driver list. More... | |
Encoder driver.
+The encoder driver performs a function of encoding the received pcm data.
+enum nugu_encoder_type | +
encoder type
+Enumerator | |
---|---|
NUGU_ENCODER_TYPE_SPEEX | SPEEX + |
NUGU_ENCODER_TYPE_OPUS | OPUS + |
NUGU_ENCODER_TYPE_CUSTOM | Custom type + |
NuguEncoderDriver* nugu_encoder_driver_new | +( | +const char * | +name, | +
+ | + | enum nugu_encoder_type | +type, | +
+ | + | struct nugu_encoder_driver_ops * | +ops | +
+ | ) | ++ |
Create new encoder driver.
+[in] | name | driver name |
[in] | type | encoder type |
[in] | ops | operation table |
int nugu_encoder_driver_free | +( | +NuguEncoderDriver * | +driver | ) | ++ |
Destroy the encoder driver.
+[in] | driver | encoder driver object |
0 | success |
-1 | failure |
int nugu_encoder_driver_register | +( | +NuguEncoderDriver * | +driver | ) | ++ |
Register the driver to driver list.
+[in] | driver | encoder driver object |
0 | success |
-1 | failure |
int nugu_encoder_driver_remove | +( | +NuguEncoderDriver * | +driver | ) | ++ |
Remove the driver from driver list.
+[in] | driver | encoder driver object |
0 | success |
-1 | failure |
NuguEncoderDriver* nugu_encoder_driver_find | +( | +const char * | +name | ) | ++ |
Find a driver by name in the driver list.
+[in] | name | encoder driver name |
NuguEncoderDriver* nugu_encoder_driver_find_bytype | +( | +enum nugu_encoder_type | +type | ) | ++ |
Find a driver by type in the driver list.
+[in] | type | encoder driver type |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
The message object sent to the server. +More...
++Typedefs | |
+typedef struct _nugu_event | NuguEvent |
Event object. | |
+Enumerations | |
enum | nugu_event_type { NUGU_EVENT_TYPE_DEFAULT +, NUGU_EVENT_TYPE_WITH_ATTACHMENT + } |
event types More... | |
+Functions | |
void | nugu_event_free (NuguEvent *nev) |
Destroy the event object. More... | |
char * | nugu_event_generate_payload (NuguEvent *nev) |
Generate JSON payload using nugu_event attributes. More... | |
int | nugu_event_get_seq (NuguEvent *nev) |
Get the current sequence number of attachment data. More... | |
enum nugu_event_type | nugu_event_get_type (NuguEvent *nev) |
Get the type of NuguEvent. More... | |
int | nugu_event_increase_seq (NuguEvent *nev) |
Increase the sequence number. More... | |
NuguEvent * | nugu_event_new (const char *name_space, const char *name, const char *version) |
Create new event object. More... | |
const char * | nugu_event_peek_context (NuguEvent *nev) |
Get the context of event. More... | |
const char * | nugu_event_peek_dialog_id (NuguEvent *nev) |
Get the dialog-request-id of event. More... | |
const char * | nugu_event_peek_json (NuguEvent *nev) |
Get the payload of event. More... | |
const char * | nugu_event_peek_mime_type (NuguEvent *nev) |
Get the attachment mime type of NuguEvent. More... | |
const char * | nugu_event_peek_msg_id (NuguEvent *nev) |
Get the message-id of event. More... | |
const char * | nugu_event_peek_name (NuguEvent *nev) |
Get the name of event. More... | |
const char * | nugu_event_peek_namespace (NuguEvent *nev) |
Get the namespace of event. More... | |
const char * | nugu_event_peek_referrer_id (NuguEvent *nev) |
Get the referer-dialog-request-id of event. More... | |
const char * | nugu_event_peek_version (NuguEvent *nev) |
Get the version of event. More... | |
int | nugu_event_set_context (NuguEvent *nev, const char *context) |
Set text context of event. More... | |
int | nugu_event_set_dialog_id (NuguEvent *nev, const char *dialog_id) |
Set the dialog-request-id of event. More... | |
int | nugu_event_set_json (NuguEvent *nev, const char *json) |
Set the payload of event. More... | |
int | nugu_event_set_mime_type (NuguEvent *nev, const char *type) |
Set the attachment mime type of NuguEvent. More... | |
int | nugu_event_set_referrer_id (NuguEvent *nev, const char *referrer_id) |
Set the referer-dialog-request-id of event. More... | |
int | nugu_event_set_type (NuguEvent *nev, enum nugu_event_type type) |
Set the type of NuguEvent. More... | |
The message object sent to the server.
+An event is a message sent to the server and consists of the following elements:
enum nugu_event_type | +
NuguEvent* nugu_event_new | +( | +const char * | +name_space, | +
+ | + | const char * | +name, | +
+ | + | const char * | +version | +
+ | ) | ++ |
Create new event object.
+[in] | name_space | capability name space (e.g. "ASR") |
[in] | name | capability name (e.g. "Recognize") |
[in] | version | version string (e.g. "1.0") |
void nugu_event_free | +( | +NuguEvent * | +nev | ) | ++ |
Destroy the event object.
+[in] | nev | event object |
const char* nugu_event_peek_namespace | +( | +NuguEvent * | +nev | ) | ++ |
Get the namespace of event.
+[in] | nev | event object |
const char* nugu_event_peek_name | +( | +NuguEvent * | +nev | ) | ++ |
Get the name of event.
+[in] | nev | event object |
const char* nugu_event_peek_version | +( | +NuguEvent * | +nev | ) | ++ |
Get the version of event.
+[in] | nev | event object |
const char* nugu_event_peek_msg_id | +( | +NuguEvent * | +nev | ) | ++ |
Get the message-id of event.
+[in] | nev | event object |
int nugu_event_set_context | +( | +NuguEvent * | +nev, | +
+ | + | const char * | +context | +
+ | ) | ++ |
Set text context of event.
+[in] | nev | event object |
[in] | context | json type context information |
0 | success |
-1 | failure |
const char* nugu_event_peek_context | +( | +NuguEvent * | +nev | ) | ++ |
Get the context of event.
+[in] | nev | event object |
int nugu_event_set_json | +( | +NuguEvent * | +nev, | +
+ | + | const char * | +json | +
+ | ) | ++ |
Set the payload of event.
+[in] | nev | event object |
[in] | json | json type payload |
0 | success |
-1 | failure |
const char* nugu_event_peek_json | +( | +NuguEvent * | +nev | ) | ++ |
Get the payload of event.
+[in] | nev | event object |
int nugu_event_set_dialog_id | +( | +NuguEvent * | +nev, | +
+ | + | const char * | +dialog_id | +
+ | ) | ++ |
Set the dialog-request-id of event.
+[in] | nev | event object |
[in] | dialog_id | dialog-request-id |
0 | success |
-1 | failure |
const char* nugu_event_peek_dialog_id | +( | +NuguEvent * | +nev | ) | ++ |
Get the dialog-request-id of event.
+[in] | nev | event object |
int nugu_event_set_referrer_id | +( | +NuguEvent * | +nev, | +
+ | + | const char * | +referrer_id | +
+ | ) | ++ |
Set the referer-dialog-request-id of event.
+[in] | nev | event object |
[in] | referrer_id | referrer-dialog-request-id |
0 | success |
-1 | failure |
const char* nugu_event_peek_referrer_id | +( | +NuguEvent * | +nev | ) | ++ |
Get the referer-dialog-request-id of event.
+[in] | nev | event object |
int nugu_event_set_type | +( | +NuguEvent * | +nev, | +
+ | + | enum nugu_event_type | +type | +
+ | ) | ++ |
Set the type of NuguEvent.
+[in] | nev | event object |
[in] | type | event type |
0 | success |
-1 | failure |
enum nugu_event_type nugu_event_get_type | +( | +NuguEvent * | +nev | ) | ++ |
Get the type of NuguEvent.
+[in] | nev | event object |
int nugu_event_get_seq | +( | +NuguEvent * | +nev | ) | ++ |
Get the current sequence number of attachment data.
+[in] | nev | event object |
int nugu_event_increase_seq | +( | +NuguEvent * | +nev | ) | ++ |
Increase the sequence number.
+[in] | nev | event object |
0 | success |
-1 | failure |
char* nugu_event_generate_payload | +( | +NuguEvent * | +nev | ) | ++ |
Generate JSON payload using nugu_event attributes.
+[in] | nev | event object |
NULL | failure |
int nugu_event_set_mime_type | +( | +NuguEvent * | +nev, | +
+ | + | const char * | +type | +
+ | ) | ++ |
Set the attachment mime type of NuguEvent.
+[in] | nev | event object |
[in] | type | attachment type. e.g. "application/octet-stream" |
0 | success |
-1 | failure |
const char* nugu_event_peek_mime_type | +( | +NuguEvent * | +nev | ) | ++ |
Get the attachment mime type of NuguEvent.
+[in] | nev | event object |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Event queue for passing events between threads. +More...
++Typedefs | |
+typedef void(* | NuguEqueueCallback) (enum nugu_equeue_type type, void *data, void *userdata) |
Callback prototype for receiving an event. | |
+typedef void(* | NuguEqueueDestroyCallback) (void *data) |
Callback prototype for releasing data after event delivery is done. | |
+Enumerations | |
enum | nugu_equeue_type { + NUGU_EQUEUE_TYPE_NEW_DIRECTIVE = 0 +, NUGU_EQUEUE_TYPE_NEW_ATTACHMENT +, NUGU_EQUEUE_TYPE_INVALID_TOKEN +, NUGU_EQUEUE_TYPE_SEND_PING_FAILED +, + NUGU_EQUEUE_TYPE_EVENT_SEND_RESULT +, NUGU_EQUEUE_TYPE_EVENT_RESPONSE +, NUGU_EQUEUE_TYPE_REGISTRY_HEALTH +, NUGU_EQUEUE_TYPE_REGISTRY_SERVERS +, + NUGU_EQUEUE_TYPE_REGISTRY_FAILED +, NUGU_EQUEUE_TYPE_SERVER_CONNECTED +, NUGU_EQUEUE_TYPE_SERVER_DISCONNECTED +, NUGU_EQUEUE_TYPE_DIRECTIVES_CLOSED +, + NUGU_EQUEUE_TYPE_MAX = 255 + + } |
event types More... | |
+Functions | |
+void | nugu_equeue_deinitialize (void) |
De-initialize the event queue. | |
int | nugu_equeue_initialize (void) |
Initialize the event queue. More... | |
int | nugu_equeue_push (enum nugu_equeue_type type, void *data) |
Push new event with data to queue and trigger event callback in GMainloop thread context. More... | |
int | nugu_equeue_set_handler (enum nugu_equeue_type type, NuguEqueueCallback callback, NuguEqueueDestroyCallback destroy_callback, void *userdata) |
Set handler for event type. More... | |
int | nugu_equeue_unset_handler (enum nugu_equeue_type type) |
Unset handler for event type. More... | |
Event queue for passing events between threads.
+Queue for raising event callbacks with passing data from another thread to the thread context in which GMainloop runs.
+Manage the queue thread-safely using GAsyncQueue and wakeup the GMainloop using eventfd.
+enum nugu_equeue_type | +
event types
+int nugu_equeue_initialize | +( | +void | +) | ++ |
Initialize the event queue.
+0 | success |
-1 | failure |
int nugu_equeue_set_handler | +( | +enum nugu_equeue_type | +type, | +
+ | + | NuguEqueueCallback | +callback, | +
+ | + | NuguEqueueDestroyCallback | +destroy_callback, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set handler for event type.
+[in] | type | type-id |
[in] | callback | callback function |
[in] | destroy_callback | destroy notifier function |
[in] | userdata | data to pass to the user callback |
0 | success |
-1 | failure |
int nugu_equeue_unset_handler | +( | +enum nugu_equeue_type | +type | ) | ++ |
Unset handler for event type.
+[in] | type | type-id |
0 | success |
-1 | failure |
int nugu_equeue_push | +( | +enum nugu_equeue_type | +type, | +
+ | + | void * | +data | +
+ | ) | ++ |
Push new event with data to queue and trigger event callback in GMainloop thread context.
+[in] | type | type-id |
[in] | data | event data |
0 | success |
-1 | failure |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
HTTP request management. +More...
++Classes | |
struct | _nugu_http_response |
HTTP Response object. More... | |
+Typedefs | |
typedef int(* | NuguHttpCallback) (NuguHttpRequest *req, const NuguHttpResponse *resp, void *user_data) |
Callback prototype for receiving async HTTP response. More... | |
+typedef struct _nugu_http_header | NuguHttpHeader |
HTTP Header object. | |
+typedef struct _nugu_http_host | NuguHttpHost |
HTTP Host object. | |
+typedef int(* | NuguHttpProgressCallback) (NuguHttpRequest *req, const NuguHttpResponse *resp, long long downloaded, long long total, void *user_data) |
Callback prototype for HTTP download progress. | |
+typedef struct _nugu_http_request | NuguHttpRequest |
HTTP Request object. | |
+typedef struct _nugu_http_response | NuguHttpResponse |
HTTP Response object. | |
+Enumerations | |
enum | NuguHttpRequestType { NUGU_HTTP_REQUEST_GET +, NUGU_HTTP_REQUEST_POST +, NUGU_HTTP_REQUEST_PUT +, NUGU_HTTP_REQUEST_DELETE + } |
HTTP request types. | |
+Functions | |
NuguHttpRequest * | nugu_http_delete (NuguHttpHost *host, const char *path, NuguHttpHeader *header, NuguHttpCallback callback, void *user_data) |
A convenient API for HTTP DELETE async requests. More... | |
NuguHttpRequest * | nugu_http_delete_sync (NuguHttpHost *host, const char *path, NuguHttpHeader *header) |
A convenient API for HTTP DELETE sync requests. More... | |
NuguHttpRequest * | nugu_http_download (NuguHttpHost *host, const char *path, const char *dest_path, NuguHttpHeader *header, NuguHttpCallback callback, NuguHttpProgressCallback progress_callback, void *user_data) |
A convenient API for HTTP file download async requests. More... | |
NuguHttpRequest * | nugu_http_get (NuguHttpHost *host, const char *path, NuguHttpHeader *header, NuguHttpCallback callback, void *user_data) |
A convenient API for HTTP GET async requests. More... | |
NuguHttpRequest * | nugu_http_get_sync (NuguHttpHost *host, const char *path, NuguHttpHeader *header) |
A convenient API for HTTP GET sync requests. More... | |
int | nugu_http_header_add (NuguHttpHeader *header, const char *key, const char *value) |
Add a key-value string to header object. More... | |
NuguHttpHeader * | nugu_http_header_dup (const NuguHttpHeader *src_header) |
Duplicate the http header object. More... | |
const char * | nugu_http_header_find (NuguHttpHeader *header, const char *key) |
Find value from header object. More... | |
void | nugu_http_header_free (NuguHttpHeader *header) |
Destroy the header object. More... | |
int | nugu_http_header_import (NuguHttpHeader *header, const NuguHttpHeader *from) |
Import header data from other header object. More... | |
NuguHttpHeader * | nugu_http_header_new (void) |
Create a new HTTP header object. More... | |
int | nugu_http_header_remove (NuguHttpHeader *header, const char *key) |
Remove a key-value string from header object. More... | |
void | nugu_http_host_free (NuguHttpHost *host) |
Destroy the host object. More... | |
NuguHttpHost * | nugu_http_host_new (const char *url) |
Create a new HTTP host object. More... | |
const char * | nugu_http_host_peek_url (NuguHttpHost *host) |
Get url from HTTP host object. More... | |
void | nugu_http_host_set_connection_timeout (NuguHttpHost *host, long msecs) |
Set connection timeout to host. More... | |
void | nugu_http_host_set_timeout (NuguHttpHost *host, long msecs) |
Set timeout to host. More... | |
+void | nugu_http_init (void) |
Initialize HTTP module (curl_global_init) | |
NuguHttpRequest * | nugu_http_post (NuguHttpHost *host, const char *path, NuguHttpHeader *header, const void *body, size_t body_len, NuguHttpCallback callback, void *user_data) |
A convenient API for HTTP POST async requests. More... | |
NuguHttpRequest * | nugu_http_post_sync (NuguHttpHost *host, const char *path, NuguHttpHeader *header, const void *body, size_t body_len) |
A convenient API for HTTP POST sync requests. More... | |
NuguHttpRequest * | nugu_http_put (NuguHttpHost *host, const char *path, NuguHttpHeader *header, const void *body, size_t body_len, NuguHttpCallback callback, void *user_data) |
A convenient API for HTTP PUT async requests. More... | |
NuguHttpRequest * | nugu_http_put_sync (NuguHttpHost *host, const char *path, NuguHttpHeader *header, const void *body, size_t body_len) |
A convenient API for HTTP PUT sync requests. More... | |
NuguHttpRequest * | nugu_http_request (enum NuguHttpRequestType type, NuguHttpHost *host, const char *path, NuguHttpHeader *header, const void *body, size_t body_len, NuguHttpCallback callback, void *user_data) |
HTTP async request. More... | |
void | nugu_http_request_free (NuguHttpRequest *req) |
Destroy the HTTP request object. More... | |
const NuguHttpResponse * | nugu_http_request_response_get (NuguHttpRequest *req) |
Get the HTTP response from request object. More... | |
NuguHttpRequest * | nugu_http_request_sync (enum NuguHttpRequestType type, NuguHttpHost *host, const char *path, NuguHttpHeader *header, const void *body, size_t body_len) |
HTTP sync request. More... | |
NuguHttpResponse * | nugu_http_response_dup (const NuguHttpResponse *orig) |
Duplicate the HTTP response object. More... | |
void | nugu_http_response_free (NuguHttpResponse *resp) |
Destroy the HTTP response object. More... | |
HTTP request management.
+The NuguHttp handles REST(GET/POST/PUT/DELETE) requests using HTTP.
+typedef int(* NuguHttpCallback) (NuguHttpRequest *req, const NuguHttpResponse *resp, void *user_data) | +
Callback prototype for receiving async HTTP response.
+1 | automatically free memory after return the callback |
0 | free the memory manually by the nugu_http_request_free(). |
NuguHttpHost* nugu_http_host_new | +( | +const char * | +url | ) | ++ |
Create a new HTTP host object.
+[in] | url | host url |
void nugu_http_host_set_timeout | +( | +NuguHttpHost * | +host, | +
+ | + | long | +msecs | +
+ | ) | ++ |
Set timeout to host.
+[in] | host | host object |
[in] | msecs | millisecond |
void nugu_http_host_set_connection_timeout | +( | +NuguHttpHost * | +host, | +
+ | + | long | +msecs | +
+ | ) | ++ |
Set connection timeout to host.
+[in] | host | host object |
[in] | msecs | millisecond |
const char* nugu_http_host_peek_url | +( | +NuguHttpHost * | +host | ) | ++ |
Get url from HTTP host object.
+[in] | host | host object |
void nugu_http_host_free | +( | +NuguHttpHost * | +host | ) | ++ |
Destroy the host object.
+[in] | host | host object |
NuguHttpHeader* nugu_http_header_new | +( | +void | +) | ++ |
int nugu_http_header_add | +( | +NuguHttpHeader * | +header, | +
+ | + | const char * | +key, | +
+ | + | const char * | +value | +
+ | ) | ++ |
Add a key-value string to header object.
+[in] | header | header object |
[in] | key | key string, e.g. "Content-Type" |
[in] | value | value string, e.g. "application/json" |
0 | success |
-1 | failure |
int nugu_http_header_remove | +( | +NuguHttpHeader * | +header, | +
+ | + | const char * | +key | +
+ | ) | ++ |
Remove a key-value string from header object.
+[in] | header | header object |
[in] | key | key string |
0 | success |
-1 | failure |
const char* nugu_http_header_find | +( | +NuguHttpHeader * | +header, | +
+ | + | const char * | +key | +
+ | ) | ++ |
Find value from header object.
+[in] | header | header object |
[in] | key | key string |
NuguHttpHeader* nugu_http_header_dup | +( | +const NuguHttpHeader * | +src_header | ) | ++ |
Duplicate the http header object.
+[in] | src_header | source header object |
int nugu_http_header_import | +( | +NuguHttpHeader * | +header, | +
+ | + | const NuguHttpHeader * | +from | +
+ | ) | ++ |
Import header data from other header object.
+[in] | header | header object |
[in] | from | header object to import |
0 | success |
-1 | failure |
void nugu_http_header_free | +( | +NuguHttpHeader * | +header | ) | ++ |
Destroy the header object.
+[in] | header | header object |
NuguHttpRequest* nugu_http_request | +( | +enum NuguHttpRequestType | +type, | +
+ | + | NuguHttpHost * | +host, | +
+ | + | const char * | +path, | +
+ | + | NuguHttpHeader * | +header, | +
+ | + | const void * | +body, | +
+ | + | size_t | +body_len, | +
+ | + | NuguHttpCallback | +callback, | +
+ | + | void * | +user_data | +
+ | ) | ++ |
HTTP async request.
+[in] | type | request type |
[in] | host | host object |
[in] | path | url path |
[in] | header | header object |
[in] | body | body data to send |
[in] | body_len | length of body data |
[in] | callback | callback function to receive response |
[in] | user_data | data to pass to the user callback |
NuguHttpRequest* nugu_http_request_sync | +( | +enum NuguHttpRequestType | +type, | +
+ | + | NuguHttpHost * | +host, | +
+ | + | const char * | +path, | +
+ | + | NuguHttpHeader * | +header, | +
+ | + | const void * | +body, | +
+ | + | size_t | +body_len | +
+ | ) | ++ |
HTTP sync request.
+[in] | type | request type |
[in] | host | host object |
[in] | path | url path |
[in] | header | header object |
[in] | body | body data to send |
[in] | body_len | length of body data |
NuguHttpRequest* nugu_http_get | +( | +NuguHttpHost * | +host, | +
+ | + | const char * | +path, | +
+ | + | NuguHttpHeader * | +header, | +
+ | + | NuguHttpCallback | +callback, | +
+ | + | void * | +user_data | +
+ | ) | ++ |
A convenient API for HTTP GET async requests.
+[in] | host | host object |
[in] | path | url path |
[in] | header | header object |
[in] | callback | callback function to receive response |
[in] | user_data | data to pass to the user callback |
NuguHttpRequest* nugu_http_get_sync | +( | +NuguHttpHost * | +host, | +
+ | + | const char * | +path, | +
+ | + | NuguHttpHeader * | +header | +
+ | ) | ++ |
A convenient API for HTTP GET sync requests.
+[in] | host | host object |
[in] | path | url path |
[in] | header | header object |
NuguHttpRequest* nugu_http_post | +( | +NuguHttpHost * | +host, | +
+ | + | const char * | +path, | +
+ | + | NuguHttpHeader * | +header, | +
+ | + | const void * | +body, | +
+ | + | size_t | +body_len, | +
+ | + | NuguHttpCallback | +callback, | +
+ | + | void * | +user_data | +
+ | ) | ++ |
A convenient API for HTTP POST async requests.
+[in] | host | host object |
[in] | path | url path |
[in] | header | header object |
[in] | body | body data to send |
[in] | body_len | length of body data |
[in] | callback | callback function to receive response |
[in] | user_data | data to pass to the user callback |
NuguHttpRequest* nugu_http_post_sync | +( | +NuguHttpHost * | +host, | +
+ | + | const char * | +path, | +
+ | + | NuguHttpHeader * | +header, | +
+ | + | const void * | +body, | +
+ | + | size_t | +body_len | +
+ | ) | ++ |
A convenient API for HTTP POST sync requests.
+[in] | host | host object |
[in] | path | url path |
[in] | header | header object |
[in] | body | body data to send |
[in] | body_len | length of body data |
NuguHttpRequest* nugu_http_put | +( | +NuguHttpHost * | +host, | +
+ | + | const char * | +path, | +
+ | + | NuguHttpHeader * | +header, | +
+ | + | const void * | +body, | +
+ | + | size_t | +body_len, | +
+ | + | NuguHttpCallback | +callback, | +
+ | + | void * | +user_data | +
+ | ) | ++ |
A convenient API for HTTP PUT async requests.
+[in] | host | host object |
[in] | path | url path |
[in] | header | header object |
[in] | body | body data to send |
[in] | body_len | length of body data |
[in] | callback | callback function to receive response |
[in] | user_data | data to pass to the user callback |
NuguHttpRequest* nugu_http_put_sync | +( | +NuguHttpHost * | +host, | +
+ | + | const char * | +path, | +
+ | + | NuguHttpHeader * | +header, | +
+ | + | const void * | +body, | +
+ | + | size_t | +body_len | +
+ | ) | ++ |
A convenient API for HTTP PUT sync requests.
+[in] | host | host object |
[in] | path | url path |
[in] | header | header object |
[in] | body | body data to send |
[in] | body_len | length of body data |
NuguHttpRequest* nugu_http_delete | +( | +NuguHttpHost * | +host, | +
+ | + | const char * | +path, | +
+ | + | NuguHttpHeader * | +header, | +
+ | + | NuguHttpCallback | +callback, | +
+ | + | void * | +user_data | +
+ | ) | ++ |
A convenient API for HTTP DELETE async requests.
+[in] | host | host object |
[in] | path | url path |
[in] | header | header object |
[in] | callback | callback function to receive response |
[in] | user_data | data to pass to the user callback |
NuguHttpRequest* nugu_http_delete_sync | +( | +NuguHttpHost * | +host, | +
+ | + | const char * | +path, | +
+ | + | NuguHttpHeader * | +header | +
+ | ) | ++ |
A convenient API for HTTP DELETE sync requests.
+[in] | host | host object |
[in] | path | url path |
[in] | header | header object |
NuguHttpRequest* nugu_http_download | +( | +NuguHttpHost * | +host, | +
+ | + | const char * | +path, | +
+ | + | const char * | +dest_path, | +
+ | + | NuguHttpHeader * | +header, | +
+ | + | NuguHttpCallback | +callback, | +
+ | + | NuguHttpProgressCallback | +progress_callback, | +
+ | + | void * | +user_data | +
+ | ) | ++ |
A convenient API for HTTP file download async requests.
+[in] | host | host object |
[in] | path | url path |
[in] | dest_path | path to save the file |
[in] | header | header object |
[in] | callback | callback function to receive response |
[in] | progress_callback | callback function to receive download progress |
[in] | user_data | data to pass to the user callback |
void nugu_http_request_free | +( | +NuguHttpRequest * | +req | ) | ++ |
Destroy the HTTP request object.
+[in] | req | request object |
NuguHttpResponse* nugu_http_response_dup | +( | +const NuguHttpResponse * | +orig | ) | ++ |
Duplicate the HTTP response object.
+[in] | orig | Original response object |
void nugu_http_response_free | +( | +NuguHttpResponse * | +resp | ) | ++ |
Destroy the HTTP response object.
+[in] | resp | response object |
const NuguHttpResponse* nugu_http_request_response_get | +( | +NuguHttpRequest * | +req | ) | ++ |
Get the HTTP response from request object.
+[in] | req | request object |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
HTTP REST request management. +More...
++Classes | |
class | NuguClientKit::NuguHttpRest |
NUGU HTTP Rest. More... | |
HTTP REST request management.
+The NuguHttpRest handles REST(GET/POST/PUT/DELETE) requests using HTTP.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
PCM manipulation functions. +More...
++Typedefs | |
+typedef struct _nugu_pcm | NuguPcm |
pcm object | |
+Functions | |
int | nugu_pcm_add (NuguPcm *pcm) |
Add pcm object to managed list. More... | |
void | nugu_pcm_clear_buffer (NuguPcm *pcm) |
Clear pcm buffer. More... | |
void | nugu_pcm_emit_event (NuguPcm *pcm, enum nugu_media_event event) |
Emit event to registered callback. More... | |
void | nugu_pcm_emit_status (NuguPcm *pcm, enum nugu_media_status status) |
Emit status to registered callback. More... | |
NuguPcm * | nugu_pcm_find (const char *name) |
Find a pcm object by name in the managed list. More... | |
void | nugu_pcm_free (NuguPcm *pcm) |
Destroy the pcm object. More... | |
int | nugu_pcm_get_audio_attribute (NuguPcm *pcm) |
Get audio attribute. More... | |
const char * | nugu_pcm_get_audio_attribute_str (NuguPcm *pcm) |
Get audio attribute. More... | |
int | nugu_pcm_get_data (NuguPcm *pcm, char *data, size_t size) |
Get all data. More... | |
size_t | nugu_pcm_get_data_size (NuguPcm *pcm) |
Get pcm data size. More... | |
void * | nugu_pcm_get_driver_data (NuguPcm *pcm) |
Get custom data for driver. More... | |
int | nugu_pcm_get_duration (NuguPcm *pcm) |
Get duration information of pcm. More... | |
int | nugu_pcm_get_position (NuguPcm *pcm) |
Get current playback position of pcm. More... | |
enum nugu_media_status | nugu_pcm_get_status (NuguPcm *pcm) |
Get status of pcm. More... | |
int | nugu_pcm_get_volume (NuguPcm *pcm) |
Get volume of pcm. More... | |
NuguPcm * | nugu_pcm_new (const char *name, NuguPcmDriver *driver, NuguAudioProperty property) |
Create new pcm object. More... | |
int | nugu_pcm_pause (NuguPcm *pcm) |
Pause pcm playback. More... | |
int | nugu_pcm_push_data (NuguPcm *pcm, const char *data, size_t size, int is_last) |
Push playback pcm data. More... | |
int | nugu_pcm_push_data_done (NuguPcm *pcm) |
Set flag that push for all data is complete. More... | |
int | nugu_pcm_receive_is_last_data (NuguPcm *pcm) |
Get flag that all data pushes are complete. More... | |
int | nugu_pcm_remove (NuguPcm *pcm) |
Remove pcm object from managed list. More... | |
int | nugu_pcm_resume (NuguPcm *pcm) |
Resume pcm playback. More... | |
int | nugu_pcm_set_audio_attribute (NuguPcm *pcm, NuguAudioAttribute attr) |
Set audio attribute. More... | |
int | nugu_pcm_set_driver_data (NuguPcm *pcm, void *data) |
Set custom data for driver. More... | |
void | nugu_pcm_set_event_callback (NuguPcm *pcm, NuguMediaEventCallback cb, void *userdata) |
Set pcm event callback. More... | |
void | nugu_pcm_set_status_callback (NuguPcm *pcm, NuguMediaStatusCallback cb, void *userdata) |
Set pcm status callback. More... | |
int | nugu_pcm_set_volume (NuguPcm *pcm, int volume) |
Set volume of pcm. More... | |
int | nugu_pcm_start (NuguPcm *pcm) |
Start pcm playback. More... | |
int | nugu_pcm_stop (NuguPcm *pcm) |
Stop pcm playback. More... | |
PCM manipulation functions.
+PCM data is managed by pushing it in the nugu buffer.
+NuguPcm* nugu_pcm_new | +( | +const char * | +name, | +
+ | + | NuguPcmDriver * | +driver, | +
+ | + | NuguAudioProperty | +property | +
+ | ) | ++ |
Create new pcm object.
+[in] | name | pcm name |
[in] | driver | driver object |
[in] | property | audio property |
void nugu_pcm_free | +( | +NuguPcm * | +pcm | ) | ++ |
int nugu_pcm_add | +( | +NuguPcm * | +pcm | ) | ++ |
Add pcm object to managed list.
+[in] | pcm | pcm object |
0 | success |
-1 | failure |
int nugu_pcm_remove | +( | +NuguPcm * | +pcm | ) | ++ |
Remove pcm object from managed list.
+[in] | pcm | pcm object |
0 | success |
-1 | failure |
NuguPcm* nugu_pcm_find | +( | +const char * | +name | ) | ++ |
Find a pcm object by name in the managed list.
+[in] | name | name of pcm object |
int nugu_pcm_set_audio_attribute | +( | +NuguPcm * | +pcm, | +
+ | + | NuguAudioAttribute | +attr | +
+ | ) | ++ |
Set audio attribute.
+[in] | pcm | pcm object |
[in] | attr | audio attribute |
0 | success |
-1 | failure |
int nugu_pcm_get_audio_attribute | +( | +NuguPcm * | +pcm | ) | ++ |
Get audio attribute.
+[in] | pcm | pcm object |
-1 | failure |
const char* nugu_pcm_get_audio_attribute_str | +( | +NuguPcm * | +pcm | ) | ++ |
Get audio attribute.
+[in] | pcm | pcm object |
NULL | failure |
int nugu_pcm_start | +( | +NuguPcm * | +pcm | ) | ++ |
Start pcm playback.
+[in] | pcm | pcm object |
0 | success |
-1 | failure |
int nugu_pcm_stop | +( | +NuguPcm * | +pcm | ) | ++ |
Stop pcm playback.
+[in] | pcm | pcm object |
0 | success |
-1 | failure |
int nugu_pcm_pause | +( | +NuguPcm * | +pcm | ) | ++ |
Pause pcm playback.
+[in] | pcm | pcm object |
0 | success |
-1 | failure |
int nugu_pcm_resume | +( | +NuguPcm * | +pcm | ) | ++ |
Resume pcm playback.
+[in] | pcm | pcm object |
0 | success |
-1 | failure |
int nugu_pcm_set_volume | +( | +NuguPcm * | +pcm, | +
+ | + | int | +volume | +
+ | ) | ++ |
Set volume of pcm.
+[in] | pcm | pcm object |
[in] | volume | volume |
0 | success |
-1 | failure |
int nugu_pcm_get_volume | +( | +NuguPcm * | +pcm | ) | ++ |
Get volume of pcm.
+[in] | pcm | pcm object |
0 | success |
-1 | failure |
int nugu_pcm_get_duration | +( | +NuguPcm * | +pcm | ) | ++ |
Get duration information of pcm.
+[in] | pcm | pcm object |
>0 | success (duration) |
-1 | failure |
int nugu_pcm_get_position | +( | +NuguPcm * | +pcm | ) | ++ |
Get current playback position of pcm.
+[in] | pcm | pcm object |
>0 | success (position) |
-1 | failure |
enum nugu_media_status nugu_pcm_get_status | +( | +NuguPcm * | +pcm | ) | ++ |
Get status of pcm.
+[in] | pcm | pcm object |
void nugu_pcm_set_status_callback | +( | +NuguPcm * | +pcm, | +
+ | + | NuguMediaStatusCallback | +cb, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set pcm status callback.
+[in] | pcm | pcm object |
[in] | cb | callback function |
[in] | userdata | data to pass to the user callback |
void nugu_pcm_emit_status | +( | +NuguPcm * | +pcm, | +
+ | + | enum nugu_media_status | +status | +
+ | ) | ++ |
Emit status to registered callback.
+[in] | pcm | pcm object |
[in] | status | pcm status |
void nugu_pcm_set_event_callback | +( | +NuguPcm * | +pcm, | +
+ | + | NuguMediaEventCallback | +cb, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set pcm event callback.
+[in] | pcm | pcm object |
[in] | cb | callback function |
[in] | userdata | data to pass to the user callback |
void nugu_pcm_emit_event | +( | +NuguPcm * | +pcm, | +
+ | + | enum nugu_media_event | +event | +
+ | ) | ++ |
Emit event to registered callback.
+[in] | pcm | pcm object |
[in] | event | pcm event |
int nugu_pcm_set_driver_data | +( | +NuguPcm * | +pcm, | +
+ | + | void * | +data | +
+ | ) | ++ |
Set custom data for driver.
+[in] | pcm | pcm object |
[in] | data | custom data managed by driver |
0 | success |
-1 | failure |
void* nugu_pcm_get_driver_data | +( | +NuguPcm * | +pcm | ) | ++ |
Get custom data for driver.
+[in] | pcm | pcm object |
void nugu_pcm_clear_buffer | +( | +NuguPcm * | +pcm | ) | ++ |
Clear pcm buffer.
+[in] | pcm | pcm object |
int nugu_pcm_push_data | +( | +NuguPcm * | +pcm, | +
+ | + | const char * | +data, | +
+ | + | size_t | +size, | +
+ | + | int | +is_last | +
+ | ) | ++ |
Push playback pcm data.
+[in] | pcm | pcm object |
[in] | data | pcm data |
[in] | size | length of pcm data |
[in] | is_last | last data(is_last=1) or not(is_last=0) |
0 | success |
-1 | failure |
int nugu_pcm_push_data_done | +( | +NuguPcm * | +pcm | ) | ++ |
Set flag that push for all data is complete.
+[in] | pcm | pcm object |
0 | success |
-1 | failure |
int nugu_pcm_get_data | +( | +NuguPcm * | +pcm, | +
+ | + | char * | +data, | +
+ | + | size_t | +size | +
+ | ) | ++ |
Get all data.
+[in] | pcm | pcm object |
[out] | data | buffer to get pcm data |
[in] | size | size of buffer |
0 | success |
-1 | failure |
size_t nugu_pcm_get_data_size | +( | +NuguPcm * | +pcm | ) | ++ |
Get pcm data size.
+[in] | pcm | pcm object |
int nugu_pcm_receive_is_last_data | +( | +NuguPcm * | +pcm | ) | ++ |
Get flag that all data pushes are complete.
+[in] | pcm | pcm object |
0 | success |
-1 | failure |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
PCM driver. +More...
++Classes | |
struct | nugu_pcm_driver_ops |
pcm driver operations More... | |
+Typedefs | |
+typedef struct _nugu_pcm_driver | NuguPcmDriver |
pcm driver object | |
+Functions | |
NuguPcmDriver * | nugu_pcm_driver_find (const char *name) |
Find a driver by name in the driver list. More... | |
int | nugu_pcm_driver_free (NuguPcmDriver *driver) |
Destroy the pcm driver object. More... | |
NuguPcmDriver * | nugu_pcm_driver_get_default (void) |
Get the default pcm driver. More... | |
NuguPcmDriver * | nugu_pcm_driver_new (const char *name, struct nugu_pcm_driver_ops *ops) |
Create new pcm driver object. More... | |
int | nugu_pcm_driver_register (NuguPcmDriver *driver) |
Register the driver to driver list. More... | |
int | nugu_pcm_driver_remove (NuguPcmDriver *driver) |
Remove the driver from driver list. More... | |
int | nugu_pcm_driver_set_default (NuguPcmDriver *driver) |
Set the default pcm driver. More... | |
PCM driver.
+Manage player drivers that can play PCM data.
+NuguPcmDriver* nugu_pcm_driver_new | +( | +const char * | +name, | +
+ | + | struct nugu_pcm_driver_ops * | +ops | +
+ | ) | ++ |
Create new pcm driver object.
+[in] | name | driver name |
[in] | ops | operation table |
int nugu_pcm_driver_free | +( | +NuguPcmDriver * | +driver | ) | ++ |
Destroy the pcm driver object.
+[in] | driver | pcm driver |
0 | success |
-1 | failure |
int nugu_pcm_driver_register | +( | +NuguPcmDriver * | +driver | ) | ++ |
Register the driver to driver list.
+[in] | driver | pcm driver |
0 | success |
-1 | failure |
int nugu_pcm_driver_remove | +( | +NuguPcmDriver * | +driver | ) | ++ |
Remove the driver from driver list.
+[in] | driver | pcm driver |
0 | success |
-1 | failure |
int nugu_pcm_driver_set_default | +( | +NuguPcmDriver * | +driver | ) | ++ |
Set the default pcm driver.
+[in] | driver | pcm driver |
0 | success |
-1 | failure |
NuguPcmDriver* nugu_pcm_driver_get_default | +( | +void | +) | ++ |
NuguPcmDriver* nugu_pcm_driver_find | +( | +const char * | +name | ) | ++ |
Find a driver by name in the driver list.
+[in] | name | pcm driver name |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Media player functions. +More...
++Typedefs | |
+typedef struct _nugu_player | NuguPlayer |
player object | |
+Functions | |
int | nugu_player_add (NuguPlayer *player) |
Add player object to managed list. More... | |
void | nugu_player_emit_event (NuguPlayer *player, enum nugu_media_event event) |
Emit event to registered callback. More... | |
void | nugu_player_emit_status (NuguPlayer *player, enum nugu_media_status status) |
Emit status to registered callback. More... | |
NuguPlayer * | nugu_player_find (const char *name) |
Find a player object by name in the managed list. More... | |
void | nugu_player_free (NuguPlayer *player) |
Destroy the player object. More... | |
int | nugu_player_get_audio_attribute (NuguPlayer *player) |
Get audio attribute. More... | |
const char * | nugu_player_get_audio_attribute_str (NuguPlayer *player) |
Get audio attribute. More... | |
void * | nugu_player_get_driver_data (NuguPlayer *player) |
Get custom data for driver. More... | |
int | nugu_player_get_duration (NuguPlayer *player) |
Get duration information of player. More... | |
int | nugu_player_get_position (NuguPlayer *player) |
Get current playback position of player. More... | |
enum nugu_media_status | nugu_player_get_status (NuguPlayer *player) |
Get status of player. More... | |
int | nugu_player_get_volume (NuguPlayer *player) |
Get volume of player. More... | |
NuguPlayer * | nugu_player_new (const char *name, NuguPlayerDriver *driver) |
Create new player object. More... | |
int | nugu_player_pause (NuguPlayer *player) |
Pause the player. More... | |
int | nugu_player_remove (NuguPlayer *player) |
Remove player object from managed list. More... | |
int | nugu_player_resume (NuguPlayer *player) |
Resume the player. More... | |
int | nugu_player_seek (NuguPlayer *player, int sec) |
Seek the player. More... | |
int | nugu_player_set_audio_attribute (NuguPlayer *player, NuguAudioAttribute attr) |
Set audio attribute. More... | |
int | nugu_player_set_driver_data (NuguPlayer *player, void *data) |
Set custom data for driver. More... | |
void | nugu_player_set_event_callback (NuguPlayer *player, NuguMediaEventCallback cb, void *userdata) |
Set player event callback. More... | |
int | nugu_player_set_position (NuguPlayer *player, int position) |
Set current playback position of player. More... | |
int | nugu_player_set_source (NuguPlayer *player, const char *url) |
Set source url. More... | |
void | nugu_player_set_status_callback (NuguPlayer *player, NuguMediaStatusCallback cb, void *userdata) |
Set player status callback. More... | |
int | nugu_player_set_volume (NuguPlayer *player, int vol) |
Set volume of player. More... | |
int | nugu_player_start (NuguPlayer *player) |
Start the player. More... | |
int | nugu_player_stop (NuguPlayer *player) |
Stop the player. More... | |
Media player functions.
+Manage the functions for media content playback.
+NuguPlayer* nugu_player_new | +( | +const char * | +name, | +
+ | + | NuguPlayerDriver * | +driver | +
+ | ) | ++ |
Create new player object.
+[in] | name | name of player |
[in] | driver | player driver |
void nugu_player_free | +( | +NuguPlayer * | +player | ) | ++ |
Destroy the player object.
+[in] | player | player object |
int nugu_player_add | +( | +NuguPlayer * | +player | ) | ++ |
Add player object to managed list.
+[in] | player | player object |
0 | success |
-1 | failure |
int nugu_player_remove | +( | +NuguPlayer * | +player | ) | ++ |
Remove player object from managed list.
+[in] | player | player object |
0 | success |
-1 | failure |
NuguPlayer* nugu_player_find | +( | +const char * | +name | ) | ++ |
Find a player object by name in the managed list.
+[in] | name | name of player object |
int nugu_player_set_audio_attribute | +( | +NuguPlayer * | +player, | +
+ | + | NuguAudioAttribute | +attr | +
+ | ) | ++ |
Set audio attribute.
+[in] | player | player object |
[in] | attr | audio attribute |
0 | success |
-1 | failure |
int nugu_player_get_audio_attribute | +( | +NuguPlayer * | +player | ) | ++ |
Get audio attribute.
+[in] | player | player object |
NULL | -1 |
const char* nugu_player_get_audio_attribute_str | +( | +NuguPlayer * | +player | ) | ++ |
Get audio attribute.
+[in] | player | player object |
NULL | failure |
int nugu_player_set_source | +( | +NuguPlayer * | +player, | +
+ | + | const char * | +url | +
+ | ) | ++ |
Set source url.
+[in] | player | player object |
[in] | url | source url |
0 | success |
-1 | failure |
int nugu_player_start | +( | +NuguPlayer * | +player | ) | ++ |
Start the player.
+[in] | player | player object |
0 | success |
-1 | failure |
int nugu_player_stop | +( | +NuguPlayer * | +player | ) | ++ |
Stop the player.
+[in] | player | player object |
0 | success |
-1 | failure |
int nugu_player_pause | +( | +NuguPlayer * | +player | ) | ++ |
Pause the player.
+[in] | player | player object |
0 | success |
-1 | failure |
int nugu_player_resume | +( | +NuguPlayer * | +player | ) | ++ |
Resume the player.
+[in] | player | player object |
0 | success |
-1 | failure |
int nugu_player_seek | +( | +NuguPlayer * | +player, | +
+ | + | int | +sec | +
+ | ) | ++ |
Seek the player.
+[in] | player | player object |
[in] | sec | position in seconds |
0 | success |
-1 | failure |
int nugu_player_set_volume | +( | +NuguPlayer * | +player, | +
+ | + | int | +vol | +
+ | ) | ++ |
Set volume of player.
+[in] | player | player object |
[in] | vol | volume value |
0 | success |
-1 | failure |
int nugu_player_get_volume | +( | +NuguPlayer * | +player | ) | ++ |
Get volume of player.
+[in] | player | player object |
>0 | success (volume) |
-1 | failure |
int nugu_player_get_duration | +( | +NuguPlayer * | +player | ) | ++ |
Get duration information of player.
+[in] | player | player object |
>0 | success (duration) |
-1 | failure |
int nugu_player_set_position | +( | +NuguPlayer * | +player, | +
+ | + | int | +position | +
+ | ) | ++ |
Set current playback position of player.
+[in] | player | nugu player object |
[in] | position | player position |
0 | success |
-1 | failure |
int nugu_player_get_position | +( | +NuguPlayer * | +player | ) | ++ |
Get current playback position of player.
+[in] | player | player object |
>0 | success (position) |
-1 | failure |
enum nugu_media_status nugu_player_get_status | +( | +NuguPlayer * | +player | ) | ++ |
Get status of player.
+[in] | player | player object |
void nugu_player_set_status_callback | +( | +NuguPlayer * | +player, | +
+ | + | NuguMediaStatusCallback | +cb, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set player status callback.
+[in] | player | player object |
[in] | cb | callback function |
[in] | userdata | data to pass to the user callback |
void nugu_player_emit_status | +( | +NuguPlayer * | +player, | +
+ | + | enum nugu_media_status | +status | +
+ | ) | ++ |
Emit status to registered callback.
+[in] | player | player object |
[in] | status | player status |
void nugu_player_set_event_callback | +( | +NuguPlayer * | +player, | +
+ | + | NuguMediaEventCallback | +cb, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set player event callback.
+[in] | player | player object |
[in] | cb | callback function |
[in] | userdata | data to pass to the user callback |
void nugu_player_emit_event | +( | +NuguPlayer * | +player, | +
+ | + | enum nugu_media_event | +event | +
+ | ) | ++ |
Emit event to registered callback.
+[in] | player | player object |
[in] | event | player event |
int nugu_player_set_driver_data | +( | +NuguPlayer * | +player, | +
+ | + | void * | +data | +
+ | ) | ++ |
Set custom data for driver.
+[in] | player | player object |
[in] | data | custom data managed by driver |
0 | success |
-1 | failure |
void* nugu_player_get_driver_data | +( | +NuguPlayer * | +player | ) | ++ |
Get custom data for driver.
+[in] | player | player object |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Media player driver. +More...
++Classes | |
struct | nugu_player_driver_ops |
player driver operations More... | |
+Typedefs | |
+typedef struct _nugu_player_driver | NuguPlayerDriver |
player driver object | |
+Functions | |
NuguPlayerDriver * | nugu_player_driver_find (const char *name) |
Find a driver by name in the driver list. More... | |
int | nugu_player_driver_free (NuguPlayerDriver *driver) |
Destroy the player driver object. More... | |
NuguPlayerDriver * | nugu_player_driver_get_default (void) |
Get the default player driver. More... | |
NuguPlayerDriver * | nugu_player_driver_new (const char *name, struct nugu_player_driver_ops *ops) |
Create new player driver object. More... | |
int | nugu_player_driver_register (NuguPlayerDriver *driver) |
Register the driver to driver list. More... | |
int | nugu_player_driver_remove (NuguPlayerDriver *driver) |
Remove the driver from driver list. More... | |
int | nugu_player_driver_set_default (NuguPlayerDriver *driver) |
Set the default player driver. More... | |
Media player driver.
+Manage player drivers that can play media content. The player must support various protocols (http, https, hls, file, etc.).
+NuguPlayerDriver* nugu_player_driver_new | +( | +const char * | +name, | +
+ | + | struct nugu_player_driver_ops * | +ops | +
+ | ) | ++ |
Create new player driver object.
+[in] | name | driver name |
[in] | ops | operation table |
int nugu_player_driver_free | +( | +NuguPlayerDriver * | +driver | ) | ++ |
Destroy the player driver object.
+[in] | driver | player driver |
0 | success |
-1 | failure |
int nugu_player_driver_register | +( | +NuguPlayerDriver * | +driver | ) | ++ |
Register the driver to driver list.
+[in] | driver | player driver |
0 | success |
-1 | failure |
int nugu_player_driver_remove | +( | +NuguPlayerDriver * | +driver | ) | ++ |
Remove the driver from driver list.
+[in] | driver | player driver |
0 | success |
-1 | failure |
int nugu_player_driver_set_default | +( | +NuguPlayerDriver * | +driver | ) | ++ |
Set the default player driver.
+[in] | driver | player driver |
0 | success |
-1 | failure |
NuguPlayerDriver* nugu_player_driver_get_default | +( | +void | +) | ++ |
Get the default player driver.
+NuguPlayerDriver* nugu_player_driver_find | +( | +const char * | +name | ) | ++ |
Find a driver by name in the driver list.
+[in] | name | player driver name |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Plugin management. +More...
++Classes | |
struct | nugu_plugin_desc |
Plugin description. More... | |
+Macros | |
#define | NUGU_PLUGIN_DEFINE(p_name, p_prio, p_ver, p_load, p_unload, p_init) |
Macros to easily define plugins. More... | |
+#define | NUGU_PLUGIN_PRIORITY_DEFAULT 100 |
A value representing default priority. | |
+#define | NUGU_PLUGIN_PRIORITY_HIGH 10 |
A value representing high priority. | |
+#define | NUGU_PLUGIN_PRIORITY_LOW 900 |
A value representing low priority. | |
+#define | NUGU_PLUGIN_SYMBOL "nugu_plugin_define_desc" |
Default symbol name for dlsym() | |
+Typedefs | |
+typedef struct _plugin | NuguPlugin |
Plugin object. | |
+Functions | |
int | nugu_plugin_add (NuguPlugin *p) |
Add the plugin to managed list. More... | |
+void | nugu_plugin_deinitialize (void) |
De-initialize plugin. | |
NuguPlugin * | nugu_plugin_find (const char *name) |
Find a plugin by name in the managed list. More... | |
void | nugu_plugin_free (NuguPlugin *p) |
Destroy the plugin. More... | |
void * | nugu_plugin_get_data (NuguPlugin *p) |
Get private data from plugin. More... | |
const struct nugu_plugin_desc * | nugu_plugin_get_description (NuguPlugin *p) |
Get the plugin description. More... | |
void * | nugu_plugin_get_symbol (NuguPlugin *p, const char *symbol_name) |
Get dlsym result from plugin. More... | |
int | nugu_plugin_initialize (void) |
Initialize plugin. More... | |
int | nugu_plugin_load_builtin (void) |
Load all built-in plugins. More... | |
int | nugu_plugin_load_directory (const char *dirpath) |
Load all plugin files from directory. More... | |
NuguPlugin * | nugu_plugin_new (struct nugu_plugin_desc *desc) |
Create new plugin object. More... | |
NuguPlugin * | nugu_plugin_new_from_file (const char *filepath) |
Create new plugin object from file. More... | |
int | nugu_plugin_remove (NuguPlugin *p) |
Remove the plugin to managed list. More... | |
int | nugu_plugin_set_data (NuguPlugin *p, void *data) |
Set private data to plugin. More... | |
Plugin management.
+The plugin is a feature provided to extend the functionality of sdk. The plugin must have a shared library type that contains the 'nugu_plugin_define_desc' symbol. And there should be no 'lib' prefix in file name.
+#define NUGU_PLUGIN_DEFINE | +( | ++ | p_name, | +
+ | + | + | p_prio, | +
+ | + | + | p_ver, | +
+ | + | + | p_load, | +
+ | + | + | p_unload, | +
+ | + | + | p_init | +
+ | ) | ++ |
Macros to easily define plugins.
+ +NuguPlugin* nugu_plugin_new | +( | +struct nugu_plugin_desc * | +desc | ) | ++ |
Create new plugin object.
+[in] | desc | plugin description |
NuguPlugin* nugu_plugin_new_from_file | +( | +const char * | +filepath | ) | ++ |
Create new plugin object from file.
+[in] | filepath | plugin file path |
void nugu_plugin_free | +( | +NuguPlugin * | +p | ) | ++ |
Destroy the plugin.
+[in] | p | plugin object |
int nugu_plugin_add | +( | +NuguPlugin * | +p | ) | ++ |
Add the plugin to managed list.
+[in] | p | plugin object |
0 | success |
1 | success (plugin is already registered) |
-1 | failure (another plugin using the same file is already registered) |
int nugu_plugin_remove | +( | +NuguPlugin * | +p | ) | ++ |
Remove the plugin to managed list.
+[in] | p | plugin object |
0 | success |
-1 | failure |
NuguPlugin* nugu_plugin_find | +( | +const char * | +name | ) | ++ |
Find a plugin by name in the managed list.
+[in] | name | name of plugin |
int nugu_plugin_set_data | +( | +NuguPlugin * | +p, | +
+ | + | void * | +data | +
+ | ) | ++ |
Set private data to plugin.
+[in] | p | plugin object |
[in] | data | plugin specific data |
0 | success |
-1 | failure |
void* nugu_plugin_get_data | +( | +NuguPlugin * | +p | ) | ++ |
Get private data from plugin.
+[in] | p | plugin object |
void* nugu_plugin_get_symbol | +( | +NuguPlugin * | +p, | +
+ | + | const char * | +symbol_name | +
+ | ) | ++ |
Get dlsym result from plugin.
+[in] | p | plugin object |
[in] | symbol_name | symbol name to find |
const struct nugu_plugin_desc* nugu_plugin_get_description | +( | +NuguPlugin * | +p | ) | ++ |
Get the plugin description.
+[in] | p | plugin object |
int nugu_plugin_load_directory | +( | +const char * | +dirpath | ) | ++ |
Load all plugin files from directory.
+[in] | dirpath | directory path |
-1 | failure |
int nugu_plugin_load_builtin | +( | +void | +) | ++ |
Load all built-in plugins.
+-1 | failure |
int nugu_plugin_initialize | +( | +void | +) | ++ |
Initialize plugin.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Voice recorder functions. +More...
++Typedefs | |
+typedef struct _nugu_recorder | NuguRecorder |
recorder object | |
+Functions | |
int | nugu_recorder_add (NuguRecorder *rec) |
Add recorder object to managed list. More... | |
int | nugu_recorder_clear (NuguRecorder *rec) |
Clear recording data. More... | |
NuguRecorder * | nugu_recorder_find (const char *name) |
Find a recorder object by name in the managed list. More... | |
void | nugu_recorder_free (NuguRecorder *rec) |
Destroy the recorder object. More... | |
void * | nugu_recorder_get_driver_data (NuguRecorder *rec) |
Get custom data for driver. More... | |
int | nugu_recorder_get_frame (NuguRecorder *rec, char *data, int *size) |
Get recorded data. More... | |
int | nugu_recorder_get_frame_count (NuguRecorder *rec) |
Get frame count. More... | |
int | nugu_recorder_get_frame_size (NuguRecorder *rec, int *size, int *max) |
Get frame size. More... | |
int | nugu_recorder_get_frame_timeout (NuguRecorder *rec, char *data, int *size, int timeout) |
Get recorded data with timeout. More... | |
int | nugu_recorder_is_recording (NuguRecorder *rec) |
Get the status of recording. More... | |
NuguRecorder * | nugu_recorder_new (const char *name, NuguRecorderDriver *driver) |
Create new recorder object. More... | |
int | nugu_recorder_push_frame (NuguRecorder *rec, const char *data, int size) |
Push recorded data. More... | |
int | nugu_recorder_remove (NuguRecorder *rec) |
Remove recorder object from managed list. More... | |
int | nugu_recorder_set_driver_data (NuguRecorder *rec, void *data) |
Set custom data for driver. More... | |
int | nugu_recorder_set_frame_size (NuguRecorder *rec, int size, int max) |
Set frame size. More... | |
int | nugu_recorder_set_property (NuguRecorder *rec, NuguAudioProperty property) |
Set property to recorder object. More... | |
int | nugu_recorder_start (NuguRecorder *rec) |
Start recording. More... | |
int | nugu_recorder_stop (NuguRecorder *rec) |
Stop recording. More... | |
Voice recorder functions.
+The recorder manages the recorded audio data by pushing it to the ringbuffer.
+NuguRecorder* nugu_recorder_new | +( | +const char * | +name, | +
+ | + | NuguRecorderDriver * | +driver | +
+ | ) | ++ |
Create new recorder object.
+[in] | name | recorder name |
[in] | driver | recorder driver object |
void nugu_recorder_free | +( | +NuguRecorder * | +rec | ) | ++ |
Destroy the recorder object.
+[in] | rec | recorder object |
int nugu_recorder_add | +( | +NuguRecorder * | +rec | ) | ++ |
Add recorder object to managed list.
+[in] | rec | recorder object |
0 | success |
-1 | failure |
int nugu_recorder_remove | +( | +NuguRecorder * | +rec | ) | ++ |
Remove recorder object from managed list.
+[in] | rec | recorder object |
0 | success |
-1 | failure |
NuguRecorder* nugu_recorder_find | +( | +const char * | +name | ) | ++ |
Find a recorder object by name in the managed list.
+[in] | name | name of recorder object |
int nugu_recorder_set_property | +( | +NuguRecorder * | +rec, | +
+ | + | NuguAudioProperty | +property | +
+ | ) | ++ |
Set property to recorder object.
+[in] | rec | recorder object |
[in] | property | property |
0 | success |
-1 | failure |
int nugu_recorder_start | +( | +NuguRecorder * | +rec | ) | ++ |
Start recording.
+[in] | rec | recorder object |
0 | success |
-1 | failure |
int nugu_recorder_stop | +( | +NuguRecorder * | +rec | ) | ++ |
Stop recording.
+[in] | rec | recorder object |
0 | success |
-1 | failure |
int nugu_recorder_clear | +( | +NuguRecorder * | +rec | ) | ++ |
Clear recording data.
+[in] | rec | recorder object |
0 | success |
-1 | failure |
int nugu_recorder_is_recording | +( | +NuguRecorder * | +rec | ) | ++ |
Get the status of recording.
+[in] | rec | recorder object |
0 | idle |
1 | recording |
-1 | failure |
int nugu_recorder_set_driver_data | +( | +NuguRecorder * | +rec, | +
+ | + | void * | +data | +
+ | ) | ++ |
Set custom data for driver.
+[in] | rec | recorder object |
[in] | data | custom data managed by driver |
0 | success |
-1 | failure |
void* nugu_recorder_get_driver_data | +( | +NuguRecorder * | +rec | ) | ++ |
Get custom data for driver.
+[in] | rec | recorder object |
int nugu_recorder_get_frame_size | +( | +NuguRecorder * | +rec, | +
+ | + | int * | +size, | +
+ | + | int * | +max | +
+ | ) | ++ |
Get frame size.
+[in] | rec | recorder object |
[out] | size | frame size |
[out] | max | max count |
0 | success |
-1 | failure |
int nugu_recorder_set_frame_size | +( | +NuguRecorder * | +rec, | +
+ | + | int | +size, | +
+ | + | int | +max | +
+ | ) | ++ |
Set frame size.
+[in] | rec | recorder object |
[in] | size | frame size |
[in] | max | max count |
0 | success |
-1 | failure |
int nugu_recorder_push_frame | +( | +NuguRecorder * | +rec, | +
+ | + | const char * | +data, | +
+ | + | int | +size | +
+ | ) | ++ |
Push recorded data.
+[in] | rec | recorder object |
[in] | data | recorded data |
[in] | size | size of recorded data |
0 | success |
-1 | failure |
int nugu_recorder_get_frame | +( | +NuguRecorder * | +rec, | +
+ | + | char * | +data, | +
+ | + | int * | +size | +
+ | ) | ++ |
Get recorded data.
+[in] | rec | recorder object |
[out] | data | data |
[out] | size | size of data |
0 | success |
-1 | failure |
int nugu_recorder_get_frame_timeout | +( | +NuguRecorder * | +rec, | +
+ | + | char * | +data, | +
+ | + | int * | +size, | +
+ | + | int | +timeout | +
+ | ) | ++ |
Get recorded data with timeout.
+[in] | rec | recorder object |
[out] | data | data |
[out] | size | size of data |
[in] | timeout | timeout milliseconds |
0 | success |
-1 | failure |
int nugu_recorder_get_frame_count | +( | +NuguRecorder * | +rec | ) | ++ |
Get frame count.
+[in] | rec | recorder object |
>0 | success (frame count) |
-1 | failure |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Audio recorder driver. +More...
++Classes | |
struct | nugu_recorder_driver_ops |
+Typedefs | |
+typedef struct _nugu_recorder_driver | NuguRecorderDriver |
recorder driver object | |
+Functions | |
NuguRecorderDriver * | nugu_recorder_driver_find (const char *name) |
Find a driver by name in the driver list. More... | |
int | nugu_recorder_driver_free (NuguRecorderDriver *driver) |
Destroy the recorder driver object. More... | |
NuguRecorderDriver * | nugu_recorder_driver_get_default (void) |
Get the default recorder driver. More... | |
NuguRecorderDriver * | nugu_recorder_driver_new (const char *name, struct nugu_recorder_driver_ops *ops) |
Create new recorder driver object. More... | |
int | nugu_recorder_driver_register (NuguRecorderDriver *driver) |
Register the driver to driver list. More... | |
int | nugu_recorder_driver_remove (NuguRecorderDriver *driver) |
Remove the driver from driver list. More... | |
int | nugu_recorder_driver_set_default (NuguRecorderDriver *driver) |
Set the default recorder driver. More... | |
Audio recorder driver.
+The recorder driver must support the ability to record in multiples according to the Audio property (frame, samplerate, channel).
+NuguRecorderDriver* nugu_recorder_driver_new | +( | +const char * | +name, | +
+ | + | struct nugu_recorder_driver_ops * | +ops | +
+ | ) | ++ |
Create new recorder driver object.
+[in] | name | driver name |
[in] | ops | operation table |
int nugu_recorder_driver_free | +( | +NuguRecorderDriver * | +driver | ) | ++ |
Destroy the recorder driver object.
+[in] | driver | recorder driver |
0 | success |
-1 | failure |
int nugu_recorder_driver_register | +( | +NuguRecorderDriver * | +driver | ) | ++ |
Register the driver to driver list.
+[in] | driver | recorder driver |
0 | success |
-1 | failure |
int nugu_recorder_driver_remove | +( | +NuguRecorderDriver * | +driver | ) | ++ |
Remove the driver from driver list.
+[in] | driver | recorder driver |
0 | success |
-1 | failure |
int nugu_recorder_driver_set_default | +( | +NuguRecorderDriver * | +driver | ) | ++ |
Set the default recorder driver.
+[in] | driver | recorder driver |
0 | success |
-1 | failure |
NuguRecorderDriver* nugu_recorder_driver_get_default | +( | +void | +) | ++ |
Get the default recorder driver.
+NuguRecorderDriver* nugu_recorder_driver_find | +( | +const char * | +name | ) | ++ |
Find a driver by name in the driver list.
+[in] | name | recorder driver name |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
RingBuffer manipulation functions. +More...
++Typedefs | |
+typedef struct _nugu_ring_buffer | NuguRingBuffer |
RingBuffer object. | |
+Functions | |
void | nugu_ring_buffer_clear_items (NuguRingBuffer *buf) |
Clear the ringbuffer. More... | |
void | nugu_ring_buffer_free (NuguRingBuffer *buf) |
Destroy the ringbuffer object. More... | |
int | nugu_ring_buffer_get_count (NuguRingBuffer *buf) |
Get count. More... | |
int | nugu_ring_buffer_get_item_size (NuguRingBuffer *buf) |
Get itemsize. More... | |
int | nugu_ring_buffer_get_maxcount (NuguRingBuffer *buf) |
Get maxcount. More... | |
NuguRingBuffer * | nugu_ring_buffer_new (int item_size, int max_items) |
Create new ringbuffer object. More... | |
int | nugu_ring_buffer_push_data (NuguRingBuffer *buf, const char *data, int size) |
Push data to ringbuffer. More... | |
int | nugu_ring_buffer_read_item (NuguRingBuffer *buf, char *item, int *size) |
Read item from ringbuffer. More... | |
int | nugu_ring_buffer_resize (NuguRingBuffer *buf, int item_size, int max_items) |
Resize the ringbuffer. More... | |
RingBuffer manipulation functions.
+The ring buffer manages items by setting the size and number of items as a basic unit.
+NuguRingBuffer* nugu_ring_buffer_new | +( | +int | +item_size, | +
+ | + | int | +max_items | +
+ | ) | ++ |
Create new ringbuffer object.
+[in] | item_size | default item size |
[in] | max_items | count of items |
void nugu_ring_buffer_free | +( | +NuguRingBuffer * | +buf | ) | ++ |
Destroy the ringbuffer object.
+[in] | buf | ringbuffer object |
int nugu_ring_buffer_resize | +( | +NuguRingBuffer * | +buf, | +
+ | + | int | +item_size, | +
+ | + | int | +max_items | +
+ | ) | ++ |
Resize the ringbuffer.
+[in] | buf | ringbuffer object |
[in] | item_size | default item size |
[in] | max_items | count of items |
0 | success |
-1 | failure |
int nugu_ring_buffer_push_data | +( | +NuguRingBuffer * | +buf, | +
+ | + | const char * | +data, | +
+ | + | int | +size | +
+ | ) | ++ |
Push data to ringbuffer.
+[in] | buf | ringbuffer object |
[in] | data | data |
[in] | size | size of data |
0 | success |
-1 | failure |
int nugu_ring_buffer_read_item | +( | +NuguRingBuffer * | +buf, | +
+ | + | char * | +item, | +
+ | + | int * | +size | +
+ | ) | ++ |
Read item from ringbuffer.
+[in] | buf | ringbuffer object |
[out] | item | item |
[out] | size | size of item |
0 | success |
-1 | failure |
int nugu_ring_buffer_get_count | +( | +NuguRingBuffer * | +buf | ) | ++ |
Get count.
+[in] | buf | ringbuffer object |
>0 | success (count) |
-1 | failure |
int nugu_ring_buffer_get_item_size | +( | +NuguRingBuffer * | +buf | ) | ++ |
Get itemsize.
+[in] | buf | ringbuffer object |
>0 | success (itemsize) |
-1 | failure |
int nugu_ring_buffer_get_maxcount | +( | +NuguRingBuffer * | +buf | ) | ++ |
Get maxcount.
+[in] | buf | ringbuffer object |
>0 | success (max count) |
-1 | failure |
void nugu_ring_buffer_clear_items | +( | +NuguRingBuffer * | +buf | ) | ++ |
Clear the ringbuffer.
+[in] | buf | ringbuffer object |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Nugu Runner. +More...
++Classes | |
class | NuguClientKit::NuguRunner |
NuguRunner. More... | |
+Typedefs | |
+typedef std::function< void()> | NuguClientKit::NuguRunner::request_method |
The request method callback. | |
+Enumerations | |
enum class | NuguClientKit::ExecuteType { Auto +, Queued +, Blocking + } |
ExecuteType. More... | |
+Functions | |
bool | NuguClientKit::NuguRunner::invokeMethod (const std::string &tag, request_method method, ExecuteType type=ExecuteType::Auto, int timeout=0) |
Request to execute method on nugu loop. More... | |
Nugu Runner.
+NuguRunner is a class that provides thread safety feature for using glib. The nugu loop is based on GMainLoop provided by glib.
+
+
|
+ +strong | +
bool NuguClientKit::NuguRunner::invokeMethod | +( | +const std::string & | +tag, | +
+ | + | request_method | +method, | +
+ | + | ExecuteType | +type = ExecuteType::Auto , |
+
+ | + | int | +timeout = 0 |
+
+ | ) | ++ |
Request to execute method on nugu loop.
+[in] | tag | tag name for debug output |
[in] | method | request method |
[in] | type | execute method type |
[in] | timeout | The invoked method is released blocking state when timeout. (unit: sec) |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Timer manipulation functions. +More...
++Typedefs | |
+typedef void(* | NuguTimeoutCallback) (void *userdata) |
Callback prototype for timeout. | |
+typedef struct _nugu_timer | NuguTimer |
Timer object. | |
+Functions | |
void | nugu_timer_delete (NuguTimer *timer) |
Destroy the timer object. More... | |
long | nugu_timer_get_interval (NuguTimer *timer) |
Get interval. More... | |
int | nugu_timer_get_singleshot (NuguTimer *timer) |
Get timer single shot property. More... | |
NuguTimer * | nugu_timer_new (long interval) |
Create new timer object. More... | |
void | nugu_timer_set_callback (NuguTimer *timer, NuguTimeoutCallback callback, void *userdata) |
Set timeout callback. More... | |
void | nugu_timer_set_interval (NuguTimer *timer, long interval) |
Set interval. More... | |
void | nugu_timer_set_singleshot (NuguTimer *timer, int singleshot) |
Set timer running single shot. More... | |
void | nugu_timer_start (NuguTimer *timer) |
Start the timer. More... | |
void | nugu_timer_stop (NuguTimer *timer) |
Stop the timer. More... | |
Timer manipulation functions.
+Timer manipulation functions
+NuguTimer* nugu_timer_new | +( | +long | +interval | ) | ++ |
Create new timer object.
+[in] | interval | interval seconds |
void nugu_timer_delete | +( | +NuguTimer * | +timer | ) | ++ |
Destroy the timer object.
+[in] | timer | timer object |
void nugu_timer_set_interval | +( | +NuguTimer * | +timer, | +
+ | + | long | +interval | +
+ | ) | ++ |
Set interval.
+[in] | timer | timer object |
[in] | interval | interval seconds |
long nugu_timer_get_interval | +( | +NuguTimer * | +timer | ) | ++ |
Get interval.
+[in] | timer | timer object |
void nugu_timer_set_singleshot | +( | +NuguTimer * | +timer, | +
+ | + | int | +singleshot | +
+ | ) | ++ |
Set timer running single shot.
+[in] | timer | timer object |
[in] | singleshot | By setting the singleshot to 1, you can trigger the timer only once. The default value of singleshot is 0, and the timer runs repeatedly. |
int nugu_timer_get_singleshot | +( | +NuguTimer * | +timer | ) | ++ |
Get timer single shot property.
+[in] | timer | timer object |
void nugu_timer_start | +( | +NuguTimer * | +timer | ) | ++ |
void nugu_timer_stop | +( | +NuguTimer * | +timer | ) | ++ |
void nugu_timer_set_callback | +( | +NuguTimer * | +timer, | +
+ | + | NuguTimeoutCallback | +callback, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set timeout callback.
+[in] | timer | timer object |
[in] | callback | callback function |
[in] | userdata | data to pass to the user callback |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
NUGU Timer Interface. +More...
++Classes | |
class | NuguClientKit::INuguTimer |
nugu timer interface More... | |
+Macros | |
+#define | NUGU_TIMER_UNIT_SEC 1000 |
time unit value(second) | |
NUGU Timer Interface.
+Timer provide by NUGU SDK
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
PhoneCall capability interface. +More...
++Classes | |
class | NuguCapability::IPhoneCallHandler |
phone call handler interface More... | |
class | NuguCapability::IPhoneCallListener |
phone call listener interface More... | |
+Enumerations | |
enum class | NuguCapability::PhoneCallState { IDLE +, OUTGOING +, INCOMING +, ESTABLISHED + } |
Phone call state. More... | |
PhoneCall capability interface.
+Dial, hangup and answer the phone call
+
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
PlaySyncManager Interface. +More...
++Classes | |
class | NuguClientKit::IPlaySyncManager |
IPlaySyncManager interface. More... | |
class | NuguClientKit::IPlaySyncManagerListener |
IPlaySyncManagerListener interface. More... | |
+Enumerations | |
enum class | NuguClientKit::PlayStackActivity { + None +, Alert +, Call +, TTS +, + Media + + } |
PlayStack Activity Type. More... | |
enum class | NuguClientKit::PlaySyncState { + None +, Prepared +, Synced +, Released +, + Appending + + } |
PlaySync State. More... | |
PlaySyncManager Interface.
+Interface of PlaySyncManager which manage context and sync flow between related capability agents.
+
+
|
+ +strong | +
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Profiling functions. +More...
++Classes | |
struct | nugu_prof_data |
Profiling raw data. More... | |
+Typedefs | |
typedef void(* | NuguProfCallback) (enum nugu_prof_type type, const struct nugu_prof_data *data, void *userdata) |
Callback prototype for receiving an attachment. More... | |
+Functions | |
+void | nugu_prof_clear (void) |
clear all cached profiling data | |
+void | nugu_prof_disable_tracelog (void) |
turn off the profiling trace log message | |
void | nugu_prof_dump (enum nugu_prof_type from, enum nugu_prof_type to) |
Dump the profiling data between 'from' type to 'to' type. More... | |
+void | nugu_prof_enable_tracelog (void) |
turn on the profiling trace log message | |
int | nugu_prof_get_diff_msec (const struct nugu_prof_data *prof1, const struct nugu_prof_data *prof2) |
Get the time difference(prof2 - prof1) value in milliseconds. More... | |
int | nugu_prof_get_diff_msec_timespec (const struct timespec *ts1, const struct timespec *ts2) |
Get the time difference(ts2 - ts1) value in milliseconds. More... | |
int | nugu_prof_get_diff_msec_type (enum nugu_prof_type type1, enum nugu_prof_type type2) |
Get the time difference(ts2 - ts1) value in milliseconds. More... | |
struct nugu_prof_data * | nugu_prof_get_last_data (enum nugu_prof_type type) |
Get last cached data by profiling type. More... | |
const char * | nugu_prof_get_type_name (enum nugu_prof_type type) |
Get string type name for profiling type. More... | |
int | nugu_prof_mark (enum nugu_prof_type type) |
Marking to profiling data and emit the callback. More... | |
int | nugu_prof_mark_data (enum nugu_prof_type type, const char *dialog_id, const char *msg_id, const char *contents) |
Marking to profiling data with additional id and emit the callback. More... | |
void | nugu_prof_set_callback (NuguProfCallback callback, void *userdata) |
Set profiling callback. More... | |
Profiling functions.
+The profiling module provides notification and performance measurement for each condition.
+typedef void(* NuguProfCallback) (enum nugu_prof_type type, const struct nugu_prof_data *data, void *userdata) | +
Callback prototype for receiving an attachment.
+enum nugu_prof_type | +
Profiling type list.
+void nugu_prof_set_callback | +( | +NuguProfCallback | +callback, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set profiling callback.
+[in] | callback | callback function |
[in] | userdata | data to pass to the user callback |
int nugu_prof_mark | +( | +enum nugu_prof_type | +type | ) | ++ |
Marking to profiling data and emit the callback.
+[in] | type | profiling type |
0 | success |
-1 | failure |
int nugu_prof_mark_data | +( | +enum nugu_prof_type | +type, | +
+ | + | const char * | +dialog_id, | +
+ | + | const char * | +msg_id, | +
+ | + | const char * | +contents | +
+ | ) | ++ |
Marking to profiling data with additional id and emit the callback.
+[in] | type | profiling type |
[in] | dialog_id | dialog request id |
[in] | msg_id | message id |
[in] | contents | additional contents |
0 | success |
-1 | failure |
struct nugu_prof_data* nugu_prof_get_last_data | +( | +enum nugu_prof_type | +type | ) | ++ |
Get last cached data by profiling type.
+[in] | type | profiling type |
int nugu_prof_get_diff_msec_timespec | +( | +const struct timespec * | +ts1, | +
+ | + | const struct timespec * | +ts2 | +
+ | ) | ++ |
Get the time difference(ts2 - ts1) value in milliseconds.
+[in] | ts1 | time value |
[in] | ts2 | time value |
int nugu_prof_get_diff_msec_type | +( | +enum nugu_prof_type | +type1, | +
+ | + | enum nugu_prof_type | +type2 | +
+ | ) | ++ |
Get the time difference(ts2 - ts1) value in milliseconds.
+[in] | type1 | profiling type |
[in] | type2 | profiling type |
int nugu_prof_get_diff_msec | +( | +const struct nugu_prof_data * | +prof1, | +
+ | + | const struct nugu_prof_data * | +prof2 | +
+ | ) | ++ |
Get the time difference(prof2 - prof1) value in milliseconds.
+[in] | prof1 | time value |
[in] | prof2 | time value |
const char* nugu_prof_get_type_name | +( | +enum nugu_prof_type | +type | ) | ++ |
Get string type name for profiling type.
+[in] | type | profiling type |
void nugu_prof_dump | +( | +enum nugu_prof_type | +from, | +
+ | + | enum nugu_prof_type | +to | +
+ | ) | ++ |
Dump the profiling data between 'from' type to 'to' type.
+[in] | from | start type to dump |
[in] | to | end type to dump |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Routine capability interface. +More...
++Classes | |
class | NuguCapability::IRoutineHandler |
routine handler interface More... | |
class | NuguCapability::IRoutineListener |
routine listener interface More... | |
Routine capability interface.
+It's for controlling the execution of actions which are belong to routine.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
RoutineManager Interface. +More...
++Classes | |
class | NuguClientKit::IRoutineManager |
IRoutineManager interface. More... | |
class | NuguClientKit::IRoutineManagerListener |
IRoutineManagerListener interface. More... | |
+Enumerations | |
enum class | NuguClientKit::RoutineActivity { + IDLE +, PLAYING +, INTERRUPTED +, FINISHED +, + STOPPED +, SUSPENDED + + } |
Routine Activity list. More... | |
RoutineManager Interface.
+Interface of RoutineManager for control routine play.
+
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+Modules | |
Buffer | |
Buffer manipulation functions. | |
Decoder | |
Decoder functions. | |
NUGU Directive | |
The message object received from the server. | |
Encoder | |
Encoder functions. | |
Event Queue | |
Event queue for passing events between threads. | |
NUGU Event | |
The message object sent to the server. | |
NuguHttp | |
HTTP request management. | |
Log | |
Log functions. | |
Media | |
media management | |
NetworkManager | |
Network management. | |
PCM manipulation | |
PCM manipulation functions. | |
Media player | |
Media player functions. | |
Plugin | |
Plugin management. | |
Profiling | |
Profiling functions. | |
Voice recorder | |
Voice recorder functions. | |
RingBuffer | |
RingBuffer manipulation functions. | |
Timer | |
Timer manipulation functions. | |
UUID | |
UUID generation functions. | |
@breif Base infrastructure API
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+Modules | |
Decoder driver | |
Decoder driver. | |
Encoder driver | |
Encoder driver. | |
PCM driver | |
PCM driver. | |
Media player driver | |
Media player driver. | |
Audio recorder driver | |
Audio recorder driver. | |
@breif Driver API for HAL(hardware abstraction layer) Support.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+Modules | |
ASRInterface | |
ASR capability interface. | |
AudioPlayerInterface | |
AudioPlayer capability interface. | |
BatteryInterface | |
Battery capability interface. | |
BluetoothInterface | |
Bluetooth capability interface. | |
CapabilityFactory | |
CapabilityFactory. | |
ChipsInterface | |
Chips capability interface. | |
DisplayInterface | |
Display capability interface. | |
ExtensionInterface | |
Extension capability interface. | |
LocationInterface | |
Location capability interface. | |
MessageInterface | |
Message capability interface. | |
MicInterface | |
MIC capability interface. | |
NudgeInterface | |
Nudge capability interface. | |
PhoneCallInterface | |
PhoneCall capability interface. | |
RoutineInterface | |
Routine capability interface. | |
SessionInterface | |
Session capability interface. | |
SoundInterface | |
Sound capability interface. | |
SpeakerInterface | |
Speaker capability interface. | |
SystemInterface | |
System capability interface. | |
TextInterface | |
Text capability interface. | |
TTSInterface | |
TTS capability interface. | |
UtilityInterface | |
Utility capability interface. | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+Modules | |
Capability | |
base capability class | |
CapabilityHelperInterface | |
CapabilityHelper Interface. | |
CapabilityInterface | |
capability interface | |
DialogUXStateAggregatorInterface | |
DialogUXStateAggregator Interface. | |
DirectiveSequencerInterface | |
Directive Sequencer Interface. | |
FocusManagerInterface | |
Focus Manager Interface. | |
InteractionControlManagerInterface | |
InteractionControlManager Interface. | |
MediaPlayerInterface | |
Media Player Interface. | |
NetworkManagerInterface | |
Network Manager interface. | |
NuguAuth | |
Authentication management. | |
NuguClient | |
Nugu Client. | |
NuguCoreContainerInterface | |
NuguCoreContainer Interface. | |
NuguHttpRest | |
HTTP REST request management. | |
NuguRunner | |
Nugu Runner. | |
NuguTimerInterface | |
NUGU Timer Interface. | |
PlaySyncManagerInterface | |
PlaySyncManager Interface. | |
RoutineManagerInterface | |
RoutineManager Interface. | |
SessionManagerInterface | |
SessionManager Interface. | |
SpeechRecognizerAggregatorInterface | |
SpeechRecognizerAggregator Interface. | |
SpeechRecognizerInterface | |
Speech Recognizer Interface. | |
WakeupInterface | |
Wakeup interface. | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Session capability interface. +More...
++Classes | |
class | NuguCapability::ISessionHandler |
session handler interface More... | |
class | NuguCapability::ISessionListener |
session listener interface More... | |
+Enumerations | |
enum class | NuguCapability::SessionState { ACTIVE +, INACTIVE + } |
Session State list. More... | |
Session capability interface.
+It's for managing session info between play and client.
+
+
|
+ +strong | +
Session State list.
+Enumerator | |
---|---|
ACTIVE | Session is activated + |
INACTIVE | Session is deactivated + |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
SessionManager Interface. +More...
++Classes | |
struct | NuguClientKit::_Session |
Model for containing session info. More... | |
class | NuguClientKit::ISessionManager |
SessionManager interface. More... | |
class | NuguClientKit::ISessionManagerListener |
ISessionManagerListener interface. More... | |
+Typedefs | |
typedef struct NuguClientKit::_Session | NuguClientKit::Session |
Model for containing session info. More... | |
SessionManager Interface.
+Interface of SessionManager which manages session info.
+typedef struct NuguClientKit::_Session NuguClientKit::Session | +
Model for containing session info.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Sound capability interface. +More...
++Classes | |
class | NuguCapability::ISoundHandler |
sound handler interface More... | |
class | NuguCapability::ISoundListener |
sound listener interface More... | |
+Enumerations | |
enum class | NuguCapability::BeepType { RESPONSE_FAIL + } |
Beep type list. More... | |
Sound capability interface.
+It's for handling request of play service which to play the specific audio resource file.
+
+
|
+ +strong | +
Beep type list.
+Enumerator | |
---|---|
RESPONSE_FAIL | the case which fallback play send to client + |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Speaker capability interface. +More...
++Classes | |
class | NuguCapability::ISpeakerHandler |
speaker handler interface More... | |
class | NuguCapability::ISpeakerListener |
speaker listener interface More... | |
class | NuguCapability::SpeakerInfo |
SpeakerInfo. More... | |
+Enumerations | |
enum class | NuguCapability::SpeakerType { + NUGU = 0 +, MUSIC = NUGU_AUDIO_ATTRIBUTE_MUSIC +, RINGTONE = NUGU_AUDIO_ATTRIBUTE_RINGTONE +, CALL = NUGU_AUDIO_ATTRIBUTE_CALL +, + NOTIFICATION = NUGU_AUDIO_ATTRIBUTE_NOTIFICATION +, ALARM = NUGU_AUDIO_ATTRIBUTE_ALARM +, VOICE_COMMAND = NUGU_AUDIO_ATTRIBUTE_VOICE_COMMAND +, NAVIGATION = NUGU_AUDIO_ATTRIBUTE_NAVIGATION +, + SYSTEM_SOUND = NUGU_AUDIO_ATTRIBUTE_SYSTEM_SOUND + + } |
SpeakerType. More... | |
Speaker capability interface.
+Control the volumes for nugu, call, alarm and external.
+
+
|
+ +strong | +
SpeakerType.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
SpeechRecognizerAggregator Interface. +More...
++Classes | |
struct | NuguClientKit::_RecognitionResult |
Model for holding recognition result. More... | |
class | NuguClientKit::ISpeechRecognizerAggregator |
SpeechRecognizerAggregator interface. More... | |
class | NuguClientKit::ISpeechRecognizerAggregatorListener |
SpeechRecognizerAggregator listener interface. More... | |
+Typedefs | |
typedef struct NuguClientKit::_RecognitionResult | NuguClientKit::RecognitionResult |
Model for holding recognition result. More... | |
+Enumerations | |
enum class | NuguClientKit::_RecognitionResult::Status { + NuguClientKit::_RecognitionResult::None +, NuguClientKit::_RecognitionResult::Partial +, NuguClientKit::_RecognitionResult::Complete +, NuguClientKit::_RecognitionResult::Cancel +, + NuguClientKit::_RecognitionResult::Error + + } |
Result status. More... | |
+Functions | |
virtual void | NuguClientKit::ISpeechRecognizerAggregator::addListener (ISpeechRecognizerAggregatorListener *listener)=0 |
Add the ISpeechRecognizerAggregatorListener object. More... | |
+virtual void | NuguClientKit::ISpeechRecognizerAggregator::finishListening ()=0 |
finish listening speech | |
virtual void | NuguClientKit::ISpeechRecognizerAggregatorListener::onASRState (ASRState state, const std::string &dialog_id, ASRInitiator initiator)=0 |
Notify to user the asr state changed. More... | |
virtual void | NuguClientKit::ISpeechRecognizerAggregatorListener::onResult (const RecognitionResult &result, const std::string &dialog_id)=0 |
Notify to user the recognition result. More... | |
virtual void | NuguClientKit::ISpeechRecognizerAggregatorListener::onWakeupState (WakeupDetectState state, float power_noise, float power_speech)=0 |
Notify to user the wakeup detection state changed. More... | |
virtual void | NuguClientKit::ISpeechRecognizerAggregator::removeListener (ISpeechRecognizerAggregatorListener *listener)=0 |
Remove the ISpeechRecognizerAggregatorListener object. More... | |
virtual void | NuguClientKit::ISpeechRecognizerAggregator::setWakeupHandler (const std::shared_ptr< IWakeupHandler > &wakeup_handler)=0 |
Set the IWakeupHandler object. More... | |
virtual bool | NuguClientKit::ISpeechRecognizerAggregator::setWakeupModel (const WakeupModelFile &model_file)=0 |
Set wakeup model file. More... | |
virtual void | NuguClientKit::ISpeechRecognizerAggregator::startListening (float power_noise=0, float power_speech=0, ASRInitiator initiator=ASRInitiator::TAP)=0 |
Start recognizing speech. More... | |
+virtual void | NuguClientKit::ISpeechRecognizerAggregator::startListeningWithTrigger ()=0 |
Start detecting wakeup and progress recognizing speech after wakeup detected. | |
virtual void | NuguClientKit::ISpeechRecognizerAggregator::stopListening (bool cancel=false)=0 |
Stop both recognizing speech and detecting wakeup. More... | |
SpeechRecognizerAggregator Interface.
+Interface of SpeechRecognizerAggregator for operating wakeup detection and speech recognition process conveniently.
+typedef struct NuguClientKit::_RecognitionResult NuguClientKit::RecognitionResult | +
Model for holding recognition result.
+ + +
+
|
+ +strong | +
+
|
+ +pure virtual | +
Notify to user the wakeup detection state changed.
+[in] | state | wakeup detection state |
[in] | power_noise | min power value |
[in] | power_speech | max power value |
+
|
+ +pure virtual | +
Notify to user the asr state changed.
+[in] | state | asr state |
[in] | dialog_id | dialog request id |
[in] | initiator | asr initiator |
+
|
+ +pure virtual | +
Notify to user the recognition result.
+[in] | result | recognition result |
[in] | dialog_id | dialog request id |
+
|
+ +pure virtual | +
Add the ISpeechRecognizerAggregatorListener object.
+[in] | listener | ISpeechRecognizerAggregatorListener object |
+
|
+ +pure virtual | +
Remove the ISpeechRecognizerAggregatorListener object.
+[in] | listener | ISpeechRecognizerAggregatorListener object |
+
|
+ +pure virtual | +
Set the IWakeupHandler object.
+[in] | wakeup_handler | IWakeupHandler object |
+
|
+ +pure virtual | +
Set wakeup model file.
+[in] | model_file | wakeup model file |
+
|
+ +pure virtual | +
Start recognizing speech.
+[in] | power_noise | min wakeup power value |
[in] | power_speech | max wakeup power value |
[in] | initiator | asr initiator |
+
|
+ +pure virtual | +
Stop both recognizing speech and detecting wakeup.
+[in] | cancel | if true, cancel the directives to be received for current dialog |
Status NuguClientKit::_RecognitionResult::status | +
result status
+ +std::string NuguClientKit::_RecognitionResult::recognized_text | +
partial or complete recognized text
+ +ASRError NuguClientKit::_RecognitionResult::error | +
ASR error
+ +bool NuguClientKit::_RecognitionResult::listen_timeout_fail_beep | +
flag whether to play fail beep or not when listen-timeout occurred
+ +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Speech Recognizer Interface. +More...
++Classes | |
struct | NuguClientKit::_EpdAttribute |
Attributes about epd. More... | |
class | NuguClientKit::ISpeechRecognizer |
SpeechRecognizer interface. More... | |
class | NuguClientKit::ISpeechRecognizerListener |
SpeechRecognizer listener interface. More... | |
+Typedefs | |
+typedef struct NuguClientKit::_EpdAttribute | NuguClientKit::EpdAttribute |
Attributes about epd. | |
+Enumerations | |
enum class | NuguClientKit::ListeningState { + READY +, LISTENING +, SPEECH_START +, SPEECH_END +, + TIMEOUT +, FAILED +, DONE + + } |
ListeningState. More... | |
Speech Recognizer Interface.
+Start/Stop Speech Recognition and receive current listening state
+
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
System capability interface. +More...
++Classes | |
class | NuguCapability::ISystemHandler |
system handler interface More... | |
class | NuguCapability::ISystemListener |
system listener interface More... | |
+Enumerations | |
enum class | NuguCapability::RevokeReason { REVOKED_DEVICE +, WITHDRAWN_USER + } |
RevokeReason. More... | |
enum class | NuguCapability::SystemException { + UNAUTHORIZED_REQUEST_EXCEPTION +, PLAY_ROUTER_PROCESSING_EXCEPTION +, ASR_RECOGNIZING_EXCEPTION +, TTS_SPEAKING_EXCEPTION +, + INTERNAL_SERVICE_EXCEPTION + + } |
SystemException. More... | |
System capability interface.
+It is responsible for system related functions of device such as network handoff processing and context sync.
+
+
|
+ +strong | +
SystemException.
+
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
TTS capability interface. +More...
++Classes | |
struct | NuguCapability::_TTSAttribute |
Attributes for setting TTS options. More... | |
class | NuguCapability::ITTSHandler |
tts handler interface More... | |
class | NuguCapability::ITTSListener |
tts listener interface More... | |
+Macros | |
+#define | NUGU_TTS_ENGINE "skt" /** @def Use skt tts engine */ |
+Typedefs | |
+typedef struct NuguCapability::_TTSAttribute | NuguCapability::TTSAttribute |
Attributes for setting TTS options. | |
+Enumerations | |
enum class | NuguCapability::TTSState { TTS_SPEECH_START +, TTS_SPEECH_STOP +, TTS_SPEECH_FINISH + } |
TTSState. More... | |
TTS capability interface.
+TTS(Text-To-Speech) plays a role in text to speech.
+
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Text capability interface. +More...
++Classes | |
struct | NuguCapability::_TextAttribute |
Attributes for setting Text options. More... | |
class | NuguCapability::ITextHandler |
text handler interface More... | |
class | NuguCapability::ITextListener |
text listener interface More... | |
+Macros | |
+#define | NUGU_SERVER_RESPONSE_TIMEOUT_SEC 10 /** @def Set server response timeout about 10s */ |
+Typedefs | |
+typedef struct NuguCapability::_TextAttribute | NuguCapability::TextAttribute |
Attributes for setting Text options. | |
+Enumerations | |
enum class | NuguCapability::TextError { RESPONSE_TIMEOUT + } |
TextError. More... | |
enum class | NuguCapability::TextState { IDLE +, BUSY + } |
TextState. More... | |
Text capability interface.
+It is possible to request NUGU service based on text rather than speech recognition.
+
+
|
+ +strong | +
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Utility capability interface. +More...
++Classes | |
class | NuguCapability::IUtilityHandler |
utility handler interface More... | |
class | NuguCapability::IUtilityListener |
utility listener interface More... | |
Utility capability interface.
+It's for blocking directive set which is located in the rear.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Wakeup interface. +More...
++Classes | |
struct | NuguClientKit::_WakeupModelFile |
Model for holding Wakeup model file info. More... | |
class | NuguClientKit::IWakeupHandler |
Wakeup handler interface. More... | |
class | NuguClientKit::IWakeupListener |
Wakeup listener interface. More... | |
+Typedefs | |
typedef struct NuguClientKit::_WakeupModelFile | NuguClientKit::WakeupModelFile |
Model for holding Wakeup model file info. More... | |
+Enumerations | |
enum class | NuguClientKit::WakeupDetectState { WAKEUP_IDLE +, WAKEUP_DETECTING +, WAKEUP_DETECTED +, WAKEUP_FAIL + } |
WakeupDetectState. More... | |
Wakeup interface.
+Start the wakeup engine and receive the status of wakeup.
+typedef struct NuguClientKit::_WakeupModelFile NuguClientKit::WakeupModelFile | +
Model for holding Wakeup model file info.
+
+
|
+ +strong | +
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
Network management. +More...
++Classes | |
struct | nugu_network_server_policy |
Server policy information used for network connections. More... | |
+Macros | |
+#define | NUGU_NETWORK_MAX_ADDRESS 255 |
maximum size of address | |
+Typedefs | |
typedef enum nugu_network_connection_type | NuguNetworkConnectionType |
network connection type More... | |
typedef enum nugu_network_handoff_status | NuguNetworkHandoffStatus |
network handoff status More... | |
typedef void(* | NuguNetworkManagerAttachmentCallback) (const char *parent_msg_id, int seq, int is_end, const char *media_type, size_t length, const void *data, void *userdata) |
Callback prototype for receiving directive attachment. More... | |
typedef void(* | NuguNetworkManagerDirectiveCallback) (NuguDirective *ndir, void *userdata) |
Callback prototype for receiving directive. More... | |
typedef void(* | NuguNetworkManagerEventDataSendNotifyCallback) (NuguEvent *nev, int is_end, size_t length, unsigned char *data, void *userdata) |
Callback prototype for notification of event data sending requests. More... | |
typedef void(* | NuguNetworkManagerEventResponseCallback) (int success, const char *event_msg_id, const char *event_dialog_id, const char *json, void *userdata) |
Callback prototype for directive response of event request. More... | |
typedef void(* | NuguNetworkManagerEventResultCallback) (int success, const char *msg_id, const char *dialog_id, int code, void *userdata) |
Callback prototype for result of event transfer request. More... | |
typedef void(* | NuguNetworkManagerEventSendNotifyCallback) (NuguEvent *nev, void *userdata) |
Callback prototype for notification of event sending requests. More... | |
+typedef void(* | NuguNetworkManagerHandoffStatusCallback) (NuguNetworkHandoffStatus status, void *userdata) |
Callback prototype for handoff status events. | |
typedef void(* | NuguNetworkManagerStatusCallback) (NuguNetworkStatus status, void *userdata) |
Callback prototype for receiving network status events. More... | |
typedef struct nugu_network_server_policy | NuguNetworkServerPolicy |
Server policy information used for network connections. More... | |
typedef enum nugu_network_status | NuguNetworkStatus |
network status More... | |
+Enumerations | |
enum | nugu_network_connection_type { NUGU_NETWORK_CONNECTION_ORIENTED +, NUGU_NETWORK_CONNECTION_ONDEMAND + } |
network connection type More... | |
enum | nugu_network_handoff_status { NUGU_NETWORK_HANDOFF_FAILED +, NUGU_NETWORK_HANDOFF_READY +, NUGU_NETWORK_HANDOFF_COMPLETED + } |
network handoff status More... | |
enum | nugu_network_protocol { NUGU_NETWORK_PROTOCOL_H2 +, NUGU_NETWORK_PROTOCOL_H2C +, NUGU_NETWORK_PROTOCOL_UNKNOWN + } |
network protocols More... | |
enum | nugu_network_status { + NUGU_NETWORK_DISCONNECTED +, NUGU_NETWORK_CONNECTING +, NUGU_NETWORK_READY +, NUGU_NETWORK_CONNECTED +, + NUGU_NETWORK_FAILED +, NUGU_NETWORK_TOKEN_ERROR + + } |
network status More... | |
+Functions | |
int | nugu_network_manager_connect (void) |
Connect to server. More... | |
+void | nugu_network_manager_deinitialize (void) |
De-initialize the network manager. | |
int | nugu_network_manager_disconnect (void) |
Disconnect from server. More... | |
int | nugu_network_manager_force_close_event (NuguEvent *nev) |
Force close the NUGU_EVENT_TYPE_WITH_ATTACHMENT type event. More... | |
NuguNetworkConnectionType | nugu_network_manager_get_connection_type (void) |
Get the connection type. More... | |
NuguNetworkStatus | nugu_network_manager_get_status (void) |
Get the current network status. More... | |
int | nugu_network_manager_handoff (const NuguNetworkServerPolicy *policy) |
Handoff the current connection to new server. More... | |
int | nugu_network_manager_initialize (void) |
Initialize the network manager. More... | |
const char * | nugu_network_manager_peek_last_asr_time (void) |
Get the last ASR event time information. More... | |
const char * | nugu_network_manager_peek_registry_url (void) |
Get the device gateway registry url. More... | |
const char * | nugu_network_manager_peek_token (void) |
Get the access token value. More... | |
const char * | nugu_network_manager_peek_useragent (void) |
Get the UserAgent information. More... | |
int | nugu_network_manager_reset_connection (void) |
Immediately disconnect the current connection and reconnect. More... | |
int | nugu_network_manager_send_event (NuguEvent *nev) |
Send the event to server. More... | |
int | nugu_network_manager_send_event_data (NuguEvent *nev, int is_end, size_t length, unsigned char *data) |
Send the attachment data of event to server. More... | |
int | nugu_network_manager_set_attachment_callback (NuguNetworkManagerAttachmentCallback callback, void *userdata) |
Set attachment of directive receive callback. More... | |
int | nugu_network_manager_set_connection_type (NuguNetworkConnectionType ctype) |
Set the connection type. More... | |
int | nugu_network_manager_set_directive_callback (NuguNetworkManagerDirectiveCallback callback, void *userdata) |
Set directive receive callback. More... | |
int | nugu_network_manager_set_event_data_send_notify_callback (NuguNetworkManagerEventDataSendNotifyCallback callback, void *userdata) |
Set event data send notify callback. More... | |
int | nugu_network_manager_set_event_response_callback (NuguNetworkManagerEventResponseCallback callback, void *userdata) |
Set event response callback. More... | |
int | nugu_network_manager_set_event_result_callback (NuguNetworkManagerEventResultCallback callback, void *userdata) |
Set event send result callback. More... | |
int | nugu_network_manager_set_event_send_notify_callback (NuguNetworkManagerEventSendNotifyCallback callback, void *userdata) |
Set event send notify callback. More... | |
int | nugu_network_manager_set_handoff_status_callback (NuguNetworkManagerHandoffStatusCallback callback, void *userdata) |
Set handoff status callback. More... | |
int | nugu_network_manager_set_registry_url (const char *urlname) |
Set the device gateway registry url. More... | |
int | nugu_network_manager_set_status (NuguNetworkStatus network_status) |
Set the current network status. More... | |
int | nugu_network_manager_set_status_callback (NuguNetworkManagerStatusCallback callback, void *userdata) |
Set network status callback. More... | |
int | nugu_network_manager_set_token (const char *token) |
Set the access token value. More... | |
int | nugu_network_manager_set_useragent (const char *app_version, const char *additional_info) |
Set the HTTP header UserAgent information. More... | |
Network management.
+The network manager is responsible for managing connections and sending and receiving events and directives with the server.
+typedef enum nugu_network_status NuguNetworkStatus | +
network status
+Basic connection status flow for connection-oriented
Basic connection status flow for connection-ondemand
Connection recovery flow for connection-oriented
typedef enum nugu_network_connection_type NuguNetworkConnectionType | +
network connection type
+ + +typedef void(* NuguNetworkManagerStatusCallback) (NuguNetworkStatus status, void *userdata) | +
Callback prototype for receiving network status events.
+ + +typedef enum nugu_network_handoff_status NuguNetworkHandoffStatus | +
network handoff status
+typedef void(* NuguNetworkManagerEventSendNotifyCallback) (NuguEvent *nev, void *userdata) | +
Callback prototype for notification of event sending requests.
+ + +typedef void(* NuguNetworkManagerEventDataSendNotifyCallback) (NuguEvent *nev, int is_end, size_t length, unsigned char *data, void *userdata) | +
Callback prototype for notification of event data sending requests.
+ + +typedef void(* NuguNetworkManagerEventResultCallback) (int success, const char *msg_id, const char *dialog_id, int code, void *userdata) | +
Callback prototype for result of event transfer request.
+ + +typedef void(* NuguNetworkManagerEventResponseCallback) (int success, const char *event_msg_id, const char *event_dialog_id, const char *json, void *userdata) | +
Callback prototype for directive response of event request.
+ + +typedef void(* NuguNetworkManagerDirectiveCallback) (NuguDirective *ndir, void *userdata) | +
Callback prototype for receiving directive.
+ + +typedef void(* NuguNetworkManagerAttachmentCallback) (const char *parent_msg_id, int seq, int is_end, const char *media_type, size_t length, const void *data, void *userdata) | +
Callback prototype for receiving directive attachment.
+ + +typedef struct nugu_network_server_policy NuguNetworkServerPolicy | +
Server policy information used for network connections.
+enum nugu_network_status | +
network status
+Basic connection status flow for connection-oriented
Basic connection status flow for connection-ondemand
Connection recovery flow for connection-oriented
enum nugu_network_connection_type | +
enum nugu_network_handoff_status | +
network handoff status
+enum nugu_network_protocol | +
int nugu_network_manager_set_status_callback | +( | +NuguNetworkManagerStatusCallback | +callback, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set network status callback.
+[in] | callback | callback function |
[in] | userdata | data to pass to the user callback |
0 | success |
-1 | failure |
int nugu_network_manager_set_handoff_status_callback | +( | +NuguNetworkManagerHandoffStatusCallback | +callback, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set handoff status callback.
+[in] | callback | callback function |
[in] | userdata | data to pass to the user callback |
0 | success |
-1 | failure |
int nugu_network_manager_set_event_send_notify_callback | +( | +NuguNetworkManagerEventSendNotifyCallback | +callback, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set event send notify callback.
+[in] | callback | callback function |
[in] | userdata | data to pass to the user callback |
0 | success |
-1 | failure |
int nugu_network_manager_set_event_data_send_notify_callback | +( | +NuguNetworkManagerEventDataSendNotifyCallback | +callback, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set event data send notify callback.
+[in] | callback | callback function |
[in] | userdata | data to pass to the user callback |
0 | success |
-1 | failure |
int nugu_network_manager_set_event_result_callback | +( | +NuguNetworkManagerEventResultCallback | +callback, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set event send result callback.
+[in] | callback | callback function |
[in] | userdata | data to pass to the user callback |
0 | success |
-1 | failure |
int nugu_network_manager_set_event_response_callback | +( | +NuguNetworkManagerEventResponseCallback | +callback, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set event response callback.
+[in] | callback | callback function |
[in] | userdata | data to pass to the user callback |
0 | success |
-1 | failure |
int nugu_network_manager_set_directive_callback | +( | +NuguNetworkManagerDirectiveCallback | +callback, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set directive receive callback.
+[in] | callback | callback function |
[in] | userdata | data to pass to the user callback |
0 | success |
-1 | failure |
int nugu_network_manager_set_attachment_callback | +( | +NuguNetworkManagerAttachmentCallback | +callback, | +
+ | + | void * | +userdata | +
+ | ) | ++ |
Set attachment of directive receive callback.
+[in] | callback | callback function |
[in] | userdata | data to pass to the user callback |
0 | success |
-1 | failure |
int nugu_network_manager_set_status | +( | +NuguNetworkStatus | +network_status | ) | ++ |
Set the current network status.
+[in] | network_status | network status |
0 | success |
-1 | failure |
NuguNetworkStatus nugu_network_manager_get_status | +( | +void | +) | ++ |
Get the current network status.
+int nugu_network_manager_send_event | +( | +NuguEvent * | +nev | ) | ++ |
Send the event to server.
+[in] | nev | event object |
0 | success |
-1 | failure |
int nugu_network_manager_send_event_data | +( | +NuguEvent * | +nev, | +
+ | + | int | +is_end, | +
+ | + | size_t | +length, | +
+ | + | unsigned char * | +data | +
+ | ) | ++ |
Send the attachment data of event to server.
+[in] | nev | event object |
[in] | is_end | data is last(is_end=1) or not(is_end=0) |
[in] | length | length of data |
[in] | data | data to send |
0 | success |
-1 | failure |
int nugu_network_manager_force_close_event | +( | +NuguEvent * | +nev | ) | ++ |
Force close the NUGU_EVENT_TYPE_WITH_ATTACHMENT type event.
+[in] | nev | event object |
0 | success |
-1 | failure |
int nugu_network_manager_initialize | +( | +void | +) | ++ |
Initialize the network manager.
+0 | success |
-1 | failure |
int nugu_network_manager_connect | +( | +void | +) | ++ |
Connect to server.
+0 | success |
-1 | failure |
int nugu_network_manager_disconnect | +( | +void | +) | ++ |
Disconnect from server.
+0 | success |
-1 | failure |
int nugu_network_manager_handoff | +( | +const NuguNetworkServerPolicy * | +policy | ) | ++ |
Handoff the current connection to new server.
+0 | success |
-1 | failure |
When a handoff request is received, the client tries to connect to another server while maintaining the current connection.
+int nugu_network_manager_reset_connection | +( | +void | +) | ++ |
Immediately disconnect the current connection and reconnect.
+0 | success |
-1 | failure |
int nugu_network_manager_set_token | +( | +const char * | +token | ) | ++ |
Set the access token value.
+[in] | token | access token |
0 | success |
-1 | failure |
const char* nugu_network_manager_peek_token | +( | +void | +) | ++ |
Get the access token value.
+int nugu_network_manager_set_registry_url | +( | +const char * | +urlname | ) | ++ |
Set the device gateway registry url.
+[in] | urlname | gateway registry url |
0 | success |
-1 | failure |
const char* nugu_network_manager_peek_registry_url | +( | +void | +) | ++ |
Get the device gateway registry url.
+int nugu_network_manager_set_useragent | +( | +const char * | +app_version, | +
+ | + | const char * | +additional_info | +
+ | ) | ++ |
Set the HTTP header UserAgent information.
+[in] | app_version | application version (e.g. "0.1.0") |
[in] | additional_info | additional information or NULL |
0 | success |
-1 | failure |
const char* nugu_network_manager_peek_useragent | +( | +void | +) | ++ |
Get the UserAgent information.
+const char* nugu_network_manager_peek_last_asr_time | +( | +void | +) | ++ |
Get the last ASR event time information.
+int nugu_network_manager_set_connection_type | +( | +NuguNetworkConnectionType | +ctype | ) | ++ |
Set the connection type.
+ctype | connection type |
0 | success |
-1 | failure |
NuguNetworkConnectionType nugu_network_manager_get_connection_type | +( | +void | +) | ++ |
Get the connection type.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
UUID generation functions. +More...
++Macros | |
#define | NUGU_BASE_TIMESTAMP_MSEC 1546300800000 |
Milliseconds for base timestamp: 2019/1/1 00:00:00.000 (GMT) More... | |
+#define | NUGU_BASE_TIMESTAMP_SEC 1546300800 |
Seconds for base timestamp: 2019/1/1 00:00:00 (GMT) | |
+#define | NUGU_MAX_UUID_SIZE 16 |
Maximum byte array UUID size. | |
+#define | NUGU_MAX_UUID_STRING_SIZE (NUGU_MAX_UUID_SIZE * 2) |
Maximum base16 encoded UUID string size. | |
+Functions | |
int | nugu_uuid_convert_base16 (const unsigned char *bytes, size_t bytes_len, char *out, size_t out_len) |
Convert byte array to base16-encoded string. More... | |
int | nugu_uuid_convert_bytes (const char *base16, size_t base16_len, unsigned char *out, size_t out_len) |
Convert base16-encoded string to byte array. More... | |
int | nugu_uuid_convert_timespec (const unsigned char *bytes, size_t bytes_len, struct timespec *out_time) |
Convert byte array to base16-encoded string. More... | |
int | nugu_uuid_fill (const struct timespec *time, const unsigned char *hash, size_t hash_len, unsigned char *out, size_t out_len) |
Fill to output buffer with NUGU UUID format using parameters. More... | |
int | nugu_uuid_fill_random (unsigned char *dest, size_t dest_len) |
Generate random bytes and fill to destination buffer. More... | |
char * | nugu_uuid_generate_time (void) |
Generate time based UUID. More... | |
UUID generation functions.
+#define NUGU_BASE_TIMESTAMP_MSEC 1546300800000 | +
Milliseconds for base timestamp: 2019/1/1 00:00:00.000 (GMT)
+This value must be treated as 64 bits.
+ +char* nugu_uuid_generate_time | +( | +void | +) | ++ |
Generate time based UUID.
+int nugu_uuid_convert_bytes | +( | +const char * | +base16, | +
+ | + | size_t | +base16_len, | +
+ | + | unsigned char * | +out, | +
+ | + | size_t | +out_len | +
+ | ) | ++ |
Convert base16-encoded string to byte array.
+[in] | base16 | base16-encoded string |
[in] | base16_len | length |
[out] | out | memory allocated output buffer |
[in] | out_len | size of output buffer |
0 | Success |
-1 | Failure |
int nugu_uuid_convert_base16 | +( | +const unsigned char * | +bytes, | +
+ | + | size_t | +bytes_len, | +
+ | + | char * | +out, | +
+ | + | size_t | +out_len | +
+ | ) | ++ |
Convert byte array to base16-encoded string.
+[in] | bytes | byte array |
[in] | bytes_len | length |
[out] | out | memory allocated output buffer |
[in] | out_len | size of output buffer |
0 | Success |
-1 | Failure |
int nugu_uuid_convert_timespec | +( | +const unsigned char * | +bytes, | +
+ | + | size_t | +bytes_len, | +
+ | + | struct timespec * | +out_time | +
+ | ) | ++ |
Convert byte array to base16-encoded string.
+[in] | bytes | byte array |
[in] | bytes_len | length |
[out] | out_time | memory allocated structure |
0 | Success |
-1 | Failure |
int nugu_uuid_fill_random | +( | +unsigned char * | +dest, | +
+ | + | size_t | +dest_len | +
+ | ) | ++ |
Generate random bytes and fill to destination buffer.
+[in] | dest | destination buffer |
[in] | dest_len | length of buffer |
0 | Success |
-1 | Failure |
int nugu_uuid_fill | +( | +const struct timespec * | +time, | +
+ | + | const unsigned char * | +hash, | +
+ | + | size_t | +hash_len, | +
+ | + | unsigned char * | +out, | +
+ | + | size_t | +out_len | +
+ | ) | ++ |
Fill to output buffer with NUGU UUID format using parameters.
+[in] | time | timestamp information |
[in] | hash | hash value(e.g. SHA1(token)) |
[in] | hash_len | length of hash value |
[out] | out | memory allocated output buffer |
[in] | out_len | size of output buffer |
0 | Success |
-1 | Failure |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
The NUGU SDK supports NUGU platform interworking on various devices and apps to provide various AI functions based on voice interface.
+It sends user requests (voice commands) to the NUGU platform and controls the functionality of the device or application depending on the processing results of the NUGU platform.
+Since the Linux SDK is implemented based on GLib's mainloop, your application should be developed in an event-driven way based on GMainLoop.
+The NUGU SDK Linux API consists of the following parts:
Apache v2
+Copyright (c) 2019 SK Telecom Co., Ltd. All rights reserved.
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <string>
Go to the source code of this file.
++Classes | |
class | NuguClientKit::IInteractionControlManager |
InteractionControlManager interface. More... | |
class | NuguClientKit::IInteractionControlManagerListener |
IInteractionControlManagerListener interface. More... | |
+Enumerations | |
enum class | NuguClientKit::InteractionMode { NONE +, MULTI_TURN + } |
Interaction Mode. More... | |
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
+ NUGU SDK Linux
+ 1.7.5
+
+ |
+
#include <clientkit/capability_interface.hh>
Go to the source code of this file.
++Classes | |
struct | NuguCapability::_LocationInfo |
Location Information. More... | |
class | NuguCapability::ILocationHandler |
location handler interface More... | |
class | NuguCapability::ILocationListener |
location listener interface More... | |
+Typedefs | |
+typedef struct NuguCapability::_LocationInfo | NuguCapability::LocationInfo |
Location Information. | |