gi-poppler-0.18.24: Poppler bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Poppler.Objects.Movie

Description

No description available in the introspection data.

Synopsis

Exported types

newtype Movie Source #

Memory-managed wrapper type.

Constructors

Movie (ManagedPtr Movie) 

Instances

Instances details
Eq Movie Source # 
Instance details

Defined in GI.Poppler.Objects.Movie

Methods

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

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

GObject Movie Source # 
Instance details

Defined in GI.Poppler.Objects.Movie

ManagedPtrNewtype Movie Source # 
Instance details

Defined in GI.Poppler.Objects.Movie

Methods

toManagedPtr :: Movie -> ManagedPtr Movie

TypedObject Movie Source # 
Instance details

Defined in GI.Poppler.Objects.Movie

Methods

glibType :: IO GType

IsGValue Movie Source #

Convert Movie to and from GValue with toGValue and fromGValue.

Instance details

Defined in GI.Poppler.Objects.Movie

Methods

toGValue :: Movie -> IO GValue

fromGValue :: GValue -> IO Movie

HasParentTypes Movie Source # 
Instance details

Defined in GI.Poppler.Objects.Movie

type ParentTypes Movie Source # 
Instance details

Defined in GI.Poppler.Objects.Movie

type ParentTypes Movie = '[Object]

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

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

Instances

Instances details
(GObject o, IsDescendantOf Movie o) => IsMovie o Source # 
Instance details

Defined in GI.Poppler.Objects.Movie

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

Cast to Movie, for types for which this is known to be safe. For general casts, use castTo.

Methods

Overloaded methods

getDuration

movieGetDuration Source #

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 Source #

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 Source #

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 Source #

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 Source #

Arguments

:: (HasCallStack, MonadIO m, IsMovie a) 
=> a

popplerMovie: a Movie

-> m Word16

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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