Class: Poppler::Movie

Inherits:

Object

• Object
• Poppler::Movie

Defined in:

(unknown)

Instance Method Summary

• #duration ⇒ Integer

  Returns the duration of the movie playback.

• #filename ⇒ String

  Returns the local filename identifying a self-describing movie file.

• #get_aspect(width, height) ⇒ nil

  Returns the dimensions of the movie's bounding box (in pixels).

• #is_synchronous ⇒ Boolean

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

• #need_poster ⇒ Boolean

  Returns whether a poster image representing the Movie shall be displayed.

• #play_mode ⇒ Poppler::MoviePlayMode

  Returns the play mode of poppler_movie.

• #rate ⇒ Float

  Returns the relative speed of the movie.

• #rotation_angle ⇒ Poppler::gushort

  Returns the rotation angle multiples of 90: 0, 90, 180, 270).

• #show_controls ⇒ Boolean

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

• #start ⇒ Integer

  Returns the start position of the movie playback.

• #volume ⇒ Float

  Returns the playback audio volume.

Instance Method Details

#duration ⇒ Integer

Returns the duration of the movie playback

Returns:

• (Integer) —

  the duration of the movie playback (in ns)

#filename ⇒ String

Returns the local filename identifying a self-describing movie file

Returns:

• (String) —

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

#get_aspect(width, height) ⇒ nil

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.

Parameters:

• width (Integer) —

  width of the movie's bounding box

• height (Integer) —

  height of the movie's bounding box

Returns:

• (nil)

#is_synchronous ⇒ Boolean

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

Returns:

• (Boolean) —

  true if yes, false otherwise

#need_poster ⇒ Boolean

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

Returns:

• (Boolean) —

  true if move needs a poster image, false otherwise

#play_mode ⇒ Poppler::MoviePlayMode

Returns the play mode of poppler_movie.

Returns:

• (Poppler::MoviePlayMode) —

  a Poppler::MoviePlayMode.

#rate ⇒ Float

Returns the relative speed of the movie

Returns:

• (Float) —

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

#rotation_angle ⇒ Poppler::gushort

Returns the rotation angle multiples of 90: 0, 90, 180, 270)

Returns:

• (Poppler::gushort) —

  the number of degrees the movie should be rotated (positive,

#show_controls ⇒ Boolean

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

Returns:

• (Boolean) —

  true if controller bar should be displayed, false otherwise

#start ⇒ Integer

Returns the start position of the movie playback

Returns:

• (Integer) —

  the start position of the movie playback (in ns)

#volume ⇒ Float

Returns the playback audio volume

Returns:

• (Float) —

  volume setting for the movie (0.0 - 1.0)