gtk4/org.gtkkn.bindings.gtk/MediaFile

MediaFile

open class MediaFile(pointer: <Error class: unknown class><<Error class: unknown class>>) : MediaStream

GtkMediaFile implements GtkMediaStream for files.

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

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

GTK itself includes implementations using GStreamer and ffmpeg.

Constructors

MediaFile

constructor()

Creates a new empty media file.

constructor(file: <Error class: unknown class>)

Creates a new media file to play @file.

constructor(filename: String)

Creates a new media file for the given filename.

constructor(stream: <Error class: unknown class>)

Creates a new media file to play @stream.

constructor(pointer: <Error class: unknown class><<Error class: unknown class>>)

Types

Companion

object Companion

Properties

duration

open val duration: Long

The stream's duration in microseconds or 0 if unknown.

error

open val error: <Error class: unknown class>?

null for a properly working stream or the GError that the stream is in.

file

open var file: <Error class: unknown class>?

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

gdkPaintablePointer

open override val gdkPaintablePointer: <Error class: unknown class><<Error class: unknown class>>

gtkMediaFilePointer

val gtkMediaFilePointer: <Error class: unknown class><<Error class: unknown class>>

gtkMediaStreamPointer

val gtkMediaStreamPointer: <Error class: unknown class><<Error class: unknown class>>

inputStream

open var inputStream: <Error class: unknown class>?

The stream being played back or null if not playing a stream.

loop

open var loop: Boolean

Try to restart the media from the beginning once it ended.

muted

open var muted: Boolean

Whether the audio stream should be muted.

playing

open var playing: Boolean

Whether the stream is currently playing.

timestamp

open val timestamp: Long

The current presentation timestamp in microseconds.

volume

open var volume: Double

Volume of the audio stream.

Functions

clear

open fun clear()

Resets the media file to be empty.

gerror

open fun gerror(error: <Error class: unknown class>)

Sets @self into an error state.

getDuration

open fun getDuration(): Long

Gets the duration of the stream.

getEnded

open fun getEnded(): Boolean

Returns whether the streams playback is finished.

getError

open fun getError(): <Error class: unknown class>?

If the stream is in an error state, returns the GError explaining that state.

getFile

open fun getFile(): <Error class: unknown class>?

Returns the file that @self is currently playing from.

getInputStream

open fun getInputStream(): <Error class: unknown class>?

Returns the stream that @self is currently playing from.

getLoop

open fun getLoop(): Boolean

Returns whether the stream is set to loop.

getMuted

open fun getMuted(): Boolean

Returns whether the audio for the stream is muted.

getPlaying

open fun getPlaying(): Boolean

Return whether the stream is currently playing.

getTimestamp

open fun getTimestamp(): Long

Returns the current presentation timestamp in microseconds.

getVolume

open fun getVolume(): Double

Returns the volume of the audio for the stream.

hasAudio

open fun hasAudio(): Boolean

Returns whether the stream has audio.

hasVideo

open fun hasVideo(): Boolean

Returns whether the stream has video.

isPrepared

open fun isPrepared(): Boolean

Returns whether the stream has finished initializing.

isSeekable

open fun isSeekable(): Boolean

Checks if a stream may be seekable.

isSeeking

open fun isSeeking(): Boolean

Checks if there is currently a seek operation going on.

pause

open fun pause()

Pauses playback of the stream.

play

open fun play()

Starts playing the stream.

realize

open fun realize(surface: <Error class: unknown class>)

Called by users to attach the media stream to a GdkSurface they manage.

seek

open fun seek(timestamp: Long)

Start a seek operation on @self to @timestamp.

seekFailed

open fun seekFailed()

Ends a seek operation started via GtkMediaStream.seek() as a failure.

seekSuccess

open fun seekSuccess()

Ends a seek operation started via GtkMediaStream.seek() successfully.

setFile

open fun setFile(file: <Error class: unknown class>? = null)

Sets the GtkMediaFile to play the given file.

setFilename

open fun setFilename(filename: String? = null)

Sets the `GtkMediaFile to play the given file.

setInputStream

open fun setInputStream(stream: <Error class: unknown class>? = null)

Sets the GtkMediaFile to play the given stream.

setLoop

open fun setLoop(loop: Boolean)

Sets whether the stream should loop.

setMuted

open fun setMuted(muted: Boolean)

Sets whether the audio stream should be muted.

setPlaying

open fun setPlaying(playing: Boolean)

Starts or pauses playback of the stream.

setResource

open fun setResource(resourcePath: String? = null)

Sets the `GtkMediaFile to play the given resource.

setVolume

open fun setVolume(volume: Double)

Sets the volume of the audio stream.

streamEnded

open fun streamEnded()

Pauses the media stream and marks it as ended.

streamPrepared

open fun streamPrepared(hasAudio: Boolean, hasVideo: Boolean, seekable: Boolean, duration: Long)

Called by GtkMediaStream implementations to advertise the stream being ready to play and providing details about the stream.

streamUnprepared

open fun streamUnprepared()

Resets a given media stream implementation.

unrealize

open fun unrealize(surface: <Error class: unknown class>)

Undoes a previous call to gtk_media_stream_realize().

update

open fun update(timestamp: Long)

Media stream implementations should regularly call this function to update the timestamp reported by the stream.