Index installed sounds and implement ARI sounds queries
[asterisk/asterisk.git] / include / asterisk / sounds_index.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Kinsey Moore <kmoore@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief Sound file format and description indexer.
21  */
22
23 #ifndef _ASTERISK_SOUNDS_INDEX_H
24 #define _ASTERISK_SOUNDS_INDEX_H
25
26 #if defined(__cplusplus) || defined(c_plusplus)
27 extern "C" {
28 #endif
29
30 /*!
31  * \brief Object representing a media index
32  */
33 struct ast_media_index;
34
35 /*!
36  * \brief Reload the sounds index
37  *
38  * \retval zero on success
39  * \retval non-zero on failure
40  */
41 int ast_sounds_reindex(void);
42
43 /*!
44  * \brief Get the sounds index
45  *
46  * \retval sounds index (must be ao2_cleanup()'ed)
47  * \retval NULL on failure
48  */
49 struct ast_media_index *ast_sounds_get_index(void);
50
51 #if defined(__cplusplus) || defined(c_plusplus)
52 }
53 #endif
54
55 #endif /* _ASTERISK_SOUNDS_INDEX_H */