diff -r 4b0c6ed43234 -r 8e837d1bf446 gst_plugins_base/gst-libs/gst/interfaces/tunerchannel.h --- a/gst_plugins_base/gst-libs/gst/interfaces/tunerchannel.h Wed Mar 24 17:58:42 2010 -0500 +++ b/gst_plugins_base/gst-libs/gst/interfaces/tunerchannel.h Wed Mar 24 18:04:17 2010 -0500 @@ -39,6 +39,20 @@ #define GST_IS_TUNER_CHANNEL_CLASS(klass) \ (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_TUNER_CHANNEL)) +typedef struct _GstTunerChannel GstTunerChannel; +typedef struct _GstTunerChannelClass GstTunerChannelClass; + +/** + * GstTunerChannelFlags: + * @GST_TUNER_CHANNEL_INPUT: The channel is for input + * @GST_TUNER_CHANNEL_OUTPUT: The channel is for output + * @GST_TUNER_CHANNEL_FREQUENCY: The channel has a frequency setting + * and signal strength. + * @GST_TUNER_CHANNEL_AUDIO: The channel carries audio. + * + * An enumeration for flags indicating the available capabilities + * of a #GstTunerChannel. + */ typedef enum { GST_TUNER_CHANNEL_INPUT = (1<<0), GST_TUNER_CHANNEL_OUTPUT = (1<<1), @@ -46,24 +60,43 @@ GST_TUNER_CHANNEL_AUDIO = (1<<3) } GstTunerChannelFlags; +/** + * GST_TUNER_CHANNEL_HAS_FLAG: + * @channel: A #GstTunerChannel + * @flag: The flag to check for + * + * Macro to check if the given flag is set on a channel + */ #define GST_TUNER_CHANNEL_HAS_FLAG(channel, flag) \ ((channel)->flags & flag) -typedef struct _GstTunerChannel { +/** + * GstTunerChannel: + * @label: A string containing a descriptive name for this channel + * @flags: A set of #GstTunerChannelFlags for this channel + * @freq_multiplicator: The step size (in Hz) for the frequency setting. + * @min_frequency: Minimum valid frequency setting (in Hz). + * @max_frequency: Maximum valid frequency setting (in Hz). + * @min_signal: Minimum reported signal strength value. + * @max_signal: Maximum reported signal strength value. + */ +struct _GstTunerChannel { GObject parent; + /*< public >*/ gchar *label; GstTunerChannelFlags flags; gfloat freq_multiplicator; - gulong min_frequency, - max_frequency; - gint min_signal, - max_signal; -} GstTunerChannel; + gulong min_frequency; + gulong max_frequency; + gint min_signal; + gint max_signal; +}; -typedef struct _GstTunerChannelClass { +struct _GstTunerChannelClass { GObjectClass parent; + /*< private >*/ /* signals */ void (*frequency_changed) (GstTunerChannel *channel, gulong frequency); @@ -71,7 +104,7 @@ gint signal); gpointer _gst_reserved[GST_PADDING]; -} GstTunerChannelClass; +}; #ifdef __SYMBIAN32__ IMPORT_C #endif