gtk4/auto/

media_file.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 crate::{ffi, MediaStream};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// [`MediaFile`][crate::MediaFile] implements [`MediaStream`][crate::MediaStream] for files.
    ///
    /// This provides a simple way to play back video files with GTK.
    ///
    /// GTK provides a GIO extension point for [`MediaFile`][crate::MediaFile] implementations
    /// to allow for external implementations using various media frameworks.
    ///
    /// GTK itself includes an implementation using GStreamer.
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// ## Properties
    ///
    ///
    /// #### `file`
    ///  The file being played back or [`None`] if not playing a file.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `input-stream`
    ///  The stream being played back or [`None`] if not playing a stream.
    ///
    /// This is [`None`] when playing a file.
    ///
    /// Readable | Writeable
    /// <details><summary><h4>MediaStream</h4></summary>
    ///
    ///
    /// #### `duration`
    ///  The stream's duration in microseconds or 0 if unknown.
    ///
    /// Readable
    ///
    ///
    /// #### `ended`
    ///  Set when playback has finished.
    ///
    /// Readable
    ///
    ///
    /// #### `error`
    ///  [`None`] for a properly working stream or the `GError`
    /// that the stream is in.
    ///
    /// Readable
    ///
    ///
    /// #### `has-audio`
    ///  Whether the stream contains audio.
    ///
    /// Readable
    ///
    ///
    /// #### `has-video`
    ///  Whether the stream contains video.
    ///
    /// Readable
    ///
    ///
    /// #### `loop`
    ///  Try to restart the media from the beginning once it ended.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `muted`
    ///  Whether the audio stream should be muted.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `playing`
    ///  Whether the stream is currently playing.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `prepared`
    ///  Whether the stream has finished initializing and existence of
    /// audio and video is known.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `seekable`
    ///  Set unless the stream is known to not support seeking.
    ///
    /// Readable
    ///
    ///
    /// #### `seeking`
    ///  Set while a seek is in progress.
    ///
    /// Readable
    ///
    ///
    /// #### `timestamp`
    ///  The current presentation timestamp in microseconds.
    ///
    /// Readable
    ///
    ///
    /// #### `volume`
    ///  Volume of the audio stream.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`MediaFileExt`][trait@crate::prelude::MediaFileExt], [`MediaStreamExt`][trait@crate::prelude::MediaStreamExt], [`trait@glib::ObjectExt`], [`trait@gdk::prelude::PaintableExt`], [`MediaStreamExtManual`][trait@crate::prelude::MediaStreamExtManual]
    #[doc(alias = "GtkMediaFile")]
    pub struct MediaFile(Object<ffi::GtkMediaFile, ffi::GtkMediaFileClass>) @extends MediaStream, @implements gdk::Paintable;

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

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

    /// Creates a new empty media file.
    ///
    /// # Returns
    ///
    /// a new [`MediaFile`][crate::MediaFile]
    #[doc(alias = "gtk_media_file_new")]
    pub fn new() -> MediaFile {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::gtk_media_file_new()) }
    }

    /// Creates a new media file to play @file.
    /// ## `file`
    /// The file to play
    ///
    /// # Returns
    ///
    /// a new [`MediaFile`][crate::MediaFile] playing @file
    #[doc(alias = "gtk_media_file_new_for_file")]
    #[doc(alias = "new_for_file")]
    pub fn for_file(file: &impl IsA<gio::File>) -> MediaFile {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gtk_media_file_new_for_file(
                file.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Creates a new media file for the given filename.
    ///
    /// This is a utility function that converts the given @filename
    /// to a `GFile` and calls [`for_file()`][Self::for_file()].
    /// ## `filename`
    /// filename to open
    ///
    /// # Returns
    ///
    /// a new [`MediaFile`][crate::MediaFile] playing @filename
    #[doc(alias = "gtk_media_file_new_for_filename")]
    #[doc(alias = "new_for_filename")]
    pub fn for_filename(filename: impl AsRef<std::path::Path>) -> MediaFile {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gtk_media_file_new_for_filename(
                filename.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Creates a new media file to play @stream.
    ///
    /// If you want the resulting media to be seekable,
    /// the stream should implement the `GSeekable` interface.
    /// ## `stream`
    /// The stream to play
    ///
    /// # Returns
    ///
    /// a new [`MediaFile`][crate::MediaFile]
    #[doc(alias = "gtk_media_file_new_for_input_stream")]
    #[doc(alias = "new_for_input_stream")]
    pub fn for_input_stream(stream: &impl IsA<gio::InputStream>) -> MediaFile {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gtk_media_file_new_for_input_stream(
                stream.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Creates a new new media file for the given resource.
    ///
    /// This is a utility function that converts the given @resource
    /// to a `GFile` and calls [`for_file()`][Self::for_file()].
    /// ## `resource_path`
    /// resource path to open
    ///
    /// # Returns
    ///
    /// a new [`MediaFile`][crate::MediaFile] playing @resource_path
    #[doc(alias = "gtk_media_file_new_for_resource")]
    #[doc(alias = "new_for_resource")]
    pub fn for_resource(resource_path: &str) -> MediaFile {
        assert_initialized_main_thread!();
        unsafe {
            from_glib_full(ffi::gtk_media_file_new_for_resource(
                resource_path.to_glib_none().0,
            ))
        }
    }
}

impl Default for MediaFile {
    fn default() -> Self {
        Self::new()
    }
}

/// Trait containing all [`struct@MediaFile`] methods.
///
/// # Implementors
///
/// [`MediaFile`][struct@crate::MediaFile]
pub trait MediaFileExt: IsA<MediaFile> + 'static {
    /// Resets the media file to be empty.
    #[doc(alias = "gtk_media_file_clear")]
    fn clear(&self) {
        unsafe {
            ffi::gtk_media_file_clear(self.as_ref().to_glib_none().0);
        }
    }

    /// Returns the file that @self is currently playing from.
    ///
    /// When @self is not playing or not playing from a file,
    /// [`None`] is returned.
    ///
    /// # Returns
    ///
    /// The currently playing file
    #[doc(alias = "gtk_media_file_get_file")]
    #[doc(alias = "get_file")]
    fn file(&self) -> Option<gio::File> {
        unsafe { from_glib_none(ffi::gtk_media_file_get_file(self.as_ref().to_glib_none().0)) }
    }

    /// Returns the stream that @self is currently playing from.
    ///
    /// When @self is not playing or not playing from a stream,
    /// [`None`] is returned.
    ///
    /// # Returns
    ///
    /// The currently playing stream
    #[doc(alias = "gtk_media_file_get_input_stream")]
    #[doc(alias = "get_input_stream")]
    #[doc(alias = "input-stream")]
    fn input_stream(&self) -> Option<gio::InputStream> {
        unsafe {
            from_glib_none(ffi::gtk_media_file_get_input_stream(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Sets the [`MediaFile`][crate::MediaFile] to play the given file.
    ///
    /// If any file is still playing, stop playing it.
    /// ## `file`
    /// the file to play
    #[doc(alias = "gtk_media_file_set_file")]
    #[doc(alias = "file")]
    fn set_file(&self, file: Option<&impl IsA<gio::File>>) {
        unsafe {
            ffi::gtk_media_file_set_file(
                self.as_ref().to_glib_none().0,
                file.map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    /// Sets the `GtkMediaFile to play the given file.
    ///
    /// This is a utility function that converts the given @filename
    /// to a `GFile` and calls [`set_file()`][Self::set_file()].
    /// ## `filename`
    /// name of file to play
    #[doc(alias = "gtk_media_file_set_filename")]
    fn set_filename(&self, filename: Option<impl AsRef<std::path::Path>>) {
        unsafe {
            ffi::gtk_media_file_set_filename(
                self.as_ref().to_glib_none().0,
                filename.as_ref().map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    /// Sets the [`MediaFile`][crate::MediaFile] to play the given stream.
    ///
    /// If anything is still playing, stop playing it.
    ///
    /// Full control about the @stream is assumed for the duration of
    /// playback. The stream will not be closed.
    /// ## `stream`
    /// the stream to play from
    #[doc(alias = "gtk_media_file_set_input_stream")]
    #[doc(alias = "input-stream")]
    fn set_input_stream(&self, stream: Option<&impl IsA<gio::InputStream>>) {
        unsafe {
            ffi::gtk_media_file_set_input_stream(
                self.as_ref().to_glib_none().0,
                stream.map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    /// Sets the `GtkMediaFile to play the given resource.
    ///
    /// This is a utility function that converts the given @resource_path
    /// to a `GFile` and calls [`set_file()`][Self::set_file()].
    /// ## `resource_path`
    /// path to resource to play
    #[doc(alias = "gtk_media_file_set_resource")]
    fn set_resource(&self, resource_path: Option<&str>) {
        unsafe {
            ffi::gtk_media_file_set_resource(
                self.as_ref().to_glib_none().0,
                resource_path.to_glib_none().0,
            );
        }
    }

    #[doc(alias = "file")]
    fn connect_file_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_file_trampoline<P: IsA<MediaFile>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkMediaFile,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(MediaFile::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::file".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_file_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "input-stream")]
    fn connect_input_stream_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_input_stream_trampoline<
            P: IsA<MediaFile>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkMediaFile,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            let f: &F = &*(f as *const F);
            f(MediaFile::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::input-stream".as_ptr() as *const _,
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_input_stream_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<MediaFile>> MediaFileExt for O {}