Struct gstreamer_check::TestClock [−][src]
pub struct TestClock(_);
GstTestClock is an implementation of crate::gst::Clock which has different
behaviour compared to crate::gst::SystemClock. Time for crate::gst::SystemClock advances
according to the system time, while time for crate::TestClock changes only
when Self::set_time() or Self::advance_time() are
called. crate::TestClock provides unit tests with the possibility to
precisely advance the time in a deterministic manner, independent of the
system time or any other external factors.
Advancing the time of a crate::TestClock
#include <gst/gst.h>
#include <gst/check/gsttestclock.h>
GstClock *clock;
GstTestClock *test_clock;
clock = gst_test_clock_new ();
test_clock = GST_TEST_CLOCK (clock);
GST_INFO ("Time: %" GST_TIME_FORMAT, GST_TIME_ARGS (gst_clock_get_time (clock)));
gst_test_clock_advance_time ( test_clock, 1 * GST_SECOND);
GST_INFO ("Time: %" GST_TIME_FORMAT, GST_TIME_ARGS (gst_clock_get_time (clock)));
g_usleep (10 * G_USEC_PER_SEC);
GST_INFO ("Time: %" GST_TIME_FORMAT, GST_TIME_ARGS (gst_clock_get_time (clock)));
gst_test_clock_set_time (test_clock, 42 * GST_SECOND);
GST_INFO ("Time: %" GST_TIME_FORMAT, GST_TIME_ARGS (gst_clock_get_time (clock)));
...
crate::gst::Clock allows for setting up single shot or periodic clock notifications
as well as waiting for these notifications synchronously (using
[crate::gst::Clock::id_wait()]) or asynchronously (using [crate::gst::Clock::id_wait_async()] or
[crate::gst::Clock::id_wait_async()]). This is used by many GStreamer elements,
among them GstBaseSrc and GstBaseSink.
crate::TestClock keeps track of these clock notifications. By calling
Self::wait_for_next_pending_id() or
Self::wait_for_multiple_pending_ids() a unit tests may wait for the
next one or several clock notifications to be requested. Additionally unit
tests may release blocked waits in a controlled fashion by calling
Self::process_next_clock_id(). This way a unit test can control the
inaccuracy (jitter) of clock notifications, since the test can decide to
release blocked waits when the clock time has advanced exactly to, or past,
the requested clock notification time.
There are also interfaces for determining if a notification belongs to a
crate::TestClock or not, as well as getting the number of requested clock
notifications so far.
N.B.: When a unit test waits for a certain amount of clock notifications to
be requested in Self::wait_for_next_pending_id() or
Self::wait_for_multiple_pending_ids() then these functions may block
for a long time. If they block forever then the expected clock notifications
were never requested from crate::TestClock, and so the assumptions in the code
of the unit test are wrong. The unit test case runner in gstcheck is
expected to catch these cases either by the default test case timeout or the
one set for the unit test by calling tcase_set_timeout().
The sample code below assumes that the element under test will delay a
buffer pushed on the source pad by some latency until it arrives on the sink
pad. Moreover it is assumed that the element will at some point call
[crate::gst::Clock::id_wait()] to synchronously wait for a specific time. The first
buffer sent will arrive exactly on time only delayed by the latency. The
second buffer will arrive a little late (7ms) due to simulated jitter in the
clock notification.
Demonstration of how to work with clock notifications and crate::TestClock
#include <gst/gst.h>
#include <gst/check/gstcheck.h>
#include <gst/check/gsttestclock.h>
GstClockTime latency;
GstElement *element;
GstPad *srcpad;
GstClock *clock;
GstTestClock *test_clock;
GstBuffer buf;
GstClockID pending_id;
GstClockID processed_id;
latency = 42 * GST_MSECOND;
element = create_element (latency, ...);
srcpad = get_source_pad (element);
clock = gst_test_clock_new ();
test_clock = GST_TEST_CLOCK (clock);
gst_element_set_clock (element, clock);
GST_INFO ("Set time, create and push the first buffer\n");
gst_test_clock_set_time (test_clock, 0);
buf = create_test_buffer (gst_clock_get_time (clock), ...);
gst_assert_cmpint (gst_pad_push (srcpad, buf), ==, GST_FLOW_OK);
GST_INFO ("Block until element is waiting for a clock notification\n");
gst_test_clock_wait_for_next_pending_id (test_clock, &pending_id);
GST_INFO ("Advance to the requested time of the clock notification\n");
gst_test_clock_advance_time (test_clock, latency);
GST_INFO ("Release the next blocking wait and make sure it is the one from element\n");
processed_id = gst_test_clock_process_next_clock_id (test_clock);
g_assert (processed_id == pending_id);
g_assert_cmpint (GST_CLOCK_ENTRY_STATUS (processed_id), ==, GST_CLOCK_OK);
gst_clock_id_unref (pending_id);
gst_clock_id_unref (processed_id);
GST_INFO ("Validate that element produced an output buffer and check its timestamp\n");
g_assert_cmpint (get_number_of_output_buffer (...), ==, 1);
buf = get_buffer_pushed_by_element (element, ...);
g_assert_cmpint (GST_BUFFER_TIMESTAMP (buf), ==, latency);
gst_buffer_unref (buf);
GST_INFO ("Check that element does not wait for any clock notification\n");
g_assert (!gst_test_clock_peek_next_pending_id (test_clock, NULL));
GST_INFO ("Set time, create and push the second buffer\n");
gst_test_clock_advance_time (test_clock, 10 * GST_SECOND);
buf = create_test_buffer (gst_clock_get_time (clock), ...);
gst_assert_cmpint (gst_pad_push (srcpad, buf), ==, GST_FLOW_OK);
GST_INFO ("Block until element is waiting for a new clock notification\n");
(gst_test_clock_wait_for_next_pending_id (test_clock, &pending_id);
GST_INFO ("Advance past 7ms beyond the requested time of the clock notification\n");
gst_test_clock_advance_time (test_clock, latency + 7 * GST_MSECOND);
GST_INFO ("Release the next blocking wait and make sure it is the one from element\n");
processed_id = gst_test_clock_process_next_clock_id (test_clock);
g_assert (processed_id == pending_id);
g_assert_cmpint (GST_CLOCK_ENTRY_STATUS (processed_id), ==, GST_CLOCK_OK);
gst_clock_id_unref (pending_id);
gst_clock_id_unref (processed_id);
GST_INFO ("Validate that element produced an output buffer and check its timestamp\n");
g_assert_cmpint (get_number_of_output_buffer (...), ==, 1);
buf = get_buffer_pushed_by_element (element, ...);
g_assert_cmpint (GST_BUFFER_TIMESTAMP (buf), ==,
10 * GST_SECOND + latency + 7 * GST_MSECOND);
gst_buffer_unref (buf);
GST_INFO ("Check that element does not wait for any clock notification\n");
g_assert (!gst_test_clock_peek_next_pending_id (test_clock, NULL));
...
Since crate::TestClock is only supposed to be used in unit tests it calls
g_assert(), g_assert_cmpint() or g_assert_cmpuint() to validate all function
arguments. This will highlight any issues with the unit test code itself.
Implements
gst::prelude::ClockExt, gst::prelude::ObjectExt, trait@glib::object::ObjectExt
Implementations
impl TestClock[src]
impl TestClock[src]pub fn new() -> TestClock[src]
pub fn new() -> TestClock[src]Creates a new test clock with its time set to zero.
MT safe.
Returns
a crate::TestClock cast to crate::gst::Clock.
pub fn with_start_time(start_time: ClockTime) -> TestClock[src]
pub fn with_start_time(start_time: ClockTime) -> TestClock[src]Creates a new test clock with its time set to the specified time.
MT safe.
start_time
a crate::gst::ClockTime set to the desired start time of the clock.
Returns
a crate::TestClock cast to crate::gst::Clock.
pub fn advance_time(&self, delta: ClockTimeDiff)[src]
pub fn advance_time(&self, delta: ClockTimeDiff)[src]Advances the time of the self by the amount given by delta. The
time of self is monotonically increasing, therefore providing a
delta which is negative or zero is a programming error.
MT safe.
delta
a positive crate::gst::ClockTimeDiff to be added to the time of the clock
pub fn crank(&self) -> bool[src]
pub fn crank(&self) -> bool[src]A “crank” consists of three steps:
1: Wait for a [crate::gst::ClockID] to be registered with the crate::TestClock.
2: Advance the crate::TestClock to the time the [crate::gst::ClockID] is waiting, unless
the clock time is already passed the clock id (Since: 1.18).
3: Release the [crate::gst::ClockID] wait.
A “crank” can be though of as the notion of
manually driving the clock forward to its next logical step.
Returns
true if the crank was successful, false otherwise.
MT safe.
pub fn next_entry_time(&self) -> ClockTime[src]
pub fn next_entry_time(&self) -> ClockTime[src]Retrieve the requested time for the next pending clock notification.
MT safe.
Returns
a crate::gst::ClockTime set to the time of the next pending clock
notification. If no clock notifications have been requested
GST_CLOCK_TIME_NONE will be returned.
pub fn peek_id_count(&self) -> u32[src]
pub fn peek_id_count(&self) -> u32[src]Determine the number of pending clock notifications that have been
requested from the self.
MT safe.
Returns
the number of pending clock notifications.
pub fn set_time(&self, new_time: ClockTime)[src]
pub fn set_time(&self, new_time: ClockTime)[src]Sets the time of self to the time given by new_time. The time of
self is monotonically increasing, therefore providing a new_time
which is earlier or equal to the time of the clock as given by
[crate::gst::prelude::ClockExt::get_time()] is a programming error.
MT safe.
new_time
a crate::gst::ClockTime later than that returned by [crate::gst::prelude::ClockExt::get_time()]
pub fn wait_for_pending_id_count(&self, count: u32)[src]
pub fn wait_for_pending_id_count(&self, count: u32)[src]Blocks until at least count clock notifications have been requested from
self. There is no timeout for this wait, see the main description of
crate::TestClock.
Deprecated
use Self::wait_for_multiple_pending_ids() instead.
count
the number of pending clock notifications to wait for
pub fn clock_type(&self) -> ClockType[src]
pub fn set_clock_type(&self, clock_type: ClockType)[src]
pub fn start_time(&self) -> u64[src]
pub fn connect_clock_type_notify<F: Fn(&TestClock) + Send + Sync + 'static>(
&self,
f: F
) -> SignalHandlerId[src]
&self,
f: F
) -> SignalHandlerId
impl TestClock[src]
impl TestClock[src]pub fn peek_next_pending_id(&self) -> Option<ClockId>[src]
pub fn peek_next_pending_id(&self) -> Option<ClockId>[src]Determines if the pending_id is the next clock notification scheduled to
be triggered given the current time of the self.
MT safe.
pending_id
a [crate::gst::ClockID] clock
notification to look for
Returns
true if pending_id is the next clock notification to be
triggered, false otherwise.
pub fn process_id(&self, pending_id: &ClockId) -> bool[src]
This is supported on crate feature v1_18 only.
pub fn process_id(&self, pending_id: &ClockId) -> bool[src]v1_18 only.pub fn process_id_list(&self, pending_list: &[&ClockId]) -> u32[src]
pub fn process_id_list(&self, pending_list: &[&ClockId]) -> u32[src]Processes and releases the pending IDs in the list.
MT safe.
pending_list
List
of pending GstClockIDs
pub fn process_next_clock_id(&self) -> Option<ClockId>[src]
pub fn process_next_clock_id(&self) -> Option<ClockId>[src]pub fn wait_for_multiple_pending_ids(&self, count: u32) -> Vec<ClockId>[src]
pub fn wait_for_multiple_pending_ids(&self, count: u32) -> Vec<ClockId>[src]Blocks until at least count clock notifications have been requested from
self. There is no timeout for this wait, see the main description of
crate::TestClock.
MT safe.
count
the number of pending clock notifications to wait for
pending_list
Address
of a [crate::glib::List] pointer variable to store the list of pending GstClockIDs
that expired, or None
pub fn wait_for_next_pending_id(&self) -> ClockId[src]
pub fn wait_for_next_pending_id(&self) -> ClockId[src]Waits until a clock notification is requested from self. There is no
timeout for this wait, see the main description of crate::TestClock. A reference
to the pending clock notification is stored in pending_id.
MT safe.
pending_id
[crate::gst::ClockID]
with information about the pending clock notification
pub fn timed_wait_for_multiple_pending_ids(
&self,
count: u32,
timeout_ms: u32
) -> (bool, Vec<ClockId>)[src]
This is supported on crate feature v1_16 only.
pub fn timed_wait_for_multiple_pending_ids(
&self,
count: u32,
timeout_ms: u32
) -> (bool, Vec<ClockId>)[src]v1_16 only.Blocks until at least count clock notifications have been requested from
self, or the timeout expires.
MT safe.
count
the number of pending clock notifications to wait for
timeout_ms
the timeout in milliseconds
pending_list
Address
of a [crate::glib::List] pointer variable to store the list of pending GstClockIDs
that expired, or None
Returns
a gboolean true if the waits have been registered, false if not.
(Could be that it timed out waiting or that more waits than waits was found)
Trait Implementations
impl Ord for TestClock[src]
impl Ord for TestClock[src]impl ParentClassIs for TestClock[src]
impl ParentClassIs for TestClock[src]impl<T: ObjectType> PartialEq<T> for TestClock[src]
impl<T: ObjectType> PartialEq<T> for TestClock[src]impl<T: ObjectType> PartialOrd<T> for TestClock[src]
impl<T: ObjectType> PartialOrd<T> for TestClock[src]fn partial_cmp(&self, other: &T) -> Option<Ordering>[src]
fn partial_cmp(&self, other: &T) -> Option<Ordering>[src]This method returns an ordering between self and other values if one exists. Read more
#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]This method tests less than (for self and other) and is used by the < operator. Read more
#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]
#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more
impl StaticType for TestClock[src]
impl StaticType for TestClock[src]fn static_type() -> Type[src]
fn static_type() -> Type[src]Returns the type identifier of Self.
impl Eq for TestClock[src]
impl IsA<Clock> for TestClock[src]
impl IsA<Object> for TestClock[src]
impl Send for TestClock[src]
impl StructuralEq for TestClock[src]
impl Sync for TestClock[src]
Auto Trait Implementations
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]pub fn borrow_mut(&mut self) -> &mut T[src]
pub fn borrow_mut(&mut self) -> &mut T[src]Mutably borrows from an owned value. Read more
impl<T> Cast for T where
T: ObjectType, [src]
impl<T> Cast for T where
T: ObjectType, [src]fn upcast<T>(self) -> T where
Self: IsA<T>,
T: ObjectType, [src]
fn upcast<T>(self) -> T where
Self: IsA<T>,
T: ObjectType, [src]Upcasts an object to a superclass or interface T. Read more
fn upcast_ref<T>(&self) -> &T where
Self: IsA<T>,
T: ObjectType, [src]
fn upcast_ref<T>(&self) -> &T where
Self: IsA<T>,
T: ObjectType, [src]Upcasts an object to a reference of its superclass or interface T. Read more
fn downcast<T>(self) -> Result<T, Self> where
Self: CanDowncast<T>,
T: ObjectType, [src]
fn downcast<T>(self) -> Result<T, Self> where
Self: CanDowncast<T>,
T: ObjectType, [src]Tries to downcast to a subclass or interface implementor T. Read more
fn downcast_ref<T>(&self) -> Option<&T> where
Self: CanDowncast<T>,
T: ObjectType, [src]
fn downcast_ref<T>(&self) -> Option<&T> where
Self: CanDowncast<T>,
T: ObjectType, [src]Tries to downcast to a reference of its subclass or interface implementor T. Read more
fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType, [src]
fn dynamic_cast<T>(self) -> Result<T, Self> where
T: ObjectType, [src]Tries to cast to an object of type T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read more
fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType, [src]
fn dynamic_cast_ref<T>(&self) -> Option<&T> where
T: ObjectType, [src]Tries to cast to reference to an object of type T. This handles upcasting, downcasting
and casting between interface and interface implementors. All checks are performed at
runtime, while downcast and upcast will do many checks at compile-time already. Read more
unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType, [src]
unsafe fn unsafe_cast<T>(self) -> T where
T: ObjectType, [src]Casts to T unconditionally. Read more
unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType, [src]
unsafe fn unsafe_cast_ref<T>(&self) -> &T where
T: ObjectType, [src]Casts to &T unconditionally. Read more
impl<O> ClockExt for O where
O: IsA<Clock>, [src]
impl<O> ClockExt for O where
O: IsA<Clock>, [src]pub fn add_observation(
&self,
slave: ClockTime,
master: ClockTime
) -> Option<f64>[src]
pub fn add_observation(
&self,
slave: ClockTime,
master: ClockTime
) -> Option<f64>[src]The time master of the master clock and the time slave of the slave
clock are added to the list of observations. If enough observations
are available, a linear regression algorithm is run on the
observations and self is recalibrated. Read more
pub fn add_observation_unapplied(
&self,
slave: ClockTime,
master: ClockTime
) -> Option<(f64, ClockTime, ClockTime, ClockTime, ClockTime)>[src]
pub fn add_observation_unapplied(
&self,
slave: ClockTime,
master: ClockTime
) -> Option<(f64, ClockTime, ClockTime, ClockTime, ClockTime)>[src]Add a clock observation to the internal slaving algorithm the same as
Self::add_observation(), and return the result of the master clock
estimation, without updating the internal calibration. Read more
pub fn adjust_unlocked(&self, internal: ClockTime) -> ClockTime[src]
pub fn adjust_unlocked(&self, internal: ClockTime) -> ClockTime[src]Converts the given internal clock time to the external time, adjusting for the
rate and reference time set with Self::set_calibration() and making sure
that the returned time is increasing. This function should be called with the
clock’s OBJECT_LOCK held and is mainly used by clock subclasses. Read more
pub fn calibration(&self) -> (ClockTime, ClockTime, ClockTime, ClockTime)[src]
pub fn calibration(&self) -> (ClockTime, ClockTime, ClockTime, ClockTime)[src]Gets the internal rate and reference time of self. See
Self::set_calibration() for more information. Read more
pub fn internal_time(&self) -> ClockTime[src]
pub fn internal_time(&self) -> ClockTime[src]Gets the current internal time of the given clock. The time is returned unadjusted for the offset and the rate. Read more
pub fn resolution(&self) -> ClockTime[src]
pub fn resolution(&self) -> ClockTime[src]Get the accuracy of the clock. The accuracy of the clock is the granularity
of the values returned by [Self::get_time()]. Read more
pub fn time(&self) -> ClockTime[src]
pub fn time(&self) -> ClockTime[src]Gets the current time of the given clock. The time is always monotonically increasing and adjusted according to the current offset and rate. Read more
pub fn timeout(&self) -> ClockTime[src]
pub fn timeout(&self) -> ClockTime[src]Get the amount of time that master and slave clocks are sampled. Read more
pub fn set_calibration(
&self,
internal: ClockTime,
external: ClockTime,
rate_num: ClockTime,
rate_denom: ClockTime
)[src]
pub fn set_calibration(
&self,
internal: ClockTime,
external: ClockTime,
rate_num: ClockTime,
rate_denom: ClockTime
)[src]Adjusts the rate and time of self. A rate of 1/1 is the normal speed of
the clock. Values bigger than 1/1 make the clock go faster. Read more
pub fn set_master<P>(&self, master: Option<&P>) -> Result<(), BoolError> where
P: IsA<Clock>, [src]
pub fn set_master<P>(&self, master: Option<&P>) -> Result<(), BoolError> where
P: IsA<Clock>, [src]Set master as the master clock for self. self will be automatically
calibrated so that [Self::get_time()] reports the same time as the
master clock. Read more
pub fn set_resolution(&self, resolution: ClockTime) -> ClockTime[src]
pub fn set_resolution(&self, resolution: ClockTime) -> ClockTime[src]Set the accuracy of the clock. Some clocks have the possibility to operate
with different accuracy at the expense of more resource usage. There is
normally no need to change the default resolution of a clock. The resolution
of a clock can only be changed if the clock has the
[crate::ClockFlags::CanSetResolution] flag set. Read more
pub fn set_synced(&self, synced: bool)[src]
pub fn set_synced(&self, synced: bool)[src]Sets self to synced and emits the GstClock::synced signal, and wakes up any
thread waiting in Self::wait_for_sync(). Read more
pub fn set_timeout(&self, timeout: ClockTime)[src]
pub fn set_timeout(&self, timeout: ClockTime)[src]Set the amount of time, in nanoseconds, to sample master and slave clocks Read more
pub fn unadjust_unlocked(&self, external: ClockTime) -> ClockTime[src]
pub fn unadjust_unlocked(&self, external: ClockTime) -> ClockTime[src]Converts the given external clock time to the internal time of self,
using the rate and reference time set with Self::set_calibration().
This function should be called with the clock’s OBJECT_LOCK held and
is mainly used by clock subclasses. Read more
pub fn wait_for_sync(&self, timeout: ClockTime) -> Result<(), BoolError>[src]
pub fn wait_for_sync(&self, timeout: ClockTime) -> Result<(), BoolError>[src]Waits until self is synced for reporting the current time. If timeout
is GST_CLOCK_TIME_NONE it will wait forever, otherwise it will time out
after timeout nanoseconds. Read more
pub fn window_size(&self) -> i32[src]
pub fn set_window_size(&self, window_size: i32)[src]
pub fn window_threshold(&self) -> i32[src]
pub fn set_window_threshold(&self, window_threshold: i32)[src]
pub fn connect_synced<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, bool) + Send + Sync, [src]
pub fn connect_synced<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, bool) + Send + Sync, [src]Signaled on clocks with GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC set once the clock is synchronized, or when it completely lost synchronization. This signal will not be emitted on clocks without the flag. Read more
pub fn connect_timeout_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O) + Send + Sync, [src]
F: 'static + Fn(&O) + Send + Sync,
pub fn connect_window_size_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O) + Send + Sync, [src]
F: 'static + Fn(&O) + Send + Sync,
pub fn connect_window_threshold_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O) + Send + Sync, [src]
F: 'static + Fn(&O) + Send + Sync,
impl<O> ClockExtManual for O where
O: IsA<Clock>, [src]
impl<O> ClockExtManual for O where
O: IsA<Clock>, [src]pub fn new_periodic_id(
&self,
start_time: ClockTime,
interval: ClockTime
) -> PeriodicClockId[src]
&self,
start_time: ClockTime,
interval: ClockTime
) -> PeriodicClockId
pub fn periodic_id_reinit(
&self,
id: &PeriodicClockId,
start_time: ClockTime,
interval: ClockTime
) -> Result<(), BoolError>[src]
&self,
id: &PeriodicClockId,
start_time: ClockTime,
interval: ClockTime
) -> Result<(), BoolError>
pub fn new_single_shot_id(&self, time: ClockTime) -> SingleShotClockId[src]
pub fn single_shot_id_reinit(
&self,
id: &SingleShotClockId,
time: ClockTime
) -> Result<(), BoolError>[src]
&self,
id: &SingleShotClockId,
time: ClockTime
) -> Result<(), BoolError>
pub fn set_clock_flags(&self, flags: ClockFlags)[src]
pub fn unset_clock_flags(&self, flags: ClockFlags)[src]
pub fn clock_flags(&self) -> ClockFlags[src]
impl<O> GObjectExtManualGst for O where
O: IsA<Object>, [src]
impl<O> GObjectExtManualGst for O where
O: IsA<Object>, [src]pub fn set_property_from_str(&self, name: &str, value: &str)[src]
impl<O> GstObjectExt for O where
O: IsA<Object>, [src]
impl<O> GstObjectExt for O where
O: IsA<Object>, [src]pub fn add_control_binding<P>(&self, binding: &P) -> Result<(), BoolError> where
P: IsA<ControlBinding>, [src]
pub fn add_control_binding<P>(&self, binding: &P) -> Result<(), BoolError> where
P: IsA<ControlBinding>, [src]Attach the crate::ControlBinding to the object. If there already was a
crate::ControlBinding for this property it will be replaced. Read more
pub fn default_error(&self, error: &Error, debug: Option<&str>)[src]
pub fn default_error(&self, error: &Error, debug: Option<&str>)[src]A default error function that uses g_printerr() to display the error message
and the optional debug string.. Read more
pub fn control_binding(&self, property_name: &str) -> Option<ControlBinding>[src]
pub fn control_binding(&self, property_name: &str) -> Option<ControlBinding>[src]Gets the corresponding crate::ControlBinding for the property. This should be
unreferenced again after use. Read more
pub fn control_rate(&self) -> ClockTime[src]
pub fn control_rate(&self) -> ClockTime[src]Obtain the control-rate for this self. Audio processing crate::Element
objects will use this rate to sub-divide their processing loop and call
Self::sync_values() in between. The length of the processing segment
should be up to control-rate nanoseconds. Read more
pub fn parent(&self) -> Option<Object>[src]
pub fn parent(&self) -> Option<Object>[src]Returns the parent of self. This function increases the refcount
of the parent object so you should [Self::unref()] it after usage. Read more
pub fn path_string(&self) -> GString[src]
pub fn path_string(&self) -> GString[src]Generates a string describing the path of self in
the object hierarchy. Only useful (or used) for debugging. Read more
pub fn value(&self, property_name: &str, timestamp: ClockTime) -> Option<Value>[src]
pub fn value(&self, property_name: &str, timestamp: ClockTime) -> Option<Value>[src]Gets the value for the given controlled property at the requested time. Read more
pub fn has_active_control_bindings(&self) -> bool[src]
pub fn has_active_control_bindings(&self) -> bool[src]Check if the self has active controlled properties. Read more
pub fn has_ancestor<P>(&self, ancestor: &P) -> bool where
P: IsA<Object>, [src]
pub fn has_ancestor<P>(&self, ancestor: &P) -> bool where
P: IsA<Object>, [src]Check if self has an ancestor ancestor somewhere up in
the hierarchy. One can e.g. check if a crate::Element is inside a crate::Pipeline. Read more
pub fn has_as_ancestor<P>(&self, ancestor: &P) -> bool where
P: IsA<Object>, [src]
pub fn has_as_ancestor<P>(&self, ancestor: &P) -> bool where
P: IsA<Object>, [src]Check if self has an ancestor ancestor somewhere up in
the hierarchy. One can e.g. check if a crate::Element is inside a crate::Pipeline. Read more
pub fn has_as_parent<P>(&self, parent: &P) -> bool where
P: IsA<Object>, [src]
pub fn has_as_parent<P>(&self, parent: &P) -> bool where
P: IsA<Object>, [src]Check if parent is the parent of self.
E.g. a crate::Element can check if it owns a given crate::Pad. Read more
pub fn remove_control_binding<P>(&self, binding: &P) -> bool where
P: IsA<ControlBinding>, [src]
pub fn remove_control_binding<P>(&self, binding: &P) -> bool where
P: IsA<ControlBinding>, [src]Removes the corresponding crate::ControlBinding. If it was the
last ref of the binding, it will be disposed. Read more
pub fn set_control_binding_disabled(&self, property_name: &str, disabled: bool)[src]
pub fn set_control_binding_disabled(&self, property_name: &str, disabled: bool)[src]This function is used to disable the control bindings on a property for
some time, i.e. Self::sync_values() will do nothing for the
property. Read more
pub fn set_control_bindings_disabled(&self, disabled: bool)[src]
pub fn set_control_bindings_disabled(&self, disabled: bool)[src]This function is used to disable all controlled properties of the self for
some time, i.e. Self::sync_values() will do nothing. Read more
pub fn set_control_rate(&self, control_rate: ClockTime)[src]
pub fn set_control_rate(&self, control_rate: ClockTime)[src]Change the control-rate for this self. Audio processing crate::Element
objects will use this rate to sub-divide their processing loop and call
Self::sync_values() in between. The length of the processing segment
should be up to control-rate nanoseconds. Read more
pub fn set_parent<P>(&self, parent: &P) -> Result<(), BoolError> where
P: IsA<Object>, [src]
pub fn set_parent<P>(&self, parent: &P) -> Result<(), BoolError> where
P: IsA<Object>, [src]Sets the parent of self to parent. The object’s reference count will
be incremented, and any floating reference will be removed (see [crate::Object::ref_sink()]). Read more
pub fn suggest_next_sync(&self) -> ClockTime[src]
pub fn suggest_next_sync(&self) -> ClockTime[src]Returns a suggestion for timestamps where buffers should be split to get best controller results. Read more
pub fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>[src]
pub fn sync_values(&self, timestamp: ClockTime) -> Result<(), BoolError>[src]Sets the properties of the object, according to the GstControlSources that
(maybe) handle them and for the given timestamp. Read more
pub fn unparent(&self)[src]
pub fn unparent(&self)[src]Clear the parent of self, removing the associated reference.
This function decreases the refcount of self. Read more
pub fn connect_parent_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O) + Send + Sync, [src]
F: 'static + Fn(&O) + Send + Sync,
impl<O> GstObjectExtManual for O where
O: IsA<Object>, [src]
impl<O> GstObjectExtManual for O where
O: IsA<Object>, [src]pub fn connect_deep_notify<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&O, &Object, &ParamSpec) + Send + Sync, [src]
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&O, &Object, &ParamSpec) + Send + Sync,
pub fn set_object_flags(&self, flags: ObjectFlags)[src]
pub fn unset_object_flags(&self, flags: ObjectFlags)[src]
pub fn object_flags(&self) -> ObjectFlags[src]
pub fn g_value_array(
&self,
property_name: &str,
timestamp: ClockTime,
interval: ClockTime,
values: &mut [Value]
) -> Result<(), BoolError>[src]
&self,
property_name: &str,
timestamp: ClockTime,
interval: ClockTime,
values: &mut [Value]
) -> Result<(), BoolError>
impl<T> ObjectExt for T where
T: ObjectType, [src]
impl<T> ObjectExt for T where
T: ObjectType, [src]pub fn is<U>(&self) -> bool where
U: StaticType, [src]
pub fn is<U>(&self) -> bool where
U: StaticType, [src]Returns true if the object is an instance of (can be cast to) T.
pub fn type_(&self) -> Type[src]
pub fn object_class(&self) -> &Class<Object>[src]
pub fn class(&self) -> &Class<T> where
T: IsClass, [src]
T: IsClass,
pub fn class_of<U>(&self) -> Option<&Class<U>> where
U: IsClass, [src]
U: IsClass,
pub fn interface<U>(&self) -> Option<InterfaceRef<'_, U>> where
U: IsInterface, [src]
U: IsInterface,
pub fn set_properties(
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>[src]
&self,
property_values: &[(&str, &dyn ToValue)]
) -> Result<(), BoolError>
pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>[src]
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>
pub fn set_property<'a, N, V>(
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
V: ToValue,
N: Into<&'a str>, [src]
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
V: ToValue,
N: Into<&'a str>,
pub fn set_property_from_value<'a, N>(
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>, [src]
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>,
pub fn property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
QD: 'static, [src]
pub unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>> where
QD: 'static, [src]Safety Read more
pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static, [src]
pub unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where
QD: 'static, [src]Safety Read more
pub unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
QD: 'static, [src]
pub unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>> where
QD: 'static, [src]Safety Read more
pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static, [src]
pub unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where
QD: 'static, [src]Safety Read more
pub fn block_signal(&self, handler_id: &SignalHandlerId)[src]
pub fn unblock_signal(&self, handler_id: &SignalHandlerId)[src]
pub fn stop_signal_emission(&self, signal_name: &str)[src]
pub fn disconnect(&self, handler_id: SignalHandlerId)[src]
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync, [src]
F: 'static + Fn(&T, &ParamSpec) + Send + Sync,
pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec), [src]
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec),
pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec), [src]
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec),
pub fn notify<'a, N>(&self, property_name: N) where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub fn notify_by_pspec(&self, pspec: &ParamSpec)[src]
pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub fn property_type<'a, N>(&self, property_name: N) -> Option<Type> where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>, [src]
N: Into<&'a str>,
pub fn list_properties(&self) -> Vec<ParamSpec, Global>[src]
pub fn connect<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>, [src]
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>,
pub fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static, [src]
pub fn connect_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static, [src]Same as connect but takes a SignalId instead of a signal name.
pub fn connect_local<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>, [src]
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>,
pub fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static, [src]
pub fn connect_local_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static, [src]Same as connect_local but takes a SignalId instead of a signal name.
pub unsafe fn connect_unsafe<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>, [src]
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>,
pub unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>, [src]
pub unsafe fn connect_unsafe_id<F>(
&self,
signal_id: SignalId,
details: Option<Quark>,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>, [src]Same as connect_unsafe but takes a SignalId instead of a signal name.
pub fn emit(
&self,
signal_id: SignalId,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>[src]
pub fn emit(
&self,
signal_id: SignalId,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>[src]Emit signal by signal id.
pub fn emit_with_details(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>[src]
pub fn emit_with_details(
&self,
signal_id: SignalId,
details: Quark,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError>[src]Emit signal with details by signal id.
pub fn emit_by_name<'a, N>(
&self,
signal_name: N,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>, [src]
pub fn emit_by_name<'a, N>(
&self,
signal_name: N,
args: &[&dyn ToValue]
) -> Result<Option<Value>, BoolError> where
N: Into<&'a str>, [src]Emit signal by it’s name.
pub fn downgrade(&self) -> WeakRef<T>[src]
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
N: Into<&'a str>,
O: ObjectType,
M: Into<&'a str>, [src]
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
N: Into<&'a str>,
O: ObjectType,
M: Into<&'a str>,
pub fn ref_count(&self) -> u32[src]
pub fn emit_with_values(
&self,
signal_id: SignalId,
args: &[Value]
) -> Result<Option<Value>, BoolError>[src]
pub fn emit_with_values(
&self,
signal_id: SignalId,
args: &[Value]
) -> Result<Option<Value>, BoolError>[src]Same as emit but takes Value for the arguments.
impl<T> ToOwned for T where
T: Clone, [src]
impl<T> ToOwned for T where
T: Clone, [src]type Owned = T
type Owned = TThe resulting type after obtaining ownership.
pub fn to_owned(&self) -> T[src]
pub fn to_owned(&self) -> T[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)[src]
pub fn clone_into(&self, target: &mut T)[src]🔬 This is a nightly-only experimental API. (toowned_clone_into)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized, [src]
impl<T> ToSendValue for T where
T: Send + ToValue + ?Sized, [src]pub fn to_send_value(&self) -> SendValue[src]
pub fn to_send_value(&self) -> SendValue[src]Returns a SendValue clone of self.
impl<Super, Sub> CanDowncast<Sub> for Super where
Sub: IsA<Super>,
Super: IsA<Super>, [src]
Sub: IsA<Super>,
Super: IsA<Super>,
impl<'a, T, C> FromValueOptional<'a> for T where
C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
T: FromValue<'a, Checker = C>, [src]
C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
T: FromValue<'a, Checker = C>,