Skip to main content

gstreamer/auto/
plugin.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
6#[cfg(feature = "v1_30")]
7#[cfg_attr(docsrs, doc(cfg(feature = "v1_30")))]
8use crate::Registry;
9use crate::{Object, PluginDependencyFlags, Structure, ffi};
10use glib::translate::*;
11
12glib::wrapper! {
13    #[doc(alias = "GstPlugin")]
14    pub struct Plugin(Object<ffi::GstPlugin, ffi::GstPluginClass>) @extends Object;
15
16    match fn {
17        type_ => || ffi::gst_plugin_get_type(),
18    }
19}
20
21impl Plugin {
22    #[doc(alias = "gst_plugin_add_dependency")]
23    pub fn add_dependency(
24        &self,
25        env_vars: &[&str],
26        paths: &[&str],
27        names: &[&str],
28        flags: PluginDependencyFlags,
29    ) {
30        unsafe {
31            ffi::gst_plugin_add_dependency(
32                self.to_glib_none().0,
33                env_vars.to_glib_none().0,
34                paths.to_glib_none().0,
35                names.to_glib_none().0,
36                flags.into_glib(),
37            );
38        }
39    }
40
41    #[doc(alias = "gst_plugin_add_dependency_simple")]
42    pub fn add_dependency_simple(
43        &self,
44        env_vars: Option<&str>,
45        paths: Option<&str>,
46        names: Option<&str>,
47        flags: PluginDependencyFlags,
48    ) {
49        unsafe {
50            ffi::gst_plugin_add_dependency_simple(
51                self.to_glib_none().0,
52                env_vars.to_glib_none().0,
53                paths.to_glib_none().0,
54                names.to_glib_none().0,
55                flags.into_glib(),
56            );
57        }
58    }
59
60    #[cfg(feature = "v1_24")]
61    #[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
62    #[doc(alias = "gst_plugin_add_status_error")]
63    pub fn add_status_error(&self, message: &str) {
64        unsafe {
65            ffi::gst_plugin_add_status_error(self.to_glib_none().0, message.to_glib_none().0);
66        }
67    }
68
69    #[cfg(feature = "v1_24")]
70    #[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
71    #[doc(alias = "gst_plugin_add_status_info")]
72    pub fn add_status_info(&self, message: &str) {
73        unsafe {
74            ffi::gst_plugin_add_status_info(self.to_glib_none().0, message.to_glib_none().0);
75        }
76    }
77
78    #[cfg(feature = "v1_24")]
79    #[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
80    #[doc(alias = "gst_plugin_add_status_warning")]
81    pub fn add_status_warning(&self, message: &str) {
82        unsafe {
83            ffi::gst_plugin_add_status_warning(self.to_glib_none().0, message.to_glib_none().0);
84        }
85    }
86
87    #[doc(alias = "gst_plugin_get_description")]
88    #[doc(alias = "get_description")]
89    pub fn description(&self) -> glib::GString {
90        unsafe { from_glib_none(ffi::gst_plugin_get_description(self.to_glib_none().0)) }
91    }
92
93    #[doc(alias = "gst_plugin_get_filename")]
94    #[doc(alias = "get_filename")]
95    pub fn filename(&self) -> Option<std::path::PathBuf> {
96        unsafe { from_glib_none(ffi::gst_plugin_get_filename(self.to_glib_none().0)) }
97    }
98
99    #[doc(alias = "gst_plugin_get_license")]
100    #[doc(alias = "get_license")]
101    pub fn license(&self) -> glib::GString {
102        unsafe { from_glib_none(ffi::gst_plugin_get_license(self.to_glib_none().0)) }
103    }
104
105    #[doc(alias = "gst_plugin_get_name")]
106    #[doc(alias = "get_name")]
107    pub fn plugin_name(&self) -> glib::GString {
108        unsafe { from_glib_none(ffi::gst_plugin_get_name(self.to_glib_none().0)) }
109    }
110
111    #[doc(alias = "gst_plugin_get_origin")]
112    #[doc(alias = "get_origin")]
113    pub fn origin(&self) -> glib::GString {
114        unsafe { from_glib_none(ffi::gst_plugin_get_origin(self.to_glib_none().0)) }
115    }
116
117    #[doc(alias = "gst_plugin_get_package")]
118    #[doc(alias = "get_package")]
119    pub fn package(&self) -> glib::GString {
120        unsafe { from_glib_none(ffi::gst_plugin_get_package(self.to_glib_none().0)) }
121    }
122
123    #[cfg(feature = "v1_30")]
124    #[cfg_attr(docsrs, doc(cfg(feature = "v1_30")))]
125    #[doc(alias = "gst_plugin_get_registry")]
126    #[doc(alias = "get_registry")]
127    pub fn registry(&self) -> Registry {
128        unsafe { from_glib_none(ffi::gst_plugin_get_registry(self.to_glib_none().0)) }
129    }
130
131    #[doc(alias = "gst_plugin_get_release_date_string")]
132    #[doc(alias = "get_release_date_string")]
133    pub fn release_date_string(&self) -> Option<glib::GString> {
134        unsafe {
135            from_glib_none(ffi::gst_plugin_get_release_date_string(
136                self.to_glib_none().0,
137            ))
138        }
139    }
140
141    #[doc(alias = "gst_plugin_get_source")]
142    #[doc(alias = "get_source")]
143    pub fn source(&self) -> glib::GString {
144        unsafe { from_glib_none(ffi::gst_plugin_get_source(self.to_glib_none().0)) }
145    }
146
147    #[cfg(feature = "v1_24")]
148    #[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
149    #[doc(alias = "gst_plugin_get_status_errors")]
150    #[doc(alias = "get_status_errors")]
151    pub fn status_errors(&self) -> Vec<glib::GString> {
152        unsafe {
153            FromGlibPtrContainer::from_glib_full(ffi::gst_plugin_get_status_errors(
154                self.to_glib_none().0,
155            ))
156        }
157    }
158
159    #[cfg(feature = "v1_24")]
160    #[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
161    #[doc(alias = "gst_plugin_get_status_infos")]
162    #[doc(alias = "get_status_infos")]
163    pub fn status_infos(&self) -> Vec<glib::GString> {
164        unsafe {
165            FromGlibPtrContainer::from_glib_full(ffi::gst_plugin_get_status_infos(
166                self.to_glib_none().0,
167            ))
168        }
169    }
170
171    #[cfg(feature = "v1_24")]
172    #[cfg_attr(docsrs, doc(cfg(feature = "v1_24")))]
173    #[doc(alias = "gst_plugin_get_status_warnings")]
174    #[doc(alias = "get_status_warnings")]
175    pub fn status_warnings(&self) -> Vec<glib::GString> {
176        unsafe {
177            FromGlibPtrContainer::from_glib_full(ffi::gst_plugin_get_status_warnings(
178                self.to_glib_none().0,
179            ))
180        }
181    }
182
183    #[doc(alias = "gst_plugin_get_version")]
184    #[doc(alias = "get_version")]
185    pub fn version(&self) -> glib::GString {
186        unsafe { from_glib_none(ffi::gst_plugin_get_version(self.to_glib_none().0)) }
187    }
188
189    #[doc(alias = "gst_plugin_is_loaded")]
190    pub fn is_loaded(&self) -> bool {
191        unsafe { from_glib(ffi::gst_plugin_is_loaded(self.to_glib_none().0)) }
192    }
193
194    #[doc(alias = "gst_plugin_load")]
195    pub fn load(&self) -> Result<Plugin, glib::BoolError> {
196        unsafe {
197            Option::<_>::from_glib_full(ffi::gst_plugin_load(self.to_glib_none().0))
198                .ok_or_else(|| glib::bool_error!("Failed to load plugin"))
199        }
200    }
201
202    #[doc(alias = "gst_plugin_set_cache_data")]
203    pub fn set_cache_data(&self, cache_data: Structure) {
204        unsafe {
205            ffi::gst_plugin_set_cache_data(self.to_glib_none().0, cache_data.into_glib_ptr());
206        }
207    }
208
209    #[cfg(feature = "v1_30")]
210    #[cfg_attr(docsrs, doc(cfg(feature = "v1_30")))]
211    #[doc(alias = "gst_plugin_set_static_features_flag")]
212    pub fn set_static_features_flag(&self) {
213        unsafe {
214            ffi::gst_plugin_set_static_features_flag(self.to_glib_none().0);
215        }
216    }
217
218    #[doc(alias = "gst_plugin_load_by_name")]
219    pub fn load_by_name(name: &str) -> Result<Plugin, glib::BoolError> {
220        assert_initialized_main_thread!();
221        unsafe {
222            Option::<_>::from_glib_full(ffi::gst_plugin_load_by_name(name.to_glib_none().0))
223                .ok_or_else(|| glib::bool_error!("Failed to load plugin"))
224        }
225    }
226
227    #[doc(alias = "gst_plugin_load_file")]
228    pub fn load_file(filename: impl AsRef<std::path::Path>) -> Result<Plugin, glib::Error> {
229        assert_initialized_main_thread!();
230        unsafe {
231            let mut error = std::ptr::null_mut();
232            let ret = ffi::gst_plugin_load_file(filename.as_ref().to_glib_none().0, &mut error);
233            if error.is_null() {
234                Ok(from_glib_full(ret))
235            } else {
236                Err(from_glib_full(error))
237            }
238        }
239    }
240}
241
242impl std::fmt::Display for Plugin {
243    #[inline]
244    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
245        f.write_str(&self.plugin_name())
246    }
247}
248
249unsafe impl Send for Plugin {}
250unsafe impl Sync for Plugin {}