gstreamermm: Gst::DiscovererStreamInfo Class Reference

gstreamermm 1.10.0

Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gst::DiscovererStreamInfo Class Reference

DiscovererStreamInfo - Base class for information concerning a media stream. More...

`#include <gstreamermm/discovererinfo.h>`

Inheritance diagram for Gst::DiscovererStreamInfo:
[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...
GstDiscovererStreamInfo* | gobj ()
| Provides access to the underlying C instance. More...
const GstDiscovererStreamInfo* | gobj () const
| Provides access to the underlying C instance. More...
GstDiscovererStreamInfo* | 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...
| DiscovererStreamInfo ()=delete
| DiscovererStreamInfo (const DiscovererStreamInfo&)=delete
DiscovererStreamInfo& | operator= (const DiscovererStreamInfo&)=delete
Glib::RefPtr< Gst::Caps > | get_caps ()
Glib::RefPtr< const Gst::Caps > | get_caps () const
Structure | get_misc () const
| Deprecated: This functions is deprecated since version 1.4, use #gst_discoverer_info_get_missing_elements_installer_details. More...
Glib::RefPtr< Gst::DiscovererStreamInfo > | get_next ()
Glib::RefPtr< const Gst::DiscovererStreamInfo > | get_next () const
Glib::RefPtr< Gst::DiscovererStreamInfo > | get_previous ()
Glib::RefPtr< Gst::DiscovererStreamInfo > | get_previous () const
Gst::TagList | get_tags () const
Glib::ustring | get_stream_type_nick () const
Glib::ustring | get_stream_id () const
Glib::RefPtr< const Gst::Toc > | get_toc () const
Public Member Functions inherited from Gst::MiniObject
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 ()=delete
| MiniObject (const MiniObject&)=delete
MiniObject& | operator= (const MiniObject&)=delete
| ~MiniObject ()
guint | get_flags () const
void | set_flags (const guint& value)
gint | get_refcount () const
gint | get_lockstate () const
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< MiniObject > | create_writable ()
| Checks if a mini-object is writable. More...
void | set_qdata (GQuark quark, QuarkData* data)
| This sets an opaque, named pointer on a miniobject. More...
QuarkData* | get_qdata (GQuark quark) const
| This function gets back user data pointers stored via set_qdata(). More...
QuarkData* | steal_qdata (GQuark quark)
| This function gets back user data pointers stored via set_qdata() and removes the data from object without invoking its destroy() function (if any was set). More...
void | add_finalize_notifier (const SlotFinalizer& slot)
| Adds notifier when mini object is finalized. More...
void | remove_finalize_notifier ()
| Remove finalize notifier. More...

## Protected Member Functions
void | operator delete (void*, std::size_t)
Protected Member Functions inherited from Gst::MiniObject
void | operator delete (void*, std::size_t)

## Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Gst::DiscovererStreamInfo > | wrap (GstDiscovererStreamInfo* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...
Related Functions inherited from Gst::MiniObject
Glib::RefPtr< Gst::MiniObject > | wrap (GstMiniObject* object, bool take_copy=false)
| A Glib::wrap() method for this object. More...

## Additional Inherited Members
Public Types inherited from Gst::MiniObject
typedef sigc::slot< void > | SlotFinalizer

## Detailed Description

DiscovererStreamInfo - Base class for information concerning a media stream.

Depending on the stream type, one can find more media-specific information in Gst::DiscovererAudioInfo, Gst::DiscovererVideoInfo, and Gst::DiscovererContainerInfo.

The Gst::DiscovererStreamInfo represents the topology of the stream. Siblings can be iterated over with get_next() and get_previous(). Children (sub-streams) of a stream can be accessed using the Gst::DiscovererContainerInfo API.

As a simple example, if you run Gst::Discoverer on an AVI file with one audio and one video stream, you will get a Gst::DiscovererContainerInfo corresponding to the AVI container, which in turn will have a Gst::DiscovererAudioInfo sub-stream and a Gst::DiscovererVideoInfo sub-stream for the audio and video streams respectively.

## Constructor & Destructor Documentation

## ◆ DiscovererStreamInfo() [1/2]

Gst::DiscovererStreamInfo::DiscovererStreamInfo | ( |  | ) |
| delete

## ◆ DiscovererStreamInfo() [2/2]

Gst::DiscovererStreamInfo::DiscovererStreamInfo | ( | const DiscovererStreamInfo& |  | ) |
| delete

## Member Function Documentation

## ◆ get_caps() [1/2]

Glib::RefPtr<Gst::Caps> Gst::DiscovererStreamInfo::get_caps | ( |  | ) |

Returns
  The Gst::Caps of the stream. Unref with #gst_caps_unref after usage.

## ◆ get_caps() [2/2]

Glib::RefPtr<const Gst::Caps> Gst::DiscovererStreamInfo::get_caps | ( |  | ) | const

Returns
  The Gst::Caps of the stream. Unref with #gst_caps_unref after usage.

## ◆ get_misc()

Structure Gst::DiscovererStreamInfo::get_misc | ( |  | ) | const

Deprecated: This functions is deprecated since version 1.4, use #gst_discoverer_info_get_missing_elements_installer_details.

Returns
  Additional information regarding the stream (for example codec version, profile, etc..). If you wish to use the Gst::Structure after the life-time of info you will need to copy it.

## ◆ get_next() [1/2]

Glib::RefPtr<Gst::DiscovererStreamInfo> Gst::DiscovererStreamInfo::get_next | ( |  | ) |

Returns
  The next Gst::DiscovererStreamInfo in a chain. `nullptr` for final streams. Unref with #gst_discoverer_stream_info_unref after usage.

## ◆ get_next() [2/2]

Glib::RefPtr<const Gst::DiscovererStreamInfo> Gst::DiscovererStreamInfo::get_next | ( |  | ) | const

Returns
  The next Gst::DiscovererStreamInfo in a chain. `nullptr` for final streams. Unref with #gst_discoverer_stream_info_unref after usage.

## ◆ get_previous() [1/2]

Glib::RefPtr<Gst::DiscovererStreamInfo> Gst::DiscovererStreamInfo::get_previous | ( |  | ) |

Returns
  The previous Gst::DiscovererStreamInfo in a chain. `nullptr` for starting points. Unref with #gst_discoverer_stream_info_unref after usage.

## ◆ get_previous() [2/2]

Glib::RefPtr<Gst::DiscovererStreamInfo> Gst::DiscovererStreamInfo::get_previous | ( |  | ) | const

Returns
  The previous Gst::DiscovererStreamInfo in a chain. `nullptr` for starting points. Unref with #gst_discoverer_stream_info_unref after usage.

## ◆ get_stream_id()

Glib::ustring Gst::DiscovererStreamInfo::get_stream_id | ( |  | ) | const

Returns
  The stream ID of this stream. If you wish to use the stream ID after the life-time of info you will need to copy it.

## ◆ get_stream_type_nick()

Glib::ustring Gst::DiscovererStreamInfo::get_stream_type_nick | ( |  | ) | const

Returns
  A human readable name for the stream type of the given info (ex : "audio", "container",...).

## ◆ get_tags()

Gst::TagList Gst::DiscovererStreamInfo::get_tags | ( |  | ) | const

Returns
  The tags contained in this stream. If you wish to use the tags after the life-time of info you will need to copy them.

## ◆ get_toc()

Glib::RefPtr<const Gst::Toc> Gst::DiscovererStreamInfo::get_toc | ( |  | ) | const

Returns
  The TOC contained in this stream. If you wish to use the TOC after the life-time of info you will need to copy it.

## ◆ gobj() [1/2]

GstDiscovererStreamInfo* Gst::DiscovererStreamInfo::gobj | ( |  | ) |

Provides access to the underlying C instance.

## ◆ gobj() [2/2]

const GstDiscovererStreamInfo* Gst::DiscovererStreamInfo::gobj | ( |  | ) | const

Provides access to the underlying C instance.

## ◆ gobj_copy()

GstDiscovererStreamInfo* Gst::DiscovererStreamInfo::gobj_copy | ( |  | ) | const

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

## ◆ operator delete()

void Gst::DiscovererStreamInfo::operator delete | ( | void * | ,
|  | std::size_t |
| ) |  |
| protected

## ◆ operator=()

DiscovererStreamInfo& Gst::DiscovererStreamInfo::operator= | ( | const DiscovererStreamInfo& |  | ) |
| delete

## ◆ reference()

void Gst::DiscovererStreamInfo::reference | ( |  | ) | const

Increment the reference count for this object.

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

## ◆ unreference()

void Gst::DiscovererStreamInfo::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

## ◆ wrap()

Glib::RefPtr< Gst::DiscovererStreamInfo > wrap | ( | GstDiscovererStreamInfo * | object,
|  | bool | take_copy = `false`
| ) |  |
| related

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

Parameters

  object | The C instance.
  take_copy | False 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.