blob: 44503c031f989d8a18436022bebb7116b6a030cf [file] [log] [blame]
Benny Prijonoa837c302006-04-27 22:36:40 +00001/* $Id$ */
2/*
Benny Prijono844653c2008-12-23 17:27:53 +00003 * Copyright (C) 2008-2009 Teluu Inc. (http://www.teluu.com)
4 * Copyright (C) 2003-2008 Benny Prijono <benny@prijono.org>
Benny Prijonoa837c302006-04-27 22:36:40 +00005 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 */
20#ifndef __PJMEDIA_CODEC_L16_H__
21#define __PJMEDIA_CODEC_L16_H__
22
23#include <pjmedia-codec/types.h>
24
25
Benny Prijono37235af2006-06-18 02:02:36 +000026/**
Benny Prijono1ec70b32006-06-20 15:39:07 +000027 * @defgroup PJMED_L16 L16 Codec Family
Benny Prijono2e8cf632009-08-13 15:57:26 +000028 * @ingroup PJMEDIA_CODEC_CODECS
Benny Prijono5b64b8d2008-06-20 21:39:02 +000029 * @brief PCM/16bit/linear codecs
Benny Prijono37235af2006-06-18 02:02:36 +000030 * @{
Benny Prijono5b64b8d2008-06-20 21:39:02 +000031 *
Benny Prijono37235af2006-06-18 02:02:36 +000032 * This section describes functions to register and register L16 codec
33 * factory to the codec manager. After the codec factory has been registered,
34 * application can use @ref PJMEDIA_CODEC API to manipulate the codec.
35 *
36 * Note that the L16 codec factory registers several (about fourteen!)
37 * L16 codec types to codec manager (different combinations of clock
38 * rate and number of channels).
39 */
40
Benny Prijonoa837c302006-04-27 22:36:40 +000041PJ_BEGIN_DECL
42
43
44/**
45 * Initialize and register L16 codec factory to pjmedia endpoint.
46 *
47 * @param endpt The pjmedia endpoint.
48 * @param options Must be zero for now.
49 *
50 * @return PJ_SUCCESS on success.
51 */
52PJ_DECL(pj_status_t) pjmedia_codec_l16_init( pjmedia_endpt *endpt,
53 unsigned options);
54
55
56
57/**
58 * Unregister L16 codec factory from pjmedia endpoint.
59 *
60 * @return PJ_SUCCESS on success.
61 */
62PJ_DECL(pj_status_t) pjmedia_codec_l16_deinit(void);
63
64
65PJ_END_DECL
66
67
68#endif /* __PJMEDIA_CODEC_L16_H__ */
69