gsttuner

gsttuner — Interface for elements providing tuner operations

Synopsis


#include <gst/interfaces/tuner.h>


            GstTuner;
const GList* gst_tuner_list_channels        (GstTuner *tuner);
GstTunerChannel* gst_tuner_get_channel      (GstTuner *tuner);
void        gst_tuner_set_channel           (GstTuner *tuner,
                                             GstTunerChannel *channel);
const GList* gst_tuner_list_norms           (GstTuner *tuner);
GstTunerNorm* gst_tuner_get_norm            (GstTuner *tuner);
void        gst_tuner_set_norm              (GstTuner *tuner,
                                             GstTunerNorm *norm);
gulong      gst_tuner_get_frequency         (GstTuner *tuner,
                                             GstTunerChannel *channel);
void        gst_tuner_set_frequency         (GstTuner *tuner,
                                             GstTunerChannel *channel,
                                             gulong frequency);
gint        gst_tuner_signal_strength       (GstTuner *tuner,
                                             GstTunerChannel *channel);
GstTunerNorm* gst_tuner_find_norm_by_name   (GstTuner *tuner,
                                             gchar *norm);
GstTunerChannel* gst_tuner_find_channel_by_name
                                            (GstTuner *tuner,
                                             gchar *channel);
void        gst_tuner_channel_changed       (GstTuner *tuner,
                                             GstTunerChannel *channel);
void        gst_tuner_norm_changed          (GstTuner *tuner,
                                             GstTunerNorm *norm);
void        gst_tuner_frequency_changed     (GstTuner *tuner,
                                             GstTunerChannel *channel,
                                             gulong frequency);
void        gst_tuner_signal_changed        (GstTuner *tuner,
                                             GstTunerChannel *channel,
                                             gint signal);

Object Hierarchy


  GInterface
   +----GstTuner

Prerequisites

GstTuner requires GstImplementsInterface and GstElement.

Description

Details

GstTuner

typedef struct _GstTuner GstTuner;


gst_tuner_list_channels ()

const GList* gst_tuner_list_channels        (GstTuner *tuner);

Retrieve a list of channels (e.g. 'composite', 's-video', ...) from the given tuner object.

tuner :tuner the GstTuner (a GstElement) to get the channels from. the GstTuner (a GstElement) to get the channels from. GstTunerGstTunerGstElementGstElementReturns :Returns a list of channels available on this tuner. a list of channels available on this tuner.
tuner : the GstTuner (a GstElement) to get the channels from.
Returns : a list of channels available on this tuner.

gst_tuner_get_channel ()

GstTunerChannel* gst_tuner_get_channel      (GstTuner *tuner);

tuner :tuner Returns :Returns
tuner :
Returns :

gst_tuner_set_channel ()

void        gst_tuner_set_channel           (GstTuner *tuner,
                                             GstTunerChannel *channel);

Tunes the object to the given channel.

tuner :tuner the GstTuner (a GstElement) that owns the channel. the GstTuner (a GstElement) that owns the channel. GstTunerGstTunerGstElementGstElementchannel :channel the channel to tune to. the channel to tune to.
tuner : the GstTuner (a GstElement) that owns the channel.
channel : the channel to tune to.

gst_tuner_list_norms ()

const GList* gst_tuner_list_norms           (GstTuner *tuner);

tuner :tuner Returns :Returns
tuner :
Returns :

gst_tuner_get_norm ()

GstTunerNorm* gst_tuner_get_norm            (GstTuner *tuner);

Get the current video norm from the given tuner object for the currently selected channel.

tuner :tuner the GstTuner (a GstElement) to get the current norm from. the GstTuner (a GstElement) to get the current norm from. GstTunerGstTunerGstElementGstElementReturns :Returns the current norm. the current norm.
tuner : the GstTuner (a GstElement) to get the current norm from.
Returns : the current norm.

gst_tuner_set_norm ()

void        gst_tuner_set_norm              (GstTuner *tuner,
                                             GstTunerNorm *norm);

Changes the video norm on this tuner to the given norm.

tuner :tuner the GstTuner (a GstElement) to set the norm on. the GstTuner (a GstElement) to set the norm on. GstTunerGstTunerGstElementGstElementnorm :norm the norm to use for the current channel. the norm to use for the current channel.
tuner : the GstTuner (a GstElement) to set the norm on.
norm : the norm to use for the current channel.

gst_tuner_get_frequency ()

gulong      gst_tuner_get_frequency         (GstTuner *tuner,
                                             GstTunerChannel *channel);

Retrieve the current frequency from the given channel. The same applies as for set_frequency(): check the flag.

tuner :tuner the GstTuner (a GstElement) that owns the given channel. the GstTuner (a GstElement) that owns the given channel. GstTunerGstTunerGstElementGstElementchannel :channel the GstTunerChannel to retrieve the frequency from. the GstTunerChannel to retrieve the frequency from. GstTunerChannelGstTunerChannelReturns :Returns the current frequency, or 0 on error. the current frequency, or 0 on error.
tuner : the GstTuner (a GstElement) that owns the given channel.
channel : the GstTunerChannel to retrieve the frequency from.
Returns : the current frequency, or 0 on error.

gst_tuner_set_frequency ()

void        gst_tuner_set_frequency         (GstTuner *tuner,
                                             GstTunerChannel *channel,
                                             gulong frequency);

Sets a tuning frequency on the given tuner/channel. Note that this requires the given channel to be a "tuning" channel, which can be checked using GST_TUNER_CHANNEL_HAS_FLAG(), with the proper flag being GST_TUNER_CHANNEL_FREQUENCY.

tuner :tuner the Gsttuner (a GstElement) that owns the given channel. the Gsttuner (a GstElement) that owns the given channel. GsttunerGsttunerGstElementGstElementchannel :channel the GstTunerChannel to set the frequency on. the GstTunerChannel to set the frequency on. GstTunerChannelGstTunerChannelfrequency :frequency the frequency to tune in to. the frequency to tune in to.
tuner : the Gsttuner (a GstElement) that owns the given channel.
channel : the GstTunerChannel to set the frequency on.
frequency : the frequency to tune in to.

gst_tuner_signal_strength ()

gint        gst_tuner_signal_strength       (GstTuner *tuner,
                                             GstTunerChannel *channel);

tuner :tuner channel :channel Returns :Returns
tuner :
channel :
Returns :

gst_tuner_find_norm_by_name ()

GstTunerNorm* gst_tuner_find_norm_by_name   (GstTuner *tuner,
                                             gchar *norm);

tuner :tuner norm :norm Returns :Returns
tuner :
norm :
Returns :

gst_tuner_find_channel_by_name ()

GstTunerChannel* gst_tuner_find_channel_by_name
                                            (GstTuner *tuner,
                                             gchar *channel);

tuner :tuner channel :channel Returns :Returns
tuner :
channel :
Returns :

gst_tuner_channel_changed ()

void        gst_tuner_channel_changed       (GstTuner *tuner,
                                             GstTunerChannel *channel);

tuner :tuner channel :channel
tuner :
channel :

gst_tuner_norm_changed ()

void        gst_tuner_norm_changed          (GstTuner *tuner,
                                             GstTunerNorm *norm);

tuner :tuner norm :norm
tuner :
norm :

gst_tuner_frequency_changed ()

void        gst_tuner_frequency_changed     (GstTuner *tuner,
                                             GstTunerChannel *channel,
                                             gulong frequency);

tuner :tuner channel :channel frequency :frequency
tuner :
channel :
frequency :

gst_tuner_signal_changed ()

void        gst_tuner_signal_changed        (GstTuner *tuner,
                                             GstTunerChannel *channel,
                                             gint signal);

tuner :tuner channel :channel signal :signal
tuner :
channel :
signal :