Module: GstAudio::StreamVolume

Defined in:

(unknown)

Overview

This interface is implemented by elements that provide a stream volume. Examples for such elements are #volume and #playbin.

Applications can use this interface to get or set the current stream volume. For this the "volume" #GObject property can be used or the helper functions gst_stream_volume_set_volume() and gst_stream_volume_get_volume(). This volume is always a linear factor, i.e. 0.0 is muted 1.0 is 100%. For showing the volume in a GUI it might make sense to convert it to a different format by using gst_stream_volume_convert_volume(). Volume sliders should usually use a cubic volume.

Separate from the volume the stream can also be muted by the "mute" #GObject property or gst_stream_volume_set_mute() and gst_stream_volume_get_mute().

Elements that provide some kind of stream volume should implement the "volume" and "mute" #GObject properties and handle setting and getting of them properly. The volume property is defined to be a linear volume factor.

Instance Method Summary

• #get_volume(format) ⇒ Float

  The current stream volume as linear factor.

• #mute ⇒ Boolean

  Returns true if the stream is muted.

• #mute=(mute) ⇒ nil
• #set_volume(format, val) ⇒ nil

Instance Method Details

#get_volume(format) ⇒ Float

Returns The current stream volume as linear factor.

Parameters:

• format (GstAudio::StreamVolumeFormat) —

  Gst::StreamVolumeFormat which should be returned

Returns:

• (Float) —

  The current stream volume as linear factor

#mute ⇒ Boolean

Returns true if the stream is muted

Returns:

• (Boolean) —

  Returns true if the stream is muted

#mute=(mute) ⇒ nil

Parameters:

• mute (Boolean) —

  Mute state that should be set

Returns:

• (nil)

#set_volume(format, val) ⇒ nil

Parameters:

• format (GstAudio::StreamVolumeFormat) —

  Gst::StreamVolumeFormat of val

• val (Float) —

  Linear volume factor that should be set

Returns:

• (nil)