# pulsesink

Source: [https://docs.qualcomm.com/doc/80-70020-50/topic/pulsesink.html](https://docs.qualcomm.com/doc/80-70020-50/topic/pulsesink.html)

The pulsesink plugin interacts with the underlying PulseAudio sound server to play
        the PCM samples.

The PulseAudio Server interacts with the underlying hardware to provide the playback
            capability. It's based on the [GstAudioBaseSink](https://gstreamer.freedesktop.org/documentation/audio/gstaudiobasesink.html#GstAudioBaseSink) base class.

## Inheritance chain

[GObject](https://docs.gtk.org/gobject/) → [GstObject](https://gstreamer.freedesktop.org/documentation/gstreamer/gstobject.html?gi-language=c) → [GstElement](https://gstreamer.freedesktop.org/documentation/gstreamer/gstelement.html?gi-language=c) → [GstBaseSink](https://gstreamer.freedesktop.org/documentation/base/gstbasesink.html?gi-language=c#GstBaseSink)→ [GstAudioBaseSink](https://gstreamer.freedesktop.org/documentation/audio/gstaudiobasesink.html#GstAudioBaseSink) → GstPulseSink

The following tables provide information on pad templates and element properties of
                pulsesink. For use cases, see [Audio (only) playback](https://docs.qualcomm.com/doc/80-70020-50/topic/audio-use-cases.html#audio-only-playback).

## Pad configuration

| Pad Name | Capabilities | Capabilities | Capabilities |
| --- | --- | --- | --- |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/x-raw | format: | { (string)S16LE, (string)S16BE, (string)F32LE, (string)F32BE,<br>                                (string)S32LE, (string)S32BE, (string)S24LE, (string)S24BE,<br>                                (string)S24\_32LE, (string)S24\_32BE, (string)U8 } |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/x-raw | layout: | interleaved |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/x-raw | rate: | [ 1, 22579200 ] |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/x-raw | channels: | [ 1, 32 ] |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/x-alaw | rate: | [ 1, 22579200 ] |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/x-alaw | channels: | [ 1, 32 ] |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/x-mulaw | rate: | [ 1, 22579200 ] |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/x-mulaw | channels: | [ 1, 32 ] |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/x-ac3 | framed: | true |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/x-eac3 | framed: | true |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/x-dts | framed: | true |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/x-dts | block-size: | { (int)512, (int)1024, (int)2048 } |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/mpeg | mpegversion: | 1 |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/mpeg | mpegaudioversion: | [ 1, 3 ] |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/mpeg | parsed: | true |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/mpeg | mpegversion: | { (int)2, (int)4 } |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/mpeg | framed: | true |
| SINK template: 'sink'<br><br><br>                                <br>*Availability:* Always<br><br><br>                                <br>*Direction:* sink | audio/mpeg | stream-format: | adts |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |
|  |  |  |  |

## Element configuration

Table : Elements properties of pulsesink

| Property | Description |
| --- | --- |
| name | The name of the object.<ul class="ul" id="pulsesink__ul_gsh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">String. Default: "pulsesink0"</li><br><br>                                </ul> |
| parent | The parent of the object.<ul class="ul" id="pulsesink__ul_hsh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Object of type "GstObject"</li><br><br>                                </ul> |
| sync | Sync on the clock.<ul class="ul" id="pulsesink__ul_ish_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Boolean. Default: true</li><br><br>                                </ul> |
| max-lateness | Maximum number of nanoseconds that a buffer can be late before<br>                                it's dropped (-1 unlimited).<ul class="ul" id="pulsesink__ul_jsh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Integer64. Range: ˗1to 9223372036854775807, default: ˗1</li><br><br>                                </ul> |
| qos | Generate quality-of-service events upstream.<ul class="ul" id="pulsesink__ul_ksh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Boolean. Default: false</li><br><br>                                </ul> |
| async | Go asynchronously to PAUSED.<ul class="ul" id="pulsesink__ul_lsh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Boolean. Default: true</li><br><br>                                </ul> |
| ts-offset | Timestamp offset in nanoseconds.<ul class="ul" id="pulsesink__ul_msh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Integer64. Range: ˗9223372036854775808 to<br>                                        9223372036854775807, default: 0</li><br><br>                                </ul> |
| enable-last-sample | Enable the last-sample property.<ul class="ul" id="pulsesink__ul_nsh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Boolean. Default: false</li><br><br>                                </ul> |
| last-sample | The last sample received in the sink.<ul class="ul" id="pulsesink__ul_osh_4b4_myb"><br>                                    <li class="li">flags: readable</li><br><br>                                    <li class="li">Boxed pointer of type "GstSample"</li><br><br>                                </ul> |
| blocksize | Size in bytes to pull per buffer (0 = default).<ul class="ul" id="pulsesink__ul_psh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Unsigned Integer. Range: 0 - 4294967295 Default: 4096</li><br><br>                                </ul> |
| render-delay | Additional render delay of the sink in nanoseconds.<ul class="ul" id="pulsesink__ul_qsh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Unsigned Integer64. Range: 0 - 18446744073709551615 Default:<br>                                        0</li><br><br>                                </ul> |
| throttle-time | The time to keep between rendered buffers (0 = disabled).<ul class="ul" id="pulsesink__ul_rsh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Unsigned Integer64. Range: 0 - 18446744073709551615 Default:<br>                                        0</li><br><br>                                </ul> |
| max-bitrate | The maximum bits per second to render (0 = disabled).<ul class="ul" id="pulsesink__ul_ssh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Unsigned Integer64. Range: 0 - 18446744073709551615 Default:<br>                                        0</li><br><br>                                </ul> |
| buffer-time | Size of audio buffer in microseconds, this is the minimum latency<br>                                that the sink reports.<ul class="ul" id="pulsesink__ul_tsh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Integer64. Range: 1 - 9223372036854775807 Default:<br>                                        200000</li><br><br>                                </ul> |
| latency-time | The minimum amount of data to write in each iteration in<br>                                    microseconds.<ul class="ul" id="pulsesink__ul_ush_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Integer64. Range: 1 - 9223372036854775807 Default:<br>                                        10000</li><br><br>                                </ul> |
| provide-clock | Provide a clock to be used as the global pipeline clock.<ul class="ul" id="pulsesink__ul_vsh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Boolean. Default: true</li><br><br>                                </ul> |
| slave-method | Algorithm used to match the rate of the primary clock.<ul class="ul" id="pulsesink__ul_wsh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                </ul><br><br>Enum "GstAudioBaseSinkSlaveMethod" Default: 1, "skew"<br><br><ul class="ul" id="pulsesink__ul_wp1_pb4_myb"><br>                                    <li class="li"> (0): resample - GST_AUDIO_BASE_SINK_SLAVE_RESAMPLE</li><br><br>                                    <li class="li"> (1): skew - GST_AUDIO_BASE_SINK_SLAVE_SKEW</li><br><br>                                    <li class="li"> (2): none - GST_AUDIO_BASE_SINK_SLAVE_NONE</li><br><br>                                    <li class="li"> (3): custom - GST_AUDIO_BASE_SINK_SLAVE_CUSTOM</li><br><br>                                </ul> |
| can-activate-pull | Allow pull-based scheduling.<ul class="ul" id="pulsesink__ul_xsh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Boolean. Default: false</li><br><br>                                </ul> |
| alignment-threshold | Timestamp alignment threshold in nanoseconds.<ul class="ul" id="pulsesink__ul_ysh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Unsigned Integer64. Range: 1 - 18446744073709551614 Default:<br>                                        40000000</li><br><br>                                </ul> |
| drift-tolerance | Tolerance for clock drift in microseconds.<ul class="ul" id="pulsesink__ul_zsh_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Integer64. Range: 1 - 9223372036854775807 Default:<br>                                        40000</li><br><br>                                </ul> |
| discont-wait | Window of time in nanoseconds to wait before creating a<br>                                    discontinuity.<ul class="ul" id="pulsesink__ul_ath_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Unsigned Integer64. Range: 0 - 18446744073709551614 Default:<br>                                        1000000000</li><br><br>                                </ul> |
| server | The PulseAudio server for connection.<ul class="ul" id="pulsesink__ul_bth_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">String. Default: null</li><br><br>                                </ul> |
| device | The PulseAudio sink device for connection.<ul class="ul" id="pulsesink__ul_cth_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">String. Default: null</li><br><br>                                </ul> |
| current-device | The current PulseAudio sink device.<ul class="ul" id="pulsesink__ul_dth_4b4_myb"><br>                                    <li class="li">flags: readable</li><br><br>                                    <li class="li">String. Default: ""</li><br><br>                                </ul> |
| device-name | Human-readable name of the sound device.<ul class="ul" id="pulsesink__ul_eth_4b4_myb"><br>                                    <li class="li">flags: readable</li><br><br>                                    <li class="li">String. Default: null</li><br><br>                                </ul> |
| volume | Linear volume of this stream, 1.0=100%.<ul class="ul" id="pulsesink__ul_fth_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Double. Range: 0 - 10 Default: 1</li><br><br>                                </ul> |
| mute | Mute state of this stream.<ul class="ul" id="pulsesink__ul_gth_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Boolean. Default: false</li><br><br>                                </ul> |
| client-name | The PulseAudio client name.<ul class="ul" id="pulsesink__ul_hth_4b4_myb"><br>                                    <li class="li">flags: readable, writable, changeable only in NULL or READY<br>                                        state</li><br><br>                                    <li class="li">String. Default: "gst-inspect-1.0"</li><br><br>                                </ul> |
| stream-properties | The list of PulseAudio stream properties.<ul class="ul" id="pulsesink__ul_ith_4b4_myb"><br>                                    <li class="li">flags: readable, writable</li><br><br>                                    <li class="li">Boxed pointer of type "GstStructure"</li><br><br>                                </ul> |
| stream-flags | The stream flags to use (not all default flags can be<br>                                    overridden).<ul class="ul" id="pulsesink__ul_jth_4b4_myb"><br>                                    <li class="li">flags: writable</li><br><br>                                    <li class="li">Flags "GstPulseStreamFlags" Default: 0x0000200b</li><br><br>                                    <li class="li">Adjust the latency of the sink/source based on the requested<br>                                        buffer metrics and adjust buffer metrics accordingly. The<br>                                        timing update requests are issued periodically<br>                                        automatically. Interpolate the latency for this stream and<br>                                        create the corked stream. <ul class="ul" id="pulsesink__ul_kth_4b4_myb"><br>                                            <li class="li">(0x00000000): Flag to pass when no specific options<br>                                                are needed - GST_PULSE_STREAM_NOFLAGS</li><br><br>                                            <li class="li">(0x00000001): Create the stream corked -<br>                                                GST_PULSE_STREAM_START_CORKED</li><br><br>                                            <li class="li">(0x00000002): Interpolate the latency for this<br>                                                stream - GST_PULSE_STREAM_INTERPOLATE_TIMING</li><br><br>                                            <li class="li">(0x00000004): Don't force the time to increase<br>                                                monotonically - GST_PULSE_STREAM_NOT_MONOTONIC</li><br><br>                                            <li class="li">(0x00000008): Timing update requests are issued<br>                                                periodically and automatically -<br>                                                GST_PULSE_STREAM_AUTO_TIMING_UPDATE</li><br><br>                                            <li class="li">(0x00000010): Don't remap channels by their name,<br>                                                instead map them by their index -<br>                                                GST_PULSE_STREAM_NO_REMAP_CHANNELS</li><br><br>                                            <li class="li">(0x00000020): When remapping channels by name, don't<br>                                                upmix or downmix them to related channels -<br>                                                GST_PULSE_STREAM_NO_REMIX_CHANNELS</li><br><br>                                            <li class="li">(0x00000040): Use the sample format of the<br>                                                sink/device to which the stream being connected -<br>                                                GST_PULSE_STREAM_FIX_FORMAT</li><br><br>                                            <li class="li">(0x00000080): Use the sample rate of the sink -<br>                                                GST_PULSE_STREAM_FIX_RATE</li><br><br>                                            <li class="li">(0x00000100): Use the number of channels and the<br>                                                channel map of the sink -<br>                                                GST_PULSE_STREAM_FIX_CHANNELS</li><br><br>                                            <li class="li">(0x00000200): Don't allow moving of this stream to<br>                                                another sink/device -<br>                                                GST_PULSE_STREAM_DONT_MOVE</li><br><br>                                            <li class="li">(0x00000400): Allow dynamic changing of the sampling<br>                                                rate during playback -<br>                                                GST_PULSE_STREAM_VARIABLE_RATE</li><br><br>                                            <li class="li">(0x00000800): Find peaks instead of resampling -<br>                                                GST_PULSE_STREAM_PEAK_DETECT</li><br><br>                                            <li class="li">(0x00001000): Create in muted state -<br>                                                GST_PULSE_STREAM_START_MUTED</li><br><br>                                            <li class="li">(0x00002000): Adjust the latency of the sink/source<br>                                                based on the requested buffer metrics and adjust<br>                                                buffer metrics accordingly -<br>                                                GST_PULSE_STREAM_ADJUST_LATENCY</li><br><br>                                            <li class="li">(0x00004000): Enable the compatibility mode for<br>                                                legacy clients that rely on a classic hardware<br>                                                device fragment-style playback model -<br>                                                GST_PULSE_STREAM_EARLY_REQUESTS</li><br><br>                                            <li class="li">(0x00008000): If set, this stream isn't considered<br>                                                when the device this stream is connected to<br>                                                auto-suspends -<br>                                                GST_PULSE_STREAM_DONT_INHIBIT_AUTO_SUSPEND</li><br><br>                                            <li class="li">(0x00010000): Create in unmuted state -<br>                                                GST_PULSE_STREAM_START_UNMUTED</li><br><br>                                            <li class="li">(0x00020000): If the sink/source connected to this<br>                                                stream is suspended during the creation of the<br>                                                stream, it cause it to fail -<br>                                                GST_PULSE_STREAM_FAIL_ON_SUSPEND</li><br><br>                                            <li class="li">(0x00040000): If volume is passed when this stream<br>                                                is created, creation of this stream fails -<br>                                                GST_PULSE_STREAM_RELATIVE_VOLUME</li><br><br>                                            <li class="li">(0x00080000): Used to tag content that are rendered<br>                                                by passthrough sinks - GST_PULSE_STREAM_PASSTHROUGH<br>                                                Write only</li><br><br>                                        </ul><br></li><br><br>                                </ul> |
| prebuf | Prebuf to be set with sink-input.<ul class="ul" id="pulsesink__ul_lth_4b4_myb"><br>                                    <li class="li">flags: writable</li><br><br>                                    <li class="li">Integer. Range: ˗1 to 2147483647, default: 0 write-only</li><br><br>                                </ul> |

**Parent Topic:** [Configure audio plugins](https://docs.qualcomm.com/doc/80-70020-50/topic/audio-plugins.html)

Last Published: Jan 30, 2026

[Previous Topic
pulsesrc](https://docs.qualcomm.com/bundle/publicresource/80-70020-50/topics/pulsesrc.md) [Next Topic
Configure ML plugins](https://docs.qualcomm.com/bundle/publicresource/80-70020-50/topics/inferencing-plugins.md)