nugu_directive.h File Reference

#include <stddef.h>

Include dependency graph for nugu_directive.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

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...