kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-10-11 07:13:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

This patch adds support for controlling a playback operation from the

Browse Source 
Asterisk REST interface.

This adds the /playback/{playbackId}/control resource, which may be
POSTed to to pause, unpause, reverse, forward or restart the media
playback.

Attempts to control a playback that is not currently playing will
either return a 404 Not Found (because the playback object no longer
exists) or a 409 Conflict (because the playback object is still in the
queue to be played).

This patch also adds skipms and offsetms parameters to the
/channels/{channelId}/play resource.

(closes issue ASTERISK-21587)
Review: https://reviewboard.asterisk.org/r/2559


git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@389603 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
David M. Lee
2013-05-23 20:21:16 +00:00
parent 10ba6bf8a8
commit 557125664d
13 changed files with 462 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
include/asterisk/stasis_app_playback.h
View File

@@ -39,18 +39,34 @@ enum stasis_app_playback_state {
STASIS_PLAYBACK_STATE_QUEUED,
/*! The media is currently playing */
STASIS_PLAYBACK_STATE_PLAYING,
/*! The media is currently playing */
STASIS_PLAYBACK_STATE_PAUSED,
/*! The media has stopped playing */
STASIS_PLAYBACK_STATE_COMPLETE,
/*! The playback was canceled. */
STASIS_PLAYBACK_STATE_CANCELED,
/*! The playback was stopped. */
STASIS_PLAYBACK_STATE_STOPPED,
/*! Enum end sentinel. */
STASIS_PLAYBACK_STATE_MAX,
};
enum stasis_app_playback_media_control {
/*! Valid operation for controlling a playback. */
enum stasis_app_playback_media_operation {
/*! Stop the playback operation. */
STASIS_PLAYBACK_STOP,
/*! Restart the media from the beginning. */
STASIS_PLAYBACK_RESTART,
/*! Pause playback. */
STASIS_PLAYBACK_PAUSE,
STASIS_PLAYBACK_PLAY,
STASIS_PLAYBACK_REWIND,
STASIS_PLAYBACK_FAST_FORWARD,
STASIS_PLAYBACK_SPEED_UP,
STASIS_PLAYBACK_SLOW_DOWN,
/*! Resume paused playback. */
STASIS_PLAYBACK_UNPAUSE,
/*! Rewind playback. */
STASIS_PLAYBACK_REVERSE,
/*! Fast forward playback. */
STASIS_PLAYBACK_FORWARD,
/*! Enum end sentinel. */
STASIS_PLAYBACK_MEDIA_OP_MAX,
};
/*!
@@ -62,12 +78,15 @@ enum stasis_app_playback_media_control {
*
* \param control Control for \c res_stasis.
* \param file Base filename for the file to play.
* \param language Selects the file based on language.
* \param skipms Number of milliseconds to skip for forward/reverse operations.
* \param offsetms Number of milliseconds to skip before playing.
* \return Playback control object.
* \return \c NULL on error.
*/
struct stasis_app_playback *stasis_app_control_play_uri(
struct stasis_app_control *control, const char *file,
const char *language);
const char *language, int skipms, long offsetms);
/*!
* \brief Gets the current state of a playback operation.
@@ -95,18 +114,27 @@ const char *stasis_app_playback_get_id(
* \return Associated \ref stasis_app_playback object.
* \return \c NULL if \a id not found.
*/
struct ast_json *stasis_app_playback_find_by_id(const char *id);
struct stasis_app_playback *stasis_app_playback_find_by_id(const char *id);
struct ast_json *stasis_app_playback_to_json(
const struct stasis_app_playback *playback);
enum stasis_playback_oper_results {
STASIS_PLAYBACK_OPER_OK,
STASIS_PLAYBACK_OPER_FAILED,
STASIS_PLAYBACK_OPER_NOT_PLAYING,
};
/*!
* \brief Controls the media for a given playback operation.
*
* \param playback Playback control object.
* \param control Media control operation.
* \return 0 on success
* \return non-zero on error.
* \return \c STASIS_PLAYBACK_OPER_OK on success.
* \return \ref stasis_playback_oper_results indicating failure.
*/
int stasis_app_playback_control(struct stasis_app_playback *playback,
enum stasis_app_playback_media_control control);
enum stasis_playback_oper_results stasis_app_playback_operation(
struct stasis_app_playback *playback,
enum stasis_app_playback_media_operation operation);
/*!
* \brief Message type for playback updates. The data is an