mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-23 22:45:39 +00:00
80ef9a21b9
Much needed was a way to assign id to objects on creation, and much change was necessary to accomplish it. Channel uniqueids and linkedids are split into separate string and creation time components without breaking linkedid propgation. This allowed the uniqueid to be specified by the user interface - and those values are now carried through to channel creation, adding the assignedids value to every function in the chain including the channel drivers. For local channels, the second channel can be specified or left to default to a ;2 suffix of first. In ARI, bridge, playback, and snoop objects can also be created with a specified uniqueid. Along the way, the args order to allocating channels was fixed in chan_mgcp and chan_gtalk, and linkedid is no longer lost as masquerade occurs. (closes issue ASTERISK-23120) Review: https://reviewboard.asterisk.org/r/3191/ ........ Merged revisions 410157 from http://svn.asterisk.org/svn/asterisk/branches/12 git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@410158 65c4cc65-6c06-0410-ace0-fbb531ad65f3
158 lines
4.8 KiB
C
158 lines
4.8 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2013, Digium, Inc.
|
|
*
|
|
* David M. Lee, II <dlee@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.
|
|
*/
|
|
|
|
#ifndef _ASTERISK_STASIS_APP_PLAYBACK_H
|
|
#define _ASTERISK_STASIS_APP_PLAYBACK_H
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Stasis Application Playback API. See \ref res_stasis "Stasis
|
|
* Application API" for detailed documentation.
|
|
*
|
|
* \author David M. Lee, II <dlee@digium.com>
|
|
* \since 12
|
|
*/
|
|
|
|
#include "asterisk/stasis_app.h"
|
|
|
|
/*! Opaque struct for handling the playback of a single file */
|
|
struct stasis_app_playback;
|
|
|
|
/*! State of a playback operation */
|
|
enum stasis_app_playback_state {
|
|
/*! The playback has not started yet */
|
|
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,
|
|
};
|
|
|
|
/*! 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,
|
|
/*! 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,
|
|
};
|
|
|
|
enum stasis_app_playback_target_type {
|
|
/*! The target is a channel */
|
|
STASIS_PLAYBACK_TARGET_CHANNEL = 0,
|
|
/*! The target is a bridge */
|
|
STASIS_PLAYBACK_TARGET_BRIDGE,
|
|
};
|
|
|
|
/*!
|
|
* \brief Play a file to the control's channel.
|
|
*
|
|
* Note that the file isn't the full path to the file. Asterisk's internal
|
|
* playback mechanism will automagically select the best format based on the
|
|
* available codecs for the channel.
|
|
*
|
|
* \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 target_id ID of the target bridge or channel.
|
|
* \param target_type What the target type is
|
|
* \param skipms Number of milliseconds to skip for forward/reverse operations.
|
|
* \param offsetms Number of milliseconds to skip before playing.
|
|
* \param id ID to assign the new playback or NULL for default.
|
|
* \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 *target_id,
|
|
enum stasis_app_playback_target_type target_type,
|
|
int skipms, long offsetms, const char *id);
|
|
|
|
/*!
|
|
* \brief Gets the current state of a playback operation.
|
|
*
|
|
* \param playback Playback control object.
|
|
* \return The state of the \a playback object.
|
|
*/
|
|
enum stasis_app_playback_state stasis_app_playback_get_state(
|
|
struct stasis_app_playback *playback);
|
|
|
|
/*!
|
|
* \brief Gets the unique id of a playback object.
|
|
*
|
|
* \param playback Playback control object.
|
|
* \return \a playback's id.
|
|
* \return \c NULL if \a playback ic \c NULL
|
|
*/
|
|
const char *stasis_app_playback_get_id(
|
|
struct stasis_app_playback *playback);
|
|
|
|
/*!
|
|
* \brief Finds the playback object with the given id.
|
|
*
|
|
* \param id Id of the playback object to find.
|
|
* \return Associated \ref stasis_app_playback object.
|
|
* \return \c NULL if \a id not found.
|
|
*/
|
|
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 \c STASIS_PLAYBACK_OPER_OK on success.
|
|
* \return \ref stasis_playback_oper_results indicating failure.
|
|
*/
|
|
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
|
|
* \ref ast_channel_blob.
|
|
*/
|
|
struct stasis_message_type *stasis_app_playback_snapshot_type(void);
|
|
|
|
#endif /* _ASTERISK_STASIS_APP_PLAYBACK_H */
|