ruby-****@sourc*****
ruby-****@sourc*****
2004年 3月 2日 (火) 05:28:34 JST
-------------------------
REMOTE_ADDR = 217.117.55.140
REMOTE_HOST =
URL = http://ruby-gnome2.sourceforge.jp/?Gst
-------------------------
= module Gst
The GStreamer module.
== Module Functions
- --- Gst.has_threads?
- Query if GStreamer has threads enabled.
+ --- Gst.has_threads?
+ This method returns true if GStreamer has threads enabled, false otherwise.
+ * Returns: true if GStreamer has threads enabled, false otherwise.
- --- Gst.init(*args)
+ --- Gst.init(*args)
Initializes the GStreamer library (using *args), setting up internal path
lists, registering built-in elements, and loading standard plugins.
-
If *args are ommited, GStreamer will be initialized using arguments from the
Ruby command line.
-
- This function will always return 'true'. A RuntimeError exception will be
- raised if GStreamer could not be initialized.
+ A RuntimeError exception will be raised if GStreamer could not be initialized.
+ * Returns: always true, or an exception on failure.
- --- Gst.set_debug(aBoolean)
- Enable or disable debug mode, according to the provided parameter.
+ --- Gst.set_debug(state)
+ Enables or disable debug mode, according to the provided parameter.
When debug mode is on, Ruby/GStreamer will print various information
on the screen (as instance, when the GC cames), useful to trace and fix bugs.
+ * state: a boolean state.
+ * Returns: always nil.
- --- Gst.use_threads(aBoolean)
+ --- Gst.use_threads(state)
Instructs the core to turn on/off threading.
-
When threading is turned off, all thread operations such as
mutexes and conditionals are turned into NOPs.
Use this if you want absolute minimal overhead and you don't
use any threads in the pipeline.
-
- Returns the provided boolean value.
+ * state: a boolean state.
+ * Returns: the provided boolean value.
- --- Gst.version
+ --- Gst.version
Gets the version number of the GStreamer library, in an array
of 3 fixnums, which represent major, minor and macro numbers.
-
- Example:
-
- # Prints GStreamer version in a String 'major.minor.macro'
- p Gst.version.join('.')
+ minor.macro'
+ p Gst.version.join('.')
+ * Example: # Prints GStreamer version in a String 'major.
+ * Returns: an Array of 3 fixnums (major, minor and macro numbers).
-
== Constants
--- MSECOND
Constant that defines one GStreamer millisecond.
--- NSECOND
Constant that defines one GStreamer nanosecond.
--- SECOND
Constant that defines one GStreamer second.
--- USECOND
Constant that defines one GStreamer microsecond.
-
- ((<lrz>))