Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
MediaStream
is the integration point for media playback inside GTK.
GTK provides an implementation of the MediaStream
interface that
is called MediaFile
.
Apart from application-facing API for stream playback, MediaStream
has a number of APIs that are only useful for implementations and should
not be used in applications:
mediaStreamPrepared
,
mediaStreamUnprepared
,
mediaStreamUpdate
,
mediaStreamEnded
,
mediaStreamSeekSuccess
,
mediaStreamSeekFailed
,
mediaStreamGerror
,
gtk_media_stream_error()
,
gtk_media_stream_error_valist()
.
Synopsis
- newtype MediaStream = MediaStream (ManagedPtr MediaStream)
- class (GObject o, IsDescendantOf MediaStream o) => IsMediaStream o
- toMediaStream :: (MonadIO m, IsMediaStream o) => o -> m MediaStream
- mediaStreamEnded :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m ()
- mediaStreamGerror :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> GError -> m ()
- mediaStreamGetDuration :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m Int64
- mediaStreamGetEnded :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m Bool
- mediaStreamGetError :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m (Maybe GError)
- mediaStreamGetLoop :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m Bool
- mediaStreamGetMuted :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m Bool
- mediaStreamGetPlaying :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m Bool
- mediaStreamGetTimestamp :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m Int64
- mediaStreamGetVolume :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m Double
- mediaStreamHasAudio :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m Bool
- mediaStreamHasVideo :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m Bool
- mediaStreamIsPrepared :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m Bool
- mediaStreamIsSeekable :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m Bool
- mediaStreamIsSeeking :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m Bool
- mediaStreamPause :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m ()
- mediaStreamPlay :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m ()
- mediaStreamPrepared :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> Bool -> Bool -> Bool -> Int64 -> m ()
- mediaStreamRealize :: (HasCallStack, MonadIO m, IsMediaStream a, IsSurface b) => a -> b -> m ()
- mediaStreamSeek :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> Int64 -> m ()
- mediaStreamSeekFailed :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m ()
- mediaStreamSeekSuccess :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m ()
- mediaStreamSetLoop :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> Bool -> m ()
- mediaStreamSetMuted :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> Bool -> m ()
- mediaStreamSetPlaying :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> Bool -> m ()
- mediaStreamSetVolume :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> Double -> m ()
- mediaStreamUnprepared :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> m ()
- mediaStreamUnrealize :: (HasCallStack, MonadIO m, IsMediaStream a, IsSurface b) => a -> b -> m ()
- mediaStreamUpdate :: (HasCallStack, MonadIO m, IsMediaStream a) => a -> Int64 -> m ()
- getMediaStreamDuration :: (MonadIO m, IsMediaStream o) => o -> m Int64
- getMediaStreamEnded :: (MonadIO m, IsMediaStream o) => o -> m Bool
- getMediaStreamError :: (MonadIO m, IsMediaStream o) => o -> m (Maybe GError)
- getMediaStreamHasAudio :: (MonadIO m, IsMediaStream o) => o -> m Bool
- getMediaStreamHasVideo :: (MonadIO m, IsMediaStream o) => o -> m Bool
- constructMediaStreamLoop :: (IsMediaStream o, MonadIO m) => Bool -> m (GValueConstruct o)
- getMediaStreamLoop :: (MonadIO m, IsMediaStream o) => o -> m Bool
- setMediaStreamLoop :: (MonadIO m, IsMediaStream o) => o -> Bool -> m ()
- constructMediaStreamMuted :: (IsMediaStream o, MonadIO m) => Bool -> m (GValueConstruct o)
- getMediaStreamMuted :: (MonadIO m, IsMediaStream o) => o -> m Bool
- setMediaStreamMuted :: (MonadIO m, IsMediaStream o) => o -> Bool -> m ()
- constructMediaStreamPlaying :: (IsMediaStream o, MonadIO m) => Bool -> m (GValueConstruct o)
- getMediaStreamPlaying :: (MonadIO m, IsMediaStream o) => o -> m Bool
- setMediaStreamPlaying :: (MonadIO m, IsMediaStream o) => o -> Bool -> m ()
- constructMediaStreamPrepared :: (IsMediaStream o, MonadIO m) => Bool -> m (GValueConstruct o)
- getMediaStreamPrepared :: (MonadIO m, IsMediaStream o) => o -> m Bool
- setMediaStreamPrepared :: (MonadIO m, IsMediaStream o) => o -> Bool -> m ()
- getMediaStreamSeekable :: (MonadIO m, IsMediaStream o) => o -> m Bool
- getMediaStreamSeeking :: (MonadIO m, IsMediaStream o) => o -> m Bool
- getMediaStreamTimestamp :: (MonadIO m, IsMediaStream o) => o -> m Int64
- constructMediaStreamVolume :: (IsMediaStream o, MonadIO m) => Double -> m (GValueConstruct o)
- getMediaStreamVolume :: (MonadIO m, IsMediaStream o) => o -> m Double
- setMediaStreamVolume :: (MonadIO m, IsMediaStream o) => o -> Double -> m ()
Exported types
newtype MediaStream Source #
Memory-managed wrapper type.
MediaStream (ManagedPtr MediaStream) |
Instances
Eq MediaStream Source # | |
Defined in GI.Gtk.Objects.MediaStream (==) :: MediaStream -> MediaStream -> Bool # (/=) :: MediaStream -> MediaStream -> Bool # | |
GObject MediaStream Source # | |
Defined in GI.Gtk.Objects.MediaStream | |
ManagedPtrNewtype MediaStream Source # | |
Defined in GI.Gtk.Objects.MediaStream toManagedPtr :: MediaStream -> ManagedPtr MediaStream | |
TypedObject MediaStream Source # | |
Defined in GI.Gtk.Objects.MediaStream | |
HasParentTypes MediaStream Source # | |
Defined in GI.Gtk.Objects.MediaStream | |
IsGValue (Maybe MediaStream) Source # | Convert |
Defined in GI.Gtk.Objects.MediaStream gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe MediaStream -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe MediaStream) | |
type ParentTypes MediaStream Source # | |
Defined in GI.Gtk.Objects.MediaStream |
class (GObject o, IsDescendantOf MediaStream o) => IsMediaStream o Source #
Type class for types which can be safely cast to MediaStream
, for instance with toMediaStream
.
Instances
(GObject o, IsDescendantOf MediaStream o) => IsMediaStream o Source # | |
Defined in GI.Gtk.Objects.MediaStream |
toMediaStream :: (MonadIO m, IsMediaStream o) => o -> m MediaStream Source #
Cast to MediaStream
, 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
bindProperty, bindPropertyFull, computeConcreteSize, ended, forceFloating, freezeNotify, gerror, getv, hasAudio, hasVideo, invalidateContents, invalidateSize, isFloating, isPrepared, isSeekable, isSeeking, notify, notifyByPspec, pause, play, prepared, realize, ref, refSink, runDispose, seek, seekFailed, seekSuccess, snapshot, stealData, stealQdata, thawNotify, unprepared, unrealize, unref, update, watchClosure.
Getters
getCurrentImage, getData, getDuration, getEnded, getError, getFlags, getIntrinsicAspectRatio, getIntrinsicHeight, getIntrinsicWidth, getLoop, getMuted, getPlaying, getProperty, getQdata, getTimestamp, getVolume.
Setters
setData, setDataFull, setLoop, setMuted, setPlaying, setProperty, setVolume.
ended
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m () |
Pauses the media stream and marks it as ended. This is a hint only, calls
to GtkMediaStream.play()
may still happen.
gerror
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> GError |
|
-> m () |
Sets self
into an error state. This will pause the stream
(you can check for an error via mediaStreamGetError
in
your GtkMediaStream.pause()
implementation), abort pending seeks
and mark the stream as prepared.
if the stream is already in an error state, this call will be ignored and the existing error will be retained. FIXME: Or do we want to set the new error?
To unset an error, the stream must be reset via a call to
mediaStreamUnprepared
.
getDuration
mediaStreamGetDuration Source #
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m Int64 | Returns: the duration of the stream or 0 if not known. |
Gets the duration of the stream. If the duration is not known, 0 will be returned.
getEnded
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the streams playback is finished.
getError
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m (Maybe GError) | Returns: |
If the stream is in an error state, returns the GError
explaining that state.
Any type of error can be reported here depending on the implementation of the
media stream.
A media stream in an error cannot be operated on, calls like
mediaStreamPlay
or mediaStreamSeek
will not have any effect.
MediaStream
itself does not provide a way to unset an error, but
implementations may provide options. For example, a MediaFile
will unset
errors when a new source is set with ie mediaFileSetFile
.
getLoop
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the stream is set to loop. See
mediaStreamSetLoop
for details.
getMuted
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the audio for the stream is muted.
See mediaStreamSetMuted
for details.
getPlaying
mediaStreamGetPlaying Source #
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m Bool | Returns: |
Return whether the stream is currently playing.
getTimestamp
mediaStreamGetTimestamp Source #
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m Int64 | Returns: the timestamp in microseconds |
Returns the current presentation timestamp in microseconds.
getVolume
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m Double | Returns: volume of the stream from 0.0 to 1.0 |
Returns the volume of the audio for the stream.
See mediaStreamSetVolume
for details.
hasAudio
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the stream has audio.
hasVideo
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the stream has video.
isPrepared
mediaStreamIsPrepared Source #
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m Bool | Returns: |
Returns whether the stream has finished initializing and existence of audio and video is known.
isSeekable
mediaStreamIsSeekable Source #
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m Bool | Returns: |
Checks if a stream may be seekable.
This is meant to be a hint. Streams may not allow seeking even if
this function returns True
. However, if this function returns
False
, streams are guaranteed to not be seekable and user interfaces
may hide controls that allow seeking.
It is allowed to call mediaStreamSeek
on a non-seekable
stream, though it will not do anything.
isSeeking
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m Bool | Returns: |
Checks if there is currently a seek operation going on.
pause
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m () |
Pauses playback of the stream. If the stream is not playing, do nothing.
play
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m () |
Starts playing the stream. If the stream is in error or already playing, do nothing.
prepared
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> Bool |
|
-> Bool |
|
-> Bool |
|
-> Int64 |
|
-> m () |
Called by MediaStream
implementations to advertise the stream
being ready to play and providing details about the stream.
Note that the arguments are hints. If the stream implementation
cannot determine the correct values, it is better to err on the
side of caution and return True
. User interfaces will use those
values to determine what controls to show.
This function may not be called again until the stream has been
reset via mediaStreamUnprepared
.
realize
:: (HasCallStack, MonadIO m, IsMediaStream a, IsSurface b) | |
=> a |
|
-> b |
|
-> m () |
Called by users to attach the media stream to a Surface
they manage.
The stream can then access the resources of surface
for its rendering
purposes. In particular, media streams might want to create
GdkGLContexts
or sync to the FrameClock
.
Whoever calls this function is responsible for calling
mediaStreamUnrealize
before either the stream or surface
get
destroyed.
Multiple calls to this function may happen from different users of the
video, even with the same surface
. Each of these calls must be followed
by its own call to mediaStreamUnrealize
.
It is not required to call this function to make a media stream work.
seek
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> Int64 |
|
-> m () |
Start a seek operation on self
to timestamp
. If timestamp
is out of range,
it will be clamped.
Seek operations may not finish instantly. While a seek operation is in process, the GtkMediaStream:seeking property will be set.
When calling mediaStreamSeek
during an ongoing seek operation,
the new seek will override any pending seek.
seekFailed
mediaStreamSeekFailed Source #
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m () |
Ends a seek operation started via GtkMediaStream.seek()
as a failure.
This will not cause an error on the stream and will assume that
playback continues as if no seek had happened.
See mediaStreamSeekSuccess
for the other way of
ending a seek.
seekSuccess
mediaStreamSeekSuccess Source #
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m () |
Ends a seek operation started via GtkMediaStream.seek()
successfully.
This function will unset the GtkMediaStream:ended property if it was
set.
See mediaStreamSeekFailed
for the other way of
ending a seek.
setLoop
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the stream should loop, ie restart playback from the beginning instead of stopping at the end.
Not all streams may support looping, in particular non-seekable streams. Those streams will ignore the loop setting and just end.
setMuted
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets whether the audio stream should be muted. Muting a stream will cause no audio to be played, but it does not modify the volume. This means that muting and then unmuting the stream will restore the volume settings.
If the stream has no audio, calling this function will still work but it will not have an audible effect.
setPlaying
mediaStreamSetPlaying Source #
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> Bool |
|
-> m () |
Starts or pauses playback of the stream.
setVolume
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> Double |
|
-> m () |
Sets the volume of the audio stream. This function call will work even if the stream is muted.
The given volume
should range from 0.0 for silence to 1.0 for as loud as
possible. Values outside of this range will be clamped to the nearest
value.
If the stream has no audio or is muted, calling this function will still work but it will not have an immediate audible effect. When the stream is unmuted, the new volume setting will take effect.
unprepared
mediaStreamUnprepared Source #
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> m () |
Resets a given media stream implementation. mediaStreamPrepared
can now be called again.
This function will also reset any error state the stream was in.
unrealize
:: (HasCallStack, MonadIO m, IsMediaStream a, IsSurface b) | |
=> a |
|
-> b |
|
-> m () |
Undoes a previous call to mediaStreamRealize
and causes
the stream to release all resources it had allocated from surface
.
update
:: (HasCallStack, MonadIO m, IsMediaStream a) | |
=> a |
|
-> Int64 |
|
-> m () |
Media stream implementations should regularly call this function to update the timestamp reported by the stream. It is up to implementations to call this at the frequency they deem appropriate.
Properties
duration
The stream's duration in microseconds or 0 if unknown.
getMediaStreamDuration :: (MonadIO m, IsMediaStream o) => o -> m Int64 Source #
Get the value of the “duration
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #duration
ended
Set when playback has finished.
getMediaStreamEnded :: (MonadIO m, IsMediaStream o) => o -> m Bool Source #
Get the value of the “ended
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #ended
error
Nothing
for a properly working stream or the GError
that the stream is in.
getMediaStreamError :: (MonadIO m, IsMediaStream o) => o -> m (Maybe GError) Source #
Get the value of the “error
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #error
hasAudio
Whether the stream contains audio
getMediaStreamHasAudio :: (MonadIO m, IsMediaStream o) => o -> m Bool Source #
Get the value of the “has-audio
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #hasAudio
hasVideo
Whether the stream contains video
getMediaStreamHasVideo :: (MonadIO m, IsMediaStream o) => o -> m Bool Source #
Get the value of the “has-video
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #hasVideo
loop
Try to restart the media from the beginning once it ended.
constructMediaStreamLoop :: (IsMediaStream o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “loop
” property. This is rarely needed directly, but it is used by new
.
getMediaStreamLoop :: (MonadIO m, IsMediaStream o) => o -> m Bool Source #
Get the value of the “loop
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #loop
setMediaStreamLoop :: (MonadIO m, IsMediaStream o) => o -> Bool -> m () Source #
Set the value of the “loop
” property.
When overloading is enabled, this is equivalent to
set
mediaStream [ #loop:=
value ]
muted
Whether the audio stream should be muted.
constructMediaStreamMuted :: (IsMediaStream o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “muted
” property. This is rarely needed directly, but it is used by new
.
getMediaStreamMuted :: (MonadIO m, IsMediaStream o) => o -> m Bool Source #
Get the value of the “muted
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #muted
setMediaStreamMuted :: (MonadIO m, IsMediaStream o) => o -> Bool -> m () Source #
Set the value of the “muted
” property.
When overloading is enabled, this is equivalent to
set
mediaStream [ #muted:=
value ]
playing
Whether the stream is currently playing.
constructMediaStreamPlaying :: (IsMediaStream o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “playing
” property. This is rarely needed directly, but it is used by new
.
getMediaStreamPlaying :: (MonadIO m, IsMediaStream o) => o -> m Bool Source #
Get the value of the “playing
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #playing
setMediaStreamPlaying :: (MonadIO m, IsMediaStream o) => o -> Bool -> m () Source #
Set the value of the “playing
” property.
When overloading is enabled, this is equivalent to
set
mediaStream [ #playing:=
value ]
prepared
Whether the stream has finished initializing and existence of audio and video is known.
constructMediaStreamPrepared :: (IsMediaStream o, MonadIO m) => Bool -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “prepared
” property. This is rarely needed directly, but it is used by new
.
getMediaStreamPrepared :: (MonadIO m, IsMediaStream o) => o -> m Bool Source #
Get the value of the “prepared
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #prepared
setMediaStreamPrepared :: (MonadIO m, IsMediaStream o) => o -> Bool -> m () Source #
Set the value of the “prepared
” property.
When overloading is enabled, this is equivalent to
set
mediaStream [ #prepared:=
value ]
seekable
Set unless the stream is known to not support seeking.
getMediaStreamSeekable :: (MonadIO m, IsMediaStream o) => o -> m Bool Source #
Get the value of the “seekable
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #seekable
seeking
Set while a seek is in progress.
getMediaStreamSeeking :: (MonadIO m, IsMediaStream o) => o -> m Bool Source #
Get the value of the “seeking
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #seeking
timestamp
The current presentation timestamp in microseconds.
getMediaStreamTimestamp :: (MonadIO m, IsMediaStream o) => o -> m Int64 Source #
Get the value of the “timestamp
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #timestamp
volume
Volume of the audio stream.
constructMediaStreamVolume :: (IsMediaStream o, MonadIO m) => Double -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “volume
” property. This is rarely needed directly, but it is used by new
.
getMediaStreamVolume :: (MonadIO m, IsMediaStream o) => o -> m Double Source #
Get the value of the “volume
” property.
When overloading is enabled, this is equivalent to
get
mediaStream #volume
setMediaStreamVolume :: (MonadIO m, IsMediaStream o) => o -> Double -> m () Source #
Set the value of the “volume
” property.
When overloading is enabled, this is equivalent to
set
mediaStream [ #volume:=
value ]