// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT

use crate::ffi;
use glib::{prelude::*, translate::*};

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

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

impl DiscovererStreamInfo {
    pub const NONE: Option<&'static DiscovererStreamInfo> = None;
}

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

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::DiscovererStreamInfo>> Sealed for T {}
}

/// Trait containing all [`struct@DiscovererStreamInfo`] methods.
///
/// # Implementors
///
/// [`DiscovererAudioInfo`][struct@crate::DiscovererAudioInfo], [`DiscovererContainerInfo`][struct@crate::DiscovererContainerInfo], [`DiscovererStreamInfo`][struct@crate::DiscovererStreamInfo], [`DiscovererSubtitleInfo`][struct@crate::DiscovererSubtitleInfo], [`DiscovererVideoInfo`][struct@crate::DiscovererVideoInfo]
pub trait DiscovererStreamInfoExt: IsA<DiscovererStreamInfo> + sealed::Sealed + 'static {
    ///
    /// # Returns
    ///
    /// the [`gst::Caps`][crate::gst::Caps] of the stream. Unref with
    /// `gst_caps_unref` after usage.
    #[doc(alias = "gst_discoverer_stream_info_get_caps")]
    #[doc(alias = "get_caps")]
    fn caps(&self) -> Option<gst::Caps> {
        unsafe {
            from_glib_full(ffi::gst_discoverer_stream_info_get_caps(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # 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`][crate::gst::Structure]
    /// after the life-time of `self` you will need to copy it.
    #[doc(alias = "gst_discoverer_stream_info_get_misc")]
    #[doc(alias = "get_misc")]
    fn misc(&self) -> Option<gst::Structure> {
        unsafe {
            from_glib_none(ffi::gst_discoverer_stream_info_get_misc(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the next [`DiscovererStreamInfo`][crate::DiscovererStreamInfo] in a chain. [`None`]
    /// for final streams.
    /// Unref with `gst_discoverer_stream_info_unref` after usage.
    #[doc(alias = "gst_discoverer_stream_info_get_next")]
    #[doc(alias = "get_next")]
    #[must_use]
    fn next(&self) -> Option<DiscovererStreamInfo> {
        unsafe {
            from_glib_full(ffi::gst_discoverer_stream_info_get_next(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the previous [`DiscovererStreamInfo`][crate::DiscovererStreamInfo] in a chain.
    /// [`None`] for starting points. Unref with `gst_discoverer_stream_info_unref`
    /// after usage.
    #[doc(alias = "gst_discoverer_stream_info_get_previous")]
    #[doc(alias = "get_previous")]
    #[must_use]
    fn previous(&self) -> Option<DiscovererStreamInfo> {
        unsafe {
            from_glib_full(ffi::gst_discoverer_stream_info_get_previous(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # 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.
    #[doc(alias = "gst_discoverer_stream_info_get_stream_id")]
    #[doc(alias = "get_stream_id")]
    fn stream_id(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::gst_discoverer_stream_info_get_stream_id(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # Returns
    ///
    /// the stream number, -1 if no index could be determined. This property
    /// acts as a unique identifier as a 'int' for the stream.
    #[cfg(feature = "v1_20")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_20")))]
    #[doc(alias = "gst_discoverer_stream_info_get_stream_number")]
    #[doc(alias = "get_stream_number")]
    fn stream_number(&self) -> i32 {
        unsafe { ffi::gst_discoverer_stream_info_get_stream_number(self.as_ref().to_glib_none().0) }
    }

    ///
    /// # Returns
    ///
    /// a human readable name for the stream type of the given `self` (ex : "audio",
    /// "container",...).
    #[doc(alias = "gst_discoverer_stream_info_get_stream_type_nick")]
    #[doc(alias = "get_stream_type_nick")]
    fn stream_type_nick(&self) -> glib::GString {
        unsafe {
            from_glib_none(ffi::gst_discoverer_stream_info_get_stream_type_nick(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # 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.
    #[doc(alias = "gst_discoverer_stream_info_get_tags")]
    #[doc(alias = "get_tags")]
    fn tags(&self) -> Option<gst::TagList> {
        unsafe {
            from_glib_none(ffi::gst_discoverer_stream_info_get_tags(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    ///
    /// # 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.
    #[doc(alias = "gst_discoverer_stream_info_get_toc")]
    #[doc(alias = "get_toc")]
    fn toc(&self) -> Option<gst::Toc> {
        unsafe {
            from_glib_none(ffi::gst_discoverer_stream_info_get_toc(
                self.as_ref().to_glib_none().0,
            ))
        }
    }
}

impl<O: IsA<DiscovererStreamInfo>> DiscovererStreamInfoExt for O {}