jackaudiosink

A Sink that outputs data to Jack ports.

It will create N Jack ports named out_<name>_<num> where <name> is the element name and <num> is starting from 1. Each port corresponds to a gstreamer channel.

The samplerate as exposed on the caps is always the same as the samplerate of the jack server.

When the connect property is set to auto, this element will try to connect each output port to a random physical jack input pin. In this mode, the sink will expose the number of physical channels on its pad caps.

When the connect property is set to none, the element will accept any number of input channels and will create (but not connect) an output port for each channel.

The element will generate an error when the Jack server is shut down when it was PAUSED or PLAYING. This element does not support dynamic rate and buffer size changes at runtime.

Example launch line

 gst-launch-1.0 audiotestsrc ! jackaudiosink

Play a sine wave to using jack.

Hierarchy

GObject
    ╰──GInitiallyUnowned
        ╰──GstObject
            ╰──GstElement
                ╰──GstBaseSink
                    ╰──GstAudioBaseSink
                        ╰──jackaudiosink

Factory details

Authors: – Wim Taymans

Classification:Sink/Audio

Rank – primary

Plugin – gstjack

Package – GStreamer Good Plug-ins

Pad Templates

sink

audio/x-raw:
         format: F32LE
         layout: interleaved
           rate: [ 1, 2147483647 ]
       channels: [ 1, 2147483647 ]

Presencealways

Directionsink

Object typeGstPad


Properties

alignment-threshold

“alignment-threshold” guint64

Timestamp alignment threshold in nanoseconds

Flags : Read / Write

Default value : 40000000


async

“async” gboolean

Go asynchronously to PAUSED

Flags : Read / Write

Default value : true


blocksize

“blocksize” guint

Size in bytes to pull per buffer (0 = default)

Flags : Read / Write

Default value : 4096


buffer-time

“buffer-time” gint64

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

Flags : Read / Write

Default value : 200000


can-activate-pull

“can-activate-pull” gboolean

Allow pull-based scheduling

Flags : Read / Write

Default value : false


client

“client” JackClient *

Handle for jack client

Flags : Read / Write


client-name

“client-name” gchararray

The client name to use.

Flags : Read / Write

Default value : NULL


connect

“connect” GstJackConnect *

Specify how the output ports will be connected

Flags : Read / Write

Default value : auto (1)


discont-wait

“discont-wait” guint64

Window of time in nanoseconds to wait before creating a discontinuity

Flags : Read / Write

Default value : 1000000000


drift-tolerance

“drift-tolerance” gint64

Tolerance for clock drift in microseconds

Flags : Read / Write

Default value : 40000


enable-last-sample

“enable-last-sample” gboolean

Enable the last-sample property

Flags : Read / Write

Default value : false


last-sample

“last-sample” GstSample *

The last sample received in the sink

Flags : Read


latency-time

“latency-time” gint64

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

Flags : Read / Write

Default value : 10000


max-bitrate

“max-bitrate” guint64

The maximum bits per second to render (0 = disabled)

Flags : Read / Write

Default value : 0


max-lateness

“max-lateness” gint64

Maximum number of nanoseconds that a buffer can be late before it is dropped (-1 unlimited)

Flags : Read / Write

Default value : 18446744073709551615


port-pattern

“port-pattern” gchararray

autoconnect to ports matching pattern, when NULL connect to physical ports

Flags : Read / Write

Default value : NULL


processing-deadline

“processing-deadline” guint64

Maximum processing time for a buffer in nanoseconds

Flags : Read / Write

Default value : 20000000


provide-clock

“provide-clock” gboolean

Provide a clock to be used as the global pipeline clock

Flags : Read / Write

Default value : true


qos

“qos” gboolean

Generate Quality-of-Service events upstream

Flags : Read / Write

Default value : false


render-delay

“render-delay” guint64

Additional render delay of the sink in nanoseconds

Flags : Read / Write

Default value : 0


server

“server” gchararray

The Jack server to connect to (NULL = default)

Flags : Read / Write

Default value : NULL


slave-method

“slave-method” GstAudioBaseSinkSlaveMethod *

Algorithm used to match the rate of the masterclock

Flags : Read / Write

Default value : skew (1)


stats

“stats” GstStructure *

Sink Statistics

Flags : Read

Default value :

application/x-gst-base-sink-stats, average-rate=(double)0, dropped=(guint64)0, rendered=(guint64)0;

sync

“sync” gboolean

Sync on the clock

Flags : Read / Write

Default value : true


throttle-time

“throttle-time” guint64

The time to keep between rendered buffers (0 = disabled)

Flags : Read / Write

Default value : 0


transport

“transport” GstJackTransport *

The jack transport behaviour for the client.

Flags : Read / Write

Default value : (none)


ts-offset

“ts-offset” gint64

Timestamp offset in nanoseconds

Flags : Read / Write

Default value : 0


The results of the search are