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

GstAudioBaseSink

Packit 971217

GstAudioBaseSink — Base class for audio sinks

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
void
Packit 971217
Packit 971217
Packit 971217
(*GstAudioBaseSinkCustomSlavingCallback) ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
Packit 971217
GST_AUDIO_BASE_SINK_CLOCK()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
#define
Packit 971217
Packit 971217
GST_AUDIO_BASE_SINK_PAD()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstAudioRingBuffer *
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_create_ringbuffer ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_set_provide_clock ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_get_provide_clock ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_set_slave_method ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstAudioBaseSinkSlaveMethod
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_get_slave_method ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_set_drift_tolerance ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
gint64
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_get_drift_tolerance ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_set_alignment_threshold ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstClockTime
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_get_alignment_threshold ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_set_discont_wait ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
GstClockTime
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_get_discont_wait ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_set_custom_slaving_callback ()
Packit 971217
Packit 971217
Packit 971217
Packit 971217
Packit 971217
void
Packit 971217
Packit 971217
Packit 971217
gst_audio_base_sink_report_device_failure ()
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
guint64
Packit 971217
alignment-threshold
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gint64
Packit 971217
buffer-time
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
can-activate-pull
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
gint64
Packit 971217
drift-tolerance
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gint64
Packit 971217
latency-time
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
gboolean
Packit 971217
provide-clock
Packit 971217
Read / Write
Packit 971217
Packit 971217
Packit 971217
GstAudioBaseSinkSlaveMethod
Packit 971217
slave-method
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
GstAudioBaseSink
Packit 971217
Packit 971217
Packit 971217
struct
Packit 971217
GstAudioBaseSinkClass
Packit 971217
Packit 971217
Packit 971217
enum
Packit 971217
GstAudioBaseSinkSlaveMethod
Packit 971217
Packit 971217
Packit 971217
enum
Packit 971217
GstAudioBaseSinkDiscontReason
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
                ╰── GstBaseSink
Packit 971217
                    ╰── GstAudioBaseSink
Packit 971217
                        ╰── GstAudioSink
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Includes

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

Description

Packit 971217

This is the base class for audio sinks. Subclasses need to implement the

Packit 971217
::create_ringbuffer vmethod. This base class will then take care of
Packit 971217
writing samples to the ringbuffer, synchronisation, clipping and flushing.

Packit 971217
Packit 971217
Packit 971217

Functions

Packit 971217
Packit 971217

GstAudioBaseSinkCustomSlavingCallback ()

Packit 971217
void
Packit 971217
(*GstAudioBaseSinkCustomSlavingCallback)
Packit 971217
                               (GstAudioBaseSink *sink,
Packit 971217
                                GstClockTime etime,
Packit 971217
                                GstClockTime itime,
Packit 971217
                                GstClockTimeDiff *requested_skew,
Packit 971217
                                GstAudioBaseSinkDiscontReason discont_reason,
Packit 971217
                                gpointer user_data);
Packit 971217

This function is set with gst_audio_base_sink_set_custom_slaving_callback()

Packit 971217
and is called during playback. It receives the current time of external and
Packit 971217
internal clocks, which the callback can then use to apply any custom
Packit 971217
slaving/synchronization schemes.

Packit 971217

The external clock is the sink's element clock, the internal one is the

Packit 971217
internal audio clock. The internal audio clock's calibration is applied to
Packit 971217
the timestamps before they are passed to the callback. The difference between
Packit 971217
etime and itime is the skew; how much internal and external clock lie apart
Packit 971217
from each other. A skew of 0 means both clocks are perfectly in sync.
Packit 971217
itime > etime means the external clock is going slower, while itime < etime
Packit 971217
means it is going faster than the internal clock. etime and itime are always
Packit 971217
valid timestamps, except for when a discontinuity happens.

Packit 971217

requested_skew is an output value the callback can write to. It informs the

Packit 971217
sink of whether or not it should move the playout pointer, and if so, by how
Packit 971217
much. This pointer is only NULL if a discontinuity occurs; otherwise, it is
Packit 971217
safe to write to *requested_skew. The default skew is 0.

Packit 971217

The sink may experience discontinuities. If one happens, discont is TRUE,

Packit 971217
itime, etime are set to GST_CLOCK_TIME_NONE, and requested_skew is NULL.
Packit 971217
This makes it possible to reset custom clock slaving algorithms when a
Packit 971217
discontinuity happens.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

etime

Packit 971217

external clock time

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

itime

Packit 971217

internal clock time

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

requested_skew

Packit 971217

skew amount requested by the callback

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

discont_reason

Packit 971217

reason for discontinuity (if any)

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

user_data

Packit 971217

user data

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

Since: 1.6

Packit 971217
Packit 971217

Packit 971217
Packit 971217

GST_AUDIO_BASE_SINK_CLOCK()

Packit 971217
#define GST_AUDIO_BASE_SINK_CLOCK(obj)   (GST_AUDIO_BASE_SINK (obj)->clock)
Packit 971217
Packit 971217

Get the GstClock of obj

Packit 971217
.

Packit 971217
Packit 971217

Parameters

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

obj

Packit 971217

a GstAudioBaseSink

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

Packit 971217
Packit 971217

GST_AUDIO_BASE_SINK_PAD()

Packit 971217
#define GST_AUDIO_BASE_SINK_PAD(obj)     (GST_BASE_SINK (obj)->sinkpad)
Packit 971217
Packit 971217

Get the sink GstPad of obj

Packit 971217
.

Packit 971217
Packit 971217

Parameters

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

obj

Packit 971217

a GstAudioBaseSink

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

Packit 971217
Packit 971217

gst_audio_base_sink_create_ringbuffer ()

Packit 971217
GstAudioRingBuffer *
Packit 971217
gst_audio_base_sink_create_ringbuffer (GstAudioBaseSink *sink);
Packit 971217

Create and return the GstAudioRingBuffer for sink

Packit 971217
. This function will
Packit 971217
call the ::create_ringbuffer vmethod and will set sink
Packit 971217
 as the parent of
Packit 971217
the returned buffer (see gst_object_set_parent()).

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink.

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

Returns

Packit 971217

The new ringbuffer of sink

Packit 971217
. 

Packit 971217

[transfer none]

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_base_sink_set_provide_clock ()

Packit 971217
void
Packit 971217
gst_audio_base_sink_set_provide_clock (GstAudioBaseSink *sink,
Packit 971217
                                       gboolean provide);
Packit 971217

Controls whether sink

Packit 971217
 will provide a clock or not. If provide
Packit 971217
 is TRUE,
Packit 971217
gst_element_provide_clock() will return a clock that reflects the datarate
Packit 971217
of sink
Packit 971217
. If provide
Packit 971217
 is FALSE, gst_element_provide_clock() will return
Packit 971217
NULL.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

provide

Packit 971217

new state

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

Packit 971217
Packit 971217

gst_audio_base_sink_get_provide_clock ()

Packit 971217
gboolean
Packit 971217
gst_audio_base_sink_get_provide_clock (GstAudioBaseSink *sink);
Packit 971217

Queries whether sink

Packit 971217
 will provide a clock or not. See also
Packit 971217
gst_audio_base_sink_set_provide_clock.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

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

Returns

Packit 971217

TRUE if sink

Packit 971217
will provide a clock.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_base_sink_set_slave_method ()

Packit 971217
void
Packit 971217
gst_audio_base_sink_set_slave_method (GstAudioBaseSink *sink,
Packit 971217
                                      GstAudioBaseSinkSlaveMethod method);
Packit 971217

Controls how clock slaving will be performed in sink

Packit 971217
.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

method

Packit 971217

the new slave method

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

Packit 971217
Packit 971217

gst_audio_base_sink_get_slave_method ()

Packit 971217
GstAudioBaseSinkSlaveMethod
Packit 971217
gst_audio_base_sink_get_slave_method (GstAudioBaseSink *sink);
Packit 971217

Get the current slave method used by sink

Packit 971217
.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

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

Returns

Packit 971217

The current slave method used by sink

Packit 971217
.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_base_sink_set_drift_tolerance ()

Packit 971217
void
Packit 971217
gst_audio_base_sink_set_drift_tolerance
Packit 971217
                               (GstAudioBaseSink *sink,
Packit 971217
                                gint64 drift_tolerance);
Packit 971217

Controls the sink's drift tolerance.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

drift_tolerance

Packit 971217

the new drift tolerance in microseconds

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

Packit 971217
Packit 971217

gst_audio_base_sink_get_drift_tolerance ()

Packit 971217
gint64
Packit 971217
gst_audio_base_sink_get_drift_tolerance
Packit 971217
                               (GstAudioBaseSink *sink);
Packit 971217

Get the current drift tolerance, in microseconds, used by sink

Packit 971217
.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

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

Returns

Packit 971217

The current drift tolerance used by sink

Packit 971217
.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_base_sink_set_alignment_threshold ()

Packit 971217
void
Packit 971217
gst_audio_base_sink_set_alignment_threshold
Packit 971217
                               (GstAudioBaseSink *sink,
Packit 971217
                                GstClockTime alignment_threshold);
Packit 971217

Controls the sink's alignment threshold.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

alignment_threshold

Packit 971217

the new alignment threshold in nanoseconds

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

Packit 971217
Packit 971217

gst_audio_base_sink_get_alignment_threshold ()

Packit 971217
GstClockTime
Packit 971217
gst_audio_base_sink_get_alignment_threshold
Packit 971217
                               (GstAudioBaseSink *sink);
Packit 971217

Get the current alignment threshold, in nanoseconds, used by sink

Packit 971217
.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

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

Returns

Packit 971217

The current alignment threshold used by sink

Packit 971217
.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_base_sink_set_discont_wait ()

Packit 971217
void
Packit 971217
gst_audio_base_sink_set_discont_wait (GstAudioBaseSink *sink,
Packit 971217
                                      GstClockTime discont_wait);
Packit 971217

Controls how long the sink will wait before creating a discontinuity.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

discont_wait

Packit 971217

the new discont wait in nanoseconds

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

Packit 971217
Packit 971217

gst_audio_base_sink_get_discont_wait ()

Packit 971217
GstClockTime
Packit 971217
gst_audio_base_sink_get_discont_wait (GstAudioBaseSink *sink);
Packit 971217

Get the current discont wait, in nanoseconds, used by sink

Packit 971217
.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

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

Returns

Packit 971217

The current discont wait used by sink

Packit 971217
.

Packit 971217
Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_base_sink_set_custom_slaving_callback ()

Packit 971217
void
Packit 971217
gst_audio_base_sink_set_custom_slaving_callback
Packit 971217
                               (GstAudioBaseSink *sink,
Packit 971217
                                GstAudioBaseSinkCustomSlavingCallback callback,
Packit 971217
                                gpointer user_data,
Packit 971217
                                GDestroyNotify notify);
Packit 971217

Sets the custom slaving callback. This callback will

Packit 971217
be invoked if the slave-method property is set to
Packit 971217
GST_AUDIO_BASE_SINK_SLAVE_CUSTOM and the audio sink
Packit 971217
receives and plays samples.

Packit 971217

Setting the callback to NULL causes the sink to

Packit 971217
behave as if the GST_AUDIO_BASE_SINK_SLAVE_NONE
Packit 971217
method were used.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

callback

Packit 971217

a GstAudioBaseSinkCustomSlavingCallback

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

user_data

Packit 971217

user data passed to the callback

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

notify

Packit 971217

called when user_data becomes unused

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

Since: 1.6

Packit 971217
Packit 971217

Packit 971217
Packit 971217

gst_audio_base_sink_report_device_failure ()

Packit 971217
void
Packit 971217
gst_audio_base_sink_report_device_failure
Packit 971217
                               (GstAudioBaseSink *sink);
Packit 971217

Informs this base class that the audio output device has failed for

Packit 971217
some reason, causing a discontinuity (for example, because the device
Packit 971217
recovered from the error, but lost all contents of its ring buffer).
Packit 971217
This function is typically called by derived classes, and is useful
Packit 971217
for the custom slave method.

Packit 971217
Packit 971217

Parameters

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

sink

Packit 971217

a GstAudioBaseSink

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217
Packit 971217

Since: 1.6

Packit 971217
Packit 971217
Packit 971217
Packit 971217

Types and Values

Packit 971217
Packit 971217

struct GstAudioBaseSink

Packit 971217
struct GstAudioBaseSink;
Packit 971217

Opaque GstAudioBaseSink.

Packit 971217
Packit 971217

Packit 971217
Packit 971217

struct GstAudioBaseSinkClass

Packit 971217
struct GstAudioBaseSinkClass {
Packit 971217
  GstBaseSinkClass     parent_class;
Packit 971217
Packit 971217
  /* subclass ringbuffer allocation */
Packit 971217
  GstAudioRingBuffer* (*create_ringbuffer)  (GstAudioBaseSink *sink);
Packit 971217
Packit 971217
  /* subclass payloader */
Packit 971217
  GstBuffer*          (*payload)            (GstAudioBaseSink *sink,
Packit 971217
                                             GstBuffer        *buffer);
Packit 971217
};
Packit 971217
Packit 971217

GstAudioBaseSink class. Override the vmethod to implement

Packit 971217
functionality.

Packit 971217
Packit 971217

Members

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

create_ringbuffer ()

Packit 971217

create and return a GstAudioRingBuffer to write to.

Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

payload ()

Packit 971217

payload data in a format suitable to write to the sink. If no

Packit 971217
payloading is required, returns a reffed copy of the original
Packit 971217
buffer, else returns the payloaded buffer with all other metadata
Packit 971217
copied.

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

Packit 971217
Packit 971217

enum GstAudioBaseSinkSlaveMethod

Packit 971217

Different possible clock slaving algorithms used when the internal audio

Packit 971217
clock is not selected as the pipeline master clock.

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_BASE_SINK_SLAVE_RESAMPLE

Packit 971217
Packit 971217

Resample to match the master clock

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_BASE_SINK_SLAVE_SKEW

Packit 971217
Packit 971217

Adjust playout pointer when master clock

Packit 971217
drifts too much.

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_BASE_SINK_SLAVE_NONE

Packit 971217
Packit 971217

No adjustment is done.

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_BASE_SINK_SLAVE_CUSTOM

Packit 971217
Packit 971217

Use custom clock slaving algorithm (Since: 1.6)

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

Packit 971217
Packit 971217

enum GstAudioBaseSinkDiscontReason

Packit 971217

Different possible reasons for discontinuities. This enum is useful for the custom

Packit 971217
slave method.

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_BASE_SINK_DISCONT_REASON_NO_DISCONT

Packit 971217
Packit 971217

No discontinuity occurred

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_BASE_SINK_DISCONT_REASON_NEW_CAPS

Packit 971217
Packit 971217

New caps are set, causing renegotiotion

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_BASE_SINK_DISCONT_REASON_FLUSH

Packit 971217
Packit 971217

Samples have been flushed

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_BASE_SINK_DISCONT_REASON_SYNC_LATENCY

Packit 971217
Packit 971217

Sink was synchronized to the estimated latency (occurs during initialization)

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_BASE_SINK_DISCONT_REASON_ALIGNMENT

Packit 971217
Packit 971217

Aligning buffers failed because the timestamps are too discontinuous

Packit 971217
Packit 971217
 
Packit 971217
Packit 971217
Packit 971217

GST_AUDIO_BASE_SINK_DISCONT_REASON_DEVICE_FAILURE

Packit 971217
Packit 971217

Audio output device experienced and recovered from an error but introduced latency in the process (see also gst_audio_base_sink_report_device_failure()

Packit 971217
)

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

Since: 1.6

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: [1,18446744073709551614]

Packit 971217

Default value: 40000000

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “buffer-time” property

Packit 971217
  “buffer-time”              gint64
Packit 971217

Size of audio buffer in microseconds, this is the minimum latency that the sink reports.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: >= 1

Packit 971217

Default value: 200000

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “can-activate-pull” property

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

Allow pull-based scheduling.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: FALSE

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “discont-wait” property

Packit 971217
  “discont-wait”             guint64
Packit 971217

A window of time in nanoseconds to wait before creating a discontinuity as

Packit 971217
a result of breaching the drift-tolerance.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: <= 18446744073709551614

Packit 971217

Default value: 1000000000

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “drift-tolerance” property

Packit 971217
  “drift-tolerance”          gint64
Packit 971217

Controls the amount of time in microseconds that clocks are allowed

Packit 971217
to drift before resynchronisation happens.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: >= 1

Packit 971217

Default value: 40000

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “latency-time” property

Packit 971217
  “latency-time”             gint64
Packit 971217

The minimum amount of data to write in each iteration in microseconds.

Packit 971217

Flags: Read / Write

Packit 971217

Allowed values: >= 1

Packit 971217

Default value: 10000

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “provide-clock” property

Packit 971217
  “provide-clock”            gboolean
Packit 971217

Provide a clock to be used as the global pipeline clock.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: TRUE

Packit 971217
Packit 971217

Packit 971217
Packit 971217

The “slave-method” property

Packit 971217
  “slave-method”             GstAudioBaseSinkSlaveMethod
Packit 971217

Algorithm used to match the rate of the masterclock.

Packit 971217

Flags: Read / Write

Packit 971217

Default value: GST_AUDIO_BASE_SINK_SLAVE_SKEW

Packit 971217
Packit 971217
Packit 971217
Packit 971217

See Also

Packit 971217

GstAudioSink, GstAudioRingBuffer.

Packit 971217
Packit 971217
Packit 971217
Packit 971217

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