[−][src]Trait gstreamer_base::BaseSinkExt
Required methods
fn get_blocksize(&self) -> u32
Get the number of bytes that the sink will pull when it is operating in pull mode.
Returns
the number of bytes self
will pull in pull mode.
fn get_drop_out_of_segment(&self) -> bool
Checks if self
is currently configured to drop buffers which are outside
the current segment
Feature: v1_12
Returns
true
if the sink is configured to drop buffers outside the
current segment.
fn get_last_sample(&self) -> Option<Sample>
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 gst::Caps
on the sample can be used to determine the type of the buffer.
Free-function: gst_sample_unref
Returns
a gst::Sample
. gst::Sample::unref
after
usage. This function returns None
when no buffer has arrived in the
sink yet or when the sink is not in PAUSED or PLAYING.
fn get_latency(&self) -> ClockTime
fn get_max_bitrate(&self) -> u64
Get the maximum amount of bits per second that the sink will render.
Returns
the maximum number of bits per second self
will render.
fn get_max_lateness(&self) -> i64
Gets the max lateness value. See BaseSinkExt::set_max_lateness
for
more details.
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.
fn get_processing_deadline(&self) -> ClockTime
Get the processing deadline of self
. see
BaseSinkExt::set_processing_deadline
for more information about
the processing deadline.
Feature: v1_16
Returns
the processing deadline
fn get_render_delay(&self) -> ClockTime
Get the render delay of self
. see BaseSinkExt::set_render_delay
for more
information about the render delay.
Returns
the render delay of self
.
fn get_stats(&self) -> Option<Structure>
Return various BaseSink
statistics. This function returns a gst::Structure
with name application/x-gst-base-sink-stats
with the following fields:
- "average-rate" G_TYPE_DOUBLE average frame rate
- "dropped" G_TYPE_UINT64 Number of dropped frames
- "rendered" G_TYPE_UINT64 Number of rendered frames
Feature: v1_18
Returns
pointer to gst::Structure
fn get_sync(&self) -> bool
Checks if self
is currently configured to synchronize against the
clock.
Returns
true
if the sink is configured to synchronize against the clock.
fn get_throttle_time(&self) -> u64
Get the time that will be inserted between frames to control the maximum buffers per second.
Returns
the number of nanoseconds self
will put between frames.
fn get_ts_offset(&self) -> ClockTimeDiff
fn is_async_enabled(&self) -> bool
Checks if self
is currently configured to perform asynchronous state
changes to PAUSED.
Returns
true
if the sink is configured to perform asynchronous state
changes.
fn is_last_sample_enabled(&self) -> bool
Checks if self
is currently configured to store the last received sample in
the last-sample property.
Returns
true
if the sink is configured to store the last received sample.
fn is_qos_enabled(&self) -> bool
Checks if self
is currently configured to send Quality-of-Service events
upstream.
Returns
true
if the sink is configured to perform Quality-of-Service.
fn set_async_enabled(&self, enabled: bool)
Configures self
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.
enabled
the new async value.
fn set_blocksize(&self, blocksize: u32)
Set the number of bytes that the sink will pull when it is operating in pull mode.
blocksize
the blocksize in bytes
fn set_drop_out_of_segment(&self, drop_out_of_segment: bool)
Configure self
to drop buffers which are outside the current segment
Feature: v1_12
drop_out_of_segment
drop buffers outside the segment
fn set_last_sample_enabled(&self, enabled: bool)
Configures self
to store the last received sample in the last-sample
property.
enabled
the new enable-last-sample value.
fn set_max_bitrate(&self, max_bitrate: u64)
Set the maximum amount of bits per second that the sink will render.
max_bitrate
the max_bitrate in bits per second
fn set_max_lateness(&self, max_lateness: i64)
Sets the new max lateness value to max_lateness
. 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.
max_lateness
the new max lateness value.
fn set_processing_deadline(&self, processing_deadline: ClockTime)
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.
Feature: v1_16
processing_deadline
the new processing deadline in nanoseconds.
fn set_qos_enabled(&self, enabled: bool)
fn set_render_delay(&self, delay: ClockTime)
Set the render delay in self
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.
delay
the new delay
fn set_sync(&self, sync: bool)
Configures self
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.
sync
the new sync value.
fn set_throttle_time(&self, throttle: u64)
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.
throttle
the throttle time in nanoseconds
fn set_ts_offset(&self, offset: ClockTimeDiff)
Adjust the synchronisation of self
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.
offset
the new offset
fn get_property_async(&self) -> bool
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.
fn set_property_async(&self, async: bool)
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.
fn get_property_enable_last_sample(&self) -> bool
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 None
. This can be useful if you need buffers to be released as soon
as possible, eg. if you're using a buffer pool.
fn set_property_enable_last_sample(&self, enable_last_sample: bool)
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 None
. This can be useful if you need buffers to be released as soon
as possible, eg. if you're using a buffer pool.
fn get_property_qos(&self) -> bool
fn set_property_qos(&self, qos: bool)
fn connect_property_async_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
fn connect_property_blocksize_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
fn connect_property_enable_last_sample_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
fn connect_property_last_sample_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
fn connect_property_max_bitrate_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
fn connect_property_max_lateness_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
fn connect_property_processing_deadline_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
fn connect_property_qos_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
fn connect_property_render_delay_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
fn connect_property_stats_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
fn connect_property_sync_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
fn connect_property_throttle_time_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
fn connect_property_ts_offset_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
&self,
f: F
) -> SignalHandlerId
Implementors
impl<O: IsA<BaseSink>> BaseSinkExt for O
[src]
fn get_blocksize(&self) -> u32
[src]
fn get_drop_out_of_segment(&self) -> bool
[src]
fn get_last_sample(&self) -> Option<Sample>
[src]
fn get_latency(&self) -> ClockTime
[src]
fn get_max_bitrate(&self) -> u64
[src]
fn get_max_lateness(&self) -> i64
[src]
fn get_processing_deadline(&self) -> ClockTime
[src]
fn get_render_delay(&self) -> ClockTime
[src]
fn get_stats(&self) -> Option<Structure>
[src]
fn get_sync(&self) -> bool
[src]
fn get_throttle_time(&self) -> u64
[src]
fn get_ts_offset(&self) -> ClockTimeDiff
[src]
fn is_async_enabled(&self) -> bool
[src]
fn is_last_sample_enabled(&self) -> bool
[src]
fn is_qos_enabled(&self) -> bool
[src]
fn set_async_enabled(&self, enabled: bool)
[src]
fn set_blocksize(&self, blocksize: u32)
[src]
fn set_drop_out_of_segment(&self, drop_out_of_segment: bool)
[src]
fn set_last_sample_enabled(&self, enabled: bool)
[src]
fn set_max_bitrate(&self, max_bitrate: u64)
[src]
fn set_max_lateness(&self, max_lateness: i64)
[src]
fn set_processing_deadline(&self, processing_deadline: ClockTime)
[src]
fn set_qos_enabled(&self, enabled: bool)
[src]
fn set_render_delay(&self, delay: ClockTime)
[src]
fn set_sync(&self, sync: bool)
[src]
fn set_throttle_time(&self, throttle: u64)
[src]
fn set_ts_offset(&self, offset: ClockTimeDiff)
[src]
fn get_property_async(&self) -> bool
[src]
fn set_property_async(&self, async: bool)
[src]
fn get_property_enable_last_sample(&self) -> bool
[src]
fn set_property_enable_last_sample(&self, enable_last_sample: bool)
[src]
fn get_property_qos(&self) -> bool
[src]
fn set_property_qos(&self, qos: bool)
[src]
fn connect_property_async_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId
fn connect_property_blocksize_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId
fn connect_property_enable_last_sample_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId
fn connect_property_last_sample_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId
fn connect_property_max_bitrate_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId
fn connect_property_max_lateness_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId
fn connect_property_processing_deadline_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId
fn connect_property_qos_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId
fn connect_property_render_delay_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId
fn connect_property_stats_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId
fn connect_property_sync_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId
fn connect_property_throttle_time_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId
fn connect_property_ts_offset_notify<F: Fn(&Self) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId
[src]
&self,
f: F
) -> SignalHandlerId