gstreamer/gst-libs/gst/interfaces/mixeroptions.h

/* GStreamer Mixer
 * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
 *
 * mixeroptions.h: mixer track options object
 * This should be a subclass of MixerItem, along with MixerOptions,
 * but that's not possible because of API/ABI in 0.8.x. FIXME.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef __GST_MIXER_OPTIONS_H__
#define __GST_MIXER_OPTIONS_H__

#include <gst/gst.h>
#include <gst/interfaces/mixertrack.h>

G_BEGIN_DECLS

#define GST_TYPE_MIXER_OPTIONS \
  (gst_mixer_options_get_type ())
#define GST_MIXER_OPTIONS(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_MIXER_OPTIONS, \
                               GstMixerOptions))
#define GST_MIXER_OPTIONS_GET_CLASS(obj) \
  (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_MIXER_OPTIONS, GstMixerOptionsClass))
#define GST_MIXER_OPTIONS_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_MIXER_OPTIONS, \
                            GstMixerOptionsClass))
#define GST_IS_MIXER_OPTIONS(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_MIXER_OPTIONS))
#define GST_IS_MIXER_OPTIONS_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_MIXER_OPTIONS))

typedef struct _GstMixerOptions GstMixerOptions;
typedef struct _GstMixerOptionsClass GstMixerOptionsClass;

/**
 * GstMixerOptions:
 * @values: List of option strings. Do not access this member directly,
 *     always use gst_mixer_options_get_values() instead.
 *
 * Mixer control object.
 */
struct _GstMixerOptions {
  GstMixerTrack parent;

  /*< public >*/
  /* list of strings (do not access directly) (FIXME 0.11: make private) */
  GList        *values;

  /*< private >*/
  gpointer _gst_reserved[GST_PADDING];
};

/**
 * GstMixerOptionsClass:
 * @parent: the parent class
 * @get_values: Optional implementation of gst_mixer_options_get_values().
 *    (Since: 0.10.18)
 */
struct _GstMixerOptionsClass {
  GstMixerTrackClass parent;

  GList * (* get_values)     (GstMixerOptions *opts);

  gpointer _gst_reserved[GST_PADDING];
};

GType           gst_mixer_options_get_type (void);

GList         * gst_mixer_options_get_values (GstMixerOptions *mixer_options);

G_END_DECLS

#endif /* __GST_MIXER_OPTIONS_H__ */