af9b77749b36be3a5268e9ad01f892a38253729e
[asterisk/asterisk.git] / include / asterisk / features.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@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 Call Parking and Pickup API
21  * Includes code and algorithms from the Zapata library.
22  */
23
24 #ifndef _AST_FEATURES_H
25 #define _AST_FEATURES_H
26
27 #include "asterisk/pbx.h"
28 #include "asterisk/linkedlists.h"
29 #include "asterisk/bridge.h"
30
31 /*! \brief main call feature structure */
32
33 enum {
34         AST_FEATURE_FLAG_NEEDSDTMF = (1 << 0),
35         AST_FEATURE_FLAG_ONPEER =    (1 << 1),
36         AST_FEATURE_FLAG_ONSELF =    (1 << 2),
37         AST_FEATURE_FLAG_BYCALLEE =  (1 << 3),
38         AST_FEATURE_FLAG_BYCALLER =  (1 << 4),
39         AST_FEATURE_FLAG_BYBOTH  =   (3 << 3),
40 };
41
42 /*! \brief Bridge a call, optionally allowing redirection */
43 int ast_bridge_call(struct ast_channel *chan, struct ast_channel *peer,struct ast_bridge_config *config);
44
45 /*!
46  * \brief Bridge a call, and add additional flags to the bridge
47  *
48  * This does the same thing as \ref ast_bridge_call, except that once the bridge
49  * is created, the provided flags are set on the bridge. The provided flags are
50  * added to the bridge's flags; they will not clear any flags already set.
51  *
52  * \param chan The calling channel
53  * \param peer The called channel
54  * \param config Bridge configuration for the channels
55  * \param flags Additional flags to set on the created bridge
56  */
57 int ast_bridge_call_with_flags(struct ast_channel *chan, struct ast_channel *peer, struct ast_bridge_config *config, unsigned int flags);
58
59 /*!
60  * \brief Add an arbitrary channel to a bridge
61  * \since 12.0.0
62  *
63  * The channel that is being added to the bridge can be in any state: unbridged,
64  * bridged, answered, unanswered, etc. The channel will be added asynchronously,
65  * meaning that when this function returns once the channel has been added to
66  * the bridge, not once the channel has been removed from the bridge.
67  *
68  * In addition, a tone can optionally be played to the channel once the
69  * channel is placed into the bridge.
70  *
71  * \note When this function returns, there is no guarantee that the channel that
72  * was passed in is valid any longer. Do not attempt to operate on the channel
73  * after this function returns.
74  *
75  * \param bridge Bridge to which the channel should be added
76  * \param chan The channel to add to the bridge
77  * \param features Features for this channel in the bridge
78  * \param play_tone Indicates if a tone should be played to the channel
79  * \param xfersound Sound that should be used to indicate transfer with play_tone
80  * \retval 0 Success
81  * \retval -1 Failure
82  */
83 int ast_bridge_add_channel(struct ast_bridge *bridge, struct ast_channel *chan,
84                 struct ast_bridge_features *features, int play_tone, const char *xfersound);
85
86
87
88 /*!
89  * \brief parse L option and read associated channel variables to set warning, warning frequency, and timelimit
90  * \note caller must be aware of freeing memory for warning_sound, end_sound, and start_sound
91 */
92 int ast_bridge_timelimit(struct ast_channel *chan, struct ast_bridge_config *config, char *parse, struct timeval *calldurationlimit);
93
94 #endif /* _AST_FEATURES_H */