2724da59d5db4abff62f6581bd45f8c17a0e498b
[framework/multimedia/gst-plugins-base0.10.git] / gst-libs / gst / interfaces / mixeroptions.h
1 /* GStreamer Mixer
2  * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
3  *
4  * mixeroptions.h: mixer track options object
5  * This should be a subclass of MixerItem, along with MixerOptions,
6  * but that's not possible because of API/ABI in 0.8.x. FIXME.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 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  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24 #ifndef __GST_MIXER_OPTIONS_H__
25 #define __GST_MIXER_OPTIONS_H__
26
27 #include <gst/gst.h>
28 #include <gst/interfaces/mixertrack.h>
29
30 G_BEGIN_DECLS
31
32 #define GST_TYPE_MIXER_OPTIONS \
33   (gst_mixer_options_get_type ())
34 #define GST_MIXER_OPTIONS(obj) \
35   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_MIXER_OPTIONS, \
36                                GstMixerOptions))
37 #define GST_MIXER_OPTIONS_GET_CLASS(obj) \
38   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_MIXER_OPTIONS, GstMixerOptionsClass))
39 #define GST_MIXER_OPTIONS_CLASS(klass) \
40   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_MIXER_OPTIONS, \
41                             GstMixerOptionsClass))
42 #define GST_IS_MIXER_OPTIONS(obj) \
43   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_MIXER_OPTIONS))
44 #define GST_IS_MIXER_OPTIONS_CLASS(klass) \
45   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_MIXER_OPTIONS))
46
47 typedef struct _GstMixerOptions GstMixerOptions;
48 typedef struct _GstMixerOptionsClass GstMixerOptionsClass;
49
50 /**
51  * GstMixerOptions:
52  * @parent: Parent object
53  * @values: List of option strings. Do not access this member directly,
54  *     always use gst_mixer_options_get_values() instead.
55  */
56 struct _GstMixerOptions {
57   GstMixerTrack parent;
58
59   /* list of strings (do not access directly) (FIXME 0.11: make private) */
60   GList        *values;
61
62   gpointer _gst_reserved[GST_PADDING];
63 };
64
65 /**
66  * GstMixerOptionsClass:
67  * @parent: Parent class
68  * @get_values: Optional implementation of gst_mixer_options_get_values().
69  *    (Since: 0.10.18)
70  */
71 struct _GstMixerOptionsClass {
72   GstMixerTrackClass parent;
73
74 #ifdef GST_MIXER_NEED_DEPRECATED
75   /* signals */
76   void    (* option_changed) (GstMixerOptions *opts,
77                               gchar           *value);
78 #endif /* GST_MIXER_NEED_DEPRECATED */
79
80   GList * (* get_values)     (GstMixerOptions *opts);
81
82   gpointer _gst_reserved[GST_PADDING-1];
83 };
84
85 GType           gst_mixer_options_get_type (void);
86
87 GList         * gst_mixer_options_get_values (GstMixerOptions *mixer_options);
88
89 G_END_DECLS
90
91 #endif /* __GST_MIXER_OPTIONS_H__ */