docs/gst/gstreamer-sections.txt: Make new GST_FLOW_IS_SUCCESS macro visible in docs.
[platform/upstream/gstreamer.git] / plugins / elements / gstfakesink.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *
5  * gstfakesink.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_FAKE_SINK_H__
25 #define __GST_FAKE_SINK_H__
26
27 #include <gst/gst.h>
28 #include <gst/base/gstbasesink.h>
29
30 G_BEGIN_DECLS
31
32
33 #define GST_TYPE_FAKE_SINK \
34   (gst_fake_sink_get_type())
35 #define GST_FAKE_SINK(obj) \
36   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_FAKE_SINK,GstFakeSink))
37 #define GST_FAKE_SINK_CLASS(klass) \
38   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_FAKE_SINK,GstFakeSinkClass))
39 #define GST_IS_FAKE_SINK(obj) \
40   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_FAKE_SINK))
41 #define GST_IS_FAKE_SINK_CLASS(obj) \
42   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_FAKE_SINK))
43
44 /**
45  * GstFakeSinkStateError:
46  * @FAKE_SINK_STATE_ERROR_NONE: no error
47  * @FAKE_SINK_STATE_ERROR_NULL_READY: cause the NULL to READY state change to fail
48  * @FAKE_SINK_STATE_ERROR_READY_PAUSED: cause the READY to PAUSED state change to fail:
49  * @FAKE_SINK_STATE_ERROR_PAUSED_PLAYING: cause the PAUSED to PLAYING state change to fail:
50  * @FAKE_SINK_STATE_ERROR_PLAYING_PAUSED: cause the PLAYING to PAUSED state change to fail:
51  * @FAKE_SINK_STATE_ERROR_PAUSED_READY: cause the PAUSED to READY state change to fail:
52  * @FAKE_SINK_STATE_ERROR_READY_NULL: cause the READY to NULL state change to fail:
53  *
54  * Possible state change errors for the state-error property.
55  */
56 typedef enum {
57   FAKE_SINK_STATE_ERROR_NONE = 0,
58   FAKE_SINK_STATE_ERROR_NULL_READY,
59   FAKE_SINK_STATE_ERROR_READY_PAUSED,
60   FAKE_SINK_STATE_ERROR_PAUSED_PLAYING,
61   FAKE_SINK_STATE_ERROR_PLAYING_PAUSED,
62   FAKE_SINK_STATE_ERROR_PAUSED_READY,
63   FAKE_SINK_STATE_ERROR_READY_NULL
64 } GstFakeSinkStateError;
65
66 typedef struct _GstFakeSink GstFakeSink;
67 typedef struct _GstFakeSinkClass GstFakeSinkClass;
68
69 /**
70  * GstFakeSink:
71  *
72  * The opaque #GstFakeSink data structure.
73  */
74 struct _GstFakeSink {
75   GstBaseSink           element;
76
77   gboolean              silent;
78   gboolean              dump;
79   gboolean              signal_handoffs;
80   GstFakeSinkStateError state_error;
81   gchar                 *last_message;
82 };
83
84 struct _GstFakeSinkClass {
85   GstBaseSinkClass parent_class;
86
87   /* signals */
88   void (*handoff) (GstElement *element, GstBuffer *buf, GstPad *pad);
89   void (*preroll_handoff) (GstElement *element, GstBuffer *buf, GstPad *pad);
90 };
91
92 GType gst_fake_sink_get_type (void);
93
94 G_END_DECLS
95
96 #endif /* __GST_FAKE_SINK_H__ */