GI.Gtk.Objects.MediaFile

MediaFile is the implementation for media file usage with MediaStream.

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.

Exported types

newtype MediaFile

Memory-managed wrapper type.

Constructors

MediaFile (ManagedPtr MediaFile)

Instances

Eq MediaFile

Defined in GI.Gtk.Objects.MediaFile

Methods

(==) :: MediaFile -> MediaFile -> Bool

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

IsGValue MediaFile

Convert MediaFile to and from GValue with toGValue and fromGValue.

Defined in GI.Gtk.Objects.MediaFile

Methods

toGValue :: MediaFile -> IO GValue

fromGValue :: GValue -> IO MediaFile

ManagedPtrNewtype MediaFile

Defined in GI.Gtk.Objects.MediaFile

Methods

toManagedPtr :: MediaFile -> ManagedPtr MediaFile

TypedObject MediaFile

Defined in GI.Gtk.Objects.MediaFile

Methods

glibType :: IO GType

GObject MediaFile

Defined in GI.Gtk.Objects.MediaFile

HasParentTypes MediaFile

Defined in GI.Gtk.Objects.MediaFile

type ParentTypes MediaFile

Defined in GI.Gtk.Objects.MediaFile

type ParentTypes MediaFile = '[MediaStream, Object, Paintable]

class (GObject o, IsDescendantOf MediaFile o) => IsMediaFile o

Type class for types which can be safely cast to MediaFile, for instance with toMediaFile.

Instances

(GObject o, IsDescendantOf MediaFile o) => IsMediaFile o

Defined in GI.Gtk.Objects.MediaFile

toMediaFile :: (MonadIO m, IsMediaFile o) => o -> m MediaFile

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

Methods

Overloaded methods

clear

mediaFileClear

Arguments

:: (HasCallStack, MonadIO m, IsMediaFile a)

=> a

self: a MediaFile

-> m ()

Resets the media file to be empty.

getFile

mediaFileGetFile

Arguments

:: (HasCallStack, MonadIO m, IsMediaFile a)

=> a

self: a MediaFile

-> m (Maybe File)

Returns: The currently playing file or Nothing if not playing from a file.

Returns the file that self is currently playing from.

When self is not playing or not playing from a file, Nothing is returned.

getInputStream

mediaFileGetInputStream

Arguments

:: (HasCallStack, MonadIO m, IsMediaFile a)

=> a

self: a MediaFile

-> m (Maybe InputStream)

Returns: The currently playing stream or Nothing if not playing from a stream.

Returns the stream that self is currently playing from.

When self is not playing or not playing from a stream, Nothing is returned.

new

mediaFileNew

Arguments

:: (HasCallStack, MonadIO m)

=> m MediaFile

Returns: a new MediaFile

Creates a new empty media file.

newForFile

mediaFileNewForFile

Arguments

:: (HasCallStack, MonadIO m, IsFile a)

=> a

file: The file to play

-> m MediaFile

Returns: a new MediaFile playing file

Creates a new media file to play file.

newForFilename

mediaFileNewForFilename

Arguments

:: (HasCallStack, MonadIO m)

=> Text

filename: filename to open

-> m MediaFile

Returns: a new MediaFile playing filename

This is a utility function that converts the given filename to a File and calls mediaFileNewForFile.

newForInputStream

mediaFileNewForInputStream

Arguments

:: (HasCallStack, MonadIO m, IsInputStream a)

=> a

stream: The stream to play

-> m MediaFile

Returns: a new MediaFile

Creates a new media file to play stream. If you want the resulting media to be seekable, the stream should implement the Seekable interface.

newForResource

mediaFileNewForResource

Arguments

:: (HasCallStack, MonadIO m)

=> Text

resourcePath: resource path to open

-> m MediaFile

Returns: a new MediaFile playing resourcePath

This is a utility function that converts the given resource to a File and calls mediaFileNewForFile.

setFile

mediaFileSetFile

Arguments

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

=> a

self: a MediaFile

-> Maybe b

file: the file to play

-> m ()

If any file is still playing, stop playing it.

Then start playing the given file.

setFilename

mediaFileSetFilename

Arguments

:: (HasCallStack, MonadIO m, IsMediaFile a)

=> a

self: a MediaFile

-> Maybe Text

filename: name of file to play

-> m ()

This is a utility function that converts the given filename to a File and calls mediaFileSetFile.

setInputStream

mediaFileSetInputStream

Arguments

:: (HasCallStack, MonadIO m, IsMediaFile a, IsInputStream b)

=> a

self: a MediaFile

-> Maybe b

stream: the stream to play from

-> m ()

If anything is still playing, stop playing it. Then start playing the given stream.

Full control about the stream is assumed for the duration of playback. The stream will not bt be closed.

setResource

mediaFileSetResource

Arguments

:: (HasCallStack, MonadIO m, IsMediaFile a)

=> a

self: a MediaFile

-> Maybe Text

resourcePath: path to resource to play

-> m ()

This is a utility function that converts the given resourcePath to a File and calls mediaFileSetFile.

Properties

file

The file being played back or Nothing if not playing a file.

clearMediaFileFile :: (MonadIO m, IsMediaFile o) => o -> m ()

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

clear #file

constructMediaFileFile :: (IsMediaFile 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.

getMediaFileFile :: (MonadIO m, IsMediaFile o) => o -> m (Maybe File)

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

get mediaFile #file

setMediaFileFile :: (MonadIO m, IsMediaFile o, IsFile a) => o -> a -> m ()

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

set mediaFile [ #file := value ]

inputStream

The stream being played back or Nothing if not playing a stream, like when playing a file.

clearMediaFileInputStream :: (MonadIO m, IsMediaFile o) => o -> m ()

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

clear #inputStream

constructMediaFileInputStream :: (IsMediaFile o, MonadIO m, IsInputStream a) => a -> m (GValueConstruct o)

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

getMediaFileInputStream :: (MonadIO m, IsMediaFile o) => o -> m (Maybe InputStream)

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

get mediaFile #inputStream

setMediaFileInputStream :: (MonadIO m, IsMediaFile o, IsInputStream a) => o -> a -> m ()

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

set mediaFile [ #inputStream := value ]