Module: ClutterGst::Player

Defined in:

(unknown)

Overview

Clutter::GstPlayer is an opaque structure whose members cannot be directly accessed

Instance Method Summary

• #audio_volume ⇒ Float

  Retrieves the playback volume of self.

• #audio_volume=(volume) ⇒ nil

  Sets the playback volume of self to volume.

• #eos(self) ⇒ nil
• #error(self, error) ⇒ nil
• #frame ⇒ ClutterGst::Frame

  Retrieves the Clutter::GstFrame of the last frame produced by self.

• #get_audio_volume(self) ⇒ Float

  The playback volume between 0.0 and 1.0.

• #get_frame(self) ⇒ ClutterGst::Frame

  The Clutter::GstFrame of the last frame.

• #get_idle(self) ⇒ Boolean

  TRUE if the pipline is in idle mode, FALSE otherwise.

• #get_pipeline(self) ⇒ Gst::Element

  The Gst::Pipeline element used by the player.

• #get_playing(self) ⇒ Boolean

  True if playing, false if stopped.

• #get_video_sink(self) ⇒ ClutterGst::VideoSink

  The Clutter::GstVideoSink element used by the player.

• #idle ⇒ Boolean

  Get the idle state of the pipeline.

• #new_frame(self, frame) ⇒ nil
• #pipeline ⇒ Gst::Element

  Retrieves the Gst::Pipeline used by the self, for direct use with GStreamer API.

• #playing ⇒ Boolean

  Retrieves the playing status of self.

• #playing=(playing) ⇒ nil

  Starts or stops playing of self.

• #ready(self) ⇒ nil
• #set_audio_volume(self, volume) ⇒ nil
• #set_playing(self, playing) ⇒ nil
• #size_change(self, width, height) ⇒ nil
• #video_sink ⇒ ClutterGst::VideoSink

  Retrieves the Clutter::GstVideoSink used by the self.

Instance Method Details

#audio_volume ⇒ Float

Retrieves the playback volume of self.

Returns:

• (Float) —

  The playback volume between 0.0 and 1.0

#audio_volume=(volume) ⇒ nil

Sets the playback volume of self to volume.

Parameters:

• volume (Float) —

  the volume as a double between 0.0 and 1.0

Returns:

• (nil)

#eos(self) ⇒ nil

Parameters:

• self (ClutterGst::Player)

Returns:

• (nil)

#error(self, error) ⇒ nil

Parameters:

• self (ClutterGst::Player)
• error (GLib::Error)

Returns:

• (nil)

#frame ⇒ ClutterGst::Frame

Retrieves the Clutter::GstFrame of the last frame produced by self.

Returns:

• (ClutterGst::Frame) —

  the Clutter::GstFrame of the last frame.

#get_audio_volume(self) ⇒ Float

Returns The playback volume between 0.0 and 1.0.

Parameters:

• self (ClutterGst::Player) —

  a Clutter::GstPlayer

Returns:

• (Float) —

  The playback volume between 0.0 and 1.0

#get_frame(self) ⇒ ClutterGst::Frame

Returns the Clutter::GstFrame of the last frame.

Parameters:

• self (ClutterGst::Player) —

  a Clutter::GstPlayer

Returns:

• (ClutterGst::Frame) —

  the Clutter::GstFrame of the last frame.

#get_idle(self) ⇒ Boolean

Returns TRUE if the pipline is in idle mode, FALSE otherwise.

Parameters:

• self (ClutterGst::Player) —

  a Clutter::GstPlayer

Returns:

• (Boolean) —

  TRUE if the pipline is in idle mode, FALSE otherwise.

#get_pipeline(self) ⇒ Gst::Element

Returns the Gst::Pipeline element used by the player.

Parameters:

• self (ClutterGst::Player) —

  a Clutter::GstPlayer

Returns:

• (Gst::Element) —

  the Gst::Pipeline element used by the player

#get_playing(self) ⇒ Boolean

Returns true if playing, false if stopped.

Parameters:

• self (ClutterGst::Player) —

  A Clutter::GstPlayer object

Returns:

• (Boolean) —

  true if playing, false if stopped.

#get_video_sink(self) ⇒ ClutterGst::VideoSink

Returns the Clutter::GstVideoSink element used by the player.

Parameters:

• self (ClutterGst::Player) —

  a Clutter::GstPlayer

Returns:

• (ClutterGst::VideoSink) —

  the Clutter::GstVideoSink element used by the player

#idle ⇒ Boolean

Get the idle state of the pipeline.

Returns:

• (Boolean) —

  TRUE if the pipline is in idle mode, FALSE otherwise.

#new_frame(self, frame) ⇒ nil

Parameters:

• self (ClutterGst::Player)
• frame (ClutterGst::Frame)

Returns:

• (nil)

#pipeline ⇒ Gst::Element

Retrieves the Gst::Pipeline used by the self, for direct use with GStreamer API.

Returns:

• (Gst::Element) —

  the Gst::Pipeline element used by the player

#playing ⇒ Boolean

Retrieves the playing status of self.

Returns:

• (Boolean) —

  true if playing, false if stopped.

#playing=(playing) ⇒ nil

Starts or stops playing of self.

The implementation might be asynchronous, so the way to know whether the actual playing state of the self is to use the #GObject::notify signal on the Clutter::GstPlayer:playing property and then retrieve the current state with clutter_gst_player_get_playing(). ClutterGstVideoActor in clutter-gst is an example of such an asynchronous implementation.

Parameters:

• playing (Boolean) —

  true to start playing

Returns:

• (nil)

#ready(self) ⇒ nil

Parameters:

• self (ClutterGst::Player)

Returns:

• (nil)

#set_audio_volume(self, volume) ⇒ nil

Parameters:

• self (ClutterGst::Player) —

  a Clutter::GstPlayer

• volume (Float) —

  the volume as a double between 0.0 and 1.0

Returns:

• (nil)

#set_playing(self, playing) ⇒ nil

Parameters:

• self (ClutterGst::Player) —

  a Clutter::GstPlayer

• playing (Boolean) —

  true to start playing

Returns:

• (nil)

#size_change(self, width, height) ⇒ nil

Parameters:

• self (ClutterGst::Player)
• width (Integer)
• height (Integer)

Returns:

• (nil)

#video_sink ⇒ ClutterGst::VideoSink

Retrieves the Clutter::GstVideoSink used by the self.

Returns:

• (ClutterGst::VideoSink) —

  the Clutter::GstVideoSink element used by the player