gstreamer_editing_services/auto/

test_clip.rs

// 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, Clip, Container, Extractable, MetaContainer, SourceClip, TimelineElement, VideoTestPattern,
};
use glib::{
    prelude::*,
    signal::{connect_raw, SignalHandlerId},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// Useful for testing purposes.
    ///
    /// ## Asset
    ///
    /// The default asset ID is GESTestClip, but the framerate and video
    /// size can be overridden using an ID of the form:
    ///
    /// ```text
    /// framerate=60/1, width=1920, height=1080, max-duration=5.0
    /// ```
    /// Note: `max-duration` can be provided in seconds as float, or as GstClockTime
    /// as guint64 or gint.
    ///
    /// ## Properties
    ///
    ///
    /// #### `freq`
    ///  The frequency to generate for audio track elements.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `mute`
    ///  Whether the sound will be played or not.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `volume`
    ///  The volume for the audio track elements.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `vpattern`
    ///  Video pattern to display in video track elements.
    ///
    /// Readable | Writeable | Construct
    /// <details><summary><h4>Clip</h4></summary>
    ///
    ///
    /// #### `duration-limit`
    ///  The maximum [`duration`][struct@crate::TimelineElement#duration] that can be *currently* set
    /// for the clip, taking into account the [`in-point`][struct@crate::TimelineElement#in-point],
    /// [`max-duration`][struct@crate::TimelineElement#max-duration], [`active`][struct@crate::TrackElement#active], and
    /// [`track`][struct@crate::TrackElement#track] properties of its children, as well as any
    /// time effects. If there is no limit, this will be set to
    /// `GST_CLOCK_TIME_NONE`.
    ///
    /// Note that whilst a clip has no children in any tracks, the limit will
    /// be unknown, and similarly set to `GST_CLOCK_TIME_NONE`.
    ///
    /// If the duration-limit would ever go below the current
    /// [`duration`][struct@crate::TimelineElement#duration] of the clip due to a change in the above
    /// variables, its [`duration`][struct@crate::TimelineElement#duration] will be set to the new
    /// limit.
    ///
    /// Readable
    ///
    ///
    /// #### `layer`
    ///  The layer this clip lies in.
    ///
    /// If you want to connect to this property's [`notify`][struct@crate::glib::Object#notify] signal,
    /// you should connect to it with `g_signal_connect_after()` since the
    /// signal emission may be stopped internally.
    ///
    /// Readable
    ///
    ///
    /// #### `supported-formats`
    ///  The [`TrackType`][crate::TrackType]-s that the clip supports, which it can create
    /// [`TrackElement`][crate::TrackElement]-s for. Note that this can be a combination of
    /// [`TrackType`][crate::TrackType] flags to indicate support for several
    /// [`track-type`][struct@crate::TrackElement#track-type] elements.
    ///
    /// Readable | Writeable | Construct
    /// </details>
    /// <details><summary><h4>Container</h4></summary>
    ///
    ///
    /// #### `height`
    ///  The span of the container's children's [`priority`][struct@crate::TimelineElement#priority]
    /// values, which is the number of integers that lie between (inclusive)
    /// the minimum and maximum priorities found amongst the container's
    /// children (maximum - minimum + 1).
    ///
    /// Readable
    /// </details>
    /// <details><summary><h4>TimelineElement</h4></summary>
    ///
    ///
    /// #### `duration`
    ///  The duration that the element is in effect for in the timeline (a
    /// time difference in nanoseconds using the time coordinates of the
    /// timeline). For example, for a source element, this would determine
    /// for how long it should output its internal content for. For an
    /// operation element, this would determine for how long its effect
    /// should be applied to any source content.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `in-point`
    ///  The initial offset to use internally when outputting content (in
    /// nanoseconds, but in the time coordinates of the internal content).
    ///
    /// For example, for a [`VideoUriSource`][crate::VideoUriSource] that references some media
    /// file, the "internal content" is the media file data, and the
    /// in-point would correspond to some timestamp in the media file.
    /// When playing the timeline, and when the element is first reached at
    /// timeline-time [`start`][struct@crate::TimelineElement#start], it will begin outputting the
    /// data from the timestamp in-point **onwards**, until it reaches the
    /// end of its [`duration`][struct@crate::TimelineElement#duration] in the timeline.
    ///
    /// For elements that have no internal content, this should be kept
    /// as 0.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `max-duration`
    ///  The full duration of internal content that is available (a time
    /// difference in nanoseconds using the time coordinates of the internal
    /// content).
    ///
    /// This will act as a cap on the [`in-point`][struct@crate::TimelineElement#in-point] of the
    /// element (which is in the same time coordinates), and will sometimes
    /// be used to limit the [`duration`][struct@crate::TimelineElement#duration] of the element in
    /// the timeline.
    ///
    /// For example, for a [`VideoUriSource`][crate::VideoUriSource] that references some media
    /// file, this would be the length of the media file.
    ///
    /// For elements that have no internal content, or whose content is
    /// indefinite, this should be kept as `GST_CLOCK_TIME_NONE`.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `name`
    ///  The name of the element. This should be unique within its timeline.
    ///
    /// Readable | Writeable | Construct
    ///
    ///
    /// #### `parent`
    ///  The parent container of the element.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `priority`
    ///  The priority of the element.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `serialize`
    ///  Whether the element should be serialized.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `start`
    ///  The starting position of the element in the timeline (in nanoseconds
    /// and in the time coordinates of the timeline). For example, for a
    /// source element, this would determine the time at which it should
    /// start outputting its internal content. For an operation element, this
    /// would determine the time at which it should start applying its effect
    /// to any source content.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `timeline`
    ///  The timeline that the element lies within.
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// # Implements
    ///
    /// [`TestClipExt`][trait@crate::prelude::TestClipExt], [`SourceClipExt`][trait@crate::prelude::SourceClipExt], [`ClipExt`][trait@crate::prelude::ClipExt], [`GESContainerExt`][trait@crate::prelude::GESContainerExt], [`TimelineElementExt`][trait@crate::prelude::TimelineElementExt], [`trait@glib::ObjectExt`], [`ExtractableExt`][trait@crate::prelude::ExtractableExt], [`MetaContainerExt`][trait@crate::prelude::MetaContainerExt], [`TimelineElementExtManual`][trait@crate::prelude::TimelineElementExtManual]
    #[doc(alias = "GESTestClip")]
    pub struct TestClip(Object<ffi::GESTestClip, ffi::GESTestClipClass>) @extends SourceClip, Clip, Container, TimelineElement, @implements Extractable, MetaContainer;

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

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

    /// Creates a new [`TestClip`][crate::TestClip].
    ///
    /// # Returns
    ///
    /// The newly created [`TestClip`][crate::TestClip],
    /// or [`None`] if there was an error.
    #[doc(alias = "ges_test_clip_new")]
    pub fn new() -> Option<TestClip> {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::ges_test_clip_new()) }
    }

    /// Creates a new [`TestClip`][crate::TestClip] for the provided `nick`.
    /// ## `nick`
    /// the nickname for which to create the [`TestClip`][crate::TestClip]
    ///
    /// # Returns
    ///
    /// The newly created [`TestClip`][crate::TestClip],
    /// or [`None`] if there was an error.
    #[doc(alias = "ges_test_clip_new_for_nick")]
    #[doc(alias = "new_for_nick")]
    pub fn for_nick(nick: &str) -> Option<TestClip> {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::ges_test_clip_new_for_nick(nick.to_glib_none().0)) }
    }
}

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

/// Trait containing all [`struct@TestClip`] methods.
///
/// # Implementors
///
/// [`TestClip`][struct@crate::TestClip]
pub trait TestClipExt: IsA<TestClip> + sealed::Sealed + 'static {
    /// Get the frequency `self` generates.
    ///
    /// # Returns
    ///
    /// The frequency `self` generates. See audiotestsrc element.
    #[doc(alias = "ges_test_clip_get_frequency")]
    #[doc(alias = "get_frequency")]
    fn frequency(&self) -> f64 {
        unsafe { ffi::ges_test_clip_get_frequency(self.as_ref().to_glib_none().0) }
    }

    /// Get the volume of the test audio signal applied on `self`.
    ///
    /// # Returns
    ///
    /// The volume of the test audio signal applied on `self`.
    #[doc(alias = "ges_test_clip_get_volume")]
    #[doc(alias = "get_volume")]
    fn volume(&self) -> f64 {
        unsafe { ffi::ges_test_clip_get_volume(self.as_ref().to_glib_none().0) }
    }

    /// Get the [`VideoTestPattern`][crate::VideoTestPattern] which is applied on `self`.
    ///
    /// # Returns
    ///
    /// The [`VideoTestPattern`][crate::VideoTestPattern] which is applied on `self`.
    #[doc(alias = "ges_test_clip_get_vpattern")]
    #[doc(alias = "get_vpattern")]
    fn vpattern(&self) -> VideoTestPattern {
        unsafe {
            from_glib(ffi::ges_test_clip_get_vpattern(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Let you know if the audio track of `self` is muted or not.
    ///
    /// # Returns
    ///
    /// Whether the audio track of `self` is muted or not.
    #[doc(alias = "ges_test_clip_is_muted")]
    fn is_muted(&self) -> bool {
        unsafe { from_glib(ffi::ges_test_clip_is_muted(self.as_ref().to_glib_none().0)) }
    }

    /// Sets the frequency to generate. See audiotestsrc element.
    /// ## `freq`
    /// the frequency you want to use on `self`
    #[doc(alias = "ges_test_clip_set_frequency")]
    fn set_frequency(&self, freq: f64) {
        unsafe {
            ffi::ges_test_clip_set_frequency(self.as_ref().to_glib_none().0, freq);
        }
    }

    /// Sets whether the audio track of this clip is muted or not.
    /// ## `mute`
    /// [`true`] to mute the audio track, [`false`] to unmute it
    #[doc(alias = "ges_test_clip_set_mute")]
    #[doc(alias = "mute")]
    fn set_mute(&self, mute: bool) {
        unsafe {
            ffi::ges_test_clip_set_mute(self.as_ref().to_glib_none().0, mute.into_glib());
        }
    }

    /// Sets the volume of the test audio signal.
    /// ## `volume`
    /// the volume of the audio signal you want to use on `self`
    #[doc(alias = "ges_test_clip_set_volume")]
    #[doc(alias = "volume")]
    fn set_volume(&self, volume: f64) {
        unsafe {
            ffi::ges_test_clip_set_volume(self.as_ref().to_glib_none().0, volume);
        }
    }

    /// Sets which video pattern to display on `self`.
    /// ## `vpattern`
    /// the [`VideoTestPattern`][crate::VideoTestPattern] to use on `self`
    #[doc(alias = "ges_test_clip_set_vpattern")]
    #[doc(alias = "vpattern")]
    fn set_vpattern(&self, vpattern: VideoTestPattern) {
        unsafe {
            ffi::ges_test_clip_set_vpattern(self.as_ref().to_glib_none().0, vpattern.into_glib());
        }
    }

    /// The frequency to generate for audio track elements.
    fn freq(&self) -> f64 {
        ObjectExt::property(self.as_ref(), "freq")
    }

    /// The frequency to generate for audio track elements.
    fn set_freq(&self, freq: f64) {
        ObjectExt::set_property(self.as_ref(), "freq", freq)
    }

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

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

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

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

impl<O: IsA<TestClip>> TestClipExt for O {}