Struct Video

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.

Properties

autoplay

If the video should automatically begin playing.

Readable | Writeable

file

The file played by this video if the video is playing a file.

Readable | Writeable

graphics-offload

Whether to enable graphics offload.

Readable | Writeable

loop

If new media files should be set to loop.

Readable | Writeable

media-stream

The media-stream played

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Implements

WidgetExt, [trait@glib::ObjectExt], AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

GLib type: GObject with reference counted clone semantics.

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 graphics_offload(&self) -> GraphicsOffloadEnabled

Available on crate feature v4_14 only.

Returns whether graphics offload is enabled.

See GraphicsOffload for more information on graphics offload.

Returns

the graphics offload status

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_graphics_offload(&self, enabled: GraphicsOffloadEnabled)

Available on crate feature v4_14 only.

Sets whether to enable graphics offload.

See GraphicsOffload for more information on graphics offload.

enabled

the new graphics offload status

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_graphics_offload_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v4_14 only.

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

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

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

type ParamSpec = ParamSpecObject

type SetValue = Video

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Video

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

where H: Hasher,

Hashes the memory address of this object.

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

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

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>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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