GI.GstBase.Objects.BaseSink

BaseSink is the base class for sink elements in GStreamer, such as xvimagesink or filesink. It is a layer on top of Element that provides a simplified interface to plugin writers. BaseSink handles many details for you, for example: preroll, clock synchronization, state changes, activation in push or pull mode, and queries.

In most cases, when writing sink elements, there is no need to implement class methods from Element or to set functions on pads, because the BaseSink infrastructure should be sufficient.

BaseSink provides support for exactly one sink pad, which should be named "sink". A sink implementation (subclass of BaseSink) should install a pad template in its class_init function, like so:

C code

static void
my_element_class_init (GstMyElementClass *klass)
{
  GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);

  // sinktemplate should be a #GstStaticPadTemplate with direction
  // %GST_PAD_SINK and name "sink"
  gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);

  gst_element_class_set_static_metadata (gstelement_class,
      "Sink name",
      "Sink",
      "My Sink element",
      "The author <[e-mail]>");
}

BaseSink will handle the prerolling correctly. This means that it will return StateChangeReturnAsync from a state change to PAUSED until the first buffer arrives in this element. The base class will call the BaseSinkClass.preroll() vmethod with this preroll buffer and will then commit the state change to the next asynchronously pending state.

When the element is set to PLAYING, BaseSink will synchronise on the clock using the times returned from BaseSinkClass.get_times(). If this function returns CLOCK_TIME_NONE for the start time, no synchronisation will be done. Synchronisation can be disabled entirely by setting the object BaseSink:sync property to False.

After synchronisation the virtual method BaseSinkClass.render() will be called. Subclasses should minimally implement this method.

Subclasses that synchronise on the clock in the BaseSinkClass.render() method are supported as well. These classes typically receive a buffer in the render method and can then potentially block on the clock while rendering. A typical example is an audiosink. These subclasses can use baseSinkWaitPreroll to perform the blocking wait.

Upon receiving the EOS event in the PLAYING state, BaseSink will wait for the clock to reach the time indicated by the stop time of the last BaseSinkClass.get_times() call before posting an EOS message. When the element receives EOS in PAUSED, preroll completes, the event is queued and an EOS message is posted when going to PLAYING.

BaseSink will internally use the EventTypeSegment events to schedule synchronisation and clipping of buffers. Buffers that fall completely outside of the current segment are dropped. Buffers that fall partially in the segment are rendered (and prerolled). Subclasses should do any subbuffer clipping themselves when needed.

BaseSink will by default report the current playback position in FormatTime based on the current clock time and segment information. If no clock has been set on the element, the query will be forwarded upstream.

The BaseSinkClass.set_caps() function will be called when the subclass should configure itself to process a specific media type.

The BaseSinkClass.start() and BaseSinkClass.stop() virtual methods will be called when resources should be allocated. Any BaseSinkClass.preroll(), BaseSinkClass.render() and BaseSinkClass.set_caps() function will be called between the BaseSinkClass.start() and BaseSinkClass.stop() calls.

The BaseSinkClass.event() virtual method will be called when an event is received by BaseSink. Normally this method should only be overridden by very specific elements (such as file sinks) which need to handle the newsegment event specially.

The BaseSinkClass.unlock() method is called when the elements should unblock any blocking operations they perform in the BaseSinkClass.render() method. This is mostly useful when the BaseSinkClass.render() method performs a blocking write on a file descriptor, for example.

The BaseSink:max-lateness property affects how the sink deals with buffers that arrive too late in the sink. A buffer arrives too late in the sink when the presentation time (as a combination of the last segment, buffer timestamp and element base_time) plus the duration is before the current time of the clock. If the frame is later than max-lateness, the sink will drop the buffer without calling the render method. This feature is disabled if sync is disabled, the BaseSinkClass.get_times() method does not return a valid start time or max-lateness is set to -1 (the default). Subclasses can use baseSinkSetMaxLateness to configure the max-lateness value.

The BaseSink:qos property will enable the quality-of-service features of the basesink which gather statistics about the real-time performance of the clock synchronisation. For each buffer received in the sink, statistics are gathered and a QOS event is sent upstream with these numbers. This information can then be used by upstream elements to reduce their processing rate, for example.

The BaseSink:async property can be used to instruct the sink to never perform an ASYNC state change. This feature is mostly usable when dealing with non-synchronized streams or sparse streams.

Exported types

newtype BaseSink

Memory-managed wrapper type.

Constructors

BaseSink (ManagedPtr BaseSink)

Instances

Eq BaseSink

Defined in GI.GstBase.Objects.BaseSink

Methods

(==) :: BaseSink -> BaseSink -> Bool

(/=) :: BaseSink -> BaseSink -> Bool

GObject BaseSink

Defined in GI.GstBase.Objects.BaseSink

Methods

gobjectType :: IO GType

IsGValue BaseSink

Convert BaseSink to and from GValue with toGValue and fromGValue.

Defined in GI.GstBase.Objects.BaseSink

Methods

toGValue :: BaseSink -> IO GValue

fromGValue :: GValue -> IO BaseSink

HasParentTypes BaseSink

Defined in GI.GstBase.Objects.BaseSink

type ParentTypes BaseSink

Defined in GI.GstBase.Objects.BaseSink

type ParentTypes BaseSink = '[Element, Object, Object]

class (GObject o, IsDescendantOf BaseSink o) => IsBaseSink o

Type class for types which can be safely cast to BaseSink, for instance with toBaseSink.

Instances

(GObject o, IsDescendantOf BaseSink o) => IsBaseSink o

Defined in GI.GstBase.Objects.BaseSink

toBaseSink :: (MonadIO m, IsBaseSink o) => o -> m BaseSink

Cast to BaseSink, for types for which this is known to be safe. For general casts, use castTo.

noBaseSink :: Maybe BaseSink

A convenience alias for Nothing :: Maybe BaseSink.

Methods

Overloaded methods

doPreroll

baseSinkDoPreroll

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> MiniObject

obj: the mini object that caused the preroll

-> m FlowReturn

Returns: FlowReturnOk if the preroll completed and processing can continue. Any other return value should be returned from the render vmethod.

If the sink spawns its own thread for pulling buffers from upstream it should call this method after it has pulled a buffer. If the element needed to preroll, this function will perform the preroll and will then block until the element state is changed.

This function should be called with the PREROLL_LOCK held.

getBlocksize

baseSinkGetBlocksize

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: a BaseSink

-> m Word32

Returns: the number of bytes sink will pull in pull mode.

Get the number of bytes that the sink will pull when it is operating in pull mode.

getDropOutOfSegment

baseSinkGetDropOutOfSegment

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> m Bool

Returns: True if the sink is configured to drop buffers outside the current segment.

Checks if sink is currently configured to drop buffers which are outside the current segment

Since: 1.12

getLastSample

baseSinkGetLastSample

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> m (Maybe Sample)

Returns: a Sample. gst_sample_unref() after usage. This function returns Nothing when no buffer has arrived in the sink yet or when the sink is not in PAUSED or PLAYING.

Get the last sample that arrived in the sink and was used for preroll or for rendering. This property can be used to generate thumbnails.

The Caps on the sample can be used to determine the type of the buffer.

Free-function: gst_sample_unref

getLatency

baseSinkGetLatency

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> m Word64

Returns: The configured latency.

Get the currently configured latency.

getMaxBitrate

baseSinkGetMaxBitrate

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: a BaseSink

-> m Word64

Returns: the maximum number of bits per second sink will render.

Get the maximum amount of bits per second that the sink will render.

Since: 1.2

getMaxLateness

baseSinkGetMaxLateness

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> m Int64

Returns: The maximum time in nanoseconds that a buffer can be late before it is dropped and not rendered. A value of -1 means an unlimited time.

Gets the max lateness value. See baseSinkSetMaxLateness for more details.

getProcessingDeadline

baseSinkGetProcessingDeadline

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: a BaseSink

-> m Word64

Returns: the processing deadline

Get the processing deadline of sink. see baseSinkSetProcessingDeadline for more information about the processing deadline.

Since: 1.16

getRenderDelay

baseSinkGetRenderDelay

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: a BaseSink

-> m Word64

Returns: the render delay of sink.

Get the render delay of sink. see baseSinkSetRenderDelay for more information about the render delay.

getSync

baseSinkGetSync

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> m Bool

Returns: True if the sink is configured to synchronize against the clock.

Checks if sink is currently configured to synchronize against the clock.

getThrottleTime

baseSinkGetThrottleTime

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: a BaseSink

-> m Word64

Returns: the number of nanoseconds sink will put between frames.

Get the time that will be inserted between frames to control the maximum buffers per second.

getTsOffset

baseSinkGetTsOffset

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> m Int64

Returns: The synchronisation offset.

Get the synchronisation offset of sink.

isAsyncEnabled

baseSinkIsAsyncEnabled

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> m Bool

Returns: True if the sink is configured to perform asynchronous state changes.

Checks if sink is currently configured to perform asynchronous state changes to PAUSED.

isLastSampleEnabled

baseSinkIsLastSampleEnabled

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> m Bool

Returns: True if the sink is configured to store the last received sample.

Checks if sink is currently configured to store the last received sample in the last-sample property.

isQosEnabled

baseSinkIsQosEnabled

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> m Bool

Returns: True if the sink is configured to perform Quality-of-Service.

Checks if sink is currently configured to send Quality-of-Service events upstream.

queryLatency

baseSinkQueryLatency

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> m (Bool, Bool, Bool, Word64, Word64)

Returns: True if the query succeeded.

Query the sink for the latency parameters. The latency will be queried from the upstream elements. live will be True if sink is configured to synchronize against the clock. upstreamLive will be True if an upstream element is live.

If both live and upstreamLive are True, the sink will want to compensate for the latency introduced by the upstream elements by setting the minLatency to a strictly positive value.

This function is mostly used by subclasses.

setAsyncEnabled

baseSinkSetAsyncEnabled

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> Bool

enabled: the new async value.

-> m ()

Configures sink to perform all state changes asynchronously. When async is disabled, the sink will immediately go to PAUSED instead of waiting for a preroll buffer. This feature is useful if the sink does not synchronize against the clock or when it is dealing with sparse streams.

setBlocksize

baseSinkSetBlocksize

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: a BaseSink

-> Word32

blocksize: the blocksize in bytes

-> m ()

Set the number of bytes that the sink will pull when it is operating in pull mode.

setDropOutOfSegment

baseSinkSetDropOutOfSegment

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> Bool

dropOutOfSegment: drop buffers outside the segment

-> m ()

Configure sink to drop buffers which are outside the current segment

Since: 1.12

setLastSampleEnabled

baseSinkSetLastSampleEnabled

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> Bool

enabled: the new enable-last-sample value.

-> m ()

Configures sink to store the last received sample in the last-sample property.

setMaxBitrate

baseSinkSetMaxBitrate

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: a BaseSink

-> Word64

maxBitrate: the max_bitrate in bits per second

-> m ()

Set the maximum amount of bits per second that the sink will render.

Since: 1.2

setMaxLateness

baseSinkSetMaxLateness

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> Int64

maxLateness: the new max lateness value.

-> m ()

Sets the new max lateness value to maxLateness. This value is used to decide if a buffer should be dropped or not based on the buffer timestamp and the current clock time. A value of -1 means an unlimited time.

setProcessingDeadline

baseSinkSetProcessingDeadline

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: a BaseSink

-> Word64

processingDeadline: the new processing deadline in nanoseconds.

-> m ()

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

This function is usually called by subclasses.

Since: 1.16

setQosEnabled

baseSinkSetQosEnabled

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> Bool

enabled: the new qos value.

-> m ()

Configures sink to send Quality-of-Service events upstream.

setRenderDelay

baseSinkSetRenderDelay

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: a BaseSink

-> Word64

delay: the new delay

-> m ()

Set the render delay in sink to delay. The render delay is the time between actual rendering of a buffer and its synchronisation time. Some devices might delay media rendering which can be compensated for with this function.

After calling this function, this sink will report additional latency and other sinks will adjust their latency to delay the rendering of their media.

This function is usually called by subclasses.

setSync

baseSinkSetSync

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> Bool

sync: the new sync value.

-> m ()

Configures sink to synchronize on the clock or not. When sync is False, incoming samples will be played as fast as possible. If sync is True, the timestamps of the incoming buffers will be used to schedule the exact render time of its contents.

setThrottleTime

baseSinkSetThrottleTime

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: a BaseSink

-> Word64

throttle: the throttle time in nanoseconds

-> m ()

Set the time that will be inserted between rendered buffers. This can be used to control the maximum buffers per second that the sink will render.

setTsOffset

baseSinkSetTsOffset

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> Int64

offset: the new offset

-> m ()

Adjust the synchronisation of sink with offset. A negative value will render buffers earlier than their timestamp. A positive value will delay rendering. This function can be used to fix playback of badly timestamped buffers.

wait

baseSinkWait

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> Word64

time: the running_time to be reached

-> m (FlowReturn, Int64)

Returns: FlowReturn

This function will wait for preroll to complete and will then block until time is reached. It is usually called by subclasses that use their own internal synchronisation but want to let some synchronization (like EOS) be handled by the base class.

This function should only be called with the PREROLL_LOCK held (like when receiving an EOS event in the event vmethod or when handling buffers in render).

The time argument should be the running_time of when the timeout should happen and will be adjusted with any latency and offset configured in the sink.

waitClock

baseSinkWaitClock

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> Word64

time: the running_time to be reached

-> m (ClockReturn, Int64)

Returns: ClockReturn

This function will block until time is reached. It is usually called by subclasses that use their own internal synchronisation.

If time is not valid, no synchronisation is done and ClockReturnBadtime is returned. Likewise, if synchronisation is disabled in the element or there is no clock, no synchronisation is done and ClockReturnBadtime is returned.

This function should only be called with the PREROLL_LOCK held, like when receiving an EOS event in the BaseSinkClass.event() vmethod or when receiving a buffer in the BaseSinkClass.render() vmethod.

The time argument should be the running_time of when this method should return and is not adjusted with any latency or offset configured in the sink.

waitPreroll

baseSinkWaitPreroll

Arguments

:: (HasCallStack, MonadIO m, IsBaseSink a)

=> a

sink: the sink

-> m FlowReturn

Returns: FlowReturnOk if the preroll completed and processing can continue. Any other return value should be returned from the render vmethod.

If the BaseSinkClass.render() method performs its own synchronisation against the clock it must unblock when going from PLAYING to the PAUSED state and call this method before continuing to render the remaining data.

If the BaseSinkClass.render() method can block on something else than the clock, it must also be ready to unblock immediately on the BaseSinkClass.unlock() method and cause the BaseSinkClass.render() method to immediately call this function. In this case, the subclass must be prepared to continue rendering where it left off if this function returns FlowReturnOk.

This function will block until a state change to PLAYING happens (in which case this function returns FlowReturnOk) or the processing must be stopped due to a state change to READY or a FLUSH event (in which case this function returns FlowReturnFlushing).

This function should only be called with the PREROLL_LOCK held, like in the render function.

Properties

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.

constructBaseSinkAsync :: IsBaseSink o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “async” property. This is rarely needed directly, but it is used by new.

getBaseSinkAsync :: (MonadIO m, IsBaseSink o) => o -> m Bool

Get the value of the “async” property. When overloading is enabled, this is equivalent to

get baseSink #async

setBaseSinkAsync :: (MonadIO m, IsBaseSink o) => o -> Bool -> m ()

Set the value of the “async” property. When overloading is enabled, this is equivalent to

set baseSink [ #async := value ]

blocksize

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

constructBaseSinkBlocksize :: IsBaseSink o => Word32 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “blocksize” property. This is rarely needed directly, but it is used by new.

getBaseSinkBlocksize :: (MonadIO m, IsBaseSink o) => o -> m Word32

Get the value of the “blocksize” property. When overloading is enabled, this is equivalent to

get baseSink #blocksize

setBaseSinkBlocksize :: (MonadIO m, IsBaseSink o) => o -> Word32 -> m ()

Set the value of the “blocksize” property. When overloading is enabled, this is equivalent to

set baseSink [ #blocksize := value ]

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 Nothing. This can be useful if you need buffers to be released as soon as possible, eg. if you're using a buffer pool.

constructBaseSinkEnableLastSample :: IsBaseSink o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “enable-last-sample” property. This is rarely needed directly, but it is used by new.

getBaseSinkEnableLastSample :: (MonadIO m, IsBaseSink o) => o -> m Bool

Get the value of the “enable-last-sample” property. When overloading is enabled, this is equivalent to

get baseSink #enableLastSample

setBaseSinkEnableLastSample :: (MonadIO m, IsBaseSink o) => o -> Bool -> m ()

Set the value of the “enable-last-sample” property. When overloading is enabled, this is equivalent to

set baseSink [ #enableLastSample := value ]

lastSample

The last buffer that arrived in the sink and was used for preroll or for rendering. This property can be used to generate thumbnails. This property can be Nothing when the sink has not yet received a buffer.

getBaseSinkLastSample :: (MonadIO m, IsBaseSink o) => o -> m (Maybe Sample)

Get the value of the “last-sample” property. When overloading is enabled, this is equivalent to

get baseSink #lastSample

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.

Since: 1.2

constructBaseSinkMaxBitrate :: IsBaseSink o => Word64 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “max-bitrate” property. This is rarely needed directly, but it is used by new.

getBaseSinkMaxBitrate :: (MonadIO m, IsBaseSink o) => o -> m Word64

Get the value of the “max-bitrate” property. When overloading is enabled, this is equivalent to

get baseSink #maxBitrate

setBaseSinkMaxBitrate :: (MonadIO m, IsBaseSink o) => o -> Word64 -> m ()

Set the value of the “max-bitrate” property. When overloading is enabled, this is equivalent to

set baseSink [ #maxBitrate := value ]

maxLateness

No description available in the introspection data.

constructBaseSinkMaxLateness :: IsBaseSink o => Int64 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “max-lateness” property. This is rarely needed directly, but it is used by new.

getBaseSinkMaxLateness :: (MonadIO m, IsBaseSink o) => o -> m Int64

Get the value of the “max-lateness” property. When overloading is enabled, this is equivalent to

get baseSink #maxLateness

setBaseSinkMaxLateness :: (MonadIO m, IsBaseSink o) => o -> Int64 -> m ()

Set the value of the “max-lateness” property. When overloading is enabled, this is equivalent to

set baseSink [ #maxLateness := value ]

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.

Since: 1.16

constructBaseSinkProcessingDeadline :: IsBaseSink o => Word64 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “processing-deadline” property. This is rarely needed directly, but it is used by new.

getBaseSinkProcessingDeadline :: (MonadIO m, IsBaseSink o) => o -> m Word64

Get the value of the “processing-deadline” property. When overloading is enabled, this is equivalent to

get baseSink #processingDeadline

setBaseSinkProcessingDeadline :: (MonadIO m, IsBaseSink o) => o -> Word64 -> m ()

Set the value of the “processing-deadline” property. When overloading is enabled, this is equivalent to

set baseSink [ #processingDeadline := value ]

qos

No description available in the introspection data.

constructBaseSinkQos :: IsBaseSink o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “qos” property. This is rarely needed directly, but it is used by new.

getBaseSinkQos :: (MonadIO m, IsBaseSink o) => o -> m Bool

Get the value of the “qos” property. When overloading is enabled, this is equivalent to

get baseSink #qos

setBaseSinkQos :: (MonadIO m, IsBaseSink o) => o -> Bool -> m ()

Set the value of the “qos” property. When overloading is enabled, this is equivalent to

set baseSink [ #qos := value ]

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.

constructBaseSinkRenderDelay :: IsBaseSink o => Word64 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “render-delay” property. This is rarely needed directly, but it is used by new.

getBaseSinkRenderDelay :: (MonadIO m, IsBaseSink o) => o -> m Word64

Get the value of the “render-delay” property. When overloading is enabled, this is equivalent to

get baseSink #renderDelay

setBaseSinkRenderDelay :: (MonadIO m, IsBaseSink o) => o -> Word64 -> m ()

Set the value of the “render-delay” property. When overloading is enabled, this is equivalent to

set baseSink [ #renderDelay := value ]

sync

No description available in the introspection data.

constructBaseSinkSync :: IsBaseSink o => Bool -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “sync” property. This is rarely needed directly, but it is used by new.

getBaseSinkSync :: (MonadIO m, IsBaseSink o) => o -> m Bool

Get the value of the “sync” property. When overloading is enabled, this is equivalent to

get baseSink #sync

setBaseSinkSync :: (MonadIO m, IsBaseSink o) => o -> Bool -> m ()

Set the value of the “sync” property. When overloading is enabled, this is equivalent to

set baseSink [ #sync := value ]

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.

constructBaseSinkThrottleTime :: IsBaseSink o => Word64 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “throttle-time” property. This is rarely needed directly, but it is used by new.

getBaseSinkThrottleTime :: (MonadIO m, IsBaseSink o) => o -> m Word64

Get the value of the “throttle-time” property. When overloading is enabled, this is equivalent to

get baseSink #throttleTime

setBaseSinkThrottleTime :: (MonadIO m, IsBaseSink o) => o -> Word64 -> m ()

Set the value of the “throttle-time” property. When overloading is enabled, this is equivalent to

set baseSink [ #throttleTime := value ]

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.

constructBaseSinkTsOffset :: IsBaseSink o => Int64 -> IO (GValueConstruct o)

Construct a GValueConstruct with valid value for the “ts-offset” property. This is rarely needed directly, but it is used by new.

getBaseSinkTsOffset :: (MonadIO m, IsBaseSink o) => o -> m Int64

Get the value of the “ts-offset” property. When overloading is enabled, this is equivalent to

get baseSink #tsOffset

setBaseSinkTsOffset :: (MonadIO m, IsBaseSink o) => o -> Int64 -> m ()

Set the value of the “ts-offset” property. When overloading is enabled, this is equivalent to

set baseSink [ #tsOffset := value ]