gsttunerchannel

## gsttunerchannel gsttunerchannel — A channel from an element implementing the GstTuner interface. |

## Functions

#define | GST_TUNER_CHANNEL_HAS_FLAG()

## Signals

void | frequency-changed | Run Last
void | signal-changed | Run Last

## Types and Values

struct | GstTunerChannel
enum | GstTunerChannelFlags

## Object Hierarchy

        GObject
        ╰── GstTunerChannel

## Includes

    #include <gst/interfaces/tuner.h>

## Description

The GstTunerChannel object is provided by an element implementing the GstTuner interface.

GstTunerChannel provides a name and flags to determine the type and capabilities of the channel. If the GST_TUNER_CHANNEL_FREQUENCY flag is set, then the channel also information about the minimum and maximum frequency, and range of the reported signal strength.

## Functions

### GST_TUNER_CHANNEL_HAS_FLAG()

    #define             GST_TUNER_CHANNEL_HAS_FLAG(channel, flag)

Macro to check if the given flag is set on a channel

#### Parameters

channel | A GstTunerChannel |
flag | The flag to check for |

## Types and Values

### struct GstTunerChannel

    struct GstTunerChannel {
      gchar               *label;
      GstTunerChannelFlags flags;
      gfloat               freq_multiplicator;
      gulong               min_frequency;
      gulong               max_frequency;
      gint                 min_signal;
      gint                 max_signal;
    };

#### Members

gchar *`label`; | A string containing a descriptive name for this channel |
GstTunerChannelFlags `flags`; | A set of GstTunerChannelFlags for this channel |
gfloat `freq_multiplicator`; | The step size (in Hz) for the frequency setting. |
gulong `min_frequency`; | Minimum valid frequency setting (in Hz). |
gulong `max_frequency`; | Maximum valid frequency setting (in Hz). |
gint `min_signal`; | Minimum reported signal strength value. |
gint `max_signal`; | Maximum reported signal strength value. |

### enum GstTunerChannelFlags

An enumeration for flags indicating the available capabilities of a GstTunerChannel.

#### Members

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. |

## Signal Details

### The `“frequency-changed”` signal

    void
    user_function (GstTunerChannel *tunerchannel,
                   gulong           frequency,
                   gpointer         user_data)

Reports that the current frequency has changed.

#### Parameters

tunerchannel | The GstTunerChannel |
frequency | The new frequency (an unsigned long) |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

### The `“signal-changed”` signal

    void
    user_function (GstTunerChannel *tunerchannel,
                   gint             signal,
                   gpointer         user_data)

Reports that the signal strength has changed.

See Also: `gst_tuner_signal_strength()`

#### Parameters

tunerchannel | The GstTunerChannel |
signal | The new signal strength (an integer) |
user_data | user data set when the signal handler was connected. |

Flags: Run Last