Struct gtk4::MediaFile

#[repr(transparent)]
pub struct MediaFile { /* private fields */ }

MediaFile implements MediaStream for files.

This provides a simple way to play back video files with GTK.

GTK provides a GIO extension point for MediaFile implementations to allow for external implementations using various media frameworks.

GTK itself includes implementations using GStreamer and ffmpeg.

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

MediaStream

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

Implements

MediaFileExt, MediaStreamExt, glib::ObjectExt, gdk::prelude::PaintableExt, MediaStreamExtManual

Implementations

impl MediaFile

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

pub fn new() -> MediaFile

Creates a new empty media file.

Returns

a new MediaFile

pub fn for_file(file: &impl IsA<File>) -> MediaFile

Creates a new media file to play @file.

file

The file to play

Returns

a new MediaFile playing @file

pub fn for_filename(filename: impl AsRef<Path>) -> MediaFile

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().

filename

filename to open

Returns

a new MediaFile playing @filename

pub fn for_input_stream(stream: &impl IsA<InputStream>) -> MediaFile

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

pub fn for_resource(resource_path: &str) -> MediaFile

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().

resource_path

resource path to open

Returns

a new MediaFile playing @resource_path

Trait Implementations

impl Clone for MediaFile

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MediaFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MediaFile

fn default() -> Self

Returns the “default value” for a type.

impl Display for MediaFile

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for MediaFile

type ParamSpec = ParamSpecObject

type SetValue = MediaFile

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, MediaFile>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for MediaFile

fn hash<H>(&self, state: &mut H)where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: MediaFileImpl> IsSubclassable<T> for MediaFile

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for MediaFile

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for MediaFile

type Parent = MediaStream

impl<OT: ObjectType> PartialEq<OT> for MediaFile

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for MediaFile

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for MediaFile

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for MediaFile

impl IsA<MediaStream> for MediaFile

impl IsA<Paintable> for MediaFile