GI.Poppler.Objects.Media

Exported types

newtype Media

Constructors

Media (ManagedPtr Media)

Instances

GObject Media

Methods

gobjectType :: Media -> IO GType

IsObject Media

IsMedia Media

((~) * info (ResolveMediaMethod t Media), MethodInfo * info Media p) => IsLabel t (Media -> p)

Methods

fromLabel :: Proxy# Symbol t -> Media -> p

((~) * info (ResolveMediaMethod t Media), MethodInfo * info Media p) => IsLabelProxy t (Media -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Media -> p

HasAttributeList * Media

type AttributeList Media

type AttributeList Media

type SignalList Media

type SignalList Media

class GObject o => IsMedia o

Instances

(GObject a, UnknownAncestorError Constraint Media a) => IsMedia a

IsMedia Media

toMedia :: IsMedia o => o -> IO Media

noMedia :: Maybe Media

Methods

getFilename

data MediaGetFilenameMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsMedia a) => MethodInfo * MediaGetFilenameMethodInfo a signature

Methods

overloadedMethod :: MethodProxy MediaGetFilenameMethodInfo a -> signature -> s

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

data MediaGetMimeTypeMethodInfo

Instances

((~) * signature (m Text), MonadIO m, IsMedia a) => MethodInfo * MediaGetMimeTypeMethodInfo a signature

Methods

overloadedMethod :: MethodProxy MediaGetMimeTypeMethodInfo a -> signature -> s

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

isEmbedded

data MediaIsEmbeddedMethodInfo

Instances

((~) * signature (m Bool), MonadIO m, IsMedia a) => MethodInfo * MediaIsEmbeddedMethodInfo a signature

Methods

overloadedMethod :: MethodProxy MediaIsEmbeddedMethodInfo a -> signature -> s

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

data MediaSaveMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m, IsMedia a) => MethodInfo * MediaSaveMethodInfo a signature

Methods

overloadedMethod :: MethodProxy MediaSaveMethodInfo a -> signature -> s

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

data MediaSaveToCallbackMethodInfo

Instances

((~) * signature (FunPtr C_MediaSaveFunc -> m ()), MonadIO m, IsMedia a) => MethodInfo * MediaSaveToCallbackMethodInfo a signature

Methods

overloadedMethod :: MethodProxy MediaSaveToCallbackMethodInfo a -> signature -> s

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