Blame docs/libs/html/GstAudioAggregator.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>GstAudioAggregator: 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-GstAudioDownmixMeta.html" title="GstAudioDownmixMeta">
Packit 971217
<link rel="next" href="GstAudioCdSrc.html" title="GstAudioCdSrc">
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

GstAudioAggregator

Packit 971217

GstAudioAggregator — Base class that manages a set of audio input pads

Packit 971217
with the purpose of aggregating or mixing their raw audio input buffers

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
void
Packit 971217
Packit 971217
Packit 971217
gst_audio_aggregator_set_sink_caps ()
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
guint64
Packit 971217
alignment-threshold
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
guint64
Packit 971217
discont-wait
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
guint64
Packit 971217
output-buffer-duration
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstStructure *
Packit 971217
converter-config
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
GstAudioAggregator
Packit 971217
Packit 971217
Packit 971217
struct
Packit 971217
GstAudioAggregatorClass
Packit 971217
Packit 971217
Packit 971217
struct
Packit 971217
GstAudioAggregatorPad
Packit 971217
Packit 971217
Packit 971217
struct
Packit 971217
GstAudioAggregatorPadClass
Packit 971217
Packit 971217
Packit 971217
struct
Packit 971217
GstAudioAggregatorConvertPad
Packit 971217
Packit 971217
Packit 971217
struct
Packit 971217
GstAudioAggregatorConvertPadClass
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
               ╰── GstAggregator
Packit 971217
                   ╰── GstAudioAggregator
Packit 971217
            ╰── GstPad
Packit 971217
                ╰── GstAggregatorPad
Packit 971217
                    ╰── GstAudioAggregatorPad
Packit 971217
                        ╰── GstAudioAggregatorConvertPad
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Includes

Packit 971217
#include <gst/audio/audio.h>
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Description

Packit 971217

Subclasses must use (a subclass of) GstAudioAggregatorPad for both

Packit 971217
their source and sink pads,
Packit 971217
gst_element_class_add_static_pad_template_with_gtype() is a convenient
Packit 971217
helper.

Packit 971217

GstAudioAggregator can perform conversion on the data arriving

Packit 971217
on its sink pads, based on the format expected downstream: in order
Packit 971217
to enable that behaviour, the GType of the sink pads must either be
Packit 971217
a (subclass of) GstAudioAggregatorConvertPad to use the default
Packit 971217
GstAudioConverter implementation, or a subclass of GstAudioAggregatorPad
Packit 971217
implementing GstAudioAggregatorPad.convert_buffer.

Packit 971217

To allow for the output caps to change, the mechanism is the same as

Packit 971217
above, with the GType of the source pad.

Packit 971217

See GstAudioMixer for an example.

Packit 971217

When conversion is enabled, GstAudioAggregator will accept

Packit 971217
any type of raw audio caps and perform conversion
Packit 971217
on the data arriving on its sink pads, with whatever downstream
Packit 971217
expects as the target format.

Packit 971217

In case downstream caps are not fully fixated, it will use

Packit 971217
the first configured sink pad to finish fixating its source pad
Packit 971217
caps.

Packit 971217

A notable exception for now is the sample rate, sink pads must

Packit 971217
have the same sample rate as either the downstream requirement,
Packit 971217
or the first configured pad, or a combination of both (when
Packit 971217
downstream specifies a range or a set of acceptable rates).

Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217
Packit 971217

gst_audio_aggregator_set_sink_caps ()

Packit 971217
void
Packit 971217
gst_audio_aggregator_set_sink_caps (GstAudioAggregator *aagg,
Packit 971217
                                    GstAudioAggregatorPad *pad,
Packit 971217
                                    GstCaps *caps);
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217

struct GstAudioAggregator

Packit 971217
struct GstAudioAggregator;
Packit 971217

GstAudioAggregator object

Packit 971217
Packit 971217

Members

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

Packit 971217
Packit 971217

struct GstAudioAggregatorClass

Packit 971217
struct GstAudioAggregatorClass {
Packit 971217
  GstAggregatorClass   parent_class;
Packit 971217
Packit 971217
  GstBuffer * (* create_output_buffer) (GstAudioAggregator * aagg,
Packit 971217
      guint num_frames);
Packit 971217
  gboolean (* aggregate_one_buffer) (GstAudioAggregator * aagg,
Packit 971217
      GstAudioAggregatorPad * pad, GstBuffer * inbuf, guint in_offset,
Packit 971217
      GstBuffer * outbuf, guint out_offset, guint num_frames);
Packit 971217
};
Packit 971217
Packit 971217
Packit 971217

Members

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

create_output_buffer ()

Packit 971217

Create a new output buffer contains num_frames frames.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

aggregate_one_buffer ()

Packit 971217

Aggregates one input buffer to the output

Packit 971217
buffer.  The in_offset and out_offset are in "frames", which is
Packit 971217
the size of a sample times the number of channels. Returns TRUE if
Packit 971217
any non-silence was added to the buffer

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

Packit 971217
Packit 971217

struct GstAudioAggregatorPad

Packit 971217
struct GstAudioAggregatorPad;
Packit 971217

The default implementation of GstPad used with GstAudioAggregator

Packit 971217
Packit 971217

Members

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

Packit 971217
Packit 971217

struct GstAudioAggregatorPadClass

Packit 971217
struct GstAudioAggregatorPadClass {
Packit 971217
  GstAggregatorPadClass   parent_class;
Packit 971217
Packit 971217
  GstBuffer * (* convert_buffer) (GstAudioAggregatorPad * pad,
Packit 971217
                                  GstAudioInfo *in_info,
Packit 971217
                                  GstAudioInfo *out_info,
Packit 971217
                                  GstBuffer * buffer);
Packit 971217
Packit 971217
  void        (* update_conversion_info) (GstAudioAggregatorPad *pad);
Packit 971217
};
Packit 971217
Packit 971217
Packit 971217

Members

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

convert_buffer ()

Packit 971217

Convert a buffer from one format to another.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

update_conversion_info ()

Packit 971217

Called when either the input or output

Packit 971217
formats have changed.

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

Packit 971217
Packit 971217

struct GstAudioAggregatorConvertPad

Packit 971217
struct GstAudioAggregatorConvertPad;
Packit 971217

An implementation of GstPad that can be used with GstAudioAggregator.

Packit 971217

See GstAudioAggregator for more details.

Packit 971217
Packit 971217

Members

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

Packit 971217
Packit 971217

struct GstAudioAggregatorConvertPadClass

Packit 971217
struct GstAudioAggregatorConvertPadClass {
Packit 971217
  GstAudioAggregatorPadClass   parent_class;
Packit 971217
};
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Property Details

Packit 971217
Packit 971217

The “alignment-threshold” property

Packit 971217
  “alignment-threshold”      guint64
Packit 971217

Timestamp alignment threshold in nanoseconds.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: <= 18446744073709551614

Packit 971217

Default value: 40000000

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “discont-wait” property

Packit 971217
  “discont-wait”             guint64
Packit 971217

Window of time in nanoseconds to wait before creating a discontinuity.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: <= 18446744073709551614

Packit 971217

Default value: 1000000000

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “output-buffer-duration” property

Packit 971217
  “output-buffer-duration”   guint64
Packit 971217

Output block size in nanoseconds.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: >= 1

Packit 971217

Default value: 10000000

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “converter-config” property

Packit 971217
  “converter-config”         GstStructure *
Packit 971217

A GstStructure describing the configuration that should be used when converting this pad's audio buffers.

Packit 971217

Flags: Read / Write

Packit 971217
Packit 971217
Packit 971217
Packit 971217

See Also

Packit 971217

GstAggregator, GstAudioMixer

Packit 971217
Packit 971217
Packit 971217
Packit 971217

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