Class: ClutterGst::Playback

Inherits:

Object

• Object
• ClutterGst::Playback

Defined in:

(unknown)

Overview

Base class for Clutter::GstPlayback.

Instance Method Summary

• #audio_stream ⇒ Integer

  Index of the current audio stream.

• #audio_stream=(audio_stream) ⇒ Integer

  Index of the current audio stream.

• #audio_streams ⇒ GObject

  List of audio streams available on the current media.

• #audio_streams=(audio_streams) ⇒ GObject

  List of audio streams available on the current media.

• #buffer_duration ⇒ Integer

  Retrieves the buffer duration when buffering network streams.

• #buffer_duration=(duration) ⇒ nil

  Sets the buffer duration to be used when buffering network streams.

• #buffer_fill ⇒ Float

  The fill level of the buffer for the current stream, as a value between 0.0 and 1.0.

• #buffer_fill=(buffer_fill) ⇒ Float

  The fill level of the buffer for the current stream, as a value between 0.0 and 1.0.

• #buffer_size ⇒ Integer

  Retrieves the buffer size when buffering network streams.

• #buffer_size=(size) ⇒ nil

  Sets the buffer size to be used when buffering network streams.

• #buffering_mode ⇒ ClutterGst::BufferingMode

  A Clutter::GstBufferingMode.

• #buffering_mode=(mode) ⇒ nil
• #can_seek=(can_seek) ⇒ Boolean

  Whether the current stream is seekable.

• #can_seek? ⇒ Boolean

  Whether the current stream is seekable.

• #duration ⇒ Float

  The duration of the current stream, in seconds.

• #duration=(duration) ⇒ Float

  The duration of the current stream, in seconds.

• #filename=(filename) ⇒ nil

  Sets the source of self using a file path.

• #in_seek ⇒ Boolean

  Whether the player is seeking.

• #in_seek=(in_seek) ⇒ Boolean

  Whether or not the stream is being seeked.

• #in_seek? ⇒ Boolean

  Whether or not the stream is being seeked.

• #initialize ⇒ ClutterGst::Playback constructor
• #is_live_media ⇒ Boolean

  Whether the player is using a live media.

• #position ⇒ Float

  Retrieves the position in the media stream that self represents.

• #progress ⇒ Float

  The current progress of the playback, as a normalized value between 0.0 and 1.0.

• #progress=(progress) ⇒ Float

  The current progress of the playback, as a normalized value between 0.0 and 1.0.

• #seek_flags ⇒ ClutterGst::SeekFlags

  Flags to use when seeking.

• #seek_flags=(seek_flags) ⇒ ClutterGst::SeekFlags

  Flags to use when seeking.

• #subtitle_font_name ⇒ String

  The font used to display subtitles.

• #subtitle_font_name=(subtitle_font_name) ⇒ String

  The font used to display subtitles.

• #subtitle_track ⇒ Integer

  Current subtitle track being displayed.

• #subtitle_track=(subtitle_track) ⇒ Integer

  Current subtitle track being displayed.

• #subtitle_tracks ⇒ GObject

  List of subtitle tracks available.

• #subtitle_tracks=(subtitle_tracks) ⇒ GObject

  List of subtitle tracks available.

• #subtitle_uri ⇒ String

  The location of a subtitle file, expressed as a valid URI.

• #subtitle_uri=(subtitle_uri) ⇒ String

  The location of a subtitle file, expressed as a valid URI.

• #uri ⇒ String

  The location of a media file, expressed as a valid URI.

• #uri=(uri) ⇒ String

  The location of a media file, expressed as a valid URI.

• #user_agent ⇒ String

  The User Agent used by Clutter::GstPlayback with network protocols.

• #user_agent=(user_agent) ⇒ String

  The User Agent used by Clutter::GstPlayback with network protocols.

Constructor Details

#initialize ⇒ ClutterGst::Playback

Instance Method Details

#audio_stream ⇒ Integer

Index of the current audio stream.

Returns:

• (Integer) —

  audio-stream

#audio_stream=(audio_stream) ⇒ Integer

Index of the current audio stream.

Parameters:

• audio_stream (Integer)

Returns:

• (Integer) —

  audio-stream

• (Integer) —

  audio-stream

#audio_streams ⇒ GObject

List of audio streams available on the current media.

Returns:

• (GObject) —

  audio-streams

#audio_streams=(audio_streams) ⇒ GObject

List of audio streams available on the current media.

Parameters:

• audio_streams (GObject)

Returns:

• (GObject) —

  audio-streams

• (GObject) —

  audio-streams

#buffer_duration ⇒ Integer

Retrieves the buffer duration when buffering network streams.

Returns:

• (Integer) —

  The buffer duration

#buffer_duration=(duration) ⇒ nil

Sets the buffer duration to be used when buffering network streams.

Parameters:

• duration (Integer) —

  The new duration

Returns:

• (nil)

#buffer_fill ⇒ Float

The fill level of the buffer for the current stream, as a value between 0.0 and 1.0.

Returns:

• (Float) —

  buffer-fill

#buffer_fill=(buffer_fill) ⇒ Float

The fill level of the buffer for the current stream, as a value between 0.0 and 1.0.

Parameters:

• buffer_fill (Float)

Returns:

• (Float) —

  buffer-fill

• (Float) —

  buffer-fill

#buffer_size ⇒ Integer

Retrieves the buffer size when buffering network streams.

Returns:

• (Integer) —

  The buffer size

#buffer_size=(size) ⇒ nil

Sets the buffer size to be used when buffering network streams.

Parameters:

• size (Integer) —

  The new size

Returns:

• (nil)

#buffering_mode ⇒ ClutterGst::BufferingMode

Returns a Clutter::GstBufferingMode.

Returns:

• (ClutterGst::BufferingMode) —

  a Clutter::GstBufferingMode

#buffering_mode=(mode) ⇒ nil

Parameters:

• mode (ClutterGst::BufferingMode) —

  a Clutter::GstBufferingMode

Returns:

• (nil)

#can_seek=(can_seek) ⇒ Boolean

Whether the current stream is seekable.

Parameters:

• can_seek (Boolean)

Returns:

• (Boolean) —

  can-seek

• (Boolean) —

  can-seek

#can_seek? ⇒ Boolean

Whether the current stream is seekable.

Returns:

• (Boolean) —

  can-seek

#duration ⇒ Float

The duration of the current stream, in seconds

Returns:

• (Float) —

  duration

#duration=(duration) ⇒ Float

The duration of the current stream, in seconds

Parameters:

• duration (Float)

Returns:

• (Float) —

  duration

• (Float) —

  duration

#filename=(filename) ⇒ nil

Sets the source of self using a file path.

Parameters:

• filename (String) —

  A filename

Returns:

• (nil)

#in_seek ⇒ Boolean

Whether the player is seeking.

Returns:

• (Boolean) —

  TRUE if the player is seeking, FALSE otherwise.

#in_seek=(in_seek) ⇒ Boolean

Whether or not the stream is being seeked.

Parameters:

• in_seek (Boolean)

Returns:

• (Boolean) —

  in-seek

• (Boolean) —

  in-seek

#in_seek? ⇒ Boolean

Whether or not the stream is being seeked.

Returns:

• (Boolean) —

  in-seek

#is_live_media ⇒ Boolean

Whether the player is using a live media.

Returns:

• (Boolean) —

  TRUE if the player is using a live media, FALSE otherwise.

#position ⇒ Float

Retrieves the position in the media stream that self represents.

Returns:

• (Float) —

  the position in the media stream, in seconds

#progress ⇒ Float

The current progress of the playback, as a normalized value between 0.0 and 1.0.

Returns:

• (Float) —

  progress

#progress=(progress) ⇒ Float

The current progress of the playback, as a normalized value between 0.0 and 1.0.

Parameters:

• progress (Float)

Returns:

• (Float) —

  progress

• (Float) —

  progress

#seek_flags ⇒ ClutterGst::SeekFlags

Flags to use when seeking.

Returns:

• (ClutterGst::SeekFlags) —

  seek-flags

#seek_flags=(seek_flags) ⇒ ClutterGst::SeekFlags

Flags to use when seeking.

Parameters:

• seek_flags (ClutterGst::SeekFlags)

Returns:

• (ClutterGst::SeekFlags) —

  seek-flags

• (ClutterGst::SeekFlags) —

  seek-flags

#subtitle_font_name ⇒ String

The font used to display subtitles. The font description has to follow the same grammar as the one recognized by pango_font_description_from_string().

Returns:

• (String) —

  subtitle-font-name

#subtitle_font_name=(subtitle_font_name) ⇒ String

The font used to display subtitles. The font description has to follow the same grammar as the one recognized by pango_font_description_from_string().

Parameters:

• subtitle_font_name (String)

Returns:

• (String) —

  subtitle-font-name

• (String) —

  subtitle-font-name

#subtitle_track ⇒ Integer

Current subtitle track being displayed.

Returns:

• (Integer) —

  subtitle-track

#subtitle_track=(subtitle_track) ⇒ Integer

Current subtitle track being displayed.

Parameters:

• subtitle_track (Integer)

Returns:

• (Integer) —

  subtitle-track

• (Integer) —

  subtitle-track

#subtitle_tracks ⇒ GObject

List of subtitle tracks available.

Returns:

• (GObject) —

  subtitle-tracks

#subtitle_tracks=(subtitle_tracks) ⇒ GObject

List of subtitle tracks available.

Parameters:

• subtitle_tracks (GObject)

Returns:

• (GObject) —

  subtitle-tracks

• (GObject) —

  subtitle-tracks

#subtitle_uri ⇒ String

The location of a subtitle file, expressed as a valid URI.

Returns:

• (String) —

  subtitle-uri

#subtitle_uri=(subtitle_uri) ⇒ String

The location of a subtitle file, expressed as a valid URI.

Parameters:

• subtitle_uri (String)

Returns:

• (String) —

  subtitle-uri

• (String) —

  subtitle-uri

#uri ⇒ String

The location of a media file, expressed as a valid URI.

Returns:

• (String) —

  uri

#uri=(uri) ⇒ String

The location of a media file, expressed as a valid URI.

Parameters:

• uri (String)

Returns:

• (String) —

  uri

• (String) —

  uri

#user_agent ⇒ String

The User Agent used by Clutter::GstPlayback with network protocols.

Returns:

• (String) —

  user-agent

#user_agent=(user_agent) ⇒ String

The User Agent used by Clutter::GstPlayback with network protocols.

Parameters:

• user_agent (String)

Returns:

• (String) —

  user-agent

• (String) —

  user-agent