Back to Seed Clases

Gst

Classes

Interfaces

Structs

Unions

Enums

Struct Gst.Segment

Import line:	Gst = imports.gi.Gst;
GIR File:	Gst-0.10.gir
C documentation:	GstSegment
Struct :	Segment
	Show / Hide Inherited methods, properties and signals

A helper structure that holds the configured region of interest in a media file.

Properties
Properties		Defined By
	_gst_reserved : String	Gst.Segment
	abs_rate : Number	Gst.Segment
	accum : Number	Gst.Segment
	applied_rate : Number	Gst.Segment
	duration : Number	Gst.Segment
	flags : Gst.SeekFlags	Gst.Segment
	format : Gst.Format	Gst.Segment
	last_stop : Number	Gst.Segment
	rate : Number	Gst.Segment
	start : Number	Gst.Segment
	stop : Number	Gst.Segment
	time : Number	Gst.Segment

Methods / Constructors
Method / Constructor		Defined By
	new Gst.Segment () Create a new Gst.Segment Create a new Gst.Segment
	clip (Format *format, Number start, Number stop, Object out_values) : Boolean Clip the given start* and stop values to the segment boundaries given in segment. Clip the given start and stop values to the segment boundaries given in segment. start and stop are compared and clipped to segment start and stop values. If the function returns FALSE, start and stop are known to fall outside of segment and clip_start and clip_stop are not updated. When the function returns TRUE, clip_start and clip_stop will be updated. If clip_start or clip_stop are different from start or stop respectively, the region fell partially in the segment. Note that when stop is -1, clip_stop will be set to the end of the segment. Depending on the use case, this may or may not be what you want. Parameters: Gst.Format format Required (not null) Number start Required (not null) Number stop Required (not null) Object out_values Number clip_start Number clip_stop Returns: Boolean completely in segment, FALSE if the values are completely outside of the segment.	Gst.Segment
	copy () : Gst.Segment Create a copy of given segment. Create a copy of given segment. Returns: Gst.Segment	Gst.Segment
	free () : none Free the allocated segment segment. Free the allocated segment segment. Returns: none	Gst.Segment
	init (Format *format) : none The start/last_stop positions are set to 0 and the stop/duration fields are set to -1 (unknown). The start/last_stop positions are set to 0 and the stop/duration fields are set to -1 (unknown). The default rate of 1.0 and no flags are set. Initialize segment* to its default values. Parameters: Gst.Format format Required (not null) Returns: none	Gst.Segment
	set_duration (Format *format, Number duration) : none Set the duration of the segment to duration. Set the duration of the segment to duration. This function is mainly used by elements that perform seeking and know the total duration of the segment. This field should be set to allow seeking requests relative to the duration. Parameters: Gst.Format format* Required (not null) Number duration Required (not null) Returns: none	Gst.Segment
	set_last_stop (Format *format, Number position) : none Set the last observed stop position in the segment to position. Set the last observed stop position in the segment to position. This field should be set to allow seeking requests relative to the current playing position. Parameters: Gst.Format format* Required (not null) Number position Required (not null) Returns: none	Gst.Segment
	set_newsegment (Boolean *update, Number rate, Format format, Number start, Number stop, Number time) : none Update the segment structure with the field values of a new segment event and with a default applied_rate of 1.0. Update the segment structure with the field values of a new segment event and with a default applied_rate of 1.0. Parameters: Boolean update* Required (not null) Number rate Required (not null) Gst.Format format Required (not null) Number start Required (not null) Number stop Required (not null) Number time Required (not null) Returns: none	Gst.Segment
	set_newsegment_full (Boolean *update, Number rate, Number applied_rate, Format format, Number start, Number stop, Number time) : none Update the segment structure with the field values of a new segment event. Update the segment structure with the field values of a new segment event. Parameters: Boolean update* Required (not null) Number rate Required (not null) Number applied_rate Required (not null) Gst.Format format Required (not null) Number start Required (not null) Number stop Required (not null) Number time Required (not null) Returns: none	Gst.Segment
	set_running_time (Format *format, Number running_time) : Boolean Adjust the start/stop and accum values of segment* such that the next valid buffer will be one with running_time. Adjust the start/stop and accum values of segment such that the next valid buffer will be one with running_time. returned, running_time is -1 or not in segment. Parameters: Gst.Format format Required (not null) Number running_time Required (not null) Returns: Boolean	Gst.Segment
	set_seek (Number *rate, Format format, SeekFlags flags, SeekType start_type, Number start, SeekType stop_type, Number stop) : Boolean Update the segment structure with the field values of a seek event (see gst_event_new_seek()). Update the segment structure with the field values of a seek event (see gst_event_new_seek()). After calling this method, the segment field last_stop and time will contain the requested new position in the segment. The new requested position in the segment depends on rate* and start_type and stop_type. For positive rate, the new position in the segment is the new segment start field when it was updated with a start_type different from GST_SEEK_TYPE_NONE. If no update was performed on segment start position (GST_SEEK_TYPE_NONE), start is ignored and segment last_stop is unmodified. For negative rate, the new position in the segment is the new segment stop field when it was updated with a stop_type different from GST_SEEK_TYPE_NONE. If no stop was previously configured in the segment, the duration of the segment will be used to update the stop position. If no update was performed on segment stop position (GST_SEEK_TYPE_NONE), The applied rate of the segment will be set to 1.0 by default. If the caller can apply a rate change, it should update segment rate and applied_rate after calling this function. last_stop field. This field can be FALSE if, for example, only the rate has been changed but not the playback position. Parameters: Number rate Required (not null) Gst.Format format Required (not null) Gst.SeekFlags flags Required (not null) Gst.SeekType start_type Required (not null) Number start Required (not null) Gst.SeekType stop_type Required (not null) Number stop Required (not null) Returns: Boolean	Gst.Segment
	to_position (Format *format, Number running_time) : Number Convert running_time* into a position in the segment so that gst_segment_to_running_time() with that position returns running_time. Convert running_time into a position in the segment so that gst_segment_to_running_time() with that position returns running_time. -1 when running_time is -1 or when it is not inside segment. Parameters: Gst.Format format Required (not null) Number running_time Required (not null) Returns: Number	Gst.Segment
	to_running_time (Format *format, Number position) : Number Translate position* to the total running time using the currently configured and previously accumulated segments. Translate position to the total running time using the currently configured and previously accumulated segments. Position is a value between segment start and stop time. This function is typically used by elements that need to synchronize to the global clock in a pipeline. The runnning time is a constantly increasing value starting from 0. When gst_segment_init() is called, this value will reset to 0. This function returns -1 if the position is outside of segment start and stop. was given. Parameters: Gst.Format format Required (not null) Number position Required (not null) Returns: Number	Gst.Segment
	to_stream_time (Format *format, Number position) : Number Translate position* to stream time using the currently configured segment. Translate position to stream time using the currently configured segment. The position value must be between segment start and stop value. This function is typically used by elements that need to operate on the stream time of the buffers it receives, such as effect plugins. In those use cases, position is typically the buffer timestamp or clock time that one wants to convert to the stream time. The stream time is always between 0 and the total duration of the media stream. was given. Parameters: Gst.Format format Required (not null) Number position Required (not null) Returns: Number	Gst.Segment

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
GstAudio Method	GstAudio.buffer_clip (Buffer *buffer, Segment segment, Number rate, Number frame_size) : Gst.Buffer Clip the the buffer to the given GstSegment*.

Documentation generated by Introspection Doc Generator Loosely Based on JsDoc Toolkit on Tue Jun 22 2010 16:33:55 GMT+0800 (HKT)