gstreamermm: Gst::Tuner Class Reference

Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions

# Gst::Tuner Class Reference
[gstreamermm Interfaces]

An interface for elements providing tuner operations. More...

Inherits Glib::Interface.

Collaboration diagram for Gst::Tuner:
[legend]

List of all members.

## Public Member Functions
virtual | ~Tuner ()
GstTuner* | gobj ()
| Provides access to the underlying C GObject.
const GstTuner* | gobj () const
| Provides access to the underlying C GObject.
Glib::ListHandle< Glib::RefPtr < Gst::TunerChannel > > | list_channels ()
| Retrieve a List of Gst::TunerChannels available (e.g. 'composite', 's-video', ...) from the given tuner object.
Glib::ListHandle< Glib::RefPtr < const Gst::TunerChannel > > | list_channels () const
| Retrieve a List of Gst::TunerChannels available (e.g. 'composite', 's-video', ...) from the given tuner object.
Glib::RefPtr< Gst::TunerChannel > | get_channel ()
| Retrieve the current channel from the tuner.
Glib::RefPtr< const Gst::TunerChannel > | get_channel () const
| Retrieve the current channel from the tuner.
void | set_channel (const Glib::RefPtr< Gst::TunerChannel >& channel)
| Tunes the object to the given channel, which should be one of the channels returned by list_channels().
Glib::ListHandle< Glib::RefPtr < Gst::TunerNorm > > | list_norms ()
| Retrieve a GList of available Gst::TunerNorm settings for the currently tuned channel on the given tuner object.
Glib::ListHandle< Glib::RefPtr < const Gst::TunerNorm > > | list_norms () const
| Retrieve a GList of available Gst::TunerNorm settings for the currently tuned channel on the given tuner object.
Glib::RefPtr< Gst::TunerNorm > | get_norm ()
| Get the current video norm from the given tuner object for the currently selected channel.
Glib::RefPtr< const Gst::TunerNorm > | get_norm () const
| Get the current video norm from the given tuner object for the currently selected channel.
void | set_norm (const Glib::RefPtr< Gst::TunerNorm >&norm)
| Changes the video norm on this tuner to the given norm, which should be one of the norms returned by list_norms().
gulong | get_frequency (const Glib::RefPtr< const Gst::TunerChannel >& channel) const
| Retrieve the current frequency from the given channel.
void | set_frequency (const Glib::RefPtr< Gst::TunerChannel >& channel, gulong frequency)
| Sets a tuning frequency on the given tuner/channel.
int | get_signal_strength (const Glib::RefPtr< Gst::TunerChannel >& channel)
| Get the strength of the signal on this channel.
Glib::RefPtr< Gst::TunerNorm > | find_norm (const Glib::ustring&norm)
| Look up a Gst::TunerNorm by name.
Glib::RefPtr< const Gst::TunerNorm > | find_norm (const Glib::ustring&norm) const
| Look up a Gst::TunerNorm by name.
Glib::RefPtr< Gst::TunerChannel > | find_channel (const Glib::ustring& channel)
| Look up a Gst::TunerChannel by name.
Glib::RefPtr< const Gst::TunerChannel > | find_channel (const Glib::ustring& channel) const
| Look up a Gst::TunerChannel by name.
void | channel_changed (const Glib::RefPtr< Gst::TunerChannel >& channel)
| Called by elements implementing the Gst::Tuner interface when the current channel changes.
void | norm_changed (const Glib::RefPtr< Gst::TunerNorm >&norm)
| Called by elements implementing the Gst::Tuner interface when the current norm changes.
void | frequency_changed (const Glib::RefPtr< Gst::TunerChannel >& channel, gulong frequency)
| Called by elements implementing the Gst::Tuner interface when the configured frequency changes.
void | signal_changed (const Glib::RefPtr< Gst::TunerChannel >& channel, int signal)
| Called by elements implementing the Gst::Tuner interface when the incoming signal strength changes.
Glib::SignalProxy1< void, const Glib::RefPtr < Gst::TunerChannel >& > | signal_channel_changed ()
| Reports that the current Gst::TunerChannel has changed.
Glib::SignalProxy2< void, const Glib::RefPtr < Gst::TunerChannel > &, gulong > | signal_frequency_changed ()
| Reports that the current frequency has changed.
Glib::SignalProxy1< void, const Glib::RefPtr < Gst::TunerNorm >& > | signal_norm_changed ()
| Reports that the current Gst::TunerNorm has changed.
Glib::SignalProxy2< void, const Glib::RefPtr < Gst::TunerChannel >&, int > | signal_signal_changed ()
| Reports that the signal strength has changed.
virtual Glib::ListHandle < Glib::RefPtr < Gst::TunerChannel > > | list_channels_vfunc () const
virtual void | set_channel_vfunc (const Glib::RefPtr< Gst::TunerChannel >& channel)
virtual Glib::RefPtr < Gst::TunerChannel > | get_channel_vfunc () const
virtual Glib::ListHandle < Glib::RefPtr< Gst::TunerNorm > > | list_norms_vfunc () const
virtual void | set_norm_vfunc (const Glib::RefPtr< Gst::TunerNorm >&norm)
virtual Glib::RefPtr < Gst::TunerNorm > | get_norm_vfunc () const
virtual void | set_frequency_vfunc (const Glib::RefPtr< Gst::TunerChannel >& channel, gulong frequency)
virtual gulong | get_frequency_vfunc (const Glib::RefPtr< Gst::TunerChannel >& channel) const
virtual int | signal_strength_vfunc (const Glib::RefPtr< Gst::TunerChannel >& channel) const
## Static Public Member Functions
static void | add_interface (GType gtype_implementer)
## Protected Member Functions
virtual void | on_channel_changed (const Glib::RefPtr< Gst::TunerChannel >& channel)
virtual void | on_frequency_changed (const Glib::RefPtr< Gst::TunerChannel >& channel, gulong frequency)
virtual void | on_norm_changed (const Glib::RefPtr< Gst::TunerNorm >&norm)
virtual void | on_signal_changed (const Glib::RefPtr< Gst::TunerChannel >& channel, int signal)
## Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gst::Tuner > | wrap (GstTuner* object, bool take_copy=false)
| A Glib::wrap() method for this object.

## Detailed Description

An interface for elements providing tuner operations.

## Constructor & Destructor Documentation

virtual Gst::Tuner::~Tuner | ( |  | ) | `[virtual]`

## Member Function Documentation

static void Gst::Tuner::add_interface | ( | GType | gtype_implementer | ) | `[static]`

void Gst::Tuner::channel_changed | ( | const Glib::RefPtr< Gst::TunerChannel >& | channel | ) |

Called by elements implementing the Gst::Tuner interface when the current channel changes.

Fires the Gst::Tuner::channel-changed signal.

Parameters:

  | channel | A Gst::TunerChannel instance.

Glib::RefPtr<Gst::TunerChannel> Gst::Tuner::find_channel | ( | const Glib::ustring & | channel | ) |

Look up a Gst::TunerChannel by name.

Parameters:

  | channel | A string containing the name of a Gst::TunerChannel.

Returns:
  A Gst::TunerChannel, or `0` if no channel with the provided name is available.

Glib::RefPtr<const Gst::TunerChannel> Gst::Tuner::find_channel | ( | const Glib::ustring & | channel | ) | const

Look up a Gst::TunerChannel by name.

Parameters:

  | channel | A string containing the name of a Gst::TunerChannel.

Returns:
  A Gst::TunerChannel, or `0` if no channel with the provided name is available.

Glib::RefPtr<Gst::TunerNorm> Gst::Tuner::find_norm | ( | const Glib::ustring & | norm | ) |

Look up a Gst::TunerNorm by name.

Parameters:

  | norm | A string containing the name of a Gst::TunerNorm.

Returns:
  A Gst::TunerNorm, or `0` if no norm with the provided name is available.

Glib::RefPtr<const Gst::TunerNorm> Gst::Tuner::find_norm | ( | const Glib::ustring & | norm | ) | const

Look up a Gst::TunerNorm by name.

Parameters:

  | norm | A string containing the name of a Gst::TunerNorm.

Returns:
  A Gst::TunerNorm, or `0` if no norm with the provided name is available.

void Gst::Tuner::frequency_changed | ( | const Glib::RefPtr< Gst::TunerChannel >& | channel,
|  | gulong | frequency |
| ) |  |  |

Called by elements implementing the Gst::Tuner interface when the configured frequency changes.

Fires the Gst::Tuner::frequency-changed signal on the tuner, and the Gst::TunerChannel::frequency-changed signal on the channel.

Parameters:

  | channel | The current Gst::TunerChannel.
  | frequency | The new frequency setting.

Glib::RefPtr<Gst::TunerChannel> Gst::Tuner::get_channel | ( |  | ) |

Retrieve the current channel from the tuner.

Returns:
  The current channel of the tuner object.

Glib::RefPtr<const Gst::TunerChannel> Gst::Tuner::get_channel | ( |  | ) | const

Retrieve the current channel from the tuner.

Returns:
  The current channel of the tuner object.

virtual Glib::RefPtr<Gst::TunerChannel> Gst::Tuner::get_channel_vfunc | ( |  | ) | const`[virtual]`

gulong Gst::Tuner::get_frequency | ( | const Glib::RefPtr< const Gst::TunerChannel >& | channel | ) | const

Retrieve the current frequency from the given channel.

As for set_frequency(), the Gst::TunerChannel must support frequency operations, as indicated by the GST_TUNER_CHANNEL_FREQUENCY flag.

Parameters:

  | channel | The Gst::TunerChannel to retrieve the frequency from.

Returns:
  The current frequency, or 0 on error.

virtual gulong Gst::Tuner::get_frequency_vfunc | ( | const Glib::RefPtr< Gst::TunerChannel >& | channel | ) | const`[virtual]`

Glib::RefPtr<Gst::TunerNorm> Gst::Tuner::get_norm | ( |  | ) |

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

Returns:
  The current norm.

Glib::RefPtr<const Gst::TunerNorm> Gst::Tuner::get_norm | ( |  | ) | const

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

Returns:
  The current norm.

virtual Glib::RefPtr<Gst::TunerNorm> Gst::Tuner::get_norm_vfunc | ( |  | ) | const`[virtual]`

int Gst::Tuner::get_signal_strength | ( | const Glib::RefPtr< Gst::TunerChannel >& | channel | ) |

Get the strength of the signal on this channel.

Note that this requires the current channel to be a "tuning" channel, i.e. a channel on which frequency can be set. This can be checked using GST_TUNER_CHANNEL_HAS_FLAG (), and the appropriate flag to check for is GST_TUNER_CHANNEL_FREQUENCY.

The valid range of the signal strength is indicated in the min_signal and max_signal properties of the Gst::TunerChannel.

Parameters:

  | channel | The Gst::TunerChannel to get the signal strength from.

Returns:
  Signal strength, or 0 on error.

GstTuner* Gst::Tuner::gobj | ( |  | ) | `[inline]`

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

const GstTuner* Gst::Tuner::gobj | ( |  | ) | const`[inline]`

Provides access to the underlying C GObject.

Reimplemented from Glib::Interface.

Glib::ListHandle< Glib::RefPtr<const Gst::TunerChannel> > Gst::Tuner::list_channels | ( |  | ) | const

Retrieve a List of Gst::TunerChannels available (e.g. 'composite', 's-video', ...) from the given tuner object.

Returns:
  A list of channels available on this tuner. The list is owned by the GstTuner and must not be freed.

Glib::ListHandle< Glib::RefPtr<Gst::TunerChannel> > Gst::Tuner::list_channels | ( |  | ) |

Retrieve a List of Gst::TunerChannels available (e.g. 'composite', 's-video', ...) from the given tuner object.

Returns:
  A list of channels available on this tuner. The list is owned by the GstTuner and must not be freed.

virtual Glib::ListHandle< Glib::RefPtr<Gst::TunerChannel> > Gst::Tuner::list_channels_vfunc | ( |  | ) | const`[virtual]`

Glib::ListHandle< Glib::RefPtr<Gst::TunerNorm> > Gst::Tuner::list_norms | ( |  | ) |

Retrieve a GList of available Gst::TunerNorm settings for the currently tuned channel on the given tuner object.

Returns:
  A list of norms available on the current channel for this tuner object. The list is owned by the GstTuner and must not be freed.

Glib::ListHandle< Glib::RefPtr<const Gst::TunerNorm> > Gst::Tuner::list_norms | ( |  | ) | const

Retrieve a GList of available Gst::TunerNorm settings for the currently tuned channel on the given tuner object.

Returns:
  A list of norms available on the current channel for this tuner object. The list is owned by the GstTuner and must not be freed.

virtual Glib::ListHandle< Glib::RefPtr<Gst::TunerNorm> > Gst::Tuner::list_norms_vfunc | ( |  | ) | const`[virtual]`

void Gst::Tuner::norm_changed | ( | const Glib::RefPtr< Gst::TunerNorm >& | norm | ) |

Called by elements implementing the Gst::Tuner interface when the current norm changes.

Fires the Gst::Tuner::norm-changed signal.

Parameters:

  | norm | A Gst::TunerNorm instance.

virtual void Gst::Tuner::on_channel_changed | ( | const Glib::RefPtr< Gst::TunerChannel >& | channel | ) | `[protected, virtual]`

virtual void Gst::Tuner::on_frequency_changed | ( | const Glib::RefPtr< Gst::TunerChannel >& | channel,
|  | gulong | frequency |
| ) |  |  | `[protected, virtual]`

virtual void Gst::Tuner::on_norm_changed | ( | const Glib::RefPtr< Gst::TunerNorm >& | norm | ) | `[protected, virtual]`

virtual void Gst::Tuner::on_signal_changed | ( | const Glib::RefPtr< Gst::TunerChannel >& | channel,
|  | int | signal |
| ) |  |  | `[protected, virtual]`

void Gst::Tuner::set_channel | ( | const Glib::RefPtr< Gst::TunerChannel >& | channel | ) |

Tunes the object to the given channel, which should be one of the channels returned by list_channels().

Parameters:

  | channel | The channel to tune to.

virtual void Gst::Tuner::set_channel_vfunc | ( | const Glib::RefPtr< Gst::TunerChannel >& | channel | ) | `[virtual]`

void Gst::Tuner::set_frequency | ( | const Glib::RefPtr< Gst::TunerChannel >& | 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.

The frequency is in Hz, with minimum steps indicated by the frequency_multiplicator provided in the Gst::TunerChannel. The valid range is provided in the min_frequency and max_frequency properties of the Gst::TunerChannel.

Parameters:

  | channel | The Gst::TunerChannel to set the frequency on.
  | frequency | The frequency to tune in to.

virtual void Gst::Tuner::set_frequency_vfunc | ( | const Glib::RefPtr< Gst::TunerChannel >& | channel,
|  | gulong | frequency |
| ) |  |  | `[virtual]`

void Gst::Tuner::set_norm | ( | const Glib::RefPtr< Gst::TunerNorm >& | norm | ) |

Changes the video norm on this tuner to the given norm, which should be one of the norms returned by list_norms().

Parameters:

  | norm | The norm to use for the current channel.

virtual void Gst::Tuner::set_norm_vfunc | ( | const Glib::RefPtr< Gst::TunerNorm >& | norm | ) | `[virtual]`

void Gst::Tuner::signal_changed | ( | const Glib::RefPtr< Gst::TunerChannel >& | channel,
|  | int | signal |
| ) |  |  |

Called by elements implementing the Gst::Tuner interface when the incoming signal strength changes.

Fires the Gst::Tuner::signal-changed signal on the tuner and the Gst::TunerChannel::signal-changed signal on the channel.

Parameters:

  | channel | The current Gst::TunerChannel.
  | signal | The new signal strength.

Glib::SignalProxy1< void,const Glib::RefPtr<Gst::TunerChannel>& > Gst::Tuner::signal_channel_changed | ( |  | ) |

Reports that the current Gst::TunerChannel has changed.

Parameters:

  | channel | The Gst::TunerChannel that has changed.

Prototype:
  `void on_my_channel_changed(const Glib::RefPtr<Gst::TunerChannel>& channel)`

Glib::SignalProxy2< void,const Glib::RefPtr<Gst::TunerChannel>&,gulong > Gst::Tuner::signal_frequency_changed | ( |  | ) |

Reports that the current frequency has changed.

Parameters:

  | channel | The Gst::TunerChannel who's frequency has changed.
  | frequency | The new frequency.

Prototype:
  `void on_my_frequency_changed(const Glib::RefPtr<Gst::TunerChannel>& channel, gulong frequency)`

Glib::SignalProxy1< void,const Glib::RefPtr<Gst::TunerNorm>& > Gst::Tuner::signal_norm_changed | ( |  | ) |

Reports that the current Gst::TunerNorm has changed.

Parameters:

  | norm | The Gst::TunerNorm that has changed.

Prototype:
  `void on_my_norm_changed(const Glib::RefPtr<Gst::TunerNorm>& norm)`

Glib::SignalProxy2< void,const Glib::RefPtr<Gst::TunerChannel>&,int > Gst::Tuner::signal_signal_changed | ( |  | ) |

Reports that the signal strength has changed.

Parameters:

  | channel | The Gst::TunerChannel who's signal has changed.
  | signal | The new signal.

Prototype:
  `void on_my_signal_changed(const Glib::RefPtr<Gst::TunerChannel>& channel, int signal)`

virtual int Gst::Tuner::signal_strength_vfunc | ( | const Glib::RefPtr< Gst::TunerChannel >& | channel | ) | const`[virtual]`

## Friends And Related Function Documentation

Glib::RefPtr< Gst::Tuner > wrap | ( | GstTuner * | object,
|  | bool | take_copy = `false` |
| ) |  |  | `[related]`

A Glib::wrap() method for this object.

Parameters:

  | object | The C instance.
  | take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref.

Returns:
  A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file:

- gstreamermm/tuner.h