|
Packit |
971217 |
|
|
Packit |
971217 |
<html>
|
|
Packit |
971217 |
<head>
|
|
Packit |
971217 |
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|
Packit |
971217 |
<title>GstStreamVolume: GStreamer Base Plugins 1.0 Library Reference Manual</title>
|
|
Packit |
971217 |
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
|
|
Packit |
971217 |
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Library Reference Manual">
|
|
Packit |
971217 |
<link rel="up" href="gstreamer-audio.html" title="Audio Library">
|
|
Packit |
971217 |
<link rel="prev" href="gst-plugins-base-libs-GstAudio-IEC61937.html" title="GstAudio IEC61937">
|
|
Packit |
971217 |
<link rel="next" href="gstreamer-ffft.html" title="FFT Library">
|
|
Packit |
971217 |
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
|
|
Packit |
971217 |
<link rel="stylesheet" href="style.css" type="text/css">
|
|
Packit |
971217 |
</head>
|
|
Packit |
971217 |
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Top |
|
|
Packit |
971217 |
Description |
|
|
Packit |
971217 |
Object Hierarchy |
|
|
Packit |
971217 |
Prerequisites |
|
|
Packit |
971217 |
Properties
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstStreamVolume
|
|
Packit |
971217 |
GstStreamVolume — Interface for elements that provide a stream volume
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Functions
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gdouble
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_stream_volume_get_volume ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_stream_volume_set_volume ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_stream_volume_get_mute ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_stream_volume_set_mute ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gdouble
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_stream_volume_convert_volume ()
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Properties
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
mute
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gdouble
|
|
Packit |
971217 |
volume
|
|
Packit |
971217 |
Read / Write
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Types and Values
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstStreamVolume
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enum
|
|
Packit |
971217 |
GstStreamVolumeFormat
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Object Hierarchy
|
|
Packit |
971217 |
GInterface
|
|
Packit |
971217 |
╰── GstStreamVolume
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Prerequisites
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstStreamVolume requires
|
|
Packit |
971217 |
GObject.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Includes
|
|
Packit |
971217 |
#include <gst/audio/streamvolume.h>
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Description
|
|
Packit |
971217 |
This interface is implemented by elements that provide a stream volume. Examples for
|
|
Packit |
971217 |
such elements are volume and playbin.
|
|
Packit |
971217 |
Applications can use this interface to get or set the current stream volume. For this
|
|
Packit |
971217 |
the "volume" GObject property can be used or the helper functions gst_stream_volume_set_volume()
|
|
Packit |
971217 |
and gst_stream_volume_get_volume() . This volume is always a linear factor, i.e. 0.0 is muted
|
|
Packit |
971217 |
1.0 is 100%. For showing the volume in a GUI it might make sense to convert it to
|
|
Packit |
971217 |
a different format by using gst_stream_volume_convert_volume() . Volume sliders should usually
|
|
Packit |
971217 |
use a cubic volume.
|
|
Packit |
971217 |
Separate from the volume the stream can also be muted by the "mute" GObject property or
|
|
Packit |
971217 |
gst_stream_volume_set_mute() and gst_stream_volume_get_mute() .
|
|
Packit |
971217 |
Elements that provide some kind of stream volume should implement the "volume" and
|
|
Packit |
971217 |
"mute" GObject properties and handle setting and getting of them properly.
|
|
Packit |
971217 |
The volume property is defined to be a linear volume factor.
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Functions
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_stream_volume_get_volume ()
|
|
Packit |
971217 |
gdouble
|
|
Packit |
971217 |
gst_stream_volume_get_volume (GstStreamVolume *volume ,
|
|
Packit |
971217 |
GstStreamVolumeFormat format );
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
volume
|
|
Packit |
971217 |
GstStreamVolume that should be used
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
format
|
|
Packit |
971217 |
GstStreamVolumeFormat which should be returned
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
The current stream volume as linear factor
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_stream_volume_set_volume ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_stream_volume_set_volume (GstStreamVolume *volume ,
|
|
Packit |
971217 |
GstStreamVolumeFormat format ,
|
|
Packit |
971217 |
gdouble val );
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
volume
|
|
Packit |
971217 |
GstStreamVolume that should be used
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
format
|
|
Packit |
971217 |
GstStreamVolumeFormat of val
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
val
|
|
Packit |
971217 |
Linear volume factor that should be set
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_stream_volume_get_mute ()
|
|
Packit |
971217 |
gboolean
|
|
Packit |
971217 |
gst_stream_volume_get_mute (GstStreamVolume *volume );
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
volume
|
|
Packit |
971217 |
GstStreamVolume that should be used
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
Returns TRUE if the stream is muted
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_stream_volume_set_mute ()
|
|
Packit |
971217 |
void
|
|
Packit |
971217 |
gst_stream_volume_set_mute (GstStreamVolume *volume ,
|
|
Packit |
971217 |
gboolean mute );
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
volume
|
|
Packit |
971217 |
GstStreamVolume that should be used
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
mute
|
|
Packit |
971217 |
Mute state that should be set
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
gst_stream_volume_convert_volume ()
|
|
Packit |
971217 |
gdouble
|
|
Packit |
971217 |
gst_stream_volume_convert_volume (GstStreamVolumeFormat from ,
|
|
Packit |
971217 |
GstStreamVolumeFormat to ,
|
|
Packit |
971217 |
gdouble val );
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Parameters
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
from
|
|
Packit |
971217 |
GstStreamVolumeFormat to convert from
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
to
|
|
Packit |
971217 |
GstStreamVolumeFormat to convert to
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
val
|
|
Packit |
971217 |
Volume in from
|
|
Packit |
971217 |
format that should be converted
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Returns
|
|
Packit |
971217 |
the converted volume
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Types and Values
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GstStreamVolume
|
|
Packit |
971217 |
typedef struct _GstStreamVolume GstStreamVolume;
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
enum GstStreamVolumeFormat
|
|
Packit |
971217 |
Different representations of a stream volume. gst_stream_volume_convert_volume()
|
|
Packit |
971217 |
allows to convert between the different representations.
|
|
Packit |
971217 |
Formulas to convert from a linear to a cubic or dB volume are
|
|
Packit |
971217 |
cbrt(val) and 20 * log10 (val).
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Members
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_STREAM_VOLUME_FORMAT_LINEAR
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Linear scale factor, 1.0 = 100%
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_STREAM_VOLUME_FORMAT_CUBIC
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Cubic volume scale
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
GST_STREAM_VOLUME_FORMAT_DB
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Logarithmic volume scale (dB, amplitude not power)
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Property Details
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “mute” property
|
|
Packit |
971217 |
“mute” gboolean
|
|
Packit |
971217 |
Mute the audio channel without changing the volume.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Default value: FALSE
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
The “volume” property
|
|
Packit |
971217 |
“volume” gdouble
|
|
Packit |
971217 |
Linear volume factor, 1.0=100%.
|
|
Packit |
971217 |
Flags: Read / Write
|
|
Packit |
971217 |
Allowed values: >= 0
|
|
Packit |
971217 |
Default value: 1
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
|
|
Packit |
971217 |
Generated by GTK-Doc V1.27
|
|
Packit |
971217 |
</body>
|
|
Packit |
971217 |
</html>
|