blob: bb4e8e60d897e640f7aed3e4d392249392e6296f [file] [log] [blame]
Benny Prijonoc5859882006-07-31 15:25:14 +00001/* $Id$ */
2/*
Benny Prijonoa771a512007-02-19 01:13:53 +00003 * Copyright (C)2003-2007 Benny Prijono <benny@prijono.org>
Benny Prijonoc5859882006-07-31 15:25:14 +00004 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
19#ifndef __PJMEDIA_CODEC_ILBC_H__
20#define __PJMEDIA_CODEC_ILBC_H__
21
22/**
23 * @file pjmedia-codec/ilbc.h
24 * @brief iLBC codec.
25 */
26
27#include <pjmedia-codec/types.h>
28
29/**
30 * @defgroup PJMED_ILBC iLBC Codec
31 * @ingroup PJMEDIA_CODEC
32 * @brief Implementation of iLBC Codec
33 * @{
Benny Prijono5b64b8d2008-06-20 21:39:02 +000034 *
Benny Prijonoc5859882006-07-31 15:25:14 +000035 * This section describes functions to register and register iLBC codec
36 * factory to the codec manager. After the codec factory has been registered,
37 * application can use @ref PJMEDIA_CODEC API to manipulate the codec.
38 */
39
40PJ_BEGIN_DECL
41
42
43/**
44 * Initialize and register iLBC codec factory to pjmedia endpoint.
45 *
46 * @param endpt The pjmedia endpoint.
47 * @param mode Default decoder mode to be used. Valid values are
48 * 20 and 30 ms. Note that encoder mode follows the
49 * setting advertised in the remote's SDP.
50 *
51 * @return PJ_SUCCESS on success.
52 */
53PJ_DECL(pj_status_t) pjmedia_codec_ilbc_init( pjmedia_endpt *endpt,
54 int mode );
55
56
57
58/**
59 * Unregister iLBC codec factory from pjmedia endpoint and deinitialize
60 * the iLBC codec library.
61 *
62 * @return PJ_SUCCESS on success.
63 */
64PJ_DECL(pj_status_t) pjmedia_codec_ilbc_deinit(void);
65
66
67PJ_END_DECL
68
69
70/**
71 * @}
72 */
73
74#endif /* __PJMEDIA_CODEC_ILBC_H__ */
75