Struct gstreamer::Object [−][src]
pub struct Object(_);
crate::Object provides a root for the object hierarchy tree filed in by the
GStreamer library. It is currently a thin wrapper on top of
crate::glib::object::InitiallyUnowned. It is an abstract class that is not very usable on its own.
crate::Object gives us basic refcounting, parenting functionality and locking.
Most of the functions are just extended for special GStreamer needs and can be
found under the same name in the base class of crate::Object which is crate::glib::object::Object
(e.g. [crate::glib::object::ObjectExt::ref()] becomes [crate::prelude::GstObjectExt::ref()]).
Since crate::Object derives from crate::glib::object::InitiallyUnowned, it also inherits the
floating reference. Be aware that functions such as crate::prelude::GstBinExt::add() and
crate::prelude::ElementExt::add_pad() take ownership of the floating reference.
In contrast to crate::glib::object::Object instances, crate::Object adds a name property. The functions
[Self::set_name()] and [crate::prelude::GstObjectExt::get_name()] are used to set/get the name
of the object.
controlled properties
Controlled properties offers a lightweight way to adjust gobject properties over stream-time. It works by using time-stamped value pairs that are queued for element-properties. At run-time the elements continuously pull value changes for the current stream-time.
What needs to be changed in a crate::Element?
Very little - it is just two steps to make a plugin controllable!
-
mark gobject-properties paramspecs that make sense to be controlled, by GST_PARAM_CONTROLLABLE.
-
when processing data (get, chain, loop function) at the beginning call gst_object_sync_values(element,timestamp). This will make the controller update all GObject properties that are under its control with the current values based on the timestamp.
What needs to be done in applications? Again it’s not a lot to change.
-
create a
crate::ControlSource. csource = gst_interpolation_control_source_new (); g_object_set (csource, “mode”, GST_INTERPOLATION_MODE_LINEAR, NULL); -
Attach the
crate::ControlSourceon the controller to a property. gst_object_add_control_binding (object, gst_direct_control_binding_new (object, “prop1”, csource)); -
Set the control values gst_timed_value_control_source_set ((GstTimedValueControlSource *)csource,0 * GST_SECOND, value1); gst_timed_value_control_source_set ((GstTimedValueControlSource *)csource,1 * GST_SECOND, value2);
-
start your pipeline
This is an Abstract Base Class, you cannot instantiate it.
Implements
Implementations
impl Object[src]
impl Object[src]pub fn check_uniqueness(list: &[Object], name: &str) -> bool[src]
pub fn check_uniqueness(list: &[Object], name: &str) -> bool[src]Checks to see if there is any object named name in list. This function
does not do any locking of any kind. You might want to protect the
provided list with the lock of the owner of the list. This function
will lock each crate::Object in the list to compare the name, so be
careful when passing a list with a locked object.
list
a list of crate::Object to
check through
name
the name to search for
Returns
true if a crate::Object named name does not appear in list,
false if it does.
MT safe. Grabs and releases the LOCK of each object in the list.
Trait Implementations
impl Ord for Object[src]
impl Ord for Object[src]impl ParentClassIs for Object[src]
impl ParentClassIs for Object[src]impl<T: ObjectType> PartialEq<T> for Object[src]
impl<T: ObjectType> PartialEq<T> for Object[src]impl<T: ObjectType> PartialOrd<T> for Object[src]
impl<T: ObjectType> PartialOrd<T> for Object[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 Object[src]
impl StaticType for Object[src]fn static_type() -> Type[src]
fn static_type() -> Type[src]Returns the type identifier of Self.
impl Eq for Object[src]
impl IsA<Object> for Allocator[src]
impl IsA<Object> for Bin[src]
impl IsA<Object> for DeviceProviderFactory[src]
impl IsA<Object> for Element[src]
impl IsA<Object> for ElementFactory[src]
impl IsA<Object> for GhostPad[src]
impl IsA<Object> for Pad[src]
impl IsA<Object> for PadTemplate[src]
impl IsA<Object> for Pipeline[src]
impl IsA<Object> for Plugin[src]
impl IsA<Object> for PluginFeature[src]
impl IsA<Object> for ProxyPad[src]
impl IsA<Object> for BufferPool[src]
impl IsA<Object> for Registry[src]
impl IsA<Object> for Stream[src]
v1_10 only.impl IsA<Object> for StreamCollection[src]
v1_10 only.impl IsA<Object> for SystemClock[src]
impl IsA<Object> for TagSetter[src]
impl IsA<Object> for TocSetter[src]
impl IsA<Object> for TypeFindFactory[src]
impl IsA<Object> for Bus[src]
impl IsA<Object> for Clock[src]
impl IsA<Object> for ControlBinding[src]
impl IsA<Object> for ControlSource[src]
impl IsA<Object> for Device[src]
impl IsA<Object> for DeviceMonitor[src]
impl IsA<Object> for DeviceProvider[src]
impl Send for Object[src]
impl StructuralEq for Object[src]
impl Sync for Object[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<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
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>, [src]
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
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>,