GI.Gtk.Objects.Video

GtkVideo is a widget to show a MediaStream with media controls as provided by 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.

GtkVideo 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 Paintable API and a media framework such as Gstreamer directly.

Exported types

newtype Video

Memory-managed wrapper type.

Constructors

Video (ManagedPtr Video)

Instances

Eq Video

Defined in GI.Gtk.Objects.Video

Methods

(==) :: Video -> Video -> Bool

(/=) :: Video -> Video -> Bool

GObject Video

Defined in GI.Gtk.Objects.Video

ManagedPtrNewtype Video

Defined in GI.Gtk.Objects.Video

Methods

toManagedPtr :: Video -> ManagedPtr Video

TypedObject Video

Defined in GI.Gtk.Objects.Video

Methods

glibType :: IO GType

HasParentTypes Video

Defined in GI.Gtk.Objects.Video

IsGValue (Maybe Video)

Convert Video to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.Video

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Video -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Video)

type ParentTypes Video

Defined in GI.Gtk.Objects.Video

type ParentTypes Video = '[Widget, Object, Accessible, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf Video o) => IsVideo o

Type class for types which can be safely cast to Video, for instance with toVideo.

Instances

(GObject o, IsDescendantOf Video o) => IsVideo o

Defined in GI.Gtk.Objects.Video

toVideo :: (MonadIO m, IsVideo o) => o -> m Video

Cast to Video, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getAutoplay, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFile, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getLoop, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getMediaStream, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setAutoplay, setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFile, setFilename, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setLoop, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setMediaStream, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setResource, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

getAutoplay

videoGetAutoplay

Arguments

:: (HasCallStack, MonadIO m, IsVideo a)

=> a

self: a Video

-> m Bool

Returns: True if streams should autoplay

Returns True if videos have been set to loop via videoSetLoop.

getFile

videoGetFile

Arguments

:: (HasCallStack, MonadIO m, IsVideo a)

=> a

self: a Video

-> m (Maybe File)

Returns: The file played by self

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

getLoop

videoGetLoop

Arguments

:: (HasCallStack, MonadIO m, IsVideo a)

=> a

self: a Video

-> m Bool

Returns: True if streams should loop

Returns True if videos have been set to loop via videoSetLoop.

getMediaStream

videoGetMediaStream

Arguments

:: (HasCallStack, MonadIO m, IsVideo a)

=> a

self: a Video

-> m (Maybe MediaStream)

Returns: The media stream managed by self

Gets the media stream managed by self or Nothing if none.

new

videoNew

Arguments

:: (HasCallStack, MonadIO m)

=> m Video

Returns: a new Video

Creates a new empty Video.

newForFile

videoNewForFile

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> Maybe a

file: a File

-> m Video

Returns: a new Video

Creates a Video to play back the given file.

newForFilename

videoNewForFilename

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe [Char]

filename: filename to play back

-> m Video

Returns: a new Video

Creates a Video to play back the given filename.

This is a utility function that calls videoNewForFile, See that function for details.

newForMediaStream

videoNewForMediaStream

Arguments

:: (HasCallStack, MonadIO m, IsMediaStream a)

=> Maybe a

stream: a MediaStream

-> m Video

Returns: a new Video

Creates a Video to play back the given stream.

newForResource

videoNewForResource

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

resourcePath: resource path to play back

-> m Video

Returns: a new Video

Creates a Video to play back the resource at the given resourcePath.

This is a utility function that calls videoNewForFile,

setAutoplay

videoSetAutoplay

Arguments

:: (HasCallStack, MonadIO m, IsVideo a)

=> a

self: a Video

-> Bool

autoplay: whether media streams should autoplay

-> m ()

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

setFile

videoSetFile

Arguments

:: (HasCallStack, MonadIO m, IsVideo a, IsFile b)

=> a

self: a Video

-> Maybe b

file: the file to play

-> m ()

Makes self play the given file.

setFilename

videoSetFilename

Arguments

:: (HasCallStack, MonadIO m, IsVideo a)

=> a

self: a Video

-> Maybe Text

filename: the filename to play

-> m ()

Makes self play the given filename.

This is a utility function that calls videoSetFile,

setLoop

videoSetLoop

Arguments

:: (HasCallStack, MonadIO m, IsVideo a)

=> a

self: a Video

-> Bool

loop: whether media streams should loop

-> m ()

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

setMediaStream

videoSetMediaStream

Arguments

:: (HasCallStack, MonadIO m, IsVideo a, IsMediaStream b)

=> a

self: a Video

-> Maybe b

stream: The media stream to play or Nothing to unset

-> m ()

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 Image for display.

If you want to display a file, consider using videoSetFile instead.

setResource

videoSetResource

Arguments

:: (HasCallStack, MonadIO m, IsVideo a)

=> a

self: a Video

-> Maybe Text

resourcePath: the resource to set

-> m ()

Makes self play the resource at the given resourcePath.

This is a utility function that calls videoSetFile,

Properties

autoplay

If the video should automatically begin playing.

constructVideoAutoplay :: (IsVideo o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “autoplay” property. This is rarely needed directly, but it is used by new.

getVideoAutoplay :: (MonadIO m, IsVideo o) => o -> m Bool

Get the value of the “autoplay” property. When overloading is enabled, this is equivalent to

get video #autoplay

setVideoAutoplay :: (MonadIO m, IsVideo o) => o -> Bool -> m ()

Set the value of the “autoplay” property. When overloading is enabled, this is equivalent to

set video [ #autoplay := value ]

file

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

clearVideoFile :: (MonadIO m, IsVideo o) => o -> m ()

Set the value of the “file” property to Nothing. When overloading is enabled, this is equivalent to

clear #file

constructVideoFile :: (IsVideo o, MonadIO m, IsFile a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “file” property. This is rarely needed directly, but it is used by new.

getVideoFile :: (MonadIO m, IsVideo o) => o -> m (Maybe File)

Get the value of the “file” property. When overloading is enabled, this is equivalent to

get video #file

setVideoFile :: (MonadIO m, IsVideo o, IsFile a) => o -> a -> m ()

Set the value of the “file” property. When overloading is enabled, this is equivalent to

set video [ #file := value ]

loop

If new media files should be set to loop.

constructVideoLoop :: (IsVideo o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “loop” property. This is rarely needed directly, but it is used by new.

getVideoLoop :: (MonadIO m, IsVideo o) => o -> m Bool

Get the value of the “loop” property. When overloading is enabled, this is equivalent to

get video #loop

setVideoLoop :: (MonadIO m, IsVideo o) => o -> Bool -> m ()

Set the value of the “loop” property. When overloading is enabled, this is equivalent to

set video [ #loop := value ]

mediaStream

The media-stream played

clearVideoMediaStream :: (MonadIO m, IsVideo o) => o -> m ()

Set the value of the “media-stream” property to Nothing. When overloading is enabled, this is equivalent to

clear #mediaStream

constructVideoMediaStream :: (IsVideo o, MonadIO m, IsMediaStream a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “media-stream” property. This is rarely needed directly, but it is used by new.

getVideoMediaStream :: (MonadIO m, IsVideo o) => o -> m (Maybe MediaStream)

Get the value of the “media-stream” property. When overloading is enabled, this is equivalent to

get video #mediaStream

setVideoMediaStream :: (MonadIO m, IsVideo o, IsMediaStream a) => o -> a -> m ()

Set the value of the “media-stream” property. When overloading is enabled, this is equivalent to

set video [ #mediaStream := value ]