8d1e53958c
use the \retval tag for documenting return values, fixing various warnings when generating the documentation, and various other things. (closes issue #10203, snuffy) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@75164 65c4cc65-6c06-0410-ace0-fbb531ad65f3
60 lines
1.7 KiB
C
60 lines
1.7 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 1999 - 2005, Digium, Inc.
|
|
*
|
|
* Mark Spencer <markster@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.
|
|
*/
|
|
|
|
/*! \file
|
|
* \brief Music on hold handling
|
|
*/
|
|
|
|
#ifndef _ASTERISK_MOH_H
|
|
#define _ASTERISK_MOH_H
|
|
|
|
#if defined(__cplusplus) || defined(c_plusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
/*!
|
|
* \brief Turn on music on hold on a given channel
|
|
*
|
|
* \param chan The channel structure that will get music on hold
|
|
* \param mclass The class to use if the musicclass is not currently set on
|
|
* the channel structure.
|
|
* \param interpclass The class to use if the musicclass is not currently set on
|
|
* the channel structure or in the mclass argument.
|
|
*
|
|
* \retval Zero on success
|
|
* \retval non-zero on failure
|
|
*/
|
|
int ast_moh_start(struct ast_channel *chan, const char *mclass, const char *interpclass);
|
|
|
|
/*! Turn off music on hold on a given channel */
|
|
void ast_moh_stop(struct ast_channel *chan);
|
|
|
|
void ast_install_music_functions(int (*start_ptr)(struct ast_channel *, const char *, const char *),
|
|
void (*stop_ptr)(struct ast_channel *),
|
|
void (*cleanup_ptr)(struct ast_channel *));
|
|
|
|
void ast_uninstall_music_functions(void);
|
|
|
|
void ast_moh_cleanup(struct ast_channel *chan);
|
|
|
|
#if defined(__cplusplus) || defined(c_plusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* _ASTERISK_MOH_H */
|