resource_recordings.h

Go to the documentation of this file.

/*
 * Asterisk -- An open source telephony toolkit.
 *
 * Copyright (C) 2012 - 2013, Digium, Inc.
 *
 * David M. Lee, II <[email protected]>
 *
 * 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.
 */

/*! \file
 *
 * \brief Generated file - declares stubs to be implemented in
 * res/ari/resource_recordings.c
 *
 * Recording resources
 *
 * \author David M. Lee, II <[email protected]>
 */

/*
 * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 * !!!!! DO NOT EDIT !!!!!
 * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 * This file is generated by a mustache template. Please see the original
 * template in rest-api-templates/ari_resource.h.mustache
 */

#ifndef _ASTERISK_RESOURCE_RECORDINGS_H
#define _ASTERISK_RESOURCE_RECORDINGS_H

#include "asterisk/ari.h"

/*! Argument struct for ast_ari_recordings_list_stored() */
struct ast_ari_recordings_list_stored_args {
};
/*!
 * \brief List recordings that are complete.
 *
 * \param headers HTTP headers
 * \param args Swagger parameters
 * \param[out] response HTTP response
 */
void ast_ari_recordings_list_stored(struct ast_variable *headers, struct ast_ari_recordings_list_stored_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_recordings_get_stored() */
struct ast_ari_recordings_get_stored_args {
 /*! The name of the recording */
 const char *recording_name;
};
/*!
 * \brief Get a stored recording's details.
 *
 * \param headers HTTP headers
 * \param args Swagger parameters
 * \param[out] response HTTP response
 */
void ast_ari_recordings_get_stored(struct ast_variable *headers, struct ast_ari_recordings_get_stored_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_recordings_delete_stored() */
struct ast_ari_recordings_delete_stored_args {
 /*! The name of the recording */
 const char *recording_name;
};
/*!
 * \brief Delete a stored recording.
 *
 * \param headers HTTP headers
 * \param args Swagger parameters
 * \param[out] response HTTP response
 */
void ast_ari_recordings_delete_stored(struct ast_variable *headers, struct ast_ari_recordings_delete_stored_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_recordings_get_stored_file() */
struct ast_ari_recordings_get_stored_file_args {
 /*! The name of the recording */
 const char *recording_name;
};
/*!
 * \brief Get the file associated with the stored recording.
 *
 * \param ser TCP/TLS session instance
 * \param headers HTTP headers
 * \param args Swagger parameters
 * \param[out] response HTTP response
 */
void ast_ari_recordings_get_stored_file(struct ast_tcptls_session_instance *ser, struct ast_variable *headers, struct ast_ari_recordings_get_stored_file_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_recordings_copy_stored() */
struct ast_ari_recordings_copy_stored_args {
 /*! The name of the recording to copy */
 const char *recording_name;
 /*! The destination name of the recording */
 const char *destination_recording_name;
};
/*!
 * \brief Body parsing function for /recordings/stored/{recordingName}/copy.
 * \param body The JSON body from which to parse parameters.
 * \param[out] args The args structure to parse into.
 * \retval zero on success
 * \retval non-zero on failure
 */
int ast_ari_recordings_copy_stored_parse_body(
 struct ast_json *body,
 struct ast_ari_recordings_copy_stored_args *args);

/*!
 * \brief Copy a stored recording.
 *
 * \param headers HTTP headers
 * \param args Swagger parameters
 * \param[out] response HTTP response
 */
void ast_ari_recordings_copy_stored(struct ast_variable *headers, struct ast_ari_recordings_copy_stored_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_recordings_get_live() */
struct ast_ari_recordings_get_live_args {
 /*! The name of the recording */
 const char *recording_name;
};
/*!
 * \brief List live recordings.
 *
 * \param headers HTTP headers
 * \param args Swagger parameters
 * \param[out] response HTTP response
 */
void ast_ari_recordings_get_live(struct ast_variable *headers, struct ast_ari_recordings_get_live_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_recordings_cancel() */
struct ast_ari_recordings_cancel_args {
 /*! The name of the recording */
 const char *recording_name;
};
/*!
 * \brief Stop a live recording and discard it.
 *
 * \param headers HTTP headers
 * \param args Swagger parameters
 * \param[out] response HTTP response
 */
void ast_ari_recordings_cancel(struct ast_variable *headers, struct ast_ari_recordings_cancel_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_recordings_stop() */
struct ast_ari_recordings_stop_args {
 /*! The name of the recording */
 const char *recording_name;
};
/*!
 * \brief Stop a live recording and store it.
 *
 * \param headers HTTP headers
 * \param args Swagger parameters
 * \param[out] response HTTP response
 */
void ast_ari_recordings_stop(struct ast_variable *headers, struct ast_ari_recordings_stop_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_recordings_pause() */
struct ast_ari_recordings_pause_args {
 /*! The name of the recording */
 const char *recording_name;
};
/*!
 * \brief Pause a live recording.
 *
 * Pausing a recording suspends silence detection, which will be restarted when the recording is unpaused. Paused time is not included in the accounting for maxDurationSeconds.
 *
 * \param headers HTTP headers
 * \param args Swagger parameters
 * \param[out] response HTTP response
 */
void ast_ari_recordings_pause(struct ast_variable *headers, struct ast_ari_recordings_pause_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_recordings_unpause() */
struct ast_ari_recordings_unpause_args {
 /*! The name of the recording */
 const char *recording_name;
};
/*!
 * \brief Unpause a live recording.
 *
 * \param headers HTTP headers
 * \param args Swagger parameters
 * \param[out] response HTTP response
 */
void ast_ari_recordings_unpause(struct ast_variable *headers, struct ast_ari_recordings_unpause_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_recordings_mute() */
struct ast_ari_recordings_mute_args {
 /*! The name of the recording */
 const char *recording_name;
};
/*!
 * \brief Mute a live recording.
 *
 * Muting a recording suspends silence detection, which will be restarted when the recording is unmuted.
 *
 * \param headers HTTP headers
 * \param args Swagger parameters
 * \param[out] response HTTP response
 */
void ast_ari_recordings_mute(struct ast_variable *headers, struct ast_ari_recordings_mute_args *args, struct ast_ari_response *response);
/*! Argument struct for ast_ari_recordings_unmute() */
struct ast_ari_recordings_unmute_args {
 /*! The name of the recording */
 const char *recording_name;
};
/*!
 * \brief Unmute a live recording.
 *
 * \param headers HTTP headers
 * \param args Swagger parameters
 * \param[out] response HTTP response
 */
void ast_ari_recordings_unmute(struct ast_variable *headers, struct ast_ari_recordings_unmute_args *args, struct ast_ari_response *response);

#endif /* _ASTERISK_RESOURCE_RECORDINGS_H */