gstaudio.audio_base_sink

Module for [AudioBaseSink] class

class AudioBaseSink AudioBaseSinkGidBuilder AudioBaseSinkGidBuilderImpl

Types 3

classAudioBaseSink : gstbase.base_sink.BaseSink

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.

Methods

GType _getGType() static nothrow

GType _gType() @property nothrow

AudioBaseSink self() nothrowReturns `this`, for use in `with` statements.

AudioBaseSinkGidBuilder builder() static nothrowGet builder for [gstaudio.audio_base_sink.AudioBaseSink] Returns: New builder object

ulong alignmentThreshold() @property nothrow

void alignmentThreshold(ulong propval) @property nothrow

long bufferTime() @property nothrow

void bufferTime(long propval) @property nothrow

bool canActivatePull() @property nothrow

void canActivatePull(bool propval) @property nothrow

ulong discontWait() @property nothrowGet `discontWait` property. Returns: A window of time in nanoseconds to wait before creating a discontinuity as a result of breaching the drift-tolerance.

void discontWait(ulong propval) @property nothrowSet `discontWait` property. Params: propval = A window of time in nanoseconds to wait before creating a discontinuity as a result of breaching the drift-tolerance.

long driftTolerance() @property nothrowGet `driftTolerance` property. Returns: Controls the amount of time in microseconds that clocks are allowed to drift before resynchronisation happens.

void driftTolerance(long propval) @property nothrowSet `driftTolerance` property. Params: propval = Controls the amount of time in microseconds that clocks are allowed to drift before resynchronisation happens.

long latencyTime() @property nothrow

void latencyTime(long propval) @property nothrow

bool provideClock() @property nothrow

void provideClock(bool propval) @property nothrow

gstaudio.types.AudioBaseSinkSlaveMethod slaveMethod() @property nothrow

void slaveMethod(gstaudio.types.AudioBaseSinkSlaveMethod propval) @property nothrow

gstaudio.audio_ring_buffer.AudioRingBuffer createRingbuffer() nothrowCreate and return the #GstAudioRingBuffer for sink. This function will call the ::create_ringbuffer vmethod and will set sink as the parent of the returned buffer (see [gst.object.ObjectWrap.setPar...

gst.types.ClockTime getAlignmentThreshold() nothrowGet the current alignment threshold, in nanoseconds, used by sink. Returns: The current alignment threshold used by sink.

gst.types.ClockTime getDiscontWait() nothrowGet the current discont wait, in nanoseconds, used by sink. Returns: The current discont wait used by sink.

long getDriftTolerance() nothrowGet the current drift tolerance, in microseconds, used by sink. Returns: The current drift tolerance used by sink.

bool getProvideClock() nothrowQueries whether sink will provide a clock or not. See also gst_audio_base_sink_set_provide_clock. Returns: true if sink will provide a clock.

gstaudio.types.AudioBaseSinkSlaveMethod getSlaveMethod() nothrowGet the current slave method used by sink. Returns: The current slave method used by sink.

void reportDeviceFailure() nothrowInforms this base class that the audio output device has failed for some reason, causing a discontinuity (for example, because the device recovered from the error, but lost all contents of its ring...

void setAlignmentThreshold(gst.types.ClockTime alignmentThreshold) nothrowControls the sink's alignment threshold.

void setCustomSlavingCallback(gstaudio.types.AudioBaseSinkCustomSlavingCallback callback) nothrowSets the custom slaving callback. This callback will be invoked if the slave-method property is set to GST_AUDIO_BASE_SINK_SLAVE_CUSTOM and the audio sink receives and plays samples.

void setDiscontWait(gst.types.ClockTime discontWait) nothrowControls how long the sink will wait before creating a discontinuity.

void setDriftTolerance(long driftTolerance) nothrowControls the sink's drift tolerance.

void setProvideClock(bool provide) nothrowControls whether sink will provide a clock or not. If provide is true, [gst.element.Element.provideClock] will return a clock that reflects the datarate of sink. If provide is false, [gst.element.E...

void setSlaveMethod(gstaudio.types.AudioBaseSinkSlaveMethod method) nothrowControls how clock slaving will be performed in sink.

Constructors

this(void * ptr, Flag!"Take" take)

classAudioBaseSinkGidBuilderImpl(T) : gstbase.base_sink.BaseSinkGidBuilderImpl!T

Fluent builder implementation template for gstaudio.audio_base_sink.AudioBaseSink

Methods

T alignmentThreshold(ulong propval) nothrow

T bufferTime(long propval) nothrow

T canActivatePull(bool propval) nothrow

T discontWait(ulong propval) nothrowSet `discontWait` property. Params: propval = A window of time in nanoseconds to wait before creating a discontinuity as a result of breaching the drift-tolerance. Returns: Builder instance for flu...

T driftTolerance(long propval) nothrowSet `driftTolerance` property. Params: propval = Controls the amount of time in microseconds that clocks are allowed to drift before resynchronisation happens. Returns: Builder instance for fluent ...

T latencyTime(long propval) nothrow

T provideClock(bool propval) nothrow

T slaveMethod(gstaudio.types.AudioBaseSinkSlaveMethod propval) nothrow

classAudioBaseSinkGidBuilder : AudioBaseSinkGidBuilderImpl!AudioBaseSinkGidBuilder

Fluent builder for gstaudio.audio_base_sink.AudioBaseSink

Methods

AudioBaseSink build() nothrowCreate object from builder. Returns: New object