src/framework/*: improve the doxygen documentation (work in progress). This also...
[melted] / src / framework / mlt_property.h
1 /**
2 * \file mlt_property.h
3 * \brief Property class declaration
4 *
5 * Copyright (C) 2003-2008 Ushodaya Enterprises Limited
6 * \author Charles Yates <charles.yates@pandora.be>
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
23 #ifndef _MLT_PROPERTY_H_
24 #define _MLT_PROPERTY_H_
25
26 #include "mlt_types.h"
27
28 extern mlt_property mlt_property_init( );
29 extern int mlt_property_set_int( mlt_property self, int value );
30 extern int mlt_property_set_double( mlt_property self, double value );
31 extern int mlt_property_set_position( mlt_property self, mlt_position value );
32 extern int mlt_property_set_int64( mlt_property self, int64_t value );
33 extern int mlt_property_set_string( mlt_property self, const char *value );
34 extern int mlt_property_set_data( mlt_property self, void *value, int length, mlt_destructor destructor, mlt_serialiser serialiser );
35 extern int mlt_property_get_int( mlt_property self );
36 extern double mlt_property_get_double( mlt_property self );
37 extern mlt_position mlt_property_get_position( mlt_property self );
38 extern int64_t mlt_property_get_int64( mlt_property self );
39 extern char *mlt_property_get_string( mlt_property self );
40 extern void *mlt_property_get_data( mlt_property self, int *length );
41 extern void mlt_property_close( mlt_property self );
42
43 extern void mlt_property_pass( mlt_property this, mlt_property that );
44
45 #endif