GI.Poppler.Objects.Media

No description available in the introspection data.

Exported types

newtype Media

Memory-managed wrapper type.

Constructors

Media (ManagedPtr Media)

Instances

Eq Media

Defined in GI.Poppler.Objects.Media

Methods

(==) :: Media -> Media -> Bool

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

GObject Media

Defined in GI.Poppler.Objects.Media

ManagedPtrNewtype Media

Defined in GI.Poppler.Objects.Media

Methods

toManagedPtr :: Media -> ManagedPtr Media

TypedObject Media

Defined in GI.Poppler.Objects.Media

Methods

glibType :: IO GType

HasParentTypes Media

Defined in GI.Poppler.Objects.Media

IsGValue (Maybe Media)

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

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

Defined in GI.Poppler.Objects.Media

type ParentTypes Media = '[Object]

class (GObject o, IsDescendantOf Media o) => IsMedia o

Type class for types which can be safely cast to Media, for instance with toMedia.

Instances

(GObject o, IsDescendantOf Media o) => IsMedia o

Defined in GI.Poppler.Objects.Media

toMedia :: (MonadIO m, IsMedia o) => o -> m Media

Cast to Media, 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, 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

setData, setDataFull, setProperty.

getAutoPlay

mediaGetAutoPlay

Arguments

:: (HasCallStack, MonadIO m, IsMedia a)

=> a

popplerMedia: a Media

-> m Bool

Returns: True if media should auto-play, False otherwise

Returns the auto-play parameter.

Since: 20.04.0

getFilename

mediaGetFilename

Arguments

:: (HasCallStack, MonadIO m, IsMedia a)

=> a

popplerMedia: a Media

-> m Text

Returns: a filename, return value is owned by Media and should not be freed

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

mediaGetMimeType

Arguments

:: (HasCallStack, MonadIO m, IsMedia a)

=> a

popplerMedia: a Media

-> m Text

Returns: the mime-type, return value is owned by Media and should not be freed

Returns the media clip mime-type

Since: 0.14

getRepeatCount

mediaGetRepeatCount

Arguments

:: (HasCallStack, MonadIO m, IsMedia a)

=> a

popplerMedia: a Media

-> m Float

Returns: Repeat count parameter (float)

Returns the repeat count parameter.

Since: 20.04.0

getShowControls

mediaGetShowControls

Arguments

:: (HasCallStack, MonadIO m, IsMedia a)

=> a

popplerMedia: a Media

-> m Bool

Returns: True if media should show controls, False otherwise

Returns the show controls parameter.

Since: 20.04.0

isEmbedded

mediaIsEmbedded

Arguments

:: (HasCallStack, MonadIO m, IsMedia a)

=> a

popplerMedia: a Media

-> m Bool

Returns: True if media clip is embedded, False otherwise

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

mediaSave

Arguments

:: (HasCallStack, MonadIO m, IsMedia a)

=> a

popplerMedia: a Media

-> Text

filename: name of file to save

-> m ()

(Can throw GError)

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

mediaSaveToCallback

Arguments

:: (HasCallStack, MonadIO m, IsMedia a)

=> a

popplerMedia: a Media

-> FunPtr C_MediaSaveFunc

saveFunc: a function that is called to save each block of data that the save routine generates.

-> m ()

(Can throw GError)

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

mediaSaveToFd

Arguments

:: (HasCallStack, MonadIO m, IsMedia a)

=> a

popplerMedia: a Media

-> Int32

fd: a valid file descriptor open for writing

-> m ()

(Can throw GError)

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