Struct gtk4::Video

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

Video is a widget to show a MediaStream with media controls.

The controls are available separately as MediaControls. If you just want to display a video without controls, you can treat it like any other paintable and for example put it into a Picture.

Video aims to cover use cases such as previews, embedded animations, etc. It supports autoplay, looping, and simple media controls. It does not have support for video overlays, multichannel audio, device selection, or input. If you are writing a full-fledged video player, you may want to use the gdk::Paintable API and a media framework such as Gstreamer directly.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Implementations

impl Video

pub fn new() -> Video

Creates a new empty Video.

Returns

a new Video

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

Creates a Video to play back the given @file.

file

a GFile

Returns

a new Video

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

Creates a Video to play back the given @filename.

This is a utility function that calls for_file(), See that function for details.

filename

filename to play back

Returns

a new Video

pub fn for_media_stream(stream: Option<&impl IsA<MediaStream>>) -> Video

Creates a Video to play back the given @stream.

stream

a MediaStream

Returns

a new Video

pub fn for_resource(resource_path: Option<&str>) -> Video

Creates a Video to play back the resource at the given @resource_path.

This is a utility function that calls for_file().

resource_path

resource path to play back

Returns

a new Video

pub fn builder() -> VideoBuilder

Creates a new builder-pattern struct instance to construct Video objects.

This method returns an instance of VideoBuilder which can be used to create Video objects.

pub fn is_autoplay(&self) -> bool

Returns true if videos have been set to loop.

Returns

true if streams should autoplay

pub fn file(&self) -> Option<File>

Gets the file played by @self or None if not playing back a file.

Returns

The file played by @self

pub fn is_loop(&self) -> bool

Returns true if videos have been set to loop.

Returns

true if streams should loop

pub fn media_stream(&self) -> Option<MediaStream>

Gets the media stream managed by @self or None if none.

Returns

The media stream managed by @self

pub fn set_autoplay(&self, autoplay: bool)

Sets whether @self automatically starts playback when it becomes visible or when a new file gets loaded.

autoplay

whether media streams should autoplay

pub fn set_file(&self, file: Option<&impl IsA<File>>)

Makes @self play the given @file.

file

the file to play

pub fn set_filename(&self, filename: Option<impl AsRef<Path>>)

Makes @self play the given @filename.

This is a utility function that calls gtk_video_set_file(),

filename

the filename to play

pub fn set_loop(&self, loop_: bool)

Sets whether new files loaded by @self should be set to loop.

loop_

whether media streams should loop

pub fn set_media_stream(&self, stream: Option<&impl IsA<MediaStream>>)

Sets the media stream to be played back.

@self will take full control of managing the media stream. If you want to manage a media stream yourself, consider using a Picture for display.

If you want to display a file, consider using set_file() instead.

stream

The media stream to play or None to unset

pub fn set_resource(&self, resource_path: Option<&str>)

Makes @self play the resource at the given @resource_path.

This is a utility function that calls set_file().

resource_path

the resource to set

pub fn connect_autoplay_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_file_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_loop_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_media_stream_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for Video

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 Video

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

Formats the value using the given formatter.

impl Default for Video

fn default() -> Self

Returns the “default value” for a type.

impl Display for Video

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

Formats the value using the given formatter.

impl Hash for Video

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 Ord for Video

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 Video

type Parent = Widget

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

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 Video

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 Video

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Video

impl IsA<Accessible> for Video

impl IsA<Buildable> for Video

impl IsA<ConstraintTarget> for Video

impl IsA<Widget> for Video