nugu_directive.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 SK Telecom Co., Ltd. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef __NUGU_DIRECTIVE_H__
#define __NUGU_DIRECTIVE_H__
 
#include <stddef.h>
#include <nugu.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct _nugu_directive NuguDirective;
 
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, 
};
 
typedef void (*NuguDirectiveDataCallback)(NuguDirective *ndir, int seq,
                                          void *userdata);
 
NUGU_API 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);
 
NUGU_API void nugu_directive_ref(NuguDirective *ndir);
 
NUGU_API void nugu_directive_unref(NuguDirective *ndir);
 
NUGU_API const char *nugu_directive_peek_namespace(const NuguDirective *ndir);
 
NUGU_API const char *nugu_directive_peek_name(const NuguDirective *ndir);
 
NUGU_API const char *nugu_directive_peek_groups(const NuguDirective *ndir);
 
NUGU_API const char *nugu_directive_peek_version(const NuguDirective *ndir);
 
NUGU_API const char *nugu_directive_peek_msg_id(const NuguDirective *ndir);
 
NUGU_API const char *nugu_directive_peek_dialog_id(const NuguDirective *ndir);
 
NUGU_API const char *nugu_directive_peek_referrer_id(const NuguDirective *ndir);
 
NUGU_API const char *nugu_directive_peek_json(const NuguDirective *ndir);
 
NUGU_API int nugu_directive_is_active(const NuguDirective *ndir);
 
NUGU_API int nugu_directive_set_active(NuguDirective *ndir, int flag);
 
NUGU_API int nugu_directive_add_data(NuguDirective *ndir, size_t length,
                                     const unsigned char *data);
 
NUGU_API int nugu_directive_close_data(NuguDirective *ndir);
 
NUGU_API int nugu_directive_is_data_end(const NuguDirective *ndir);
 
NUGU_API int nugu_directive_set_media_type(NuguDirective *ndir,
                                           const char *type);
 
NUGU_API const char *nugu_directive_peek_media_type(const NuguDirective *ndir);
 
NUGU_API unsigned char *nugu_directive_get_data(NuguDirective *ndir,
                                                size_t *length);
 
NUGU_API size_t nugu_directive_get_data_size(const NuguDirective *ndir);
 
NUGU_API int nugu_directive_set_blocking_policy(
        NuguDirective *ndir, enum nugu_directive_medium medium, int is_block);
 
NUGU_API enum nugu_directive_medium
nugu_directive_get_blocking_medium(const NuguDirective *ndir);
 
NUGU_API const char *
nugu_directive_get_blocking_medium_string(const NuguDirective *ndir);
 
NUGU_API int nugu_directive_is_blocking(const NuguDirective *ndir);
 
NUGU_API int
nugu_directive_set_data_callback(NuguDirective *ndir,
                                 NuguDirectiveDataCallback callback,
                                 void *userdata);
 
NUGU_API int nugu_directive_remove_data_callback(NuguDirective *ndir);
 
#ifdef __cplusplus
}
#endif
 
#endif