| Copyright | Will Thompson and Iñaki García Etxebarria |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Poppler.Objects.Media
Description
No description available in the introspection data.
Synopsis
- newtype Media = Media (ManagedPtr Media)
- class (GObject o, IsDescendantOf Media o) => IsMedia o
- toMedia :: (MonadIO m, IsMedia o) => o -> m Media
- mediaGetAutoPlay :: (HasCallStack, MonadIO m, IsMedia a) => a -> m Bool
- mediaGetFilename :: (HasCallStack, MonadIO m, IsMedia a) => a -> m Text
- mediaGetMimeType :: (HasCallStack, MonadIO m, IsMedia a) => a -> m Text
- mediaGetRepeatCount :: (HasCallStack, MonadIO m, IsMedia a) => a -> m Float
- mediaGetShowControls :: (HasCallStack, MonadIO m, IsMedia a) => a -> m Bool
- mediaIsEmbedded :: (HasCallStack, MonadIO m, IsMedia a) => a -> m Bool
- mediaSave :: (HasCallStack, MonadIO m, IsMedia a) => a -> Text -> m ()
- mediaSaveToCallback :: (HasCallStack, MonadIO m, IsMedia a) => a -> FunPtr C_MediaSaveFunc -> m ()
- mediaSaveToFd :: (HasCallStack, MonadIO m, IsMedia a) => a -> Int32 -> m ()
Exported types
Memory-managed wrapper type.
Instances
| Eq Media Source # | |
| GObject Media Source # | |
Defined in GI.Poppler.Objects.Media | |
| ManagedPtrNewtype Media Source # | |
Defined in GI.Poppler.Objects.Media Methods toManagedPtr :: Media -> ManagedPtr Media | |
| TypedObject Media Source # | |
Defined in GI.Poppler.Objects.Media | |
| HasParentTypes Media Source # | |
Defined in GI.Poppler.Objects.Media | |
| IsGValue (Maybe Media) Source # | Convert |
Defined in GI.Poppler.Objects.Media Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe Media -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe Media) | |
| type ParentTypes Media Source # | |
Defined in GI.Poppler.Objects.Media type ParentTypes Media = '[Object] | |
class (GObject o, IsDescendantOf Media o) => IsMedia o Source #
Instances
| (GObject o, IsDescendantOf Media o) => IsMedia o Source # | |
Defined in GI.Poppler.Objects.Media | |
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isEmbedded, isFloating, notify, notifyByPspec, ref, refSink, runDispose, save, saveToCallback, saveToFd, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getAutoPlay, getData, getFilename, getMimeType, getProperty, getQdata, getRepeatCount, getShowControls.
Setters
getAutoPlay
Arguments
| :: (HasCallStack, MonadIO m, IsMedia a) | |
| => a |
|
| -> m Bool |
Returns the auto-play parameter.
Since: 20.04.0
getFilename
Arguments
| :: (HasCallStack, MonadIO m, IsMedia a) | |
| => a |
|
| -> m Text | Returns: a filename, return value is owned by |
Returns the media clip filename, in case of non-embedded media. filename might be a local relative or absolute path or a URI
Since: 0.14
getMimeType
Arguments
| :: (HasCallStack, MonadIO m, IsMedia a) | |
| => a |
|
| -> m Text | Returns: the mime-type, return value is owned by |
Returns the media clip mime-type
Since: 0.14
getRepeatCount
Arguments
| :: (HasCallStack, MonadIO m, IsMedia a) | |
| => a |
|
| -> m Float | Returns: Repeat count parameter (float) |
Returns the repeat count parameter.
Since: 20.04.0
getShowControls
Arguments
| :: (HasCallStack, MonadIO m, IsMedia a) | |
| => a |
|
| -> m Bool | Returns: |
Returns the show controls parameter.
Since: 20.04.0
isEmbedded
Arguments
| :: (HasCallStack, MonadIO m, IsMedia a) | |
| => a |
|
| -> m Bool |
Whether the media clip is embedded in the PDF. If the result is True, the embedded stream
can be saved with mediaSave or mediaSaveToCallback function.
If the result is False, the media clip filename can be retrieved with
mediaGetFilename function.
Since: 0.14
save
Arguments
| :: (HasCallStack, MonadIO m, IsMedia a) | |
| => a |
|
| -> Text |
|
| -> m () | (Can throw |
Saves embedded stream of popplerMedia to a file indicated by filename.
If error is set, False will be returned.
Possible errors include those in the G_FILE_ERROR domain
and whatever the save function generates.
Since: 0.14
saveToCallback
Arguments
| :: (HasCallStack, MonadIO m, IsMedia a) | |
| => a |
|
| -> FunPtr C_MediaSaveFunc |
|
| -> m () | (Can throw |
Saves embedded stream of popplerMedia by feeding the produced data to saveFunc. Can be used
when you want to store the media clip stream to something other than a file, such as
an in-memory buffer or a socket. If error is set, False will be
returned. Possible errors include those in the G_FILE_ERROR domain and
whatever the save function generates.
Since: 0.14
saveToFd
Arguments
| :: (HasCallStack, MonadIO m, IsMedia a) | |
| => a |
|
| -> Int32 |
|
| -> m () | (Can throw |
Saves embedded stream of popplerMedia to a file referred to by fd.
If error is set, False will be returned.
Possible errors include those in the G_FILE_ERROR domain
and whatever the save function generates.
Note that this function takes ownership of fd; you must not operate on it
again, nor close it.
Since: 21.12.0