a bunch of gtk-doc fixes
[platform/upstream/gstreamer.git] / plugins / elements / gstfilesink.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstfilesink.h: 
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23
24 #ifndef __GST_FILESINK_H__
25 #define __GST_FILESINK_H__
26
27
28 #include <config.h>
29 #include <gst/gst.h>
30
31 G_BEGIN_DECLS
32
33 GstElementDetails gst_filesink_details;
34
35
36 #define GST_TYPE_FILESINK \
37   (gst_filesink_get_type())
38 #define GST_FILESINK(obj) \
39   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_FILESINK,GstFileSink))
40 #define GST_FILESINK_CLASS(klass) \
41   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_FILESINK,GstFileSinkClass))
42 #define GST_IS_FILESINK(obj) \
43   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_FILESINK))
44 #define GST_IS_FILESINK_CLASS(obj) \
45   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_FILESINK))
46
47 typedef struct _GstFileSink GstFileSink;
48 typedef struct _GstFileSinkClass GstFileSinkClass;
49
50 typedef enum {
51   GST_FILESINK_OPEN             = GST_ELEMENT_FLAG_LAST,
52
53   GST_FILESINK_FLAG_LAST        = GST_ELEMENT_FLAG_LAST + 2
54 } GstFileSinkFlags;
55
56 struct _GstFileSink {
57   GstElement element;
58
59   gchar *filename;
60   FILE *file;
61
62   gint filenum;
63
64   guint64 data_written;
65   gint maxfilesize;
66 };
67
68 struct _GstFileSinkClass {
69   GstElementClass parent_class;
70
71   /* signals */
72   void (*handoff) (GstElement *element,GstPad *pad);
73 };
74
75 GType gst_filesink_get_type(void);
76
77 G_END_DECLS
78
79 #endif /* __GST_FILESINK_H__ */