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

Packit 971217
Packit 971217
<html>
Packit 971217
<head>
Packit 971217
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 971217
<title>audiotestsrc: GStreamer Base Plugins 1.0 Plugins 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 Plugins Reference Manual">
Packit 971217
<link rel="up" href="ch01.html" title="gst-plugins-base Elements">
Packit 971217
<link rel="prev" href="gst-plugins-base-plugins-audioresample.html" title="audioresample">
Packit 971217
<link rel="next" href="gst-plugins-base-plugins-cdparanoiasrc.html" title="cdparanoiasrc">
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
                  Properties
Packit 971217
Packit 971217
Home
Packit 971217
Up
Packit 971217
Prev
Packit 971217
Next
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

audiotestsrc

Packit 971217

audiotestsrc

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
can-activate-pull
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
can-activate-push
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gdouble
Packit 971217
freq
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
is-live
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gint
Packit 971217
samplesperbuffer
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gint64
Packit 971217
timestamp-offset
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gdouble
Packit 971217
volume
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
GstAudioTestSrcWave
Packit 971217
wave
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
struct
Packit 971217
GstAudioTestSrc
Packit 971217
Packit 971217
Packit 971217
enum
Packit 971217
GstAudioTestSrcWave
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Object Hierarchy

Packit 971217
    GObject
Packit 971217
    ╰── GInitiallyUnowned
Packit 971217
        ╰── GstObject
Packit 971217
            ╰── GstElement
Packit 971217
                ╰── GstBaseSrc
Packit 971217
                    ╰── GstAudioTestSrc
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Description

Packit 971217

AudioTestSrc can be used to generate basic audio signals. It support several

Packit 971217
different waveforms and allows to set the base frequency and volume.

Packit 971217
Packit 971217

Example launch line

Packit 971217
Packit 971217
  
Packit 971217
    
Packit 971217
      
Packit 971217
        
1
Packit 971217
        
gst-launch-1.0 audiotestsrc ! audioconvert ! autoaudiosink
Packit 971217
      
Packit 971217
    
Packit 971217
  
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 This pipeline produces a sine with default frequency, 440 Hz, and the
Packit 971217
default volume, 0.8 (relative to a maximum 1.0).

Packit 971217
Packit 971217
  
Packit 971217
    
Packit 971217
      
Packit 971217
        
1
Packit 971217
        
gst-launch-1.0 audiotestsrc wave=2 freq=200 ! tee name=t ! queue ! audioconvert ! autoaudiosink t. ! queue ! audioconvert ! libvisual_lv_scope ! videoconvert ! autovideosink
Packit 971217
      
Packit 971217
    
Packit 971217
  
Packit 971217
Packit 971217
Packit 971217

Packit 971217
 In this example a saw wave is generated. The wave is shown using a
Packit 971217
scope visualizer from libvisual, allowing you to visually verify that
Packit 971217
the saw wave is correct.

Packit 971217
Packit 971217
Packit 971217

Synopsis

Packit 971217
Packit 971217

Element Information

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

plugin

Packit 971217
Packit 971217
            audiotestsrc
Packit 971217
          
Packit 971217
Packit 971217
Packit 971217

author

Packit 971217
Stefan Kost <ensonic@users.sf.net>
Packit 971217
Packit 971217
Packit 971217

class

Packit 971217
Source/Audio
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

Element Pads

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

name

Packit 971217
src
Packit 971217
Packit 971217
Packit 971217

direction

Packit 971217
source
Packit 971217
Packit 971217
Packit 971217

presence

Packit 971217
always
Packit 971217
Packit 971217
Packit 971217

details

Packit 971217
audio/x-raw, format=(string){ S16LE, S16BE, U16LE, U16BE, S24_32LE, S24_32BE, U24_32LE, U24_32BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, S20LE, S20BE, U20LE, U20BE, S18LE, S18BE, U18LE, U18BE, F32LE, F32BE, F64LE, F64BE, S8, U8 }, layout=(string)interleaved, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217

Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217

struct GstAudioTestSrc

Packit 971217
struct GstAudioTestSrc;
Packit 971217

audiotestsrc object structure.

Packit 971217
Packit 971217

Packit 971217
Packit 971217

enum GstAudioTestSrcWave

Packit 971217

Different types of supported sound waves.

Packit 971217
Packit 971217

Members

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_SINE

Packit 971217
Packit 971217

a sine wave

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_SQUARE

Packit 971217
Packit 971217

a square wave

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_SAW

Packit 971217
Packit 971217

a saw wave

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_TRIANGLE

Packit 971217
Packit 971217

a tringle wave

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_SILENCE

Packit 971217
Packit 971217

silence

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_WHITE_NOISE

Packit 971217
Packit 971217

white uniform noise

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_PINK_NOISE

Packit 971217
Packit 971217

pink noise

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_SINE_TAB

Packit 971217
Packit 971217

sine wave using a table

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_TICKS

Packit 971217
Packit 971217

periodic ticks

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_GAUSSIAN_WHITE_NOISE

Packit 971217
Packit 971217

white (zero mean) Gaussian noise; volume sets the standard deviation of the noise in units of the range of values of the sample type, e.g. volume=0.1 produces noise with a standard deviation of 0.1*32767=3277 with 16-bit integer samples, or 0.1*1.0=0.1 with floating-point samples.

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_RED_NOISE

Packit 971217
Packit 971217

red (brownian) noise

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_BLUE_NOISE

Packit 971217
Packit 971217

spectraly inverted pink noise

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_TEST_SRC_WAVE_VIOLET_NOISE

Packit 971217
Packit 971217

spectraly inverted red (brownian) noise

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 “can-activate-pull” property

Packit 971217
  “can-activate-pull”        gboolean
Packit 971217

Can activate in pull mode.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: FALSE

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “can-activate-push” property

Packit 971217
  “can-activate-push”        gboolean
Packit 971217

Can activate in push mode.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: TRUE

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “freq” property

Packit 971217
  “freq”                     gdouble
Packit 971217

Frequency of test signal. The sample rate needs to be at least 4 times higher.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: [0,5.36871e+08]

Packit 971217

Default value: 440

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “is-live” property

Packit 971217
  “is-live”                  gboolean
Packit 971217

Whether to act as a live source.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: FALSE

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “samplesperbuffer” property

Packit 971217
  “samplesperbuffer”         gint
Packit 971217

Number of samples in each outgoing buffer.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: >= 1

Packit 971217

Default value: 1024

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “timestamp-offset” property

Packit 971217
  “timestamp-offset”         gint64
Packit 971217

An offset added to timestamps set on buffers (in ns).

Packit 971217

Flags: Read / Write

Packit 971217

Default value: 0

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “volume” property

Packit 971217
  “volume”                   gdouble
Packit 971217

Volume of test signal.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: [0,1]

Packit 971217

Default value: 0.8

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “wave” property

Packit 971217
  “wave”                     GstAudioTestSrcWave
Packit 971217

Oscillator waveform.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: Sine

Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Generated by GTK-Doc V1.27
Packit 971217
</body>
Packit 971217
</html>