Module: ClutterGst

Defined in:
lib/clutter-gst/version.rb,
lib/clutter-gst.rb

Overview

Copyright (C) 2015 Ruby-GNOME2 Project Team

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Defined Under Namespace

Modules: BufferingMode, Player, SeekFlags, Version Classes: Aspectratio, Camera, CameraDevice, CameraManager, Content, Crop, InitError, Loader, Playback, VideoSink

Constant Summary collapse

MAJOR_VERSION =

ClutterGst major version (e.g. "1", if %CLUTTER_GST_VERSION is "1.2.3")

3
MICRO_VERSION =

ClutterGst micro version (e.g. "3", if %CLUTTER_GST_VERSION is "1.2.3")

27
MINOR_VERSION =

ClutterGst minor version (e.g. "2", if %CLUTTER_GST_VERSION is "1.2.3")

0
VERSION =

ClutterGst full version (e.g. "1.2.3")

3.000000
VERSION_HEX =

ClutterGst full version, encoded as an hexadecimal value.

0
VERSION_S =

ClutterGst full version, encoded as a string.

3.0.27
LOG_DOMAIN = 
"Clutter-GStreamer"

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.load_version ⇒ Object

Returns the value of attribute load_version.



26
27
28
 
# File 'lib/clutter-gst.rb', line 26

def load_version
  @load_version
end

Class Method Details

.const_missing(name) ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/clutter-gst.rb', line 28

def const_missing(name)
  init
  if const_defined?(name)
    const_get(name)
  else
    super
  end
end

.init(argv = []) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/clutter-gst.rb', line 37

def init(argv=[])
  class << self
    remove_method(:init)
    remove_method(:const_missing)
  end
  Gst.init if Gst.respond_to?(:init)
  Clutter.init if Clutter.respond_to?(:init)

  loader = Loader.new(self, argv)
  loader.version = load_version
  loader.load
end

Instance Method Details

#create_video_sink ⇒ Gst::Element

Creates a new Clutter::GstVideoSink initialized with Clutter's Cogl context.

Returns:

  • (Gst::Element) —

    the newly created Clutter::GstVideoSink.

#init(argc, argv) ⇒ Clutter::InitError

Utility function to initialize both Clutter and GStreamer.

This function should be called before calling any other GLib functions. If this is not an option, your program must initialise the GLib thread system using g_thread_init() before any other GLib functions are called.

Parameters:

  • argc (Integer) —

    The number of arguments in argv

  • argv (Array<String>) —

    A pointer to an array

Returns:

  • (Clutter::InitError) —

    A Clutter::InitError.

#init_with_args(argc, argv, parameter_string, entries, translation_domain) ⇒ Clutter::InitError

This function does the same work as clutter_gst_init(). Additionally, it allows you to add your own command line options, and it automatically generates nicely formatted --help output. Clutter's and GStreamer's GOption::Groups are added to the set of available options.

Your program must initialise the GLib thread system using g_thread_init() before any other GLib functions are called.

Parameters:

  • argc (Integer) —

    The number of arguments in argv

  • argv (Array<String>) —

    A pointer to an array

  • parameter_string (String) —

    a string which is displayed in the first line of --help output, after programname [OPTION...]

  • entries (GLib::OptionEntry) —

    an array of GOption::Entrys describing the options of your program

  • translation_domain (String) —

    a translation domain to use for translating the --help output for the options in entries with gettext(), or nil

Returns:

  • (Clutter::InitError) —

    %CLUTTER_INIT_SUCCESS on success, a negative integer on failure.