gstreamermm  1.0.10
Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gst::MiniObject Class Reference

This is a base class for some gstreamermm objects. More...

Inheritance diagram for Gst::MiniObject:
Inheritance graph
[legend]

Public Member Functions

void reference () const
 Increment the reference count for this object. More...
 
void unreference () const
 Decrement the reference count for this object. More...
 
GstMiniObject* gobj ()
 Provides access to the underlying C instance. More...
 
const GstMiniObject* gobj () const
 Provides access to the underlying C instance. More...
 
GstMiniObject* gobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
 ~MiniObject ()
 
guint get_flags () const
 
void set_flags (const guint& value)
 
bool lock (LockFlags flags)
 Lock the mini-object with the specified access mode in flags. More...
 
void unlock (LockFlags flags)
 Unlock the mini-object with the specified access mode in flags. More...
 
bool is_writable () const
 If mini_object has the LOCKABLE flag set, check if the current EXCLUSIVE lock on object is the only one, this means that changes to the object will not be visible to any other object. More...
 
Glib::RefPtr< MiniObjectcreate_writable ()
 Checks if a mini-object is writable. More...
 

Protected Member Functions

 MiniObject ()
 
void operator delete (void*, std::size_t)
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gst::MiniObjectwrap (GstMiniObject* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Detailed Description

This is a base class for some gstreamermm objects.

It is similar to Glib::Object but has no GObject property or signal support.

Constructor & Destructor Documentation

Gst::MiniObject::MiniObject ( )
protected
Gst::MiniObject::~MiniObject ( )

Member Function Documentation

Glib::RefPtr<MiniObject> Gst::MiniObject::create_writable ( )

Checks if a mini-object is writable.

If not, a writable copy is made and returned. This gives away the reference to the original mini object, and returns a reference to the new object.

MT safe

Returns
A mini-object (possibly the same pointer) that is writable.
guint Gst::MiniObject::get_flags ( ) const
GstMiniObject* Gst::MiniObject::gobj ( )

Provides access to the underlying C instance.

const GstMiniObject* Gst::MiniObject::gobj ( ) const

Provides access to the underlying C instance.

GstMiniObject* Gst::MiniObject::gobj_copy ( ) const

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

bool Gst::MiniObject::is_writable ( ) const

If mini_object has the LOCKABLE flag set, check if the current EXCLUSIVE lock on object is the only one, this means that changes to the object will not be visible to any other object.

If the LOCKABLE flag is not set, check if the refcount of mini_object is exactly 1, meaning that no other reference exists to the object and that the object is therefore writable.

Modification of a mini-object should only be done after verifying that it is writable.

Returns
true if the object is writable.
bool Gst::MiniObject::lock ( LockFlags  flags)

Lock the mini-object with the specified access mode in flags.

Parameters
flagsGst::LockFlags.
Returns
true if object could be locked.
void Gst::MiniObject::operator delete ( void *  ,
std::size_t   
)
protected
void Gst::MiniObject::reference ( ) const

Increment the reference count for this object.

You should never need to do this manually - use the object via a RefPtr instead.

void Gst::MiniObject::set_flags ( const guint &  value)
void Gst::MiniObject::unlock ( LockFlags  flags)

Unlock the mini-object with the specified access mode in flags.

Parameters
flagsGst::LockFlags.
void Gst::MiniObject::unreference ( ) const

Decrement the reference count for this object.

You should never need to do this manually - use the object via a RefPtr instead.

Friends And Related Function Documentation

Glib::RefPtr< Gst::MiniObject > wrap ( GstMiniObject *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file: