Package org.freedesktop.gstreamer.base

Class BaseSink.Builder<B extends BaseSink.Builder<B>>

java.lang.Object

io.github.jwharm.javagi.gobject.Builder<B>

org.gnome.gobject.GObject.Builder<B>

org.gnome.gobject.InitiallyUnowned.Builder<B>

org.freedesktop.gstreamer.gst.GstObject.Builder<B>

org.freedesktop.gstreamer.gst.Element.Builder<B>

org.freedesktop.gstreamer.base.BaseSink.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Direct Known Subclasses:

AudioBaseSink.Builder, VideoSink.Builder

Enclosing class:

BaseSink

public static class BaseSink.Builder<B extends BaseSink.Builder<B>>
extends Element.Builder<B>

Inner class implementing a builder pattern to construct a GObject with properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor for a Builder object.

Method Summary

Modifier and Type	Method	Description
BaseSink	build()	Finish building the BaseSink object.
B	setAsync(boolean async)	If set to true, the basesink will perform asynchronous state changes.
B	setBlocksize(int blocksize)	The amount of bytes to pull when operating in pull mode.
B	setEnableLastSample(boolean enableLastSample)	Enable the last-sample property.
B	setMaxBitrate(long maxBitrate)	Control the maximum amount of bits that will be rendered per second.
B	setMaxLateness(long maxLateness)
B	setProcessingDeadline(long processingDeadline)	Maximum amount of time (in nanoseconds) that the pipeline can take for processing the buffer.
B	setQos(boolean qos)
B	setRenderDelay(long renderDelay)	The additional delay between synchronisation and actual rendering of the media.
B	setSync(boolean sync)
B	setThrottleTime(long throttleTime)	The time to insert between buffers.
B	setTsOffset(long tsOffset)	Controls the final synchronisation, a negative value will render the buffer earlier while a positive value delays playback.

Methods inherited from class org.freedesktop.gstreamer.gst.Element.Builder

onNoMorePads, onPadAdded, onPadRemoved

Methods inherited from class org.freedesktop.gstreamer.gst.GstObject.Builder

onDeepNotify, setName, setParent

Methods inherited from class org.gnome.gobject.GObject.Builder

onNotify

Methods inherited from class io.github.jwharm.javagi.gobject.Builder

addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public BaseSink build()

Finish building the BaseSink object. This will call GObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[]) to create a new GObject instance, which is then cast to BaseSink.

Overrides:

build in class Element.Builder<B extends BaseSink.Builder<B>>

Returns:

a new instance of BaseSink with the properties that were set in the Builder object.

setAsync

public B setAsync(boolean async)

If set to true, the basesink will perform asynchronous state changes. When set to false, the sink will not signal the parent when it prerolls. Use this option when dealing with sparse streams or when synchronisation is not required.

Parameters:

async - the value for the async property

Returns:

the Builder instance is returned, to allow method chaining

setBlocksize

public B setBlocksize(int blocksize)

The amount of bytes to pull when operating in pull mode.

Parameters:

blocksize - the value for the blocksize property

Returns:

the Builder instance is returned, to allow method chaining

setEnableLastSample

public B setEnableLastSample(boolean enableLastSample)

Enable the last-sample property. If false, basesink doesn't keep a reference to the last buffer arrived and the last-sample property is always set to null. This can be useful if you need buffers to be released as soon as possible, eg. if you're using a buffer pool.

Parameters:

enableLastSample - the value for the enable-last-sample property

Returns:

the Builder instance is returned, to allow method chaining

setMaxBitrate

public B setMaxBitrate(long maxBitrate)

Control the maximum amount of bits that will be rendered per second. Setting this property to a value bigger than 0 will make the sink delay rendering of the buffers when it would exceed to max-bitrate.

Parameters:

maxBitrate - the value for the max-bitrate property

Returns:

the Builder instance is returned, to allow method chaining

setMaxLateness

public B setMaxLateness(long maxLateness)

setProcessingDeadline

public B setProcessingDeadline(long processingDeadline)

Maximum amount of time (in nanoseconds) that the pipeline can take for processing the buffer. This is added to the latency of live pipelines.

Parameters:

processingDeadline - the value for the processing-deadline property

Returns:

the Builder instance is returned, to allow method chaining

setQos

public B setQos(boolean qos)

setRenderDelay

public B setRenderDelay(long renderDelay)

The additional delay between synchronisation and actual rendering of the media. This property will add additional latency to the device in order to make other sinks compensate for the delay.

Parameters:

renderDelay - the value for the render-delay property

Returns:

the Builder instance is returned, to allow method chaining

setSync

public B setSync(boolean sync)

setThrottleTime

public B setThrottleTime(long throttleTime)

The time to insert between buffers. This property can be used to control the maximum amount of buffers per second to render. Setting this property to a value bigger than 0 will make the sink create THROTTLE QoS events.

Parameters:

throttleTime - the value for the throttle-time property

Returns:

the Builder instance is returned, to allow method chaining

setTsOffset

public B setTsOffset(long tsOffset)

Controls the final synchronisation, a negative value will render the buffer earlier while a positive value delays playback. This property can be used to fix synchronisation in bad files.

Parameters:

tsOffset - the value for the ts-offset property

Returns:

the Builder instance is returned, to allow method chaining