Poppler.Movie¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`get_aspect` (width, height)
	`get_duration` ()
	`get_filename` ()
	`get_play_mode` ()
	`get_rate` ()
	`get_rotation_angle` ()
	`get_start` ()
	`get_volume` ()
	`is_synchronous` ()
	`need_poster` ()
	`show_controls` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

None

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Poppler.Movie(**kwargs)¶

Bases:: GObject.Object
Abstract:: No

get_aspect(width, height)¶

Parameters:

width (int) – width of the movie’s bounding box
height (int) – height of the movie’s bounding box

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.

New in version 0.89.

get_duration()¶

Returns:: the duration of the movie playback (in ns)
Return type:: int

Returns the duration of the movie playback

New in version 0.80.

get_filename()¶

Returns:: a local filename, return value is owned by Poppler.Movie and should not be freed
Return type:: str

Returns the local filename identifying a self-describing movie file

New in version 0.14.

get_play_mode()¶

Returns:: a Poppler.MoviePlayMode.
Return type:: Poppler.MoviePlayMode

Returns the play mode of self.

New in version 0.54.

get_rate()¶

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

Returns the relative speed of the movie

New in version 0.80.

get_rotation_angle()¶

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

Returns the rotation angle

New in version 0.80.

get_start()¶

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

Returns the start position of the movie playback

New in version 0.80.

get_volume()¶

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

Returns the playback audio volume

New in version 0.80.

is_synchronous()¶

Returns:: True if yes, False otherwise
Return type:: bool

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

New in version 0.80.

need_poster()¶

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

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

New in version 0.14.

show_controls()¶

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

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

New in version 0.14.