ruby-****@sourc*****
ruby-****@sourc*****
2004年 3月 2日 (火) 05:39:26 JST
-------------------------
REMOTE_ADDR = 217.117.55.140
REMOTE_HOST =
URL = http://ruby-gnome2.sourceforge.jp/?Gst%3A%3AClockEntry
-------------------------
= class Gst::ClockEntry
A wrapper for GstClockID, used to create and start timers
on Gst::Clock objects.
+ == Object Hierarchy
+ * Object
+ * GLib::Boxed
+ * Gst::ClockEntry
+
== Class Methods
- --- Gst::ClockEntry.new(aClock, aTime, anInterval=nil)
+ --- Gst::ClockEntry.new(clock, time, interval=nil)
Creates a new Gst::ClockEntry object based on the given Gst::Clock.
-
Two types of Gst::ClockEntry objects can be created:
-
- * One-shot: if anInterval is ommited or nil, the entry will trigger
- a single shot notification, at the requested aTime (in nanoseconds);
- * Periodic: if anInterval is not nil, the timer entry will trigger a
- periodic notification, starting at aTime (in nanoseconds), and
- be fired with the given interval (also in nanoseconds).
-
+ - One-shot: if anInterval is ommited or nil, the entry will trigger
+ a single shot notification, at the requested aTime (in nanoseconds);
+ - Periodic: if anInterval is not nil, the timer entry will trigger a
+ periodic notification, starting at aTime (in nanoseconds), and
+ be fired with the given interval (also in nanoseconds).
The timer will be issued after Gst::ClockEntry#wait
or Gst::ClockEntry#wait_async.
+ * time: a time period, in nanoseconds.
+ * clock: a Gst::Clock.
+ * interval: an interval period, in nanoseconds.
+ * Returns: a new Gst::ClockEntry object.
-
== Instance Methods
- --- clock
- Gets the owner clock of the entry, as a Gst::Clock object.
+ --- clock
+ This method returns the owner clock of the entry, as a Gst::Clock object.
+ * Returns: the owner clock of the entry, as a Gst::Clock object.
- --- interval
- Gets the interval of the entry, in nanoseconds.
- Returns 0 if the entry is not periodic.
+ --- interval
+ This method returns the interval of the entry (in nanoseconds), or 0 if the entry is not periodic.
+ * Returns: the interval of the entry (in nanoseconds), or 0 if the entry is not periodic.
- --- periodic?
- Checks if the entry is periodic.
+ --- periodic?
+ This method returns true if the entry is periodic, false otherwise.
+ * Returns: true if the entry is periodic, false otherwise.
- --- single_shot?
- Checks if the entry is single-shot.
+ --- single_shot?
+ This method returns true if the entry is single-shot, false otherwise.
+ * Returns: true if the entry is single-shot, false otherwise.
- --- status
- Gets the status of the entry, as a Fixnum integer.
- Possible values are:
- * Gst::ClockEntry::OK;
- * Gst::ClockEntry::EARLY;
- * Gst::ClockEntry::RESTART.
+ --- status
+ This method returns the status of the entry (see GstClockEntryStatus).
+ * Returns: the status of the entry (see GstClockEntryStatus).
- --- time
- Gets the requested time of the entry, in nanoseconds.
+ --- time
+ This method returns the requested time of the entry, in nanoseconds.
+ * Returns: the requested time of the entry, in nanoseconds.
- --- unlock
- Unlock the entry.
+ --- unlock
+ Unlocks the entry.
+ * Returns: self.
- --- unschedule
- Cancel an outstanding async notification request.
+ --- unschedule
+ Cancels an outstanding async notification request.
+ * Returns: self.
- --- wait
+ --- wait
Performs a blocking wait on the entry.
-
- Returns a code (as a Fixnum):
- * Gst::Clock::STOPPED;
- * Gst::Clock::TIMEOUT;
- * Gst::Clock::EARLY;
- * Gst::Clock::ERROR;
- * Gst::Clock::UNSUPPORTED.
+ * Returns: a return code (see GstClockReturn).
- --- wait_async { |aClock, aTime, aEntryClock| ... }
- Register a block code, which will be called passing references
+ --- wait_async { |clock, time, clock_entry| ... }
+ Registers a block code, which will be called passing references
to the Gst::Clock, the time (in nanoseconds) and the Gst::ClockEntry as
parameters.
-
- Returns a code (as a Fixnum):
- * Gst::Clock::STOPPED;
- * Gst::Clock::TIMEOUT;
- * Gst::Clock::EARLY;
- * Gst::Clock::ERROR;
- * Gst::Clock::UNSUPPORTED.
+ * Returns: a return code (see GstClockReturn).
-
- == Constants
- --- EARLY
- Request for timeout that has been passed.
-
- --- OK
- Timeout happened.
-
- --- RESTART
- Need to restart the timeout request.
-
+ == See Also
+ ((<Gst>)).
- ((<lrz>))