gstreamer-rs/gstreamer-pbutils/src/auto/discoverer_stream_info.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use ffi;
use glib::object::IsA;
use glib::translate::*;
use glib_ffi;
use gobject_ffi;
use gst;
use std::mem;
use std::ptr;

glib_wrapper! {
    /// Base structure for information concerning a media stream. Depending on the
    /// stream type, one can find more media-specific information in
    /// `DiscovererAudioInfo`, `DiscovererVideoInfo`, and
    /// `DiscovererContainerInfo`.
    ///
    /// The `DiscovererStreamInfo` represents the topology of the stream. Siblings
    /// can be iterated over with `DiscovererStreamInfoExt::get_next` and
    /// `DiscovererStreamInfoExt::get_previous`. Children (sub-streams) of a
    /// stream can be accessed using the `DiscovererContainerInfo` API.
    ///
    /// As a simple example, if you run `Discoverer` on an AVI file with one audio
    /// and one video stream, you will get a `DiscovererContainerInfo`
    /// corresponding to the AVI container, which in turn will have a
    /// `DiscovererAudioInfo` sub-stream and a `DiscovererVideoInfo` sub-stream
    /// for the audio and video streams respectively.
    ///
    /// # Implements
    ///
    /// [`DiscovererStreamInfoExt`](trait.DiscovererStreamInfoExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
    pub struct DiscovererStreamInfo(Object<ffi::GstDiscovererStreamInfo>);

    match fn {
        get_type => || ffi::gst_discoverer_stream_info_get_type(),
    }
}

unsafe impl Send for DiscovererStreamInfo {}
unsafe impl Sync for DiscovererStreamInfo {}

/// Trait containing all `DiscovererStreamInfo` methods.
///
/// # Implementors
///
/// [`DiscovererAudioInfo`](struct.DiscovererAudioInfo.html), [`DiscovererContainerInfo`](struct.DiscovererContainerInfo.html), [`DiscovererStreamInfo`](struct.DiscovererStreamInfo.html), [`DiscovererSubtitleInfo`](struct.DiscovererSubtitleInfo.html), [`DiscovererVideoInfo`](struct.DiscovererVideoInfo.html)
pub trait DiscovererStreamInfoExt {
    ///
    /// # Returns
    ///
    /// the `gst::Caps` of the stream. Unref with
    /// `gst_caps_unref` after usage.
    fn get_caps(&self) -> Option<gst::Caps>;

    ///
    /// # Deprecated
    ///
    /// This functions is deprecated since version 1.4, use
    /// `DiscovererInfoExt::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 `self` you will need to copy it.
    fn get_misc(&self) -> Option<gst::Structure>;

    ///
    /// # Returns
    ///
    /// the next `DiscovererStreamInfo` in a chain. `None`
    /// for final streams.
    /// Unref with `gst_discoverer_stream_info_unref` after usage.
    fn get_next(&self) -> Option<DiscovererStreamInfo>;

    ///
    /// # Returns
    ///
    /// the previous `DiscovererStreamInfo` in a chain.
    /// `None` for starting points. Unref with `gst_discoverer_stream_info_unref`
    /// after usage.
    fn get_previous(&self) -> Option<DiscovererStreamInfo>;

    ///
    /// # Returns
    ///
    /// the stream ID of this stream. If you wish to
    /// use the stream ID after the life-time of `self` you will need to copy it.
    fn get_stream_id(&self) -> Option<String>;

    ///
    /// # Returns
    ///
    /// a human readable name for the stream type of the given `self` (ex : "audio",
    /// "container",...).
    fn get_stream_type_nick(&self) -> String;

    ///
    /// # Returns
    ///
    /// the tags contained in this stream. If you wish to
    /// use the tags after the life-time of `self` you will need to copy them.
    fn get_tags(&self) -> Option<gst::TagList>;

    ///
    /// # Returns
    ///
    /// the TOC contained in this stream. If you wish to
    /// use the TOC after the life-time of `self` you will need to copy it.
    fn get_toc(&self) -> Option<gst::Toc>;
}

impl<O: IsA<DiscovererStreamInfo>> DiscovererStreamInfoExt for O {
    fn get_caps(&self) -> Option<gst::Caps> {
        unsafe {
            from_glib_full(ffi::gst_discoverer_stream_info_get_caps(self.to_glib_none().0))
        }
    }

    fn get_misc(&self) -> Option<gst::Structure> {
        unsafe {
            from_glib_none(ffi::gst_discoverer_stream_info_get_misc(self.to_glib_none().0))
        }
    }

    fn get_next(&self) -> Option<DiscovererStreamInfo> {
        unsafe {
            from_glib_full(ffi::gst_discoverer_stream_info_get_next(self.to_glib_none().0))
        }
    }

    fn get_previous(&self) -> Option<DiscovererStreamInfo> {
        unsafe {
            from_glib_full(ffi::gst_discoverer_stream_info_get_previous(self.to_glib_none().0))
        }
    }

    fn get_stream_id(&self) -> Option<String> {
        unsafe {
            from_glib_none(ffi::gst_discoverer_stream_info_get_stream_id(self.to_glib_none().0))
        }
    }

    fn get_stream_type_nick(&self) -> String {
        unsafe {
            from_glib_none(ffi::gst_discoverer_stream_info_get_stream_type_nick(self.to_glib_none().0))
        }
    }

    fn get_tags(&self) -> Option<gst::TagList> {
        unsafe {
            from_glib_none(ffi::gst_discoverer_stream_info_get_tags(self.to_glib_none().0))
        }
    }

    fn get_toc(&self) -> Option<gst::Toc> {
        unsafe {
            from_glib_none(ffi::gst_discoverer_stream_info_get_toc(self.to_glib_none().0))
        }
    }
}