blob: 40fb72102a17404043e13e302f606ea92313fd01 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
/*
* Asterisk -- An open source telephony toolkit.
*
* Copyright (C) 2013, Digium, Inc.
*
* Kinsey Moore <kmoore@digium.com>
*
* See http://www.asterisk.org for more information about
* the Asterisk project. Please do not directly contact
* any of the maintainers of this project for assistance;
* the project provides a web site, mailing lists and IRC
* channels for your use.
*
* This program is free software, distributed under the terms of
* the GNU General Public License Version 2. See the LICENSE file
* at the top of the source tree.
*/
/*! \file
* \brief Media file format and description indexing engine.
*/
#ifndef _ASTERISK_MEDIA_INDEX_H
#define _ASTERISK_MEDIA_INDEX_H
#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif
struct ast_format_cap;
/*!
* \brief Object representing a media index
*/
struct ast_media_index;
/*!
* \brief Creates a new media index
*
* \param base_dir Base directory for indexing
*
* \retval NULL on error
* \retval A new AO2 refcounted media index
*/
struct ast_media_index *ast_media_index_create(
const char *base_dir);
/*!
* \brief Get the description for a media file
*
* \param index Media index in which to query information
* \param filename Name of the file for which to get the description
* \param variant Media variant for which to get the description
*
* \retval NULL if not found
* \return The description requested (must be copied to be kept)
*/
const char *ast_media_get_description(struct ast_media_index *index, const char *filename, const char *variant);
/*!
* \brief Get the ast_format_cap for a media file
*
* \param index Media index in which to query information
* \param filename Name of the file for which to get the description
* \param variant Media variant for which to get the description
*
* \retval NULL if not found
* \return a copy of the format capabilities (must be destroyed with ast_format_cap_destroy)
*/
struct ast_format_cap *ast_media_get_format_cap(struct ast_media_index *index, const char *filename, const char *variant);
/*!
* \brief Get the languages in which a media file is available
*
* \param index Media index in which to query information
* \param filename Name of the file for which to get available languages
*
* \retval NULL on error
* \return an ast_str_container filled with language strings
*/
struct ao2_container *ast_media_get_variants(struct ast_media_index *index, const char *filename);
/*!
* \brief Get the a container of all media available on the system
*
* \param index Media index in which to query information
*
* \retval NULL on error
* \return an ast_str_container filled with media file name strings
*/
struct ao2_container *ast_media_get_media(struct ast_media_index *index);
/*!
* \brief Update a media index
*
* \param index Media index in which to query information
* \param variant Media variant for which to get the description
*
* \retval non-zero on error
* \return zero on success
*/
int ast_media_index_update(struct ast_media_index *index,
const char *variant);
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif
#endif /* _ASTERISK_MEDIA_INDEX_H */
|
