ari: Add Snoop operation for spying/whispering on channels.
[asterisk/asterisk.git] / include / asterisk / stasis_app_snoop.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Joshua Colp <jcolp@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 #ifndef _ASTERISK_STASIS_APP_SNOOP_H
20 #define _ASTERISK_STASIS_APP_SNOOP_H
21
22 /*! \file
23  *
24  * \brief Stasis Application Snoop API. See \ref res_stasis "Stasis
25  * Application API" for detailed documentation.
26  *
27  * \author Joshua Colp <jcolp@digium.com>
28  * \since 12
29  */
30
31 #include "asterisk/stasis_app.h"
32
33 /*! \brief Directions for audio stream flow */
34 enum stasis_app_snoop_direction {
35         /*! \brief No direction */
36         STASIS_SNOOP_DIRECTION_NONE = 0,
37         /*! \brief Audio stream out to the channel */
38         STASIS_SNOOP_DIRECTION_OUT,
39         /*! \brief Audio stream in from the channel */
40         STASIS_SNOOP_DIRECTION_IN,
41         /*! \brief Audio stream to AND from the channel */
42         STASIS_SNOOP_DIRECTION_BOTH,
43 };
44
45 /*!
46  * \brief Create a snoop on the provided channel.
47  *
48  * \param chan Channel to snoop on.
49  * \param spy Direction of media that should be spied on.
50  * \param whisper Direction of media that should be whispered into.
51  * \param app Stasis application to execute on the snoop channel.
52  * \param app_args Stasis application arguments.
53  * \return Snoop channel. ast_channel_unref() when done.
54  * \return \c NULL if snoop channel couldn't be created.
55  */
56 struct ast_channel *stasis_app_control_snoop(struct ast_channel *chan,
57         enum stasis_app_snoop_direction spy, enum stasis_app_snoop_direction whisper,
58         const char *app, const char *app_args);
59
60 #endif /* _ASTERISK_STASIS_APP_SNOOP_H */