volume

volume — Set volume on audio/raw streams

Synopsis

struct              GstVolume;

Object Hierarchy

  GObject
   +----GstObject
         +----GstElement
               +----GstBaseTransform
                     +----GstAudioFilter
                           +----GstVolume

Implemented Interfaces

GstVolume implements GstImplementsInterface, GstMixer and GstStreamVolume.

Properties

  "mute"                     gboolean              : Read / Write
  "volume"                   gdouble               : Read / Write

Description

The volume element changes the volume of the audio data.

Example launch line

1
 
gst-launch -v -m audiotestsrc ! volume volume=0.5 ! level ! fakesink silent=TRUE
This pipeline shows that the level of audiotestsrc has been halved (peak values are around -6 dB and RMS around -9 dB) compared to the same pipeline without the volume element.

Synopsis

Element Information

plugin

 volume

author

 Andy Wingo <wingo@pobox.com>

class

 Filter/Effect/Audio

Element Pads

name

 sink

direction

 sink

presence

 always

details

 audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int){ 32, 64 }

audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)8, depth=(int)8, signed=(boolean)true

audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true

audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)24, depth=(int)24, signed=(boolean)true

audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)32, depth=(int)32, signed=(boolean)true

name

 src

direction

 source

presence

 always

details

 audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int){ 32, 64 }

audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)8, depth=(int)8, signed=(boolean)true

audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true

audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)24, depth=(int)24, signed=(boolean)true

audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)32, depth=(int)32, signed=(boolean)true

Details

struct GstVolume

struct GstVolume;

Opaque data structure.

Property Details

The "mute" property

  "mute"                     gboolean              : Read / Write

mute channel.

Default value: FALSE

The "volume" property

  "volume"                   gdouble               : Read / Write

volume factor, 1.0=100%.

Allowed values: [0,10]

Default value: 1

Generated by GTK-Doc V1.18