[−][src]Struct gstreamer::Object

pub struct Object(_, _);

Object provides a root for the object hierarchy tree filed in by the GStreamer library. It is currently a thin wrapper on top of gobject::InitiallyUnowned. It is an abstract class that is not very usable on its own.

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 Object which is gobject::Object (e.g. gobject::ObjectExt::ref becomes GstObjectExt::ref).

Since Object derives from gobject::InitiallyUnowned, it also inherits the floating reference. Be aware that functions such as GstBinExt::add and ElementExt::add_pad take ownership of the floating reference.

In contrast to gobject::Object instances, Object adds a name property. The functions Object::set_name and 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 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 ControlSource. csource = gst_interpolation_control_source_new (); g_object_set (csource, "mode", GST_INTERPOLATION_MODE_LINEAR, NULL);
Attach the ControlSource on 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

Implements

GstObjectExt, glib::object::ObjectExt

Implementations

`impl Object`[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 Object in the list to compare the name, so be careful when passing a list with a locked object.

`list`

a list of Object to check through

`name`

the name to search for

Returns

true if a 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 Clone for Object`[src]

`fn clone(&self) -> Object`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Object`[src]

`fn fmt(&self, f: &mut Formatter<'_>) -> Result`[src]

`impl Eq for Object`[src]

`impl Hash for Object`[src]

`fn hash<H: Hasher>(&self, state: &mut H)`[src]

`fn hash_slice<H>(data: &[Self], state: &mut H) where H: Hasher,` 1.3.0[src]

`impl IsA<Object> for Allocator`[src]

`impl IsA<Object> for Bin`[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 Registry`[src]

`impl IsA<Object> for Stream`[src]

`impl IsA<Object> for BufferPool`[src]

`impl IsA<Object> for StreamCollection`[src]

`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 Device`[src]

`impl IsA<Object> for DeviceMonitor`[src]

`impl IsA<Object> for DeviceProvider`[src]

`impl IsA<Object> for DeviceProviderFactory`[src]

`impl IsA<Object> for Element`[src]

`impl Ord for Object`[src]

`fn cmp(&self, other: &Object) -> Ordering`[src]

`#[must_use]fn max(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn min(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn clamp(self, min: Self, max: Self) -> Self`[src]

`impl<T: ObjectType> PartialEq<T> for Object`[src]

`fn eq(&self, other: &T) -> bool`[src]

`#[must_use]fn ne(&self, other: &Rhs) -> bool`1.0.0[src]

`impl<T: ObjectType> PartialOrd<T> for Object`[src]

`fn partial_cmp(&self, other: &T) -> Option<Ordering>`[src]

`#[must_use]fn lt(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn le(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn gt(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn ge(&self, other: &Rhs) -> bool`1.0.0[src]

`impl Send for Object`[src]

`impl StaticType for Object`[src]

`fn static_type() -> Type`[src]

`impl Sync for Object`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Object`

`impl Unpin for Object`

`impl UnwindSafe for Object`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<Super, Sub> CanDowncast<Sub> for Super where Sub: IsA<Super>, Super: IsA<Super>,` [src]

`impl<T> Cast for T where T: ObjectType,` [src]

`fn upcast<T>(self) -> T where Self: IsA<T>, T: ObjectType,` [src]

`fn upcast_ref<T>(&self) -> &T where Self: IsA<T>, T: ObjectType,` [src]

`fn downcast<T>(self) -> Result<T, Self> where Self: CanDowncast<T>, T: ObjectType,` [src]

`fn downcast_ref<T>(&self) -> Option<&T> where Self: CanDowncast<T>, T: ObjectType,` [src]

`fn dynamic_cast<T>(self) -> Result<T, Self> where T: ObjectType,` [src]

`fn dynamic_cast_ref<T>(&self) -> Option<&T> where T: ObjectType,` [src]

`unsafe fn unsafe_cast<T>(self) -> T where T: ObjectType,` [src]

`unsafe fn unsafe_cast_ref<T>(&self) -> &T where T: ObjectType,` [src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> ObjectExt for T where T: ObjectType,` [src]

`fn is<U>(&self) -> bool where U: StaticType,` [src]

`fn get_type(&self) -> Type`[src]

`fn get_object_class(&self) -> &ObjectClass`[src]

`fn set_properties( &self, property_values: &[(&str, &dyn ToValue)] ) -> Result<(), BoolError>`[src]

`fn set_property<'a, N>( &self, property_name: N, value: &dyn ToValue ) -> Result<(), BoolError> where N: Into<&'a str>,` [src]

`fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where N: Into<&'a str>,` [src]

`unsafe fn set_qdata<QD>(&self, key: Quark, value: QD) where QD: 'static,` [src]

`unsafe fn get_qdata<QD>(&self, key: Quark) -> Option<&QD> where QD: 'static,` [src]

`unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD> where QD: 'static,` [src]

`unsafe fn set_data<QD>(&self, key: &str, value: QD) where QD: 'static,` [src]

`unsafe fn get_data<QD>(&self, key: &str) -> Option<&QD> where QD: 'static,` [src]

`unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD> where QD: 'static,` [src]

`fn block_signal(&self, handler_id: &SignalHandlerId)`[src]

`fn unblock_signal(&self, handler_id: &SignalHandlerId)`[src]

`fn stop_signal_emission(&self, signal_name: &str)`[src]

`fn disconnect(&self, handler_id: SignalHandlerId)`[src]

`fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where F: 'static + Send + Sync + Fn(&T, &ParamSpec),` [src]

`unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F ) -> SignalHandlerId where F: Fn(&T, &ParamSpec),` [src]

`fn notify<'a, N>(&self, property_name: N) where N: Into<&'a str>,` [src]

`fn notify_by_pspec(&self, pspec: &ParamSpec)`[src]

`fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where N: Into<&'a str>,` [src]

`fn get_property_type<'a, N>(&self, property_name: N) -> Option<Type> where N: Into<&'a str>,` [src]

`fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where N: Into<&'a str>,` [src]

`fn list_properties(&self) -> Vec<ParamSpec>`[src]

`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]

`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]

`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]

`fn emit<'a, N>( &self, signal_name: N, args: &[&dyn ToValue] ) -> Result<Option<Value>, BoolError> where N: Into<&'a str>,` [src]

`fn downgrade(&self) -> WeakRef<T>`[src]

`fn bind_property<'a, O, N, M>( &'a self, source_property: N, target: &'a O, target_property: M ) -> BindingBuilder<'a> where M: Into<&'a str>, N: Into<&'a str>, O: ObjectType,` [src]

`fn ref_count(&self) -> u32`[src]

`impl<'a, T> ToGlibContainerFromSlice<'a, *const GList> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,` [src]

`type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (const GList, <T as ToGlibContainerFromSlice<'a, const GList>>::Storage)`[src]

`fn to_glib_container_from_slice( _t: &'a [T] ) -> (const GList, <T as ToGlibContainerFromSlice<'a, const GList>>::Storage)`[src]

`fn to_glib_full_from_slice(_t: &[T]) -> *const GList`[src]

`impl<'a, T> ToGlibContainerFromSlice<'a, *const GPtrArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,` [src]

`type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (const GPtrArray, <T as ToGlibContainerFromSlice<'a, const GPtrArray>>::Storage)`[src]

`fn to_glib_container_from_slice( _t: &'a [T] ) -> (const GPtrArray, <T as ToGlibContainerFromSlice<'a, const GPtrArray>>::Storage)`[src]

`fn to_glib_full_from_slice(_t: &[T]) -> *const GPtrArray`[src]

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,` [src]

`type Storage = (Option<Array>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GArray, <T as ToGlibContainerFromSlice<'a, mut GArray>>::Storage)`[src]

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GArray, <T as ToGlibContainerFromSlice<'a, mut GArray>>::Storage)`[src]

`fn to_glib_full_from_slice(t: &[T]) -> *mut GArray`[src]

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GList> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,` [src]

`type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GList, <T as ToGlibContainerFromSlice<'a, mut GList>>::Storage)`[src]

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GList, <T as ToGlibContainerFromSlice<'a, mut GList>>::Storage)`[src]

`fn to_glib_full_from_slice(t: &[T]) -> *mut GList`[src]

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GPtrArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,` [src]

`type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GPtrArray, <T as ToGlibContainerFromSlice<'a, mut GPtrArray>>::Storage)`[src]

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GPtrArray, <T as ToGlibContainerFromSlice<'a, mut GPtrArray>>::Storage)`[src]

`fn to_glib_full_from_slice(t: &[T]) -> *mut GPtrArray`[src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> ToSendValue for T where T: ToValue + SetValue + Send + ?Sized,` [src]

`fn to_send_value(&self) -> SendValue`[src]

`impl<T> ToValue for T where T: SetValue + ?Sized,` [src]

`fn to_value(&self) -> Value`[src]

`fn to_value_type(&self) -> Type`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]