gi-poppler-0.18.20: Poppler bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (inaki@blueleaf.cc)
Safe HaskellNone
LanguageHaskell2010

GI.Poppler.Objects.Movie

Contents

Description

No description available in the introspection data.

Synopsis

Exported types

newtype Movie Source #

Memory-managed wrapper type.

Constructors

Movie (ManagedPtr Movie) 
Instances
GObject Movie Source # 
Instance details

Defined in GI.Poppler.Objects.Movie

Methods

gobjectType :: IO GType #

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 ': ([] :: [Type])

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
(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.

noMovie :: Maybe Movie Source #

A convenience alias for Nothing :: Maybe Movie.

Methods

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

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