GI.Poppler.Objects.Movie

No description available in the introspection data.

Exported types

newtype Movie

Memory-managed wrapper type.

Constructors

Movie (ManagedPtr Movie)

Instances

Eq Movie

Defined in GI.Poppler.Objects.Movie

Methods

(==) :: Movie -> Movie -> Bool

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

GObject Movie

Defined in GI.Poppler.Objects.Movie

ManagedPtrNewtype Movie

Defined in GI.Poppler.Objects.Movie

Methods

toManagedPtr :: Movie -> ManagedPtr Movie

TypedObject Movie

Defined in GI.Poppler.Objects.Movie

Methods

glibType :: IO GType

HasParentTypes Movie

Defined in GI.Poppler.Objects.Movie

IsGValue (Maybe Movie)

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

Defined in GI.Poppler.Objects.Movie

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Movie -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Movie)

type ParentTypes Movie

Defined in GI.Poppler.Objects.Movie

type ParentTypes Movie = '[Object]

class (GObject o, IsDescendantOf Movie o) => IsMovie o

Type class for types which can be safely cast to Movie, for instance with toMovie.

Instances

(GObject o, IsDescendantOf Movie o) => IsMovie o

Defined in GI.Poppler.Objects.Movie

toMovie :: (MonadIO m, IsMovie o) => o -> m Movie

Cast to Movie, 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, isFloating, isSynchronous, needPoster, notify, notifyByPspec, ref, refSink, runDispose, showControls, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAspect, getData, getDuration, getFilename, getPlayMode, getProperty, getQdata, getRate, getRotationAngle, getStart, getVolume.

Setters

setData, setDataFull, setProperty.

getAspect

movieGetAspect

Arguments

:: (HasCallStack, MonadIO m, IsMovie a)

=> a

popplerMovie: a Movie

-> Int32

width: width of the movie's bounding box

-> Int32

height: height of the movie's bounding box

-> m ()

Returns the dimensions of the movie's bounding box (in pixels). The respective PDF movie dictionary entry is optional; if missing, -1x-1 will be returned.

Since: 0.89

getDuration

movieGetDuration

Arguments

:: (HasCallStack, MonadIO m, IsMovie a)

=> a

popplerMovie: a Movie

-> m Word64

Returns: the duration of the movie playback (in ns)

Returns the duration of the movie playback

Since: 0.80

getFilename

movieGetFilename

Arguments

:: (HasCallStack, MonadIO m, IsMovie a)

=> a

popplerMovie: a Movie

-> m Text

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

Returns the local filename identifying a self-describing movie file

Since: 0.14

getPlayMode

movieGetPlayMode

Arguments

:: (HasCallStack, MonadIO m, IsMovie a)

=> a

popplerMovie: a Movie

-> m MoviePlayMode

Returns: a MoviePlayMode.

Returns the play mode of popplerMovie.

Since: 0.54

getRate

movieGetRate

Arguments

:: (HasCallStack, MonadIO m, IsMovie a)

=> a

popplerMovie: a Movie

-> m Double

Returns: the relative speed of the movie (1 means no change)

Returns the relative speed of the movie

Since: 0.80

getRotationAngle

movieGetRotationAngle

Arguments

:: (HasCallStack, MonadIO m, IsMovie a)

=> a

popplerMovie: a Movie

-> m CUShort

Returns: the number of degrees the movie should be rotated (positive, multiples of 90: 0, 90, 180, 270)

Returns the rotation angle

Since: 0.80

getStart

movieGetStart

Arguments

:: (HasCallStack, MonadIO m, IsMovie a)

=> a

popplerMovie: a Movie

-> m Word64

Returns: the start position of the movie playback (in ns)

Returns the start position of the movie playback

Since: 0.80

getVolume

movieGetVolume

Arguments

:: (HasCallStack, MonadIO m, IsMovie a)

=> a

popplerMovie: a Movie

-> m Double

Returns: volume setting for the movie (0.0 - 1.0)

Returns the playback audio volume

Since: 0.80

isSynchronous

movieIsSynchronous

Arguments

:: (HasCallStack, MonadIO m, IsMovie a)

=> a

popplerMovie: a Movie

-> m Bool

Returns: True if yes, False otherwise

Returns whether the user must wait for the movie to be finished before the PDF viewer accepts any interactive action

Since: 0.80

needPoster

movieNeedPoster

Arguments

:: (HasCallStack, MonadIO m, IsMovie a)

=> a

popplerMovie: a Movie

-> m Bool

Returns: True if move needs a poster image, False otherwise

Returns whether a poster image representing the Movie shall be displayed. The poster image must be retrieved from the movie file.

Since: 0.14

showControls

movieShowControls

Arguments

:: (HasCallStack, MonadIO m, IsMovie a)

=> a

popplerMovie: a Movie

-> m Bool

Returns: True if controller bar should be displayed, False otherwise

Returns whether to display a movie controller bar while playing the movie

Since: 0.14