gstreamer_play/auto/
play_media_info.rs

1// This file was generated by gir (https://github.com/gtk-rs/gir)
2// from gir-files (https://github.com/gtk-rs/gir-files)
3// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
4// DO NOT EDIT
5
6use crate::{ffi, PlayAudioInfo, PlayStreamInfo, PlaySubtitleInfo, PlayVideoInfo};
7use glib::translate::*;
8
9glib::wrapper! {
10    /// Structure containing the media information of a URI.
11    ///
12    /// # Implements
13    ///
14    /// [`trait@glib::ObjectExt`]
15    #[doc(alias = "GstPlayMediaInfo")]
16    pub struct PlayMediaInfo(Object<ffi::GstPlayMediaInfo, ffi::GstPlayMediaInfoClass>);
17
18    match fn {
19        type_ => || ffi::gst_play_media_info_get_type(),
20    }
21}
22
23impl PlayMediaInfo {
24    ///
25    /// # Returns
26    ///
27    /// A `GList` of
28    /// matching [`PlayAudioInfo`][crate::PlayAudioInfo].
29    #[doc(alias = "gst_play_media_info_get_audio_streams")]
30    #[doc(alias = "get_audio_streams")]
31    pub fn audio_streams(&self) -> Vec<PlayAudioInfo> {
32        unsafe {
33            FromGlibPtrContainer::from_glib_none(ffi::gst_play_media_info_get_audio_streams(
34                self.to_glib_none().0,
35            ))
36        }
37    }
38
39    ///
40    /// # Returns
41    ///
42    /// the container format or [`None`] if unknown.
43    #[doc(alias = "gst_play_media_info_get_container_format")]
44    #[doc(alias = "get_container_format")]
45    pub fn container_format(&self) -> Option<glib::GString> {
46        unsafe {
47            from_glib_none(ffi::gst_play_media_info_get_container_format(
48                self.to_glib_none().0,
49            ))
50        }
51    }
52
53    ///
54    /// # Returns
55    ///
56    /// duration of the media.
57    #[doc(alias = "gst_play_media_info_get_duration")]
58    #[doc(alias = "get_duration")]
59    pub fn duration(&self) -> Option<gst::ClockTime> {
60        unsafe { from_glib(ffi::gst_play_media_info_get_duration(self.to_glib_none().0)) }
61    }
62
63    /// Function to get the image (or preview-image) stored in taglist.
64    /// Application can use `gst_sample_*`_()`` API's to get caps, buffer etc.
65    ///
66    /// # Returns
67    ///
68    /// GstSample or [`None`].
69    #[doc(alias = "gst_play_media_info_get_image_sample")]
70    #[doc(alias = "get_image_sample")]
71    pub fn image_sample(&self) -> Option<gst::Sample> {
72        unsafe {
73            from_glib_none(ffi::gst_play_media_info_get_image_sample(
74                self.to_glib_none().0,
75            ))
76        }
77    }
78
79    ///
80    /// # Returns
81    ///
82    /// number of audio streams.
83    #[doc(alias = "gst_play_media_info_get_number_of_audio_streams")]
84    #[doc(alias = "get_number_of_audio_streams")]
85    pub fn number_of_audio_streams(&self) -> u32 {
86        unsafe { ffi::gst_play_media_info_get_number_of_audio_streams(self.to_glib_none().0) }
87    }
88
89    ///
90    /// # Returns
91    ///
92    /// number of total streams.
93    #[doc(alias = "gst_play_media_info_get_number_of_streams")]
94    #[doc(alias = "get_number_of_streams")]
95    pub fn number_of_streams(&self) -> u32 {
96        unsafe { ffi::gst_play_media_info_get_number_of_streams(self.to_glib_none().0) }
97    }
98
99    ///
100    /// # Returns
101    ///
102    /// number of subtitle streams.
103    #[doc(alias = "gst_play_media_info_get_number_of_subtitle_streams")]
104    #[doc(alias = "get_number_of_subtitle_streams")]
105    pub fn number_of_subtitle_streams(&self) -> u32 {
106        unsafe { ffi::gst_play_media_info_get_number_of_subtitle_streams(self.to_glib_none().0) }
107    }
108
109    ///
110    /// # Returns
111    ///
112    /// number of video streams.
113    #[doc(alias = "gst_play_media_info_get_number_of_video_streams")]
114    #[doc(alias = "get_number_of_video_streams")]
115    pub fn number_of_video_streams(&self) -> u32 {
116        unsafe { ffi::gst_play_media_info_get_number_of_video_streams(self.to_glib_none().0) }
117    }
118
119    ///
120    /// # Returns
121    ///
122    /// A `GList` of
123    /// matching [`PlayStreamInfo`][crate::PlayStreamInfo].
124    #[doc(alias = "gst_play_media_info_get_stream_list")]
125    #[doc(alias = "get_stream_list")]
126    pub fn stream_list(&self) -> Vec<PlayStreamInfo> {
127        unsafe {
128            FromGlibPtrContainer::from_glib_none(ffi::gst_play_media_info_get_stream_list(
129                self.to_glib_none().0,
130            ))
131        }
132    }
133
134    ///
135    /// # Returns
136    ///
137    /// A `GList` of
138    /// matching [`PlaySubtitleInfo`][crate::PlaySubtitleInfo].
139    #[doc(alias = "gst_play_media_info_get_subtitle_streams")]
140    #[doc(alias = "get_subtitle_streams")]
141    pub fn subtitle_streams(&self) -> Vec<PlaySubtitleInfo> {
142        unsafe {
143            FromGlibPtrContainer::from_glib_none(ffi::gst_play_media_info_get_subtitle_streams(
144                self.to_glib_none().0,
145            ))
146        }
147    }
148
149    ///
150    /// # Returns
151    ///
152    /// the tags contained in media info.
153    #[doc(alias = "gst_play_media_info_get_tags")]
154    #[doc(alias = "get_tags")]
155    pub fn tags(&self) -> Option<gst::TagList> {
156        unsafe { from_glib_none(ffi::gst_play_media_info_get_tags(self.to_glib_none().0)) }
157    }
158
159    ///
160    /// # Returns
161    ///
162    /// the media title or [`None`] if unknown.
163    #[doc(alias = "gst_play_media_info_get_title")]
164    #[doc(alias = "get_title")]
165    pub fn title(&self) -> Option<glib::GString> {
166        unsafe { from_glib_none(ffi::gst_play_media_info_get_title(self.to_glib_none().0)) }
167    }
168
169    ///
170    /// # Returns
171    ///
172    /// the URI associated with [`PlayMediaInfo`][crate::PlayMediaInfo].
173    #[doc(alias = "gst_play_media_info_get_uri")]
174    #[doc(alias = "get_uri")]
175    pub fn uri(&self) -> glib::GString {
176        unsafe { from_glib_none(ffi::gst_play_media_info_get_uri(self.to_glib_none().0)) }
177    }
178
179    ///
180    /// # Returns
181    ///
182    /// A `GList` of
183    /// matching [`PlayVideoInfo`][crate::PlayVideoInfo].
184    #[doc(alias = "gst_play_media_info_get_video_streams")]
185    #[doc(alias = "get_video_streams")]
186    pub fn video_streams(&self) -> Vec<PlayVideoInfo> {
187        unsafe {
188            FromGlibPtrContainer::from_glib_none(ffi::gst_play_media_info_get_video_streams(
189                self.to_glib_none().0,
190            ))
191        }
192    }
193
194    ///
195    /// # Returns
196    ///
197    /// [`true`] if the media is live.
198    #[doc(alias = "gst_play_media_info_is_live")]
199    pub fn is_live(&self) -> bool {
200        unsafe { from_glib(ffi::gst_play_media_info_is_live(self.to_glib_none().0)) }
201    }
202
203    ///
204    /// # Returns
205    ///
206    /// [`true`] if the media is seekable.
207    #[doc(alias = "gst_play_media_info_is_seekable")]
208    pub fn is_seekable(&self) -> bool {
209        unsafe { from_glib(ffi::gst_play_media_info_is_seekable(self.to_glib_none().0)) }
210    }
211}
212
213unsafe impl Send for PlayMediaInfo {}
214unsafe impl Sync for PlayMediaInfo {}
gstreamer_play/auto/play_media_info.rs

gstreamer_play/auto/
play_media_info.rs
