Blame docs/plugins/html/gst-plugins-base-plugins-volume.html

Packit 0652a1
Packit 0652a1
<html>
Packit 0652a1
<head>
Packit 0652a1
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 0652a1
<title>volume: GStreamer Base Plugins 1.0 Plugins Reference Manual</title>
Packit 0652a1
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
Packit 0652a1
<link rel="home" href="index.html" title="GStreamer Base Plugins 1.0 Plugins Reference Manual">
Packit 0652a1
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
Packit 0652a1
<link rel="prev" href="gst-plugins-base-plugins-videotestsrc.html" title="videotestsrc">
Packit 0652a1
<link rel="next" href="gst-plugins-base-plugins-vorbisdec.html" title="vorbisdec">
Packit 0652a1
<meta name="generator" content="GTK-Doc V1.28 (XML mode)">
Packit 0652a1
<link rel="stylesheet" href="style.css" type="text/css">
Packit 0652a1
</head>
Packit 0652a1
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 0652a1
Packit 0652a1
Packit 0652a1
Top  | 
Packit 0652a1
                  Description  | 
Packit 0652a1
                  Object Hierarchy  | 
Packit 0652a1
                  Implemented Interfaces  | 
Packit 0652a1
                  Properties
Packit 0652a1
Packit 0652a1
Home
Packit 0652a1
Up
Packit 0652a1
Prev
Packit 0652a1
Next
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

volume

Packit 0652a1

volume

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Properties

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
gboolean
Packit 0652a1
mute
Packit 0652a1
Read / Write
Packit 0652a1
Packit 0652a1
Packit 0652a1
gdouble
Packit 0652a1
volume
Packit 0652a1
Read / Write
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Types and Values

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
struct
Packit 0652a1
GstVolume
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Object Hierarchy

Packit 0652a1
    GObject
Packit 0652a1
    ╰── GInitiallyUnowned
Packit 0652a1
        ╰── GstObject
Packit 0652a1
            ╰── GstElement
Packit 0652a1
                ╰── GstBaseTransform
Packit 0652a1
                    ╰── GstAudioFilter
Packit 0652a1
                        ╰── GstVolume
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Implemented Interfaces

Packit 0652a1

Packit 0652a1
GstVolume implements
Packit 0652a1
 GstStreamVolume.

Packit 0652a1
Packit 0652a1
Packit 0652a1

Description

Packit 0652a1

The volume element changes the volume of the audio data.

Packit 0652a1
Packit 0652a1

Example launch line

Packit 0652a1
Packit 0652a1
  
Packit 0652a1
    
Packit 0652a1
      
Packit 0652a1
        
1
Packit 0652a1
        
gst-launch-1.0 -v -m audiotestsrc ! volume volume=0.5 ! level ! fakesink silent=TRUE
Packit 0652a1
      
Packit 0652a1
    
Packit 0652a1
  
Packit 0652a1
Packit 0652a1
Packit 0652a1

Packit 0652a1
 This pipeline shows that the level of audiotestsrc has been halved
Packit 0652a1
(peak values are around -6 dB and RMS around -9 dB) compared to
Packit 0652a1
the same pipeline without the volume element.

Packit 0652a1
Packit 0652a1
Packit 0652a1

Synopsis

Packit 0652a1
Packit 0652a1

Element Information

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

plugin

Packit 0652a1
Packit 0652a1
            volume
Packit 0652a1
          
Packit 0652a1
Packit 0652a1
Packit 0652a1

author

Packit 0652a1
Andy Wingo <wingo@pobox.com>
Packit 0652a1
Packit 0652a1
Packit 0652a1

class

Packit 0652a1
Filter/Effect/Audio
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Packit 0652a1
Packit 0652a1

Element Pads

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

name

Packit 0652a1
sink
Packit 0652a1
Packit 0652a1
Packit 0652a1

direction

Packit 0652a1
sink
Packit 0652a1
Packit 0652a1
Packit 0652a1

presence

Packit 0652a1
always
Packit 0652a1
Packit 0652a1
Packit 0652a1

details

Packit 0652a1
audio/x-raw, format=(string){ F32LE, F64LE, S8, S16LE, S24LE, S32LE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string)interleaved
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

name

Packit 0652a1
src
Packit 0652a1
Packit 0652a1
Packit 0652a1

direction

Packit 0652a1
source
Packit 0652a1
Packit 0652a1
Packit 0652a1

presence

Packit 0652a1
always
Packit 0652a1
Packit 0652a1
Packit 0652a1

details

Packit 0652a1
audio/x-raw, format=(string){ F32LE, F64LE, S8, S16LE, S24LE, S32LE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string)interleaved
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Functions

Packit 0652a1

Packit 0652a1
Packit 0652a1
Packit 0652a1

Types and Values

Packit 0652a1
Packit 0652a1

struct GstVolume

Packit 0652a1
struct GstVolume;
Packit 0652a1

Opaque data structure.

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Property Details

Packit 0652a1
Packit 0652a1

The “mute” property

Packit 0652a1
  “mute”                     gboolean
Packit 0652a1

mute channel.

Packit 0652a1

Flags: Read / Write

Packit 0652a1

Default value: FALSE

Packit 0652a1
Packit 0652a1

Packit 0652a1
Packit 0652a1

The “volume” property

Packit 0652a1
  “volume”                   gdouble
Packit 0652a1

volume factor, 1.0=100%.

Packit 0652a1

Flags: Read / Write

Packit 0652a1

Allowed values: [0,10]

Packit 0652a1

Default value: 1

Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1
Packit 0652a1

Generated by GTK-Doc V1.28
Packit 0652a1
</body>
Packit 0652a1
</html>