gstbaseaudiosink

gstbaseaudiosink — Base class for audio sinks

Synopsis


#include <gst/audio/gstbaseaudiosink.h>


            GstBaseAudioSink;
            GstBaseAudioSinkClass;
#define     GST_BASE_AUDIO_SINK_CLOCK       (obj)
#define     GST_BASE_AUDIO_SINK_PAD         (obj)
GstRingBuffer* gst_base_audio_sink_create_ringbuffer
                                            (GstBaseAudioSink *sink);

Object Hierarchy


  GObject
   +----GstObject
         +----GstElement
               +----GstBaseSink
                     +----GstBaseAudioSink
                           +----GstAudioSink

Properties


  "buffer-time"          gint64                : Read / Write
  "latency-time"         gint64                : Read / Write
  "provide-clock"        gboolean              : Read / Write

Description

This is the base class for audio sinks. Subclasses need to implement the ::create_ringbuffer vmethod. This base class will then take care of writing samples to the ringbuffer, synchronisation, clipping and flushing.

Last reviewed on 2006-09-27 (0.10.12)

Details

GstBaseAudioSink

typedef struct _GstBaseAudioSink GstBaseAudioSink;

Opaque GstBaseAudioSink.


GstBaseAudioSinkClass

typedef struct {
  GstBaseSinkClass parent_class;

  /* subclass ringbuffer allocation */
  GstRingBuffer* (*create_ringbuffer)  (GstBaseAudioSink *sink);
} GstBaseAudioSinkClass;

GstBaseAudioSink class. Override the vmethod to implement functionality.

GstBaseSinkClass parent_class;GstBaseSinkClassparent_class the parent class. the parent class. create_ringbuffer ()create_ringbuffer create and return a GstRingBuffer to write to. create and return a GstRingBuffer to write to. GstRingBufferGstRingBuffer
GstBaseSinkClass parent_class; the parent class.
create_ringbuffer () create and return a GstRingBuffer to write to.

GST_BASE_AUDIO_SINK_CLOCK()

#define GST_BASE_AUDIO_SINK_CLOCK(obj)   (GST_BASE_AUDIO_SINK (obj)->clock)

Get the GstClock of obj.

obj :obj a GstBaseAudioSink a GstBaseAudioSink GstBaseAudioSinkGstBaseAudioSink
obj : a GstBaseAudioSink

GST_BASE_AUDIO_SINK_PAD()

#define GST_BASE_AUDIO_SINK_PAD(obj)     (GST_BASE_SINK (obj)->sinkpad)

Get the sink GstPad of obj.

obj :obj a GstBaseAudioSink a GstBaseAudioSink GstBaseAudioSinkGstBaseAudioSink
obj : a GstBaseAudioSink

gst_base_audio_sink_create_ringbuffer ()

GstRingBuffer* gst_base_audio_sink_create_ringbuffer
                                            (GstBaseAudioSink *sink);

Create and return the GstRingBuffer for sink. This function will call the ::create_ringbuffer vmethod and will set sink as the parent of the returned buffer (see gst_object_set_parent()).

sink :sink a GstBaseAudioSink. a GstBaseAudioSink. GstBaseAudioSinkGstBaseAudioSinkReturns :Returns The new ringbuffer of sink. The new ringbuffer of sink. sink
sink : a GstBaseAudioSink.
Returns : The new ringbuffer of sink.

Property Details

The "buffer-time" property

  "buffer-time"          gint64                : Read / Write

Size of audio buffer in microseconds.

Allowed values: >= 1

Default value: 200000


The "latency-time" property

  "latency-time"         gint64                : Read / Write

Audio latency in microseconds.

Allowed values: >= 1

Default value: 10000


The "provide-clock" property

  "provide-clock"        gboolean              : Read / Write

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

Default value: TRUE

See Also

GstAudioSink, GstRingBuffer.