This patch adds support for controlling a playback operation from the
[asterisk/asterisk.git] / include / asterisk / stasis_app_playback.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@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_PLAYBACK_H
20 #define _ASTERISK_STASIS_APP_PLAYBACK_H
21
22 /*! \file
23  *
24  * \brief Stasis Application Playback API. See \ref res_stasis "Stasis
25  * Application API" for detailed documentation.
26  *
27  * \author David M. Lee, II <dlee@digium.com>
28  * \since 12
29  */
30
31 #include "asterisk/stasis_app.h"
32
33 /*! Opaque struct for handling the playback of a single file */
34 struct stasis_app_playback;
35
36 /*! State of a playback operation */
37 enum stasis_app_playback_state {
38         /*! The playback has not started yet */
39         STASIS_PLAYBACK_STATE_QUEUED,
40         /*! The media is currently playing */
41         STASIS_PLAYBACK_STATE_PLAYING,
42         /*! The media is currently playing */
43         STASIS_PLAYBACK_STATE_PAUSED,
44         /*! The media has stopped playing */
45         STASIS_PLAYBACK_STATE_COMPLETE,
46         /*! The playback was canceled. */
47         STASIS_PLAYBACK_STATE_CANCELED,
48         /*! The playback was stopped. */
49         STASIS_PLAYBACK_STATE_STOPPED,
50         /*! Enum end sentinel. */
51         STASIS_PLAYBACK_STATE_MAX,
52 };
53
54 /*! Valid operation for controlling a playback. */
55 enum stasis_app_playback_media_operation {
56         /*! Stop the playback operation. */
57         STASIS_PLAYBACK_STOP,
58         /*! Restart the media from the beginning. */
59         STASIS_PLAYBACK_RESTART,
60         /*! Pause playback. */
61         STASIS_PLAYBACK_PAUSE,
62         /*! Resume paused playback. */
63         STASIS_PLAYBACK_UNPAUSE,
64         /*! Rewind playback. */
65         STASIS_PLAYBACK_REVERSE,
66         /*! Fast forward playback. */
67         STASIS_PLAYBACK_FORWARD,
68         /*! Enum end sentinel. */
69         STASIS_PLAYBACK_MEDIA_OP_MAX,
70 };
71
72 /*!
73  * \brief Play a file to the control's channel.
74  *
75  * Note that the file isn't the full path to the file. Asterisk's internal
76  * playback mechanism will automagically select the best format based on the
77  * available codecs for the channel.
78  *
79  * \param control Control for \c res_stasis.
80  * \param file Base filename for the file to play.
81  * \param language Selects the file based on language.
82  * \param skipms Number of milliseconds to skip for forward/reverse operations.
83  * \param offsetms Number of milliseconds to skip before playing.
84  * \return Playback control object.
85  * \return \c NULL on error.
86  */
87 struct stasis_app_playback *stasis_app_control_play_uri(
88         struct stasis_app_control *control, const char *file,
89         const char *language, int skipms, long offsetms);
90
91 /*!
92  * \brief Gets the current state of a playback operation.
93  *
94  * \param playback Playback control object.
95  * \return The state of the \a playback object.
96  */
97 enum stasis_app_playback_state stasis_app_playback_get_state(
98         struct stasis_app_playback *playback);
99
100 /*!
101  * \brief Gets the unique id of a playback object.
102  *
103  * \param playback Playback control object.
104  * \return \a playback's id.
105  * \return \c NULL if \a playback ic \c NULL
106  */
107 const char *stasis_app_playback_get_id(
108         struct stasis_app_playback *playback);
109
110 /*!
111  * \brief Finds the playback object with the given id.
112  *
113  * \param id Id of the playback object to find.
114  * \return Associated \ref stasis_app_playback object.
115  * \return \c NULL if \a id not found.
116  */
117 struct stasis_app_playback *stasis_app_playback_find_by_id(const char *id);
118
119 struct ast_json *stasis_app_playback_to_json(
120         const struct stasis_app_playback *playback);
121
122 enum stasis_playback_oper_results {
123         STASIS_PLAYBACK_OPER_OK,
124         STASIS_PLAYBACK_OPER_FAILED,
125         STASIS_PLAYBACK_OPER_NOT_PLAYING,
126 };
127 /*!
128  * \brief Controls the media for a given playback operation.
129  *
130  * \param playback Playback control object.
131  * \param control Media control operation.
132  * \return \c STASIS_PLAYBACK_OPER_OK on success.
133  * \return \ref stasis_playback_oper_results indicating failure.
134  */
135 enum stasis_playback_oper_results stasis_app_playback_operation(
136         struct stasis_app_playback *playback,
137         enum stasis_app_playback_media_operation operation);
138
139 /*!
140  * \brief Message type for playback updates. The data is an
141  * \ref ast_channel_blob.
142  */
143 struct stasis_message_type *stasis_app_playback_snapshot_type(void);
144
145 #endif /* _ASTERISK_STASIS_APP_PLAYBACK_H */