* to avoid polling.
*
* Last reviewed on 2008-12-17 (0.10.22)
- *
- * Since: 0.10.22
*/
#ifdef HAVE_CONFIG_H
* a copy of the caps structure. After calling this method, the sink will only
* accept caps that match @caps. If @caps is non-fixed, you must check the caps
* on the buffers to get the actual used caps.
- *
- * Since: 0.10.22
*/
void
gst_app_sink_set_caps (GstAppSink * appsink, const GstCaps * caps)
* Get the configured caps on @appsink.
*
* Returns: the #GstCaps accepted by the sink. gst_caps_unref() after usage.
- *
- * Since: 0.10.22
*/
GstCaps *
gst_app_sink_get_caps (GstAppSink * appsink)
* PLAYING state.
*
* Returns: %TRUE if no more samples can be pulled and the appsink is EOS.
- *
- * Since: 0.10.22
*/
gboolean
gst_app_sink_is_eos (GstAppSink * appsink)
* Make appsink emit the "new-preroll" and "new-sample" signals. This option is
* by default disabled because signal emission is expensive and unneeded when
* the application prefers to operate in pull mode.
- *
- * Since: 0.10.22
*/
void
gst_app_sink_set_emit_signals (GstAppSink * appsink, gboolean emit)
*
* Returns: %TRUE if @appsink is emiting the "new-preroll" and "new-sample"
* signals.
- *
- * Since: 0.10.22
*/
gboolean
gst_app_sink_get_emit_signals (GstAppSink * appsink)
* Set the maximum amount of buffers that can be queued in @appsink. After this
* amount of buffers are queued in appsink, any more buffers will block upstream
* elements until a sample is pulled from @appsink.
- *
- * Since: 0.10.22
*/
void
gst_app_sink_set_max_buffers (GstAppSink * appsink, guint max)
* Get the maximum amount of buffers that can be queued in @appsink.
*
* Returns: The maximum amount of buffers that can be queued.
- *
- * Since: 0.10.22
*/
guint
gst_app_sink_get_max_buffers (GstAppSink * appsink)
*
* Instruct @appsink to drop old buffers when the maximum amount of queued
* buffers is reached.
- *
- * Since: 0.10.22
*/
void
gst_app_sink_set_drop (GstAppSink * appsink, gboolean drop)
*
* Returns: %TRUE if @appsink is dropping old buffers when the queue is
* filled.
- *
- * Since: 0.10.22
*/
gboolean
gst_app_sink_get_drop (GstAppSink * appsink)
* element is set to the READY/NULL state.
*
* Returns: a #GstBuffer or NULL when the appsink is stopped or EOS.
- *
- * Since: 0.10.22
*/
GstSample *
gst_app_sink_pull_preroll (GstAppSink * appsink)
* %NULL. Use gst_app_sink_is_eos () to check for the EOS condition.
*
* Returns: a #GstBuffer or NULL when the appsink is stopped or EOS.
- *
- * Since: 0.10.22
*/
GstSample *
*
* If callbacks are installed, no signals will be emitted for performance
* reasons.
- *
- * Since: 0.10.23
*/
void
gst_app_sink_set_callbacks (GstAppSink * appsink,
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_APP_SINK))
#define GST_IS_APP_SINK_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_APP_SINK))
-/* Since 0.10.23 */
#define GST_APP_SINK_CAST(obj) \
((GstAppSink*)(obj))
*
* A set of callbacks that can be installed on the appsink with
* gst_app_sink_set_callbacks().
- *
- * Since: 0.10.23
*/
typedef struct {
void (*eos) (GstAppSink *sink, gpointer user_data);
* happened or the state of the appsrc has gone through READY.
*
* Last reviewed on 2008-12-17 (0.10.10)
- *
- * Since: 0.10.22
*/
#ifdef HAVE_CONFIG_H
gobject_class->get_property = gst_app_src_get_property;
/**
- * GstAppSrc::caps
+ * GstAppSrc::caps:
*
* The GstCaps that will negotiated downstream and will be put
* on outgoing buffers.
"The allowed caps for the src pad", GST_TYPE_CAPS,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAppSrc::format
+ * GstAppSrc::format:
*
* The format to use for segment events. When the source is producing
* timestamped buffers this property should be set to GST_FORMAT_TIME.
"The format of the segment events and seek", GST_TYPE_FORMAT,
DEFAULT_PROP_FORMAT, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAppSrc::size
+ * GstAppSrc::size:
*
* The total size in bytes of the data stream. If the total size is known, it
* is recommended to configure it with this property.
-1, G_MAXINT64, DEFAULT_PROP_SIZE,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAppSrc::stream-type
+ * GstAppSrc::stream-type:
*
* The type of stream that this source is producing. For seekable streams the
* application should connect to the seek-data signal.
DEFAULT_PROP_STREAM_TYPE,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAppSrc::max-bytes
+ * GstAppSrc::max-bytes:
*
* The maximum amount of bytes that can be queued internally.
* After the maximum amount of bytes are queued, appsrc will emit the
0, G_MAXUINT64, DEFAULT_PROP_MAX_BYTES,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAppSrc::block
+ * GstAppSrc::block:
*
* When max-bytes are queued and after the enough-data signal has been emitted,
* block any further push-buffer calls until the amount of queued bytes drops
DEFAULT_PROP_BLOCK, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAppSrc::is-live
+ * GstAppSrc::is-live:
*
* Instruct the source to behave like a live source. This includes that it
* will only push out buffers in the PLAYING state.
"Whether to act as a live source",
DEFAULT_PROP_IS_LIVE, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAppSrc::min-latency
+ * GstAppSrc::min-latency:
*
* The minimum latency of the source. A value of -1 will use the default
* latency calculations of #GstBaseSrc.
-1, G_MAXINT64, DEFAULT_PROP_MIN_LATENCY,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAppSrc::max-latency
+ * GstAppSrc::max-latency:
*
* The maximum latency of the source. A value of -1 means an unlimited amout
* of latency.
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAppSrc::emit-signals
+ * GstAppSrc::emit-signals:
*
* Make appsrc emit the "need-data", "enough-data" and "seek-data" signals.
* This option is by default enabled for backwards compatibility reasons but
* can disabled when needed because signal emission is expensive.
- *
- * Since: 0.10.23
*/
g_object_class_install_property (gobject_class, PROP_EMIT_SIGNALS,
g_param_spec_boolean ("emit-signals", "Emit signals",
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAppSrc::empty-percent
+ * GstAppSrc::empty-percent:
*
* Make appsrc emit the "need-data" signal when the amount of bytes in the
* queue drops below this percentage of max-bytes.
- *
- * Since: 0.10.27
*/
g_object_class_install_property (gobject_class, PROP_MIN_PERCENT,
g_param_spec_uint ("min-percent", "Min Percent",
* a copy of the caps structure. After calling this method, the source will
* only produce caps that match @caps. @caps must be fixed and the caps on the
* buffers must match the caps or left NULL.
- *
- * Since: 0.10.22
*/
void
gst_app_src_set_caps (GstAppSrc * appsrc, const GstCaps * caps)
* Get the configured caps on @appsrc.
*
* Returns: the #GstCaps produced by the source. gst_caps_unref() after usage.
- *
- * Since: 0.10.22
*/
GstCaps *
gst_app_src_get_caps (GstAppSrc * appsrc)
*
* Set the size of the stream in bytes. A value of -1 means that the size is
* not known.
- *
- * Since: 0.10.22
*/
void
gst_app_src_set_size (GstAppSrc * appsrc, gint64 size)
* not known.
*
* Returns: the size of the stream previously set with gst_app_src_set_size();
- *
- * Since: 0.10.22
*/
gint64
gst_app_src_get_size (GstAppSrc * appsrc)
* be connected to.
*
* A stream_type stream
- *
- * Since: 0.10.22
*/
void
gst_app_src_set_stream_type (GstAppSrc * appsrc, GstAppStreamType type)
* with gst_app_src_set_stream_type().
*
* Returns: the stream type.
- *
- * Since: 0.10.22
*/
GstAppStreamType
gst_app_src_get_stream_type (GstAppSrc * appsrc)
* Set the maximum amount of bytes that can be queued in @appsrc.
* After the maximum amount of bytes are queued, @appsrc will emit the
* "enough-data" signal.
- *
- * Since: 0.10.22
*/
void
gst_app_src_set_max_bytes (GstAppSrc * appsrc, guint64 max)
* Get the maximum amount of bytes that can be queued in @appsrc.
*
* Returns: The maximum amount of bytes that can be queued.
- *
- * Since: 0.10.22
*/
guint64
gst_app_src_get_max_bytes (GstAppSrc * appsrc)
*
* Configure the @min and @max latency in @src. If @min is set to -1, the
* default latency calculations for pseudo-live sources will be used.
- *
- * Since: 0.10.22
*/
void
gst_app_src_set_latency (GstAppSrc * appsrc, guint64 min, guint64 max)
* @max: the min latency
*
* Retrieve the min and max latencies in @min and @max respectively.
- *
- * Since: 0.10.22
*/
void
gst_app_src_get_latency (GstAppSrc * appsrc, guint64 * min, guint64 * max)
* Make appsrc emit the "new-preroll" and "new-buffer" signals. This option is
* by default disabled because signal emission is expensive and unneeded when
* the application prefers to operate in pull mode.
- *
- * Since: 0.10.23
*/
void
gst_app_src_set_emit_signals (GstAppSrc * appsrc, gboolean emit)
*
* Returns: %TRUE if @appsrc is emitting the "new-preroll" and "new-buffer"
* signals.
- *
- * Since: 0.10.23
*/
gboolean
gst_app_src_get_emit_signals (GstAppSrc * appsrc)
* Returns: #GST_FLOW_OK when the buffer was successfuly queued.
* #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
* #GST_FLOW_EOS when EOS occured.
- *
- * Since: 0.10.22
*/
GstFlowReturn
gst_app_src_push_buffer (GstAppSrc * appsrc, GstBuffer * buffer)
*
* Returns: #GST_FLOW_OK when the EOS was successfuly queued.
* #GST_FLOW_FLUSHING when @appsrc is not PAUSED or PLAYING.
- *
- * Since: 0.10.22
*/
GstFlowReturn
gst_app_src_end_of_stream (GstAppSrc * appsrc)
*
* If callbacks are installed, no signals will be emitted for performance
* reasons.
- *
- * Since: 0.10.23
*/
void
gst_app_src_set_callbacks (GstAppSrc * appsrc,
(G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_APP_SRC))
#define GST_IS_APP_SRC_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_APP_SRC))
-/* Since 0.10.23 */
#define GST_APP_SRC_CAST(obj) \
((GstAppSrc*)(obj))
*
* A set of callbacks that can be installed on the appsrc with
* gst_app_src_set_callbacks().
- *
- * Since: 0.10.23
*/
typedef struct {
void (*need_data) (GstAppSrc *src, guint length, gpointer user_data);
GType gst_app_src_get_type(void);
-/* GType getter for GstAppStreamType, since 0.10.32 */
+/* GType getter for GstAppStreamType */
#define GST_TYPE_APP_STREAM_TYPE (gst_app_stream_type_get_type ())
GType gst_app_stream_type_get_type (void);
* @channels: The number of channels
* @channel_mask: The input channel_mask
* @position: The %GstAudioChannelPositions
- * @caps: a #GstCaps
*
* Convert the @channels present in @channel_mask to a @position array
* (which should have at least @channels entries ensured by caller).
/**
* gst_audio_info_convert:
* @info: a #GstAudioInfo
- * @src_format: #GstFormat of the @src_value
- * @src_value: value to convert
- * @dest_format: #GstFormat of the @dest_value
- * @dest_value: pointer to destination value
+ * @src_fmt: #GstFormat of the @src_val
+ * @src_val: value to convert
+ * @dest_fmt: #GstFormat of the @dest_val
+ * @dest_val: pointer to destination value
*
* Converts among various #GstFormat types. This function handles
* GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For
*
* If the buffer has no timestamp, it is assumed to be inside the segment and
* is not clipped
- *
- * Since: 0.10.14
*/
GstBuffer *
gst_audio_buffer_clip (GstBuffer * buffer, GstSegment * segment, gint rate,
"Allow pull-based scheduling", DEFAULT_CAN_ACTIVATE_PULL,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAudioBaseSink:drift-tolerance
+ * GstAudioBaseSink:drift-tolerance:
*
* Controls the amount of time in microseconds that clocks are allowed
* to drift before resynchronisation happens.
- *
- * Since: 0.10.26
*/
g_object_class_install_property (gobject_class, PROP_DRIFT_TOLERANCE,
g_param_spec_int64 ("drift-tolerance", "Drift Tolerance",
G_MAXINT64, DEFAULT_DRIFT_TOLERANCE,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAudioBaseSink:alignment_threshold
+ * GstAudioBaseSink:alignment_threshold:
*
* Controls the amount of time in nanoseconds that timestamps are allowed
* to drift from their ideal time before choosing not to align them.
- *
- * Since: 0.10.36
*/
g_object_class_install_property (gobject_class, PROP_ALIGNMENT_THRESHOLD,
g_param_spec_uint64 ("alignment-threshold", "Alignment Threshold",
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
/**
- * GstAudioBaseSink:discont-wait
+ * GstAudioBaseSink:discont-wait:
*
* A window of time in nanoseconds to wait before creating a discontinuity as
* a result of breaching the drift-tolerance.
- *
- * Since: 0.10.36
*/
g_object_class_install_property (gobject_class, PROP_DISCONT_WAIT,
g_param_spec_uint64 ("discont-wait", "Discont Wait",
* Controls whether @sink will provide a clock or not. If @provide is %TRUE,
* gst_element_provide_clock() will return a clock that reflects the datarate
* of @sink. If @provide is %FALSE, gst_element_provide_clock() will return NULL.
- *
- * Since: 0.10.16
*/
void
gst_audio_base_sink_set_provide_clock (GstAudioBaseSink * sink,
* gst_audio_base_sink_set_provide_clock.
*
* Returns: %TRUE if @sink will provide a clock.
- *
- * Since: 0.10.16
*/
gboolean
gst_audio_base_sink_get_provide_clock (GstAudioBaseSink * sink)
* @method: the new slave method
*
* Controls how clock slaving will be performed in @sink.
- *
- * Since: 0.10.16
*/
void
gst_audio_base_sink_set_slave_method (GstAudioBaseSink * sink,
* Get the current slave method used by @sink.
*
* Returns: The current slave method used by @sink.
- *
- * Since: 0.10.16
*/
GstAudioBaseSinkSlaveMethod
gst_audio_base_sink_get_slave_method (GstAudioBaseSink * sink)
* @drift_tolerance: the new drift tolerance in microseconds
*
* Controls the sink's drift tolerance.
- *
- * Since: 0.10.31
*/
void
gst_audio_base_sink_set_drift_tolerance (GstAudioBaseSink * sink,
}
/**
- * gst_audio_base_sink_get_drift_tolerance
+ * gst_audio_base_sink_get_drift_tolerance:
* @sink: a #GstAudioBaseSink
*
* Get the current drift tolerance, in microseconds, used by @sink.
*
* Returns: The current drift tolerance used by @sink.
- *
- * Since: 0.10.31
*/
gint64
gst_audio_base_sink_get_drift_tolerance (GstAudioBaseSink * sink)
* @alignment_threshold: the new alignment threshold in nanoseconds
*
* Controls the sink's alignment threshold.
- *
- * Since: 0.10.36
*/
void
gst_audio_base_sink_set_alignment_threshold (GstAudioBaseSink * sink,
}
/**
- * gst_audio_base_sink_get_alignment_threshold
+ * gst_audio_base_sink_get_alignment_threshold:
* @sink: a #GstAudioBaseSink
*
* Get the current alignment threshold, in nanoseconds, used by @sink.
*
* Returns: The current alignment threshold used by @sink.
- *
- * Since: 0.10.36
*/
GstClockTime
gst_audio_base_sink_get_alignment_threshold (GstAudioBaseSink * sink)
* @discont_wait: the new discont wait in nanoseconds
*
* Controls how long the sink will wait before creating a discontinuity.
- *
- * Since: 0.10.36
*/
void
gst_audio_base_sink_set_discont_wait (GstAudioBaseSink * sink,
}
/**
- * gst_audio_base_sink_get_discont_wait
+ * gst_audio_base_sink_get_discont_wait:
* @sink: a #GstAudioBaseSink
*
* Get the current discont wait, in nanoseconds, used by @sink.
*
* Returns: The current discont wait used by @sink.
- *
- * Since: 0.10.36
*/
GstClockTime
gst_audio_base_sink_get_discont_wait (GstAudioBaseSink * sink)
* ::create_ringbuffer vmethod and will set @sink as the parent of the returned
* buffer (see gst_object_set_parent()).
*
- * Returns: The new ringbuffer of @sink.
+ * Returns: (transfer none): The new ringbuffer of @sink.
*/
GstAudioRingBuffer *
gst_audio_base_sink_create_ringbuffer (GstAudioBaseSink * sink)
* @payload: payload data in a format suitable to write to the sink. If no
* payloading is required, returns a reffed copy of the original
* buffer, else returns the payloaded buffer with all other metadata
- * copied. (Since: 0.10.36)
+ * copied.
*
* #GstAudioBaseSink class. Override the vmethod to implement
* functionality.
* GstAudioBaseSrc:actual-buffer-time:
*
* Actual configured size of audio buffer in microseconds.
- *
- * Since: 0.10.20
**/
g_object_class_install_property (gobject_class, PROP_ACTUAL_BUFFER_TIME,
g_param_spec_int64 ("actual-buffer-time", "Actual Buffer Time",
* GstAudioBaseSrc:actual-latency-time:
*
* Actual configured audio latency in microseconds.
- *
- * Since: 0.10.20
**/
g_object_class_install_property (gobject_class, PROP_ACTUAL_LATENCY_TIME,
g_param_spec_int64 ("actual-latency-time", "Actual Latency Time",
* Controls whether @src will provide a clock or not. If @provide is %TRUE,
* gst_element_provide_clock() will return a clock that reflects the datarate
* of @src. If @provide is %FALSE, gst_element_provide_clock() will return NULL.
- *
- * Since: 0.10.16
*/
void
gst_audio_base_src_set_provide_clock (GstAudioBaseSrc * src, gboolean provide)
* gst_audio_base_src_set_provide_clock.
*
* Returns: %TRUE if @src will provide a clock.
- *
- * Since: 0.10.16
*/
gboolean
gst_audio_base_src_get_provide_clock (GstAudioBaseSrc * src)
* @method: the new slave method
*
* Controls how clock slaving will be performed in @src.
- *
- * Since: 0.10.20
*/
void
gst_audio_base_src_set_slave_method (GstAudioBaseSrc * src,
* Get the current slave method used by @src.
*
* Returns: The current slave method used by @src.
- *
- * Since: 0.10.20
*/
GstAudioBaseSrcSlaveMethod
gst_audio_base_src_get_slave_method (GstAudioBaseSrc * src)
* ::create_ringbuffer vmethod and will set @src as the parent of the returned
* buffer (see gst_object_set_parent()).
*
- * Returns: The new ringbuffer of @src.
+ * Returns: (transfer none): The new ringbuffer of @src.
*/
GstAudioRingBuffer *
gst_audio_base_src_create_ringbuffer (GstAudioBaseSrc * src)
* #GST_CLOCK_TIME_NONE, the clock will return the last reported time.
*
* Returns: a new #GstAudioClock casted to a #GstClock.
- *
- * Since: 0.10.31
*/
GstClock *
gst_audio_clock_new (const gchar * name, GstAudioClockGetTimeFunc func,
* any offsets.
*
* Returns: the time as reported by the time function of the audio clock
- *
- * Since: 0.10.23
*/
GstClockTime
gst_audio_clock_get_time (GstClock * clock)
* Adjust @time with the internal offset of the audio clock.
*
* Returns: @time adjusted with the internal offset.
- *
- * Since: 0.10.23
*/
GstClockTime
gst_audio_clock_adjust (GstClock * clock, GstClockTime time)
*
* After calling this function, @clock will return the last returned time for
* the rest of its lifetime.
- *
- * Since: 0.10.31
*/
void
gst_audio_clock_invalidate (GstClock * clock)
* SECTION:gstaudiodecoder
* @short_description: Base class for audio decoders
* @see_also: #GstBaseTransform
- * @since: 0.10.36
*
* This base class is for audio decoders turning encoded data into
* raw audio samples.
* invalidated by a call to this function.
*
* Returns: a #GstFlowReturn that should be escalated to caller (of caller)
- *
- * Since: 0.10.36
*/
GstFlowReturn
gst_audio_decoder_finish_frame (GstAudioDecoder * dec, GstBuffer * buf,
* @dec: a #GstAudioDecoder
*
* Returns: a #GstAudioInfo describing the input audio format
- *
- * Since: 0.10.36
*/
GstAudioInfo *
gst_audio_decoder_get_audio_info (GstAudioDecoder * dec)
* @plc: new plc state
*
* Indicates whether or not subclass handles packet loss concealment (plc).
- *
- * Since: 0.10.36
*/
void
gst_audio_decoder_set_plc_aware (GstAudioDecoder * dec, gboolean plc)
* @dec: a #GstAudioDecoder
*
* Returns: currently configured plc handling
- *
- * Since: 0.10.36
*/
gint
gst_audio_decoder_get_plc_aware (GstAudioDecoder * dec)
* @enabled: whether to enable byte to time conversion
*
* Allows baseclass to perform byte to time estimated conversion.
- *
- * Since: 0.10.36
*/
void
gst_audio_decoder_set_estimate_rate (GstAudioDecoder * dec, gboolean enabled)
* @dec: a #GstAudioDecoder
*
* Returns: currently configured byte to time conversion setting
- *
- * Since: 0.10.36
*/
gint
gst_audio_decoder_get_estimate_rate (GstAudioDecoder * dec)
* @dec: a #GstAudioDecoder
*
* Returns: currently configured decoder delay
- *
- * Since: 0.10.36
*/
gint
gst_audio_decoder_get_delay (GstAudioDecoder * dec)
* Sets numbers of tolerated decoder errors, where a tolerated one is then only
* warned about, but more than tolerated will lead to fatal error. Default
* is set to GST_AUDIO_DECODER_MAX_ERRORS.
- *
- * Since: 0.10.36
*/
void
gst_audio_decoder_set_max_errors (GstAudioDecoder * dec, gint num)
* @dec: a #GstAudioDecoder
*
* Returns: currently configured decoder tolerated error count.
- *
- * Since: 0.10.36
*/
gint
gst_audio_decoder_get_max_errors (GstAudioDecoder * dec)
* @max: maximum latency
*
* Sets decoder latency.
- *
- * Since: 0.10.36
*/
void
gst_audio_decoder_set_latency (GstAudioDecoder * dec,
*
* Sets the variables pointed to by @min and @max to the currently configured
* latency.
- *
- * Since: 0.10.36
*/
void
gst_audio_decoder_get_latency (GstAudioDecoder * dec,
* @eos: a pointer to a variable to hold the current eos state
*
* Return current parsing (sync and eos) state.
- *
- * Since: 0.10.36
*/
void
gst_audio_decoder_get_parse_state (GstAudioDecoder * dec,
* and codec are capable and allow handling plc.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_audio_decoder_set_plc (GstAudioDecoder * dec, gboolean enabled)
* Returns: TRUE if packet loss concealment is enabled.
*
* MT safe.
- *
- * Since: 0.10.36
*/
gboolean
gst_audio_decoder_get_plc (GstAudioDecoder * dec)
* Sets decoder minimum aggregation latency.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_audio_decoder_set_min_latency (GstAudioDecoder * dec, gint64 num)
* Returns: aggregation latency.
*
* MT safe.
- *
- * Since: 0.10.36
*/
gint64
gst_audio_decoder_get_min_latency (GstAudioDecoder * dec)
* Configures decoder audio jitter tolerance threshold.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_audio_decoder_set_tolerance (GstAudioDecoder * dec, gint64 tolerance)
* Returns: decoder audio jitter tolerance threshold.
*
* MT safe.
- *
- * Since: 0.10.36
*/
gint64
gst_audio_decoder_get_tolerance (GstAudioDecoder * dec)
* real data.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_audio_decoder_set_drainable (GstAudioDecoder * dec, gboolean enabled)
* Returns: TRUE if drainable handling is enabled.
*
* MT safe.
- *
- * Since: 0.10.36
*/
gboolean
gst_audio_decoder_get_drainable (GstAudioDecoder * dec)
* or based on the input data.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_audio_decoder_set_needs_format (GstAudioDecoder * dec, gboolean enabled)
* Returns: TRUE if required format handling is enabled.
*
* MT safe.
- *
- * Since: 0.10.36
*/
gboolean
gst_audio_decoder_get_needs_format (GstAudioDecoder * dec)
* of the usual CODEC/AUDIO_CODEC tags.
*
* MT safe.
- *
- * Since: 0.10.37
*/
void
gst_audio_decoder_merge_tags (GstAudioDecoder * dec,
* GST_AUDIO_DECODER_SINK_NAME:
*
* The name of the templates for the sink pad.
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_DECODER_SINK_NAME "sink"
/**
* GST_AUDIO_DECODER_SRC_NAME:
*
* The name of the templates for the source pad.
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_DECODER_SRC_NAME "src"
* @obj: base audio codec instance
*
* Gives the pointer to the source #GstPad object of the element.
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_DECODER_SRC_PAD(obj) (((GstAudioDecoder *) (obj))->srcpad)
* @obj: base audio codec instance
*
* Gives the pointer to the sink #GstPad object of the element.
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_DECODER_SINK_PAD(obj) (((GstAudioDecoder *) (obj))->sinkpad)
* @obj: audio decoder instance
*
* Gives the input segment of the element.
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_DECODER_INPUT_SEGMENT(obj) (GST_AUDIO_DECODER_CAST (obj)->input_segment)
* @obj: audio decoder instance
*
* Gives the output segment of the element.
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_DECODER_OUTPUT_SEGMENT(obj) (GST_AUDIO_DECODER_CAST (obj)->output_segment)
* media processing. Otherwise, it is considered a "glitch" and only a warning
* is logged. In either case, @ret is set to the proper value to
* return to upstream/caller (indicating either GST_FLOW_ERROR or GST_FLOW_OK).
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_DECODER_ERROR(el, weight, domain, code, text, debug, ret) \
G_STMT_START { \
* GST_AUDIO_DECODER_MAX_ERRORS:
*
* Default maximum number of errors tolerated before signaling error.
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_DECODER_MAX_ERRORS 10
* GstAudioDecoder:
*
* The opaque #GstAudioDecoder data structure.
- *
- * Since: 0.10.36
*/
struct _GstAudioDecoder
{
* and a not OK flow return will abort downstream pushing.
* @open: Optional.
* Called when the element changes to GST_STATE_READY.
- * Allows opening external resources. Since: 0.10.37.
+ * Allows opening external resources.
* @close: Optional.
* Called when the element changes to GST_STATE_NULL.
- * Allows closing external resources. Since: 0.10.37.
+ * Allows closing external resources.
*
* Subclasses can override any of the available virtual methods or not, as
* needed. At minimum @handle_frame (and likely @set_format) needs to be
* overridden.
- *
- * Since: 0.10.36
*/
struct _GstAudioDecoderClass
{
* SECTION:gstaudioencoder
* @short_description: Base class for audio encoders
* @see_also: #GstBaseTransform
- * @since: 0.10.36
*
* This base class is for audio encoders turning raw audio samples into
* encoded audio data.
* may be invalidated by a call to this function.
*
* Returns: a #GstFlowReturn that should be escalated to caller (of caller)
- *
- * Since: 0.10.36
*/
GstFlowReturn
gst_audio_encoder_finish_frame (GstAudioEncoder * enc, GstBuffer * buf,
* (e.g. muxers).
*
* Returns: a #GstCaps owned by caller
- *
- * Since: 0.10.36
*/
GstCaps *
gst_audio_encoder_proxy_getcaps (GstAudioEncoder * enc, GstCaps * caps)
* @dest_format for encoded audio data. Conversion is possible between
* BYTE and TIME format by using estimated bitrate based on
* @samples and @bytes (and @fmt).
- *
- * Since: 0.10.36
*/
/* FIXME: make gst_audio_encoded_audio_convert() public? */
static gboolean
* @enc: a #GstAudioEncoder
*
* Returns: a #GstAudioInfo describing the input audio format
- *
- * Since: 0.10.36
*/
GstAudioInfo *
gst_audio_encoder_get_audio_info (GstAudioEncoder * enc)
*
* If an exact number of samples is required, gst_audio_encoder_set_frame_samples_max()
* must be called with the same number.
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_set_frame_samples_min (GstAudioEncoder * enc, gint num)
* @enc: a #GstAudioEncoder
*
* Returns: currently minimum requested samples per frame
- *
- * Since: 0.10.36
*/
gint
gst_audio_encoder_get_frame_samples_min (GstAudioEncoder * enc)
*
* If an exact number of samples is required, gst_audio_encoder_set_frame_samples_min()
* must be called with the same number.
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_set_frame_samples_max (GstAudioEncoder * enc, gint num)
}
/**
- * gst_audio_encoder_get_frame_samples_min:
+ * gst_audio_encoder_get_frame_samples_max:
* @enc: a #GstAudioEncoder
*
* Returns: currently maximum requested samples per frame
- *
- * Since: 0.10.36
*/
gint
gst_audio_encoder_get_frame_samples_max (GstAudioEncoder * enc)
*
* Sets max number of frames accepted at once (assumed minimally 1).
* Requires @frame_samples_min and @frame_samples_max to be the equal.
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_set_frame_max (GstAudioEncoder * enc, gint num)
* @enc: a #GstAudioEncoder
*
* Returns: currently configured maximum handled frames
- *
- * Since: 0.10.36
*/
gint
gst_audio_encoder_get_frame_max (GstAudioEncoder * enc)
* @num: lookahead
*
* Sets encoder lookahead (in units of input rate samples)
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_set_lookahead (GstAudioEncoder * enc, gint num)
* @max: maximum latency
*
* Sets encoder latency.
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_set_latency (GstAudioEncoder * enc,
*
* Sets the variables pointed to by @min and @max to the currently configured
* latency.
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_get_latency (GstAudioEncoder * enc,
/**
* gst_audio_encoder_set_headers:
- * @encoder: a #GstAudioEncoder
- * @headers: (transfer full): a list of #GstBuffer containing the codec header
+ * @enc: a #GstAudioEncoder
+ * @headers: (transfer full) (element-type GstBuffer): a list of #GstBuffer containing the codec header
*
* Set the codec headers to be sent downstream whenever requested.
*/
* Enable or disable encoder granule handling.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_set_mark_granule (GstAudioEncoder * enc, gboolean enabled)
* Returns: TRUE if granule marking is enabled.
*
* MT safe.
- *
- * Since: 0.10.36
*/
gboolean
gst_audio_encoder_get_mark_granule (GstAudioEncoder * enc)
* Enable or disable encoder perfect output timestamp preference.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_set_perfect_timestamp (GstAudioEncoder * enc,
* Returns: TRUE if perfect timestamp setting enabled.
*
* MT safe.
- *
- * Since: 0.10.36
*/
gboolean
gst_audio_encoder_get_perfect_timestamp (GstAudioEncoder * enc)
* Sets encoder hard resync handling.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_set_hard_resync (GstAudioEncoder * enc, gboolean enabled)
* Returns: TRUE if hard resync is enabled.
*
* MT safe.
- *
- * Since: 0.10.36
*/
gboolean
gst_audio_encoder_get_hard_resync (GstAudioEncoder * enc)
* Configures encoder audio jitter tolerance threshold.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_set_tolerance (GstAudioEncoder * enc, gint64 tolerance)
* Returns: encoder audio jitter tolerance threshold.
*
* MT safe.
- *
- * Since: 0.10.36
*/
gint64
gst_audio_encoder_get_tolerance (GstAudioEncoder * enc)
* will simply be discarded.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_set_hard_min (GstAudioEncoder * enc, gboolean enabled)
* Returns: TRUE if hard minimum handling is enabled.
*
* MT safe.
- *
- * Since: 0.10.36
*/
gboolean
gst_audio_encoder_get_hard_min (GstAudioEncoder * enc)
* real data.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_set_drainable (GstAudioEncoder * enc, gboolean enabled)
* Returns: TRUE if drainable handling is enabled.
*
* MT safe.
- *
- * Since: 0.10.36
*/
gboolean
gst_audio_encoder_get_drainable (GstAudioEncoder * enc)
* of the usual CODEC/AUDIO_CODEC tags.
*
* MT safe.
- *
- * Since: 0.10.36
*/
void
gst_audio_encoder_merge_tags (GstAudioEncoder * enc,
* GST_AUDIO_ENCODER_SINK_NAME:
*
* the name of the templates for the sink pad
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_ENCODER_SINK_NAME "sink"
/**
* GST_AUDIO_ENCODER_SRC_NAME:
*
* the name of the templates for the source pad
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_ENCODER_SRC_NAME "src"
* @obj: audio encoder instance
*
* Gives the pointer to the source #GstPad object of the element.
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_ENCODER_SRC_PAD(obj) (GST_AUDIO_ENCODER_CAST (obj)->srcpad)
* @obj: audio encoder instance
*
* Gives the pointer to the sink #GstPad object of the element.
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_ENCODER_SINK_PAD(obj) (GST_AUDIO_ENCODER_CAST (obj)->sinkpad)
* @obj: base parse instance
*
* Gives the input segment of the element.
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_ENCODER_INPUT_SEGMENT(obj) (GST_AUDIO_ENCODER_CAST (obj)->input_segment)
* @obj: base parse instance
*
* Gives the output segment of the element.
- *
- * Since: 0.10.36
*/
#define GST_AUDIO_ENCODER_OUTPUT_SEGMENT(obj) (GST_AUDIO_ENCODER_CAST (obj)->output_segment)
* GstAudioEncoder:
*
* The opaque #GstAudioEncoder data structure.
- *
- * Since: 0.10.36
*/
struct _GstAudioEncoder {
GstElement element;
* applied to sink template caps.
* @open: Optional.
* Called when the element changes to GST_STATE_READY.
- * Allows opening external resources. Since: 0.10.37.
+ * Allows opening external resources.
* @close: Optional.
* Called when the element changes to GST_STATE_NULL.
- * Allows closing external resources. Since: 0.10.37.
+ * Allows closing external resources.
*
* Subclasses can override any of the available virtual methods or not, as
* needed. At minimum @set_format and @handle_frame needs to be overridden.
- *
- * Since: 0.10.36
*/
struct _GstAudioEncoderClass {
GstElementClass element_class;
* virtual functions in their class_init function.
*
* Last reviewed on 2007-02-03 (0.10.11.1)
- *
- * Since: 0.10.12
*/
#ifdef HAVE_CONFIG_H
* @allowed_caps as the caps that can be handled.
*
* This function is usually used from within a GObject class_init function.
- *
- * Since: 0.10.12
*/
void
gst_audio_filter_class_add_pad_templates (GstAudioFilterClass * klass,
* GstAudioFilter:
*
* Base class for audio filters with the same format for input and output.
- *
- * Since: 0.10.12
*/
struct _GstAudioFilter {
GstBaseTransform basetransform;
* In addition to the @setup virtual function, you should also override the
* GstBaseTransform::transform and/or GstBaseTransform::transform_ip virtual
* function.
- *
- * Since: 0.10.12
*/
struct _GstAudioFilterClass {
/**
* SECTION:gstaudioiec61937
* @short_description: Utility functions for IEC 61937 payloading
- * @since: 0.10.36
*
* This module contains some helper functions for encapsulating various
* audio formats in IEC 61937 headers and padding.
*
* Returns: the size or 0 if the given @type is not supported or cannot be
* payloaded.
- *
- * Since: 0.10.36
*/
guint
gst_audio_iec61937_frame_size (const GstAudioRingBufferSpec * spec)
*
* Returns: transfer-full: %TRUE if the payloading was successful, %FALSE
* otherwise.
- *
- * Since: 0.10.36
*/
gboolean
gst_audio_iec61937_payload (const guint8 * src, guint src_n, guint8 * dst,
* @buffer: a #GstBuffer
* @to_position: the channel positions of the destination
* @to_channels: The number of channels of the destination
- * @matrix: The matrix coefficients.
*
* Find the #GstAudioDownmixMeta on @buffer for the given destination
* channel positions.
* will be put in @dest_val.
*
* Returns: TRUE if the conversion succeeded.
- *
- * Since: 0.10.22.
*/
gboolean
gst_audio_ring_buffer_convert (GstAudioRingBuffer * buf,
*
* Returns: TRUE if the device could be activated in the requested mode,
* FALSE on error.
- *
- * Since: 0.10.22.
*/
gboolean
gst_audio_ring_buffer_activate (GstAudioRingBuffer * buf, gboolean active)
* MT safe.
*
* Returns: TRUE if the device is active.
- *
- * Since: 0.10.22.
*/
gboolean
gst_audio_ring_buffer_is_active (GstAudioRingBuffer * buf)
* Returns: The number of samples written to the ringbuffer or -1 on error. The
* number of samples written can be less than @out_samples when @buf was interrupted
* with a flush or stop.
- *
- * Since: 0.10.11.
*/
guint
gst_audio_ring_buffer_commit (GstAudioRingBuffer * buf, guint64 * sample,
* the ringbuffer is filled with samples.
*
* MT safe.
- *
- * Since: 0.10.6
*/
void
gst_audio_ring_buffer_may_start (GstAudioRingBuffer * buf, gboolean allowed)
* @stop: stop processing of samples
* @delay: get number of samples queued in device
* @activate: activate the thread that starts pulling and monitoring the
- * consumed segments in the device. Since 0.10.22
+ * consumed segments in the device.
* @commit: write samples into the ringbuffer
- * @clear_all: clear the entire ringbuffer Since 0.10.24
+ * @clear_all: clear the entire ringbuffer.
*
* The vmethods that subclasses can override to implement the ringbuffer.
*/
* @format: #GstStreamVolumeFormat which should be returned
*
* Returns: The current stream volume as linear factor
- *
- * Since: 0.10.25
*/
gdouble
gst_stream_volume_get_volume (GstStreamVolume * volume,
* @volume: #GstStreamVolume that should be used
* @format: #GstStreamVolumeFormat of @val
* @val: Linear volume factor that should be set
- *
- * Since: 0.10.25
*/
void
gst_stream_volume_set_volume (GstStreamVolume * volume,
* @volume: #GstStreamVolume that should be used
*
* Returns: Returns %TRUE if the stream is muted
- *
- * Since: 0.10.25
*/
gboolean
gst_stream_volume_get_mute (GstStreamVolume * volume)
* gst_stream_volume_set_mute:
* @volume: #GstStreamVolume that should be used
* @mute: Mute state that should be set
- *
- * Since: 0.10.25
*/
void
gst_stream_volume_set_mute (GstStreamVolume * volume, gboolean mute)
* @val: Volume in @from format that should be converted
*
* Returns: the converted volume
- *
- * Since: 0.10.25
*/
gdouble
gst_stream_volume_convert_volume (GstStreamVolumeFormat from,
*
* Formulas to convert from a linear to a cubic or dB volume are
* cbrt(val) and 20 * log10 (val).
- *
- * Since: 0.10.25
*/
typedef enum {
GST_STREAM_VOLUME_FORMAT_LINEAR = 0,
* rate.
*
* Returns: The sample rate if @sr_idx is valid, 0 otherwise.
- *
- * Since: 0.10.31
*/
guint
gst_codec_utils_aac_get_sample_rate_from_index (guint sr_idx)
*
* Returns: The profile as a const string and %NULL if the profile could not be
* determined.
- *
- * Since: 0.10.31
*/
const gchar *
gst_codec_utils_aac_get_profile (const guint8 * audio_config, guint len)
*
* Returns: The level as a const string and %NULL if the level could not be
* determined.
- *
- * Since: 0.10.31
*/
const gchar *
gst_codec_utils_aac_get_level (const guint8 * audio_config, guint len)
* If mpegversion is 4, the "base-profile" field is also set in @caps.
*
* Returns: %TRUE if the level and profile could be set, %FALSE otherwise.
- *
- * Since: 0.10.31
*/
gboolean
gst_codec_utils_aac_caps_set_level_and_profile (GstCaps * caps,
* </itemizedlist>
*
* Returns: The profile as a const string, or %NULL if there is an error.
- *
- * Since: 0.10.31
*/
const gchar *
gst_codec_utils_h264_get_profile (const guint8 * sps, guint len)
* same format as for gst_codec_utils_h264_get_profile().
*
* Returns: The level as a const string, or %NULL if there is an error.
- *
- * Since: 0.10.31
*/
const gchar *
gst_codec_utils_h264_get_level (const guint8 * sps, guint len)
* Transform a level string from the caps into the level_idc
*
* Returns: the level_idc or 0 if the level is unknown
- *
- * Since: 0.10.36
*/
guint8
gst_codec_utils_h264_get_level_idc (const gchar * level)
* for more details on the parameters.
*
* Returns: %TRUE if the level and profile could be set, %FALSE otherwise.
- *
- * Since: 0.10.31
*/
gboolean
gst_codec_utils_h264_caps_set_level_and_profile (GstCaps * caps,
* (profile_and_level_indication) is used.
*
* Returns: The profile as a const string, or NULL if there is an error.
- *
- * Since: 0.10.31
*/
const gchar *
gst_codec_utils_mpeg4video_get_profile (const guint8 * vis_obj_seq, guint len)
* (profile_and_level_indication) is used.
*
* Returns: The level as a const string, or NULL if there is an error.
- *
- * Since: 0.10.31
*/
const gchar *
gst_codec_utils_mpeg4video_get_level (const guint8 * vis_obj_seq, guint len)
* parameters.
*
* Returns: %TRUE if the level and profile could be set, %FALSE otherwise.
- *
- * Since: 0.10.31
*/
gboolean
gst_codec_utils_mpeg4video_caps_set_level_and_profile (GstCaps * caps,
* ]|
* </para>
* </refsect2>
- *
- * Since: 0.10.32
*/
#ifdef HAVE_CONFIG_H
* gst_encoding_profile_get_name:
* @profile: a #GstEncodingProfile
*
- * Since: 0.10.32
- *
* Returns: the name of the profile, can be %NULL.
*/
const gchar *
* gst_encoding_profile_get_description:
* @profile: a #GstEncodingProfile
*
- * Since: 0.10.32
- *
* Returns: the description of the profile, can be %NULL.
*/
const gchar *
* gst_encoding_profile_get_format:
* @profile: a #GstEncodingProfile
*
- * Since: 0.10.32
- *
* Returns: (transfer full): the #GstCaps corresponding to the media format used
* in the profile. Unref after usage.
*/
* gst_encoding_profile_get_preset:
* @profile: a #GstEncodingProfile
*
- * Since: 0.10.32
- *
* Returns: the name of the #GstPreset to be used in the profile.
*/
const gchar *
* gst_encoding_profile_get_presence:
* @profile: a #GstEncodingProfile
*
- * Since: 0.10.32
- *
* Returns: The number of times the profile is used in its parent
* container profile. If 0, it is not a mandatory stream.
*/
* gst_encoding_profile_get_restriction:
* @profile: a #GstEncodingProfile
*
- * Since: 0.10.32
- *
* Returns: (transfer full): The restriction #GstCaps to apply before the encoder
* that will be used in the profile. The fields present in restriction caps are
* properties of the raw stream (that is before encoding), such as height and
*
* Set @name as the given name for the @profile. A copy of @name will be made
* internally.
- *
- * Since: 0.10.32
*/
void
gst_encoding_profile_set_name (GstEncodingProfile * profile, const gchar * name)
*
* Set @description as the given description for the @profile. A copy of
* @description will be made internally.
- *
- * Since: 0.10.32
*/
void
gst_encoding_profile_set_description (GstEncodingProfile * profile,
* @format: the media format to use in the profile.
*
* Sets the media format used in the profile.
- *
- * Since: 0.10.32
*/
void
gst_encoding_profile_set_format (GstEncodingProfile * profile, GstCaps * format)
* @preset: the element preset to use
*
* Sets the preset to use for the profile.
- *
- * Since: 0.10.32
*/
void
gst_encoding_profile_set_preset (GstEncodingProfile * profile,
*
* Set the number of time the profile is used in its parent
* container profile. If 0, it is not a mandatory stream
- *
- * Since: 0.10.32
*/
void
gst_encoding_profile_set_presence (GstEncodingProfile * profile, guint presence)
* Set the restriction #GstCaps to apply before the encoder
* that will be used in the profile. See gst_encoding_profile_set_restriction()
* for more about restrictions. Does not apply to #GstEncodingContainerProfile.
- *
- * Since: 0.10.32
*/
void
gst_encoding_profile_set_restriction (GstEncodingProfile * profile,
*
* Returns: The pass number. Starts at 1 for multi-pass. 0 if this is
* not a multi-pass profile
- *
- * Since: 0.10.32
*/
guint
gst_encoding_video_profile_get_pass (GstEncodingVideoProfile * prof)
* gst_encoding_video_profile_get_variableframerate:
* @prof: a #GstEncodingVideoProfile
*
- * Since: 0.10.32
- *
* Returns: Whether non-constant video framerate is allowed for encoding.
*/
gboolean
* Sets the pass number of this video profile. The first pass profile should have
* this value set to 1. If this video profile isn't part of a multi-pass profile,
* you may set it to 0 (the default value).
- *
- * Since: 0.10.32
*/
void
gst_encoding_video_profile_set_pass (GstEncodingVideoProfile * prof, guint pass)
* framerate. If set to %FALSE (default value), then the incoming stream will
* be normalized by dropping/duplicating frames in order to produce a
* constance framerate.
- *
- * Since: 0.10.32
*/
void
gst_encoding_video_profile_set_variableframerate (GstEncodingVideoProfile *
* Checks if @container contains a #GstEncodingProfile identical to
* @profile.
*
- * Since: 0.10.32
- *
* Returns: %TRUE if @container contains a #GstEncodingProfile identical
* to @profile, else %FALSE.
*/
* No copy of @profile will be made, if you wish to use it elsewhere after this
* method you should increment its reference count.
*
- * Since: 0.10.32
- *
* Returns: %TRUE if the @stream was properly added, else %FALSE.
*/
gboolean
*
* Creates a new #GstEncodingContainerProfile.
*
- * Since: 0.10.32
- *
* Returns: The newly created #GstEncodingContainerProfile.
*/
GstEncodingContainerProfile *
* If you wish to use/force a constant framerate please refer to the
* gst_encoding_video_profile_set_variableframerate() documentation.
*
- * Since: 0.10.32
- *
* Returns: the newly created #GstEncodingVideoProfile.
*/
GstEncodingVideoProfile *
* All provided allocatable arguments will be internally copied, so can be
* safely freed/unreferenced after calling this method.
*
- * Since: 0.10.32
- *
* Returns: the newly created #GstEncodingAudioProfile.
*/
GstEncodingAudioProfile *
*
* Checks whether the two #GstEncodingProfile are equal
*
- * Since: 0.10.32
- *
* Returns: %TRUE if @a and @b are equal, else %FALSE.
*/
gboolean
*
* Computes the full output caps that this @profile will be able to consume.
*
- * Since: 0.10.32
- *
* Returns: (transfer full): The full caps the given @profile can consume. Call
* gst_caps_unref() when you are done with the caps.
*/
* gst_encoding_profile_get_type_nick:
* @profile: a #GstEncodingProfile
*
- * Since: 0.10.32
- *
* Returns: the human-readable name of the type of @profile.
*/
const gchar *
* Find the #GstEncodingProfile with the specified name and category.
*
* Returns: (transfer full): The matching #GstEncodingProfile or %NULL.
- *
- * Since: 0.10.32
*/
GstEncodingProfile *
gst_encoding_profile_find (const gchar * targetname, const gchar * profilename,
* subtitles), are currently ignored.
*
* Returns: (transfer full): The new #GstEncodingProfile or %NULL.
- *
- * Since: 0.10.36
*/
GstEncodingProfile *
gst_encoding_profile_from_discoverer (GstDiscovererInfo * info)
*
* The opaque base class object for all encoding profiles. This contains generic
* information like name, description, format and preset.
- *
- * Since: 0.10.32
*/
#define GST_TYPE_ENCODING_PROFILE \
* GstEncodingContainerProfile:
*
* Encoding profiles for containers. Keeps track of a list of #GstEncodingProfile
- *
- * Since: 0.10.32
*/
#define GST_TYPE_ENCODING_CONTAINER_PROFILE \
(gst_encoding_container_profile_get_type ())
* GstEncodingVideoProfile:
*
* Variant of #GstEncodingProfile for video streams, allows specifying the @pass.
- *
- * Since: 0.10.32
*/
#define GST_TYPE_ENCODING_VIDEO_PROFILE \
(gst_encoding_video_profile_get_type ())
* GstEncodingAudioProfile:
*
* Variant of #GstEncodingProfile for audio streams.
- *
- * Since: 0.10.32
*/
#define GST_TYPE_ENCODING_AUDIO_PROFILE \
(gst_encoding_audio_profile_get_type ())
* @profile: a #GstEncodingProfile
*
* Decreases the reference count of the @profile, possibly freeing the @profile.
- *
- * Since: 0.10.32
*/
#define gst_encoding_profile_unref(profile) (g_object_unref ((GObject*) profile))
* @profile: a #GstEncodingProfile
*
* Increases the reference count of the @profile.
- *
- * Since: 0.10.32
*/
#define gst_encoding_profile_ref(profile) (g_object_ref ((GObject*) profile))
* gst_encoding_target_get_name:
* @target: a #GstEncodingTarget
*
- * Since: 0.10.32
- *
* Returns: (transfer none): The name of the @target.
*/
const gchar *
* gst_encoding_target_get_category:
* @target: a #GstEncodingTarget
*
- * Since: 0.10.32
- *
* Returns: (transfer none): The category of the @target. For example:
* #GST_ENCODING_CATEGORY_DEVICE.
*/
* gst_encoding_target_get_description:
* @target: a #GstEncodingTarget
*
- * Since: 0.10.32
- *
* Returns: (transfer none): The description of the @target.
*/
const gchar *
* gst_encoding_target_get_profiles:
* @target: a #GstEncodingTarget
*
- * Since: 0.10.32
- *
* Returns: (transfer none) (element-type GstPbutils.EncodingProfile): A list of
* #GstEncodingProfile(s) this @target handles.
*/
* @target: a #GstEncodingTarget
* @name: the name of the profile to retrieve
*
- * Since: 0.10.32
- *
* Returns: (transfer full): The matching #GstEncodingProfile, or %NULL.
*/
GstEncodingProfile *
* <emphasis>can</emphasis> be a application or user specific category if
* needed.
*
- * Since: 0.10.32
- *
* Returns: (transfer full): The newly created #GstEncodingTarget or %NULL if
* there was an error.
*/
* the profile after calling this method, you should increase its reference
* count.
*
- * Since: 0.10.32
- *
* Returns: %TRUE if the profile was added, else %FALSE.
**/
*
* Opens the provided file and returns the contained #GstEncodingTarget.
*
- * Since: 0.10.32
- *
* Returns: (transfer full): The #GstEncodingTarget contained in the file, else
* %NULL
*/
* If the category name is specified only targets from that category will be
* searched for.
*
- * Since: 0.10.32
- *
* Returns: (transfer full): The #GstEncodingTarget if available, else %NULL.
*/
GstEncodingTarget *
*
* Saves the @target to the provided file location.
*
- * Since: 0.10.32
- *
* Returns: %TRUE if the target was correctly saved, else %FALSE.
**/
*
* Saves the @target to a default user-local directory.
*
- * Since: 0.10.32
- *
* Returns: %TRUE if the target was correctly saved, else %FALSE.
**/
*
* Returns: (transfer full) (element-type gchar*): A list
* of #GstEncodingTarget categories.
- *
- * Since: 0.10.32
*/
GList *
gst_encoding_list_available_categories (void)
* if @categoryname is %NULL.
*
* Returns: (transfer full) (element-type GstEncodingTarget): The list of #GstEncodingTarget
- *
- * Since: 0.10.32
*/
GList *
gst_encoding_list_all_targets (const gchar * categoryname)
*
* When being stored/loaded, targets come from a specific category, like
* #GST_ENCODING_CATEGORY_DEVICE.
- *
- * Since: 0.10.32
*/
#define GST_TYPE_ENCODING_TARGET \
(gst_encoding_target_get_type ())
* @target: a #GstEncodingTarget
*
* Decreases the reference count of the @target, possibly freeing it.
- *
- * Since: 0.10.32
*/
#define gst_encoding_target_unref(target) \
(g_object_unref ((GObject*) target))
* @target: a #GstEncodingTarget
*
* Increases the reference count of the @target.
- *
- * Since: 0.10.32
*/
#define gst_encoding_target_ref(target) \
(g_object_ref ((GObject*) target))
* Returns: (transfer full) (element-type GstPbutils.DiscovererStreamInfo): A #GList of
* matching #GstDiscovererStreamInfo. The caller should free it with
* gst_discoverer_stream_info_list_free().
- *
- * Since: 0.10.31
*/
GList *
gst_discoverer_info_get_streams (GstDiscovererInfo * info, GType streamtype)
* Returns: (transfer full) (element-type GstPbutils.DiscovererStreamInfo): A #GList of
* matching #GstDiscovererStreamInfo. The caller should free it with
* gst_discoverer_stream_info_list_free().
- *
- * Since: 0.10.31
*/
GList *
gst_discoverer_info_get_audio_streams (GstDiscovererInfo * info)
* Returns: (transfer full) (element-type GstPbutils.DiscovererStreamInfo): A #GList of
* matching #GstDiscovererStreamInfo. The caller should free it with
* gst_discoverer_stream_info_list_free().
- *
- * Since: 0.10.31
*/
GList *
gst_discoverer_info_get_video_streams (GstDiscovererInfo * info)
* Returns: (transfer full) (element-type GstPbutils.DiscovererStreamInfo): A #GList of
* matching #GstDiscovererStreamInfo. The caller should free it with
* gst_discoverer_stream_info_list_free().
- *
- * Since: 0.10.36
*/
GList *
gst_discoverer_info_get_subtitle_streams (GstDiscovererInfo * info)
* Returns: (transfer full) (element-type GstPbutils.DiscovererStreamInfo): A #GList of
* matching #GstDiscovererStreamInfo. The caller should free it with
* gst_discoverer_stream_info_list_free().
- *
- * Since: 0.10.31
*/
GList *
gst_discoverer_info_get_container_streams (GstDiscovererInfo * info)
*
* Returns: a human readable name for the stream type of the given @info (ex : "audio",
* "container",...).
- *
- * Since: 0.10.31
*/
const gchar *
gst_discoverer_stream_info_get_stream_type_nick (GstDiscovererStreamInfo * info)
* Returns: (transfer full): the previous #GstDiscovererStreamInfo in a chain.
* %NULL for starting points. Unref with #gst_discoverer_stream_info_unref
* after usage.
- *
- * Since: 0.10.31
*/
GstDiscovererStreamInfo *
gst_discoverer_stream_info_get_previous (GstDiscovererStreamInfo * info)
* Returns: (transfer full): the next #GstDiscovererStreamInfo in a chain. %NULL
* for final streams.
* Unref with #gst_discoverer_stream_info_unref after usage.
- *
- * Since: 0.10.31
*/
GstDiscovererStreamInfo *
gst_discoverer_stream_info_get_next (GstDiscovererStreamInfo * info)
*
* Returns: (transfer full): the #GstCaps of the stream. Unref with
* #gst_caps_unref after usage.
- *
- * Since: 0.10.31
*/
GstCaps *
gst_discoverer_stream_info_get_caps (GstDiscovererStreamInfo * info)
*
* Returns: (transfer none): the tags contained in this stream. If you wish to
* use the tags after the life-time of @info you will need to copy them.
- *
- * Since: 0.10.31
*/
const GstTagList *
gst_discoverer_stream_info_get_tags (GstDiscovererStreamInfo * info)
*
* Returns: (transfer none): the TOC contained in this stream. If you wish to
* use the TOC after the life-time of @info you will need to copy it.
- *
- * Since: 0.11.92
*/
const GstToc *
gst_discoverer_stream_info_get_toc (GstDiscovererStreamInfo * info)
* Returns: (transfer none): additional information regarding the stream (for
* example codec version, profile, etc..). If you wish to use the #GstStructure
* after the life-time of @info you will need to copy it.
- *
- * Since: 0.10.31
*/
const GstStructure *
gst_discoverer_stream_info_get_misc (GstDiscovererStreamInfo * info)
* Returns: (transfer full) (element-type GstPbutils.DiscovererStreamInfo): the list of
* #GstDiscovererStreamInfo this container stream offers.
* Free with gst_discoverer_stream_info_list_free() after usage.
- *
- * Since: 0.10.31
*/
GList *
* @info: a #GstDiscovererAudioInfo
*
* Returns: the number of channels in the stream.
- *
- * Since: 0.10.31
*/
AUDIO_INFO_ACCESSOR_CODE (channels, guint, 0);
* @info: a #GstDiscovererAudioInfo
*
* Returns: the sample rate of the stream in Hertz.
- *
- * Since: 0.10.31
*/
AUDIO_INFO_ACCESSOR_CODE (sample_rate, guint, 0);
* @info: a #GstDiscovererAudioInfo
*
* Returns: the number of bits used per sample in each channel.
- *
- * Since: 0.10.31
*/
AUDIO_INFO_ACCESSOR_CODE (depth, guint, 0);
* @info: a #GstDiscovererAudioInfo
*
* Returns: the average or nominal bitrate of the stream in bits/second.
- *
- * Since: 0.10.31
*/
AUDIO_INFO_ACCESSOR_CODE (bitrate, guint, 0);
* @info: a #GstDiscovererAudioInfo
*
* Returns: the maximum bitrate of the stream in bits/second.
- *
- * Since: 0.10.31
*/
AUDIO_INFO_ACCESSOR_CODE (max_bitrate, guint, 0);
* @info: a #GstDiscovererAudioInfo
*
* Returns: the language of the stream, or NULL if unknown.
- *
- * Since: 0.10.36
*/
AUDIO_INFO_ACCESSOR_CODE (language, const gchar *, NULL);
* @info: a #GstDiscovererVideoInfo
*
* Returns: the width of the video stream in pixels.
- *
- * Since: 0.10.31
*/
VIDEO_INFO_ACCESSOR_CODE (width, guint, 0);
* @info: a #GstDiscovererVideoInfo
*
* Returns: the height of the video stream in pixels.
- *
- * Since: 0.10.31
*/
VIDEO_INFO_ACCESSOR_CODE (height, guint, 0);
* @info: a #GstDiscovererVideoInfo
*
* Returns: the depth in bits of the video stream.
- *
- * Since: 0.10.31
*/
VIDEO_INFO_ACCESSOR_CODE (depth, guint, 0);
* @info: a #GstDiscovererVideoInfo
*
* Returns: the framerate of the video stream (numerator).
- *
- * Since: 0.10.31
*/
VIDEO_INFO_ACCESSOR_CODE (framerate_num, guint, 0);
* @info: a #GstDiscovererVideoInfo
*
* Returns: the framerate of the video stream (denominator).
- *
- * Since: 0.10.31
*/
VIDEO_INFO_ACCESSOR_CODE (framerate_denom, guint, 0);
* @info: a #GstDiscovererVideoInfo
*
* Returns: the Pixel Aspect Ratio (PAR) of the video stream (numerator).
- *
- * Since: 0.10.31
*/
VIDEO_INFO_ACCESSOR_CODE (par_num, guint, 0);
* @info: a #GstDiscovererVideoInfo
*
* Returns: the Pixel Aspect Ratio (PAR) of the video stream (denominator).
- *
- * Since: 0.10.31
*/
VIDEO_INFO_ACCESSOR_CODE (par_denom, guint, 0);
* @info: a #GstDiscovererVideoInfo
*
* Returns: %TRUE if the stream is interlaced, else %FALSE.
- *
- * Since: 0.10.31
*/
gboolean
gst_discoverer_video_info_is_interlaced (const GstDiscovererVideoInfo * info)
* @info: a #GstDiscovererVideoInfo
*
* Returns: the average or nominal bitrate of the video stream in bits/second.
- *
- * Since: 0.10.31
*/
VIDEO_INFO_ACCESSOR_CODE (bitrate, guint, 0);
* @info: a #GstDiscovererVideoInfo
*
* Returns: the maximum bitrate of the video stream in bits/second.
- *
- * Since: 0.10.31
*/
VIDEO_INFO_ACCESSOR_CODE (max_bitrate, guint, 0);
*
* Returns: #TRUE if the video stream corresponds to an image (i.e. only contains
* one frame).
- *
- * Since: 0.10.31
*/
gboolean
gst_discoverer_video_info_is_image (const GstDiscovererVideoInfo * info)
* @info: a #GstDiscovererSubtitleInfo
*
* Returns: the language of the stream, or NULL if unknown.
- *
- * Since: 0.10.36
*/
SUBTITLE_INFO_ACCESSOR_CODE (language, const gchar *, NULL);
*
* Returns: (transfer none): the URI to which this information corresponds to.
* Copy it if you wish to use it after the life-time of @info.
- *
- * Since: 0.10.31
*/
DISCOVERER_INFO_ACCESSOR_CODE (uri, const gchar *, NULL);
* @info: a #GstDiscovererInfo
*
* Returns: the result of the discovery as a #GstDiscovererResult.
- *
- * Since: 0.10.31
*/
DISCOVERER_INFO_ACCESSOR_CODE (result, GstDiscovererResult, GST_DISCOVERER_OK);
* #GstDiscovererStreamInfo.
* This structure can be traversed to see the original hierarchy. Unref with
* gst_discoverer_stream_info_unref() after usage.
- *
- * Since: 0.10.31
*/
GstDiscovererStreamInfo *
* Returns: (transfer full) (element-type GstPbutils.DiscovererStreamInfo): the list of
* all streams contained in the #info. Free after usage
* with gst_discoverer_stream_info_list_free().
- *
- * Since: 0.10.31
*/
GList *
gst_discoverer_info_get_stream_list (GstDiscovererInfo * info)
* @info: a #GstDiscovererInfo
*
* Returns: the duration of the URI in #GstClockTime (nanoseconds).
- *
- * Since: 0.10.31
*/
DISCOVERER_INFO_ACCESSOR_CODE (duration, GstClockTime, GST_CLOCK_TIME_NONE);
* @info: a #GstDiscovererInfo
*
* Returns: the whether the URI is seekable.
- *
- * Since: 0.10.32
*/
DISCOVERER_INFO_ACCESSOR_CODE (seekable, gboolean, FALSE);
* Returns: (transfer none): Miscellaneous information stored as a #GstStructure
* (for example: information about missing plugins). If you wish to use the
* #GstStructure after the life-time of @info, you will need to copy it.
- *
- * Since: 0.10.31
*/
DISCOVERER_INFO_ACCESSOR_CODE (misc, const GstStructure *, NULL);
*
* Returns: (transfer none): all tags contained in the URI. If you wish to use
* the tags after the life-time of @info, you will need to copy them.
- *
- * Since: 0.10.31
*/
DISCOVERER_INFO_ACCESSOR_CODE (tags, const GstTagList *, NULL);
*
* Returns: (transfer none): TOC contained in the URI. If you wish to use
* the TOC after the life-time of @info, you will need to copy it.
- *
- * Since: 0.11.92
*/
DISCOVERER_INFO_ACCESSOR_CODE (toc, const GstToc *, NULL);
* Increments the reference count of @info.
*
* Returns: the same #GstDiscovererInfo object
- *
- * Since: 0.10.31
*/
/**
* @info: a #GstDiscovererInfo
*
* Decrements the reference count of @info.
- *
- * Since: 0.10.31
*/
/**
* Increments the reference count of @info.
*
* Returns: the same #GstDiscovererStreamInfo object
- *
- * Since: 0.10.31
*/
/**
* @info: a #GstDiscovererStreamInfo
*
* Decrements the reference count of @info.
- *
- * Since: 0.10.31
*/
* asks for the discovery to begin (through gst_discoverer_start()).
*
* All the information is returned in a #GstDiscovererInfo structure.
- *
- * Since: 0.10.31
*/
#ifdef HAVE_CONFIG_H
/* properties */
/**
- * GstDiscoverer:timeout
+ * GstDiscoverer:timeout:
*
* The duration (in nanoseconds) after which the discovery of an individual
* URI will timeout.
* Allow asynchronous discovering of URIs to take place.
* A #GMainLoop must be available for #GstDiscoverer to properly work in
* asynchronous mode.
- *
- * Since: 0.10.31
*/
void
gst_discoverer_start (GstDiscoverer * discoverer)
*
* Stop the discovery of any pending URIs and clears the list of
* pending URIS (if any).
- *
- * Since: 0.10.31
*/
void
gst_discoverer_stop (GstDiscoverer * discoverer)
*
* Returns: %TRUE if the @uri was successfully appended to the list of pending
* uris, else %FALSE
- *
- * Since: 0.10.31
*/
gboolean
gst_discoverer_discover_uri_async (GstDiscoverer * discoverer,
*
* Returns: (transfer full): the result of the scanning. Can be %NULL if an
* error occurred.
- *
- * Since: 0.10.31
*/
GstDiscovererInfo *
gst_discoverer_discover_uri (GstDiscoverer * discoverer, const gchar * uri,
* If an error occurred when creating the discoverer, @err will be set
* accordingly and %NULL will be returned. If @err is set, the caller must
* free it when no longer needed using g_error_free().
- *
- * Since: 0.10.31
*/
GstDiscoverer *
gst_discoverer_new (GstClockTime timeout, GError ** err)
* corresponding to the AVI container, which in turn will have a
* #GstDiscovererAudioInfo sub-stream and a #GstDiscovererVideoInfo sub-stream
* for the audio and video streams respectively.
- *
- * Since: 0.10.31
*/
#define gst_discoverer_stream_info_ref(info) ((GstDiscovererStreamInfo*) g_object_ref((GObject*) info))
#define gst_discoverer_stream_info_unref(info) (g_object_unref((GObject*) info))
* GstDiscovererContainerInfo:
*
* #GstDiscovererStreamInfo specific to container streams.
- *
- * Since: 0.10.31
*/
#define GST_TYPE_DISCOVERER_CONTAINER_INFO \
(gst_discoverer_container_info_get_type ())
* GstDiscovererAudioInfo:
*
* #GstDiscovererStreamInfo specific to audio streams.
- *
- * Since: 0.10.31
*/
#define GST_TYPE_DISCOVERER_AUDIO_INFO \
(gst_discoverer_audio_info_get_type ())
* GstDiscovererVideoInfo:
*
* #GstDiscovererStreamInfo specific to video streams (this includes images).
- *
- * Since: 0.10.31
*/
#define GST_TYPE_DISCOVERER_VIDEO_INFO \
(gst_discoverer_video_info_get_type ())
*
* #GstDiscovererStreamInfo specific to subtitle streams (this includes text and
* image based ones).
- *
- * Since: 0.10.36
*/
#define GST_TYPE_DISCOVERER_SUBTITLE_INFO \
(gst_discoverer_subtitle_info_get_type ())
* @GST_DISCOVERER_MISSING_PLUGINS: Some plugins are missing for full discovery
*
* Result values for the discovery process.
- *
- * Since: 0.10.31
*/
typedef enum {
GST_DISCOVERER_OK = 0,
* GstDiscovererInfo:
*
* Structure containing the information of a URI analyzed by #GstDiscoverer.
- *
- * Since: 0.10.31
*/
typedef struct _GstDiscovererInfo GstDiscovererInfo;
* GstDiscoverer:
*
* The #GstDiscoverer structure.
- *
- * Since: 0.10.31
**/
struct _GstDiscoverer {
GObject parent;
* @nano: (out): pointer to a guint to store the nano version number, or %NULL
*
* Gets the version number of the GStreamer Plugins Base libraries.
- *
- * Since: 0.10.31
*/
void
gst_plugins_base_version (guint * major, guint * minor, guint * micro,
* strings, logging, about dialogs ...
*
* Returns: a newly allocated string describing this version of gst-plugins-base
- *
- * Since: 0.10.31
*/
gchar *
gst_plugins_base_version_string (void)
* GST_PLUGINS_BASE_VERSION_MAJOR:
*
* The major version of GStreamer's gst-plugins-base libraries at compile time.
- *
- * Since: 0.10.31
*/
#define GST_PLUGINS_BASE_VERSION_MAJOR (@PACKAGE_VERSION_MAJOR@)
/**
* GST_PLUGINS_BASE_VERSION_MINOR:
*
* The minor version of GStreamer's gst-plugins-base libraries at compile time.
- *
- * Since: 0.10.31
*/
#define GST_PLUGINS_BASE_VERSION_MINOR (@PACKAGE_VERSION_MINOR@)
/**
* GST_PLUGINS_BASE_VERSION_MICRO:
*
* The micro version of GStreamer's gst-plugins-base libraries at compile time.
- *
- * Since: 0.10.31
*/
#define GST_PLUGINS_BASE_VERSION_MICRO (@PACKAGE_VERSION_MICRO@)
/**
*
* The nano version of GStreamer's gst-plugins-base libraries at compile time.
* Actual releases have 0, GIT versions have 1, prerelease versions have 2-...
- *
- * Since: 0.10.31
*/
#define GST_PLUGINS_BASE_VERSION_NANO (@PACKAGE_VERSION_NANO@)
*
* Check whether a GStreamer's gst-plugins-base libraries' version equal to
* or greater than major.minor.micro is present.
- *
- * Since: 0.10.31
*/
#define GST_CHECK_PLUGINS_BASE_VERSION(major,minor,micro) \
(GST_PLUGINS_BASE_VERSION_MAJOR > (major) || \
* ##endif
* ...
* </programlisting>
- *
- * Since: 0.10.12
*/
void
gst_install_plugins_context_set_xid (GstInstallPluginsContext * ctx, guint xid)
*
* Returns: a new #GstInstallPluginsContext. Free with
* gst_install_plugins_context_free() when no longer needed
- *
- * Since: 0.10.12
*/
GstInstallPluginsContext *
gst_install_plugins_context_new (void)
* @ctx: a #GstInstallPluginsContext
*
* Frees a #GstInstallPluginsContext.
- *
- * Since: 0.10.12
*/
void
gst_install_plugins_context_free (GstInstallPluginsContext * ctx)
* installed but no suitable video decoder and no suitable audio decoder).
*
* Returns: result code whether an external installer could be started
- *
- * Since: 0.10.12
*/
GstInstallPluginsReturn
* gst_install_plugins_async() instead of this function.
*
* Returns: the result of the installation.
- *
- * Since: 0.10.12
*/
GstInstallPluginsReturn
gst_install_plugins_sync (gchar ** details, GstInstallPluginsContext * ctx)
* in debugging.
*
* Returns: a descriptive string for the status code in @ret
- *
- * Since: 0.10.12
*/
const gchar *
gst_install_plugins_return_get_name (GstInstallPluginsReturn ret)
* is currently in progress.
*
* Returns: TRUE if plugin installation is in progress, otherwise FALSE
- *
- * Since: 0.10.12
*/
gboolean
gst_install_plugins_installation_in_progress (void)
* exists.
*
* Returns: TRUE if plugin installation is likely to be supported.
- *
- * Since: 0.10.15
*/
gboolean
gst_install_plugins_supported (void)
*
* These codes indicate success or failure of starting an external installer
* program and to what extent the requested plugins could be installed.
- *
- * Since: 0.10.12
*/
typedef enum {
/* Return codes from the installer. Returned by gst_install_plugins_sync(),
*
* Opaque context structure for the plugin installation. Use the provided
* API to set details on it.
- *
- * Since: 0.10.12
*/
#define GST_TYPE_INSTALL_PLUGINS_CONTEXT (gst_install_plugins_context_get_type())
* The prototype of the callback function that will be called once the
* external plugin installer program has returned. You only need to provide
* a callback function if you are using the asynchronous interface.
- *
- * Since: 0.10.12
*/
typedef void (*GstInstallPluginsResultFunc) (GstInstallPluginsReturn result,
gpointer user_data);
*
* Returns: a newly-allocated detail string, or NULL on error. Free string
* with g_free() when not needed any longer.
- *
- * Since: 0.10.15
*/
gchar *
gst_missing_uri_source_installer_detail_new (const gchar * protocol)
*
* Returns: a newly-allocated detail string, or NULL on error. Free string
* with g_free() when not needed any longer.
- *
- * Since: 0.10.15
*/
gchar *
gst_missing_uri_sink_installer_detail_new (const gchar * protocol)
*
* Returns: a newly-allocated detail string, or NULL on error. Free string
* with g_free() when not needed any longer.
- *
- * Since: 0.10.15
*/
gchar *
gst_missing_element_installer_detail_new (const gchar * factory_name)
*
* Returns: a newly-allocated detail string, or NULL on error. Free string
* with g_free() when not needed any longer.
- *
- * Since: 0.10.15
*/
gchar *
gst_missing_decoder_installer_detail_new (const GstCaps * decode_caps)
*
* Returns: a newly-allocated detail string, or NULL on error. Free string
* with g_free() when not needed any longer.
- *
- * Since: 0.10.15
*/
gchar *
gst_missing_encoder_installer_detail_new (const GstCaps * encode_caps)
*
* <refsect2>
* <para>
- * libgstpbutils is a general utility library for plugins and applications,
- * available since gst-plugins-base 0.10.12. It currently provides the
+ * libgstpbutils is a general utility library for plugins and applications.
+ * It currently provides the
* following:
* </para>
* <itemizedlist>
*
* This function may be called multiple times. It will do nothing if the
* library has already been initialised.
- *
- * Since: 0.10.12
*/
void
gst_pb_utils_init (void)
* @tag: fourcc of the chunk (returned by this function).
* @chunk_data: buffer (returned by this function).
*
- * Reads a single chunk of data. Since 0.10.8 'JUNK' chunks
- * are skipped automatically.
+ * Reads a single chunk of data. 'JUNK' chunks are skipped
+ * automatically.
*
* Returns: flow status.
*/
* </refsect2>
*
* Last reviewed on 2007-03-26 (0.10.13)
- *
- * Since: 0.10.13
*/
#include <string.h>
* Get the sender SSRC field of the RTPFB or PSFB @packet.
*
* Returns: the sender SSRC.
- *
- * Since: 0.10.23
*/
guint32
gst_rtcp_packet_fb_get_sender_ssrc (GstRTCPPacket * packet)
* @ssrc: a sender SSRC
*
* Set the sender SSRC field of the RTPFB or PSFB @packet.
- *
- * Since: 0.10.23
*/
void
gst_rtcp_packet_fb_set_sender_ssrc (GstRTCPPacket * packet, guint32 ssrc)
* Get the media SSRC field of the RTPFB or PSFB @packet.
*
* Returns: the media SSRC.
- *
- * Since: 0.10.23
*/
guint32
gst_rtcp_packet_fb_get_media_ssrc (GstRTCPPacket * packet)
* @ssrc: a media SSRC
*
* Set the media SSRC field of the RTPFB or PSFB @packet.
- *
- * Since: 0.10.23
*/
void
gst_rtcp_packet_fb_set_media_ssrc (GstRTCPPacket * packet, guint32 ssrc)
* Get the feedback message type of the FB @packet.
*
* Returns: The feedback message type.
- *
- * Since: 0.10.23
*/
GstRTCPFBType
gst_rtcp_packet_fb_get_type (GstRTCPPacket * packet)
* @type: the #GstRTCPFBType to set
*
* Set the feedback message type of the FB @packet.
- *
- * Since: 0.10.23
*/
void
gst_rtcp_packet_fb_set_type (GstRTCPPacket * packet, GstRTCPFBType type)
* key in a #GstStructure containing SDES items.
*
* Returns: the string equivalent of @type
- *
- * Since: 0.10.26
*/
const gchar *
gst_rtcp_sdes_type_to_name (GstRTCPSDESType type)
*
* Returns: the #GstRTCPSDESType for @name or #GST_RTCP_SDES_PRIV when @name
* is a private sdes item.
- *
- * Since: 0.10.26
*/
GstRTCPSDESType
gst_rtcp_sdes_name_to_type (const gchar * name)
* RTPFB or PSFB @packet.
*
* Returns: The length of the FCI in 32-bit words.
- *
- * Since: 0.10.31
*/
guint16
gst_rtcp_packet_fb_get_fci_length (GstRTCPPacket * packet)
* RTPFB or PSFB @packet.
*
* Returns: %TRUE if there was enough space in the packet to add this much FCI
- *
- * Since: 0.10.31
*/
gboolean
gst_rtcp_packet_fb_set_fci_length (GstRTCPPacket * packet, guint16 wordlen)
* Get the Feedback Control Information attached to a RTPFB or PSFB @packet.
*
* Returns: a pointer to the FCI
- *
- * Since: 0.10.31
*/
guint8 *
gst_rtcp_packet_fb_get_fci (GstRTCPPacket * packet)
* @GST_RTCP_TYPE_SDES: Source description
* @GST_RTCP_TYPE_BYE: Goodbye
* @GST_RTCP_TYPE_APP: Application defined
- * @GST_RTCP_TYPE_RTPFB: Transport layer feedback. Since: 0.10.23
- * @GST_RTCP_TYPE_PSFB: Payload-specific feedback. Since: 0.10.23
+ * @GST_RTCP_TYPE_RTPFB: Transport layer feedback.
+ * @GST_RTCP_TYPE_PSFB: Payload-specific feedback.
*
* Different RTCP packet types.
*/
* @GST_RTCP_PSFB_TYPE_VBCN: Video Back Channel Message
*
* Different types of feedback messages.
- *
- * Since: 0.10.23
*/
typedef enum
{
* @sample_size: Size per sample in bits.
*
* Sets the options for sample based audio codecs.
- *
- * Since: 0.10.18
*/
void
gst_rtp_base_audio_payload_set_samplebits_options (GstRTPBaseAudioPayload
* the buffer downstream.
*
* Returns: a #GstFlowReturn
- *
- * Since: 0.10.13
*/
GstFlowReturn
gst_rtp_base_audio_payload_push (GstRTPBaseAudioPayload * baseaudiopayload,
* -1, the timestamp will be calculated automatically.
*
* Returns: a #GstFlowReturn
- *
- * Since: 0.10.25
*/
GstFlowReturn
gst_rtp_base_audio_payload_flush (GstRTPBaseAudioPayload * baseaudiopayload,
* Gets the internal adapter used by the depayloader.
*
* Returns: a #GstAdapter.
- *
- * Since: 0.10.13
*/
GstAdapter *
gst_rtp_base_audio_payload_get_adapter (GstRTPBaseAudioPayload
* @out_list.
*
* Returns: a #GstFlowReturn.
- *
- * Since: 0.10.32
*/
GstFlowReturn
gst_rtp_base_depayload_push_list (GstRTPBaseDepayload * filter,
gboolean (*packet_lost) (GstRTPBaseDepayload *filter, GstEvent *event);
/* the default implementation does the default actions for events but
- * implementation can override.
- * Since: 0.10.32 */
+ * implementation can override. */
gboolean (*handle_event) (GstRTPBaseDepayload * filter, GstEvent * event);
/*< private >*/
* GstRTPBaseAudioPayload:min-ptime:
*
* Minimum duration of the packet data in ns (can't go above MTU)
- *
- * Since: 0.10.13
**/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_MIN_PTIME,
g_param_spec_int64 ("min-ptime", "Min packet time",
* option is disabled, RTP timestamps are generated from the GStreamer
* timestamps, which could result in RTP timestamps that don't increment with
* the amount of data in the packet.
- *
- * Since: 0.10.25
*/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PERFECT_RTPTIME,
g_param_spec_boolean ("perfect-rtptime", "Perfect RTP Time",
* GstRTPBaseAudioPayload:ptime-multiple:
*
* Force buffers to be multiples of this duration in ns (0 disables)
- *
- * Since: 0.10.29
**/
g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_PTIME_MULTIPLE,
g_param_spec_int64 ("ptime-multiple", "Packet time multiple",
* This function takes ownership of @list.
*
* Returns: a #GstFlowReturn.
- *
- * Since: 0.10.24
*/
GstFlowReturn
gst_rtp_base_payload_push_list (GstRTPBasePayload * payload,
* with @bits, @data and @wordlen unchanged.
*
* Returns: TRUE if @buffer had the extension bit set.
- *
- * Since: 0.10.15
*/
gboolean
gst_rtp_buffer_get_extension_data (GstRTPBuffer * rtp, guint16 * bits,
* large enough.
*
* Returns: True if done.
- *
- * Since: 0.10.18
*/
gboolean
gst_rtp_buffer_set_extension_data (GstRTPBuffer * rtp, guint16 bits,
* If @len is -1 the total payload starting from @offset if subbuffered.
*
* Returns: A new buffer with the specified data of the payload.
- *
- * Since: 0.10.10
*/
GstBuffer *
gst_rtp_buffer_get_payload_subbuffer (GstRTPBuffer * rtp, guint offset,
*
* Returns: the default clock rate or -1 if the payload type is not static or
* the clock-rate is undefined.
- *
- * Since: 0.10.13
*/
guint32
gst_rtp_buffer_default_clock_rate (guint8 payload_type)
*
* Returns: a negative value if @seqnum1 is bigger than @seqnum2, 0 if they
* are equal or a positive value if @seqnum1 is smaller than @segnum2.
- *
- * Since: 0.10.15
*/
gint
gst_rtp_buffer_compare_seqnum (guint16 seqnum1, guint16 seqnum2)
* value even in the case where there is a timestamp wraparound.
*
* Returns: The extended timestamp of @timestamp.
- *
- * Since: 0.10.15
*/
guint64
gst_rtp_buffer_ext_timestamp (guint64 * exttimestamp, guint32 timestamp)
* return the nth extension with the requested id.
*
* Returns: TRUE if @buffer had the requested header extension
- *
- * Since: 0.10.31
*/
gboolean
* return the nth extension with the requested id.
*
* Returns: TRUE if @buffer had the requested header extension
- *
- * Since: 0.10.31
*/
gboolean
* gst_rtp_buffer_add_extension_twobytes_header()
*
* Returns: %TRUE if header extension could be added
- *
- * Since: 0.10.31
*/
gboolean
* gst_rtp_buffer_add_extension_onebyte_header()
*
* Returns: %TRUE if header extension could be added
- *
- * Since: 0.10.31
*/
gboolean
* @socket which should be used before starting to read new data.
*
* Returns: #GST_RTSP_OK when @conn contains a valid connection.
- *
- * Since: 0.10.25
*/
GstRTSPResult
gst_rtsp_connection_create_from_socket (GSocket * socket, const gchar * ip,
* handling communication on new socket.
*
* Returns: #GST_RTSP_OK when @conn contains a valid connection.
- *
- * Since: 0.10.23
*/
GstRTSPResult
gst_rtsp_connection_accept (GSocket * socket, GstRTSPConnection ** conn,
* This function can be cancelled with gst_rtsp_connection_flush().
*
* Returns: #GST_RTSP_OK on success.
- *
- * Since: 0.10.15
*/
GstRTSPResult
gst_rtsp_connection_poll (GstRTSPConnection * conn, GstRTSPEvent events,
* Set the proxy host and port.
*
* Returns: #GST_RTSP_OK.
- *
- * Since: 0.10.23
*/
GstRTSPResult
gst_rtsp_connection_set_proxy (GstRTSPConnection * conn,
* #GST_RTSP_AUTH_DIGEST, directives should be taken from the digest challenge
* in the WWW-Authenticate response header and can include realm, domain,
* nonce, opaque, stale, algorithm, qop as per RFC2617.
- *
- * Since: 0.10.20
*/
void
gst_rtsp_connection_set_auth_param (GstRTSPConnection * conn,
* @conn: a #GstRTSPConnection
*
* Clear the list of authentication directives stored in @conn.
- *
- * Since: 0.10.20
*/
void
gst_rtsp_connection_clear_auth_params (GstRTSPConnection * conn)
* Configure @conn to use the specified DSCP value.
*
* Returns: #GST_RTSP_OK on success.
- *
- * Since: 0.10.20
*/
GstRTSPResult
gst_rtsp_connection_set_qos_dscp (GstRTSPConnection * conn, guint qos_dscp)
*
* Returns: The URL. This value remains valid until the
* connection is freed.
- *
- * Since: 0.10.23
*/
GstRTSPUrl *
gst_rtsp_connection_get_url (const GstRTSPConnection * conn)
*
* Returns: The IP address as a string. this value remains valid until the
* connection is closed.
- *
- * Since: 0.10.20
*/
const gchar *
gst_rtsp_connection_get_ip (const GstRTSPConnection * conn)
* @ip: an ip address
*
* Set the IP address of the server.
- *
- * Since: 0.10.23
*/
void
gst_rtsp_connection_set_ip (GstRTSPConnection * conn, const gchar * ip)
*
* Returns: the file descriptor used for reading or %NULL on error. The file
* descriptor remains valid until the connection is closed.
- *
- * Since: 0.10.23
*/
GSocket *
gst_rtsp_connection_get_read_socket (const GstRTSPConnection * conn)
*
* Returns: the file descriptor used for writing or NULL on error. The file
* descriptor remains valid until the connection is closed.
- *
- * Since: 0.10.23
*/
GSocket *
gst_rtsp_connection_get_write_socket (const GstRTSPConnection * conn)
* By setting the HTTP mode to %TRUE the message parsing will support HTTP
* messages in addition to the RTSP messages. It will also disable the
* automatic handling of setting up an HTTP tunnel.
- *
- * Since: 0.10.25
*/
void
gst_rtsp_connection_set_http_mode (GstRTSPConnection * conn, gboolean enable)
*
* Set the HTTP tunneling state of the connection. This must be configured before
* the @conn is connected.
- *
- * Since: 0.10.23
*/
void
gst_rtsp_connection_set_tunneled (GstRTSPConnection * conn, gboolean tunneled)
* Get the tunneling state of the connection.
*
* Returns: if @conn is using HTTP tunneling.
- *
- * Since: 0.10.23
*/
gboolean
gst_rtsp_connection_is_tunneled (const GstRTSPConnection * conn)
* Get the tunnel session id the connection.
*
* Returns: returns a non-empty string if @conn is being tunneled over HTTP.
- *
- * Since: 0.10.23
*/
const gchar *
gst_rtsp_connection_get_tunnelid (const GstRTSPConnection * conn)
* @conn.
*
* Returns: return GST_RTSP_OK on success.
- *
- * Since: 0.10.23
*/
GstRTSPResult
gst_rtsp_connection_do_tunnel (GstRTSPConnection * conn,
*
* Returns: a #GstRTSPWatch that can be used for asynchronous RTSP
* communication. Free with gst_rtsp_watch_unref () after usage.
- *
- * Since: 0.10.23
*/
GstRTSPWatch *
gst_rtsp_watch_new (GstRTSPConnection * conn,
*
* Reset @watch, this is usually called after gst_rtsp_connection_do_tunnel()
* when the file descriptors of the connection might have changed.
- *
- * Since: 0.10.23
*/
void
gst_rtsp_watch_reset (GstRTSPWatch * watch)
* Adds a #GstRTSPWatch to a context so that it will be executed within that context.
*
* Returns: the ID (greater than 0) for the watch within the GMainContext.
- *
- * Since: 0.10.23
*/
guint
gst_rtsp_watch_attach (GstRTSPWatch * watch, GMainContext * context)
*
* Decreases the reference count of @watch by one. If the resulting reference
* count is zero the watch and associated memory will be destroyed.
- *
- * Since: 0.10.23
*/
void
gst_rtsp_watch_unref (GstRTSPWatch * watch)
* This function will take ownership of @data and g_free() it after use.
*
* Returns: #GST_RTSP_OK on success.
- *
- * Since: 0.10.25
*/
GstRTSPResult
gst_rtsp_watch_write_data (GstRTSPWatch * watch, const guint8 * data,
* callback.
*
* Returns: #GST_RTSP_OK on success.
- *
- * Since: 0.10.25
*/
GstRTSPResult
gst_rtsp_watch_send_message (GstRTSPWatch * watch, GstRTSPMessage * message,
* you usually pair the tunnelid of this connection with the saved one using
* gst_rtsp_connection_do_tunnel().
* @error_full: callback when an error occured with more information than
- * the @error callback. Since 0.10.25
+ * the @error callback.
* @tunnel_lost: callback when the post connection of a tunnel is closed.
- * Since 0.10.29
*
* Callback functions from a #GstRTSPWatch.
- *
- * Since: 0.10.23
*/
typedef struct {
GstRTSPResult (*message_received) (GstRTSPWatch *watch, GstRTSPMessage *message,
* Convert @options to a string.
*
* Returns: a new string of @options. g_free() after usage.
- *
- * Since: 0.10.23
*/
gchar *
gst_rtsp_options_as_text (GstRTSPMethod options)
* Check whether @field may appear multiple times in a message.
*
* Returns: %TRUE if multiple headers are allowed.
- *
- * Since: 0.10.25
*/
gboolean
gst_rtsp_header_allow_multiple (GstRTSPHeaderField field)
* GstRTSPVersion:
* @GST_RTSP_VERSION_INVALID: unknown/invalid version
* @GST_RTSP_VERSION_1_0: version 1.0
- * @GST_RTSP_VERSION_1_1: version 1.1. Since 0.10.25
+ * @GST_RTSP_VERSION_1_1: version 1.1.
*
* The supported RTSP versions.
*/
* @GST_RTSP_SETUP: the SETUP method
* @GST_RTSP_SET_PARAMETER: the SET_PARAMETER method
* @GST_RTSP_TEARDOWN: the TEARDOWN method
- * @GST_RTSP_GET: the GET method (HTTP). Since 0.10.25
- * @GST_RTSP_POST: the POST method (HTTP). Since 0.10.25
+ * @GST_RTSP_GET: the GET method (HTTP).
+ * @GST_RTSP_POST: the POST method (HTTP).
*
* The different supported RTSP methods.
*/
* ownership of @value.
*
* Returns: a #GstRTSPResult.
- *
- * Since: 0.10.23
*/
GstRTSPResult
gst_rtsp_message_take_header (GstRTSPMessage * msg, GstRTSPHeaderField field,
* @GST_RTSP_MESSAGE_INVALID: invalid message type
* @GST_RTSP_MESSAGE_REQUEST: RTSP request message
* @GST_RTSP_MESSAGE_RESPONSE: RTSP response message
- * @GST_RTSP_MESSAGE_HTTP_REQUEST: HTTP request message. Since 0.10.25
- * @GST_RTSP_MESSAGE_HTTP_RESPONSE: HTTP response message. Since 0.10.25
+ * @GST_RTSP_MESSAGE_HTTP_REQUEST: HTTP request message.
+ * @GST_RTSP_MESSAGE_HTTP_RESPONSE: HTTP response message.
* @GST_RTSP_MESSAGE_DATA: data message
*
* The type of a message.
* Convert @range into a string representation.
*
* Returns: The string representation of @range. g_free() after usage.
- *
- * Since: 0.10.23
*/
gchar *
gst_rtsp_range_to_string (const GstRTSPTimeRange * range)
* @GST_RTSP_LOWER_TRANS_UDP: stream data over UDP
* @GST_RTSP_LOWER_TRANS_UDP_MCAST: stream data over UDP multicast
* @GST_RTSP_LOWER_TRANS_TCP: stream data over TCP
- * @GST_RTSP_LOWER_TRANS_HTTP: stream data tunneled over HTTP. Since: 0.10.23
+ * @GST_RTSP_LOWER_TRANS_HTTP: stream data tunneled over HTTP.
*
* The different transport methods.
*/
* Make a copy of @url.
*
* Returns: a copy of @url. Free with gst_rtsp_url_free () after usage.
- *
- * Since: 0.10.22
*/
GstRTSPUrl *
gst_rtsp_url_copy (const GstRTSPUrl * url)
* will usually be the empty string.
*
* Returns: a string vector. g_strfreev() after usage.
- *
- * Since: 0.10.32
*/
gchar **
gst_rtsp_url_decode_path_components (const GstRTSPUrl * url)
* Check if the given @addr is a multicast address.
*
* Returns: TRUE when @addr is multicast.
- *
- * Since: 0.10.32
*/
gboolean
gst_sdp_address_is_multicast (const gchar * nettype, const gchar * addrtype,
* http://tools.ietf.org/html/draft-fujikawa-sdp-url-01
*
* Returns: #GST_SDP_OK on success.
- *
- * Since: 0.10.31
*/
GstSDPResult
gst_sdp_message_parse_uri (const gchar * uri, GstSDPMessage * msg)
* Where each value is url encoded.
*
* Returns: a uri for @msg.
- *
- * Since: 0.10.31
*/
gchar *
gst_sdp_message_as_uri (const gchar * scheme, const GstSDPMessage * msg)
* GST_SDP_BWTYPE_RS:
*
* RTCP bandwidth allocated to active data senders (RFC 3556).
- *
- * Since: 0.10.15
*/
#define GST_SDP_BWTYPE_RS "RS"
/**
* GST_SDP_BWTYPE_RR:
*
* RTCP bandwidth allocated to data receivers (RFC 3556).
- *
- * Since: 0.10.15
*/
#define GST_SDP_BWTYPE_RR "RR"
/**
* GST_SDP_BWTYPE_TIAS:
*
* Transport Independent Application Specific Maximum bandwidth (RFC 3890).
- *
- * Since: 0.10.30
*/
#define GST_SDP_BWTYPE_TIAS "TIAS"
* the tags IFD and is followed by the data pointed by the tag entries.
*
* Returns: A GstBuffer containing the tag entries followed by the tag data
- *
- * Since: 0.10.30
*/
GstBuffer *
gst_tag_list_to_exif_buffer (const GstTagList * taglist, gint byte_order,
* is put in the beginning of the buffer.
*
* Returns: A GstBuffer containing the data
- *
- * Since: 0.10.30
*/
GstBuffer *
gst_tag_list_to_exif_buffer_with_tiff_header (const GstTagList * taglist)
* start
*
* Returns: The parsed taglist
- *
- * Since: 0.10.30
*/
GstTagList *
gst_tag_list_from_exif_buffer (GstBuffer * buffer, gint byte_order,
* Parses the exif tags starting with a tiff header structure.
*
* Returns: The taglist
- *
- * Since: 0.10.30
*/
GstTagList *
gst_tag_list_from_exif_buffer_with_tiff_header (GstBuffer * buffer)
* more information on image tags in GStreamer.
*
* Returns: %TRUE if the image was processed, otherwise %FALSE
- *
- * Since: 0.10.20
*/
gboolean
gst_tag_list_add_id3_image (GstTagList * tag_list, const guint8 * image_data,
* @GST_TAG_DEMUX_RESULT_OK : parsed tag successfully
*
* Result values from the parse_tag virtual function.
- *
- * Since: 0.10.15
*/
typedef enum {
GST_TAG_DEMUX_RESULT_BROKEN_TAG,
* @element: parent element
*
* Opaque #GstTagDemux structure.
- *
- * Since: 0.10.15
*/
struct _GstTagDemux
{
*
* The #GstTagDemuxClass structure. See documentation at beginning of section
* for details about what subclasses need to override and do.
- *
- * Since: 0.10.15
*/
struct _GstTagDemuxClass
{
* </itemizedlist>
* </para>
* </refsect2>
- *
- * Since 0.10.36
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
* @element: parent element
*
* Opaque #GstTagMux structure.
- *
- * Since: 0.10.36
*/
struct _GstTagMux {
GstElement element;
*
* The #GstTagMuxClass structure. Subclasses need to override at least one
* of the two render vfuncs.
- *
- * Since: 0.10.36
*/
struct _GstTagMuxClass {
GstElementClass parent_class;
* given taglist @list.
*
* Unknown vorbiscomment tags will be added to the tag list in form
- * of a #GST_TAG_EXTENDED_COMMENT (since 0.10.10 at least).
+ * of a #GST_TAG_EXTENDED_COMMENT.
*/
void
gst_vorbis_tag_add (GstTagList * list, const gchar * tag, const gchar * value)
*
* Returns: (transfer none): a %NULL terminated array of strings with the
* schema names
- *
- * Since: 0.10.33
*/
const gchar **
gst_tag_xmp_list_schemas (void)
* Parse a xmp packet into a taglist.
*
* Returns: new taglist or %NULL, free the list when done
- *
- * Since: 0.10.29
*/
GstTagList *
gst_tag_list_from_xmp_buffer (GstBuffer * buffer)
* be used
*
* Returns: new buffer or %NULL, unref the buffer when done
- *
- * Since: 0.10.33
*/
GstBuffer *
gst_tag_list_to_xmp_buffer_full (const GstTagList * list, gboolean read_only,
* Formats a taglist as a xmp packet.
*
* Returns: new buffer or %NULL, unref the buffer when done
- *
- * Since: 0.10.29
*/
GstBuffer *
gst_tag_list_to_xmp_buffer (const GstTagList * list, gboolean read_only)
* i.e. at least #GST_TAG_ID3V2_HEADER_SIZE (10) bytes;
*
* Returns: Size of tag, or 0 if header is invalid or too small.
- *
- * Since: 0.10.36
*/
guint
gst_tag_get_id3v2_tag_size (GstBuffer * buffer)
*
* Returns: A new #GstTagList with all tags that could be extracted from the
* given vorbiscomment buffer or NULL on error.
- *
- * Since: 0.10.36
*/
GstTagList *
gst_tag_list_from_id3v2_tag (GstBuffer * buffer)
*
* Returns: (transfer full): NULL-terminated string array with two-letter
* language codes. Free with g_strfreev() when no longer needed.
- *
- * Since: 0.10.26
*/
gchar **
gst_tag_get_language_codes (void)
* not be mapped to a language name. The returned string must not be
* modified and does not need to freed; it will stay valid until the
* application is terminated.
- *
- * Since: 0.10.26
*/
const gchar *
gst_tag_get_language_name (const gchar * language_code)
* Returns: two-letter ISO-639-1 language code string that maps to @lang_code,
* or NULL if no mapping is known. The returned string must not be
* modified or freed.
- *
- * Since: 0.10.26
*/
const gchar *
gst_tag_get_language_code_iso_639_1 (const gchar * lang_code)
* Returns: three-letter ISO-639-2 language code string that maps to @lang_code,
* or NULL if no mapping is known. The returned string must not be
* modified or freed.
- *
- * Since: 0.10.26
*/
const gchar *
gst_tag_get_language_code_iso_639_2T (const gchar * lang_code)
* Returns: three-letter ISO-639-2 language code string that maps to @lang_code,
* or NULL if no mapping is known. The returned string must not be
* modified or freed.
- *
- * Since: 0.10.26
*/
const gchar *
gst_tag_get_language_code_iso_639_2B (const gchar * lang_code)
*
* Returns: TRUE if the two- or three-letter language code in @lang_code
* is a valid ISO-639 language code.
- *
- * Since: 0.10.37
*/
gboolean
gst_tag_check_language_code (const gchar * lang_code)
*
* Returns: (transfer full): NULL-terminated array of license strings. Free
* with g_strfreev() when no longer needed.
- *
- * Since: 0.10.36
*/
gchar **
gst_tag_get_licenses (void)
* a license in their most general form.
*
* Returns: the flags of the license, or 0 if the license is unknown
- *
- * Since: 0.10.36
*/
GstTagLicenseFlags
gst_tag_get_license_flags (const gchar * license_ref)
* such as e.g. "CC BY-NC-ND 2.0 UK".
*
* Returns: the nick name of the license, or NULL if the license is unknown
- *
- * Since: 0.10.36
*/
const gchar *
gst_tag_get_license_nick (const gchar * license_ref)
*
* Returns: the title of the license, or NULL if the license is unknown or
* no title is available.
- *
- * Since: 0.10.36
*/
const gchar *
gst_tag_get_license_title (const gchar * license_ref)
*
* Returns: the description of the license, or NULL if the license is unknown
* or a description is not available.
- *
- * Since: 0.10.36
*/
const gchar *
gst_tag_get_license_description (const gchar * license_ref)
*
* Returns: the jurisdiction code of the license, or NULL if the license is
* unknown or is not specific to a particular jurisdiction.
- *
- * Since: 0.10.36
*/
const gchar *
gst_tag_get_license_jurisdiction (const gchar * license_ref)
*
* Returns: the version of the license, or NULL if the license is not known or
* has no version
- *
- * Since: 0.10.36
*/
const gchar *
gst_tag_get_license_version (const gchar * license_ref)
/* Tag names */
/**
- * GST_TAG_MUSICBRAINZ_TRACKID
+ * GST_TAG_MUSICBRAINZ_TRACKID:
*
* MusicBrainz track ID
*/
#define GST_TAG_MUSICBRAINZ_TRACKID "musicbrainz-trackid"
/**
- * GST_TAG_MUSICBRAINZ_ARTISTID
+ * GST_TAG_MUSICBRAINZ_ARTISTID:
*
* MusicBrainz artist ID
*/
#define GST_TAG_MUSICBRAINZ_ARTISTID "musicbrainz-artistid"
/**
- * GST_TAG_MUSICBRAINZ_ALBUMID
+ * GST_TAG_MUSICBRAINZ_ALBUMID:
*
* MusicBrainz album ID
*/
#define GST_TAG_MUSICBRAINZ_ALBUMID "musicbrainz-albumid"
/**
- * GST_TAG_MUSICBRAINZ_ALBUMARTISTID
+ * GST_TAG_MUSICBRAINZ_ALBUMARTISTID:
*
* MusicBrainz album artist ID
*/
#define GST_TAG_MUSICBRAINZ_ALBUMARTISTID "musicbrainz-albumartistid"
/**
- * GST_TAG_MUSICBRAINZ_TRMID
+ * GST_TAG_MUSICBRAINZ_TRMID:
*
* MusicBrainz track TRM ID
*/
#define GST_TAG_MUSICBRAINZ_TRMID "musicbrainz-trmid"
/**
- * GST_TAG_CMML_STREAM
+ * GST_TAG_CMML_STREAM:
*
* Annodex CMML stream element tag
*/
#define GST_TAG_CMML_STREAM "cmml-stream"
/**
- * GST_TAG_CMML_HEAD
+ * GST_TAG_CMML_HEAD:
*
* Annodex CMML head element tag
*/
#define GST_TAG_CMML_HEAD "cmml-head"
/**
- * GST_TAG_CMML_CLIP
+ * GST_TAG_CMML_CLIP:
*
* Annodex CMML clip element tag
*/
* GST_TAG_CAPTURING_SHUTTER_SPEED:
*
* Shutter speed used when capturing an image, in seconds. (fraction)
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_SHUTTER_SPEED "capturing-shutter-speed"
*
* The value stored is the denominator of the focal ratio (f-number).
* For example, if this tag value is 2, the focal ratio is f/2.
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_FOCAL_RATIO "capturing-focal-ratio"
* GST_TAG_CAPTURING_FOCAL_LENGTH:
*
* Focal length used when capturing an image, in mm. (double)
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_FOCAL_LENGTH "capturing-focal-length"
* GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO:
*
* Digital zoom ratio used when capturing an image. (double)
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_DIGITAL_ZOOM_RATIO "capturing-digital-zoom-ratio"
* GST_TAG_CAPTURING_ISO_SPEED:
*
* ISO speed used when capturing an image. (integer)
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_ISO_SPEED "capturing-iso-speed"
* "action" - biased towards fast shutter speed
* "portrait" - closeup, leaving background out of focus
* "landscape" - landscape photos, background in focus
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_EXPOSURE_PROGRAM "capturing-exposure-program"
* "auto-exposure"
* "manual-exposure"
* "auto-bracket"
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_EXPOSURE_MODE "capturing-exposure-mode"
* GST_TAG_CAPTURING_EXPOSURE_COMPENSATION:
*
* Exposure compensation using when capturing an image in EV. (double)
- *
- * Since: 0.10.33
*/
#define GST_TAG_CAPTURING_EXPOSURE_COMPENSATION "capturing-exposure-compensation"
* "landscape"
* "portrait"
* "night-scene"
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_SCENE_CAPTURE_TYPE "capturing-scene-capture-type"
* "high-gain-up"
* "low-gain-down"
* "high-gain-down"
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_GAIN_ADJUSTMENT "capturing-gain-adjustment"
* "fluorescent"
* "fluorescent h" (newer daylight-calibrated fluorescents)
* "flash"
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_WHITE_BALANCE "capturing-white-balance"
* "normal"
* "soft"
* "hard"
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_CONTRAST "capturing-contrast"
* "normal"
* "low-saturation"
* "high-saturation"
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_SATURATION "capturing-saturation"
* "normal"
* "soft"
* "hard"
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_SHARPNESS "capturing-sharpness"
*
* Note that if this tag isn't present, it should not be assumed that
* the flash did not fire. It should be treated as unknown.
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_FLASH_FIRED "capturing-flash-fired"
* "auto"
* "always"
* "never"
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_FLASH_MODE "capturing-flash-mode"
* "pattern"
* "partial"
* "other"
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_METERING_MODE "capturing-metering-mode"
* "transparent-scanner"
* "reflex-scanner"
* "other"
- *
- * Since: 0.10.31
*/
#define GST_TAG_CAPTURING_SOURCE "capturing-source"
* GST_TAG_IMAGE_HORIZONTAL_PPI:
*
* Media (image/video) intended horizontal pixel density in ppi. (double)
- *
- * Since: 0.10.31
*/
#define GST_TAG_IMAGE_HORIZONTAL_PPI "image-horizontal-ppi"
/**
* GST_TAG_IMAGE_VERTICAL_PPI:
*
* Media (image/video) intended vertical pixel density in ppi. (double)
- *
- * Since: 0.10.31
*/
#define GST_TAG_IMAGE_VERTICAL_PPI "image-vertical-ppi"
* GstTagImageType:
* @GST_TAG_IMAGE_TYPE_NONE : No image type. Can be used to
* tell functions such as gst_tag_image_data_to_image_sample() that no
- * image type should be set. (Since: 0.10.20)
+ * image type should be set.
* @GST_TAG_IMAGE_TYPE_UNDEFINED : Undefined/other image type
* @GST_TAG_IMAGE_TYPE_FRONT_COVER : Cover (front)
* @GST_TAG_IMAGE_TYPE_BACK_COVER : Cover (back)
*
* Type of image contained in an image tag (specified as field in
* the image buffer's caps structure)
- *
- * Since: 0.10.9
*/
/* Note: keep in sync with register_tag_image_type_enum() */
typedef enum {
*
* ID3V2 header size considered minimum input for some functions such as
* gst_tag_list_from_id3v2_tag() and gst_tag_get_id3v2_tag_size() for example.
- *
- * Since: 0.10.36
*/
#define GST_TAG_ID3V2_HEADER_SIZE 10
* @lang_code: ISO-639 language code (e.g. "deu" or "ger" or "de")
*
* Convenience macro wrapping gst_tag_get_language_code_iso_639_1().
- *
- * Since: 0.10.26
*/
#define gst_tag_get_language_code(lang_code) \
gst_tag_get_language_code_iso_639_1(lang_code)
* created by the Free Software Foundation (FSF)
*
* See http://creativecommons.org/ns for more information.
- *
- * Since: 0.10.36
*/
typedef enum {
GST_TAG_LICENSE_PERMITS_REPRODUCTION = (1 << 0),
* that the core can load+register tags automatically when needed. */
/**
- * gst_tag_register_musicbrainz_tags
+ * gst_tag_register_musicbrainz_tags:
*
* Registers additional musicbrainz-specific tags with the GStreamer tag
* system. Plugins and applications that use these tags should call this
* code in the extended comment string.
*
* Returns: TRUE if the string could be parsed, otherwise FALSE
- *
- * Since: 0.10.10
*/
gboolean
gst_tag_parse_extended_comment (const gchar * ext_comment, gchar ** key,
* WINDOWS-1252/ISO-8859-1 is assumed (which will almost always succeed).
*
* Returns: a newly-allocated string in UTF-8 encoding, or NULL
- *
- * Since: 0.10.13
*/
gchar *
gst_tag_freeform_string_to_utf8 (const gchar * data, gint size,
* data (we can't trust the declared mime type).
*
* Returns: a newly-allocated image sample for use in tag lists, or NULL
- *
- * Since: 0.10.20
*/
GstSample *
gst_tag_image_data_to_image_sample (const guint8 * image_data,
*
* Adds all available XMP schemas to the configuration. Meaning that
* all will be used.
- *
- * Since: 0.10.33
*/
void
gst_tag_xmp_writer_add_all_schemas (GstTagXmpWriter * config)
* @schema: the schema to be added
*
* Adds @schema to the list schemas
- *
- * Since: 0.10.33
*/
void
gst_tag_xmp_writer_add_schema (GstTagXmpWriter * config, const gchar * schema)
* Checks if @schema is going to be used
*
* Returns: %TRUE if it is going to be used
- * Since: 0.10.33
*/
gboolean
gst_tag_xmp_writer_has_schema (GstTagXmpWriter * config, const gchar * schema)
*
* Removes a schema from the list of schemas to use. Nothing is done if
* the schema wasn't in the list
- *
- * Since: 0.10.33
*/
void
gst_tag_xmp_writer_remove_schema (GstTagXmpWriter * config,
*
* Removes all schemas from the list of schemas to use. Meaning that no
* XMP will be generated.
- *
- * Since: 0.10.33
*/
void
gst_tag_xmp_writer_remove_all_schemas (GstTagXmpWriter * config)
* Get the #GstColorBalanceType of this implementation.
*
* Returns: A the #GstColorBalanceType.
- *
- * Since: 0.10.24
*/
GstColorBalanceType
gst_color_balance_get_balance_type (GstColorBalance * balance)
*
* Returns: The converted #GstSample, or %NULL if an error happened (in which case @err
* will point to the #GError).
- *
- * Since: 0.10.31
- *
*/
GstSample *
gst_video_convert_sample (GstSample * sample, const GstCaps * to_caps,
*
* @destroy_notify will be called after the callback was called and @user_data is not needed
* anymore.
- *
- * Since: 0.10.31
- *
*/
void
gst_video_convert_sample_async (GstSample * sample,
* In any case, the frame is considered finished and released.
*
* Returns: a #GstFlowReturn, usually GST_FLOW_OK.
- *
- * Since: 0.10.36
*/
GstFlowReturn
gst_video_decoder_drop_frame (GstVideoDecoder * dec, GstVideoCodecFrame * frame)
* of the buffer.
*
* Returns: a #GstFlowReturn resulting from sending data downstream
- *
- * Since: 0.10.36
*/
GstFlowReturn
gst_video_decoder_finish_frame (GstVideoDecoder * decoder,
* @n_bytes: the number of bytes to add
*
* Removes next @n_bytes of input data and adds it to currently parsed frame.
- *
- * Since: 0.10.36
*/
void
gst_video_decoder_add_to_frame (GstVideoDecoder * decoder, int n_bytes)
* metadata and passes it along for further processing, i.e. @handle_frame.
*
* Returns: a #GstFlowReturn
- *
- * Since: 0.10.36
*/
GstFlowReturn
gst_video_decoder_have_frame (GstVideoDecoder * decoder)
* Get the #GstVideoCodecState currently describing the output stream.
*
* Returns: (transfer full): #GstVideoCodecState describing format of video data.
- *
- * Since: 0.10.36
*/
GstVideoCodecState *
gst_video_decoder_get_output_state (GstVideoDecoder * decoder)
* from the next call to #gst_video_decoder_finish_frame().
*
* Returns: (transfer full): the newly configured output state.
- *
- * Since: 0.10.36
*/
GstVideoCodecState *
gst_video_decoder_set_output_state (GstVideoDecoder * decoder,
* Get the oldest pending unfinished #GstVideoCodecFrame
*
* Returns: (transfer full): oldest pending unfinished #GstVideoCodecFrame.
- *
- * Since: 0.10.36
*/
GstVideoCodecFrame *
gst_video_decoder_get_oldest_frame (GstVideoDecoder * decoder)
* Get a pending unfinished #GstVideoCodecFrame
*
* Returns: (transfer full): pending unfinished #GstVideoCodecFrame identified by @frame_number.
- *
- * Since: 0.10.36
*/
GstVideoCodecFrame *
gst_video_decoder_get_frame (GstVideoDecoder * decoder, int frame_number)
* Sets src pad caps according to currently configured #GstVideoCodecState.
*
* Returns: #TRUE if the caps were accepted downstream, else #FALSE.
- *
- * Since: 0.10.36
*/
static gboolean
gst_video_decoder_set_src_caps (GstVideoDecoder * decoder)
* current #GstVideoCodecState.
*
* Returns: (transfer full): allocated buffer
- *
- * Since: 0.10.36
*/
GstBuffer *
gst_video_decoder_alloc_output_buffer (GstVideoDecoder * decoder)
* keep references to the frame, not the buffer.
*
* Returns: %GST_FLOW_OK if an output buffer could be allocated
- *
- * Since: 0.10.36
*/
GstFlowReturn
gst_video_decoder_alloc_output_frame (GstVideoDecoder *
* and should therefore occur as soon/skippy as possible.
*
* Returns: max decoding time.
- *
- * Since: 0.10.36
*/
GstClockTimeDiff
gst_video_decoder_get_max_decode_time (GstVideoDecoder *
* Sets numbers of tolerated decoder errors, where a tolerated one is then only
* warned about, but more than tolerated will lead to fatal error. Default
* is set to GST_VIDEO_DECODER_MAX_ERRORS.
- *
- * Since: 0.10.36
*/
void
gst_video_decoder_set_max_errors (GstVideoDecoder * dec, gint num)
* @dec: a #GstVideoDecoder
*
* Returns: currently configured decoder tolerated error count.
- *
- * Since: 0.10.36
*/
gint
gst_video_decoder_get_max_errors (GstVideoDecoder * dec)
*
* Allows baseclass to consider input data as packetized or not. If the
* input is packetized, then the @parse method will not be called.
- *
- * Since: 0.10.36
*/
void
gst_video_decoder_set_packetized (GstVideoDecoder * decoder,
* base class.
*
* Returns: TRUE if input data is considered packetized.
- *
- * Since: 0.10.36
*/
gboolean
gst_video_decoder_get_packetized (GstVideoDecoder * decoder)
* @enabled: whether to enable byte to time conversion
*
* Allows baseclass to perform byte to time estimated conversion.
- *
- * Since: 0.10.36
*/
void
gst_video_decoder_set_estimate_rate (GstVideoDecoder * dec, gboolean enabled)
* @dec: a #GstVideoDecoder
*
* Returns: currently configured byte to time conversion setting
- *
- * Since: 0.10.36
*/
gboolean
gst_video_decoder_get_estimate_rate (GstVideoDecoder * dec)
* Lets #GstVideoDecoder sub-classes tell the baseclass what the decoder
* latency is. Will also post a LATENCY message on the bus so the pipeline
* can reconfigure its global latency.
- *
- * Since: 0.10.36
*/
void
gst_video_decoder_set_latency (GstVideoDecoder * decoder,
*
* Query the configured decoder latency. Results will be returned via
* @min_latency and @max_latency.
- *
- * Since: 0.10.36
*/
void
gst_video_decoder_get_latency (GstVideoDecoder * decoder,
* GST_VIDEO_DECODER_SINK_NAME:
*
* The name of the templates for the sink pad.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_DECODER_SINK_NAME "sink"
/**
* GST_VIDEO_DECODER_SRC_NAME:
*
* The name of the templates for the source pad.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_DECODER_SRC_NAME "src"
* @obj: a #GstVideoDecoder
*
* Gives the pointer to the source #GstPad object of the element.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_DECODER_SRC_PAD(obj) (((GstVideoDecoder *) (obj))->srcpad)
* @obj: a #GstVideoDecoder
*
* Gives the pointer to the sink #GstPad object of the element.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_DECODER_SINK_PAD(obj) (((GstVideoDecoder *) (obj))->sinkpad)
/**
* GST_VIDEO_DECODER_FLOW_NEED_DATA:
*
* Returned while parsing to indicate more data is needed.
- *
- * Since: 0.10.36
**/
#define GST_VIDEO_DECODER_FLOW_NEED_DATA GST_FLOW_CUSTOM_SUCCESS
* @obj: base decoder instance
*
* Gives the segment of the element.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_DECODER_INPUT_SEGMENT(obj) (GST_VIDEO_DECODER_CAST (obj)->input_segment)
* @obj: base decoder instance
*
* Gives the segment of the element.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_DECODER_OUTPUT_SEGMENT(obj) (GST_VIDEO_DECODER_CAST (obj)->output_segment)
* @decoder: video decoder instance
*
* Obtain a lock to protect the decoder function from concurrent access.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_DECODER_STREAM_LOCK(decoder) g_rec_mutex_lock (&GST_VIDEO_DECODER (decoder)->stream_lock)
* @decoder: video decoder instance
*
* Release the lock that protects the decoder function from concurrent access.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_DECODER_STREAM_UNLOCK(decoder) g_rec_mutex_unlock (&GST_VIDEO_DECODER (decoder)->stream_lock)
* media processing. Otherwise, it is considered a "glitch" and only a warning
* is logged. In either case, @ret is set to the proper value to
* return to upstream/caller (indicating either GST_FLOW_ERROR or GST_FLOW_OK).
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_DECODER_ERROR(el, w, domain, code, text, debug, ret) \
G_STMT_START { \
* GST_VIDEO_DECODER_MAX_ERRORS:
*
* Default maximum number of errors tolerated before signaling error.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_DECODER_MAX_ERRORS 10
* GstVideoDecoder:
*
* The opaque #GstVideoDecoder data structure.
- *
- * Since: 0.10.36
*/
struct _GstVideoDecoder
{
* needed. At minimum @handle_frame needs to be overridden, and @set_format
* and likely as well. If non-packetized input is supported or expected,
* @parse needs to be overridden as well.
- *
- * Since: 0.10.36
*/
struct _GstVideoDecoderClass
{
* @headers: (transfer full) (element-type GstBuffer): a list of #GstBuffer containing the codec header
*
* Set the codec headers to be sent downstream whenever requested.
- *
- * Since: 0.10.36
*/
void
gst_video_encoder_set_headers (GstVideoEncoder * video_encoder, GList * headers)
* elements (e.g. muxers).
*
* Returns: a #GstCaps owned by caller
- *
- * Since: 0.10.36
*/
GstCaps *
gst_video_encoder_proxy_getcaps (GstVideoEncoder * encoder, GstCaps * caps,
* of the buffer.
*
* Returns: a #GstFlowReturn resulting from sending data downstream
- *
- * Since: 0.10.36
*/
GstFlowReturn
gst_video_encoder_finish_frame (GstVideoEncoder * encoder,
* Get the current #GstVideoCodecState
*
* Returns: (transfer full): #GstVideoCodecState describing format of video data.
- *
- * Since: 0.10.36
*/
GstVideoCodecState *
gst_video_encoder_get_output_state (GstVideoEncoder * encoder)
* from the next call to #gst_video_encoder_finish_frame().
*
* Returns: (transfer full): the newly configured output state.
- *
- * Since: 0.10.36
*/
GstVideoCodecState *
gst_video_encoder_set_output_state (GstVideoEncoder * encoder, GstCaps * caps,
* @max_latency: maximum latency
*
* Informs baseclass of encoding latency.
- *
- * Since: 0.10.36
*/
void
gst_video_encoder_set_latency (GstVideoEncoder * encoder,
*
* Query the configured encoding latency. Results will be returned via
* @min_latency and @max_latency.
- *
- * Since: 0.10.36
*/
void
gst_video_encoder_get_latency (GstVideoEncoder * encoder,
* Get the oldest unfinished pending #GstVideoCodecFrame
*
* Returns: (transfer full): oldest unfinished pending #GstVideoCodecFrame
- *
- * Since: 0.10.36
*/
GstVideoCodecFrame *
gst_video_encoder_get_oldest_frame (GstVideoEncoder * encoder)
* Get a pending unfinished #GstVideoCodecFrame
*
* Returns: (transfer full): pending unfinished #GstVideoCodecFrame identified by @frame_number.
- *
- * Since: 0.10.36
*/
GstVideoCodecFrame *
gst_video_encoder_get_frame (GstVideoEncoder * encoder, int frame_number)
* GST_VIDEO_ENCODER_SINK_NAME:
*
* The name of the templates for the sink pad.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_ENCODER_SINK_NAME "sink"
/**
* GST_VIDEO_ENCODER_SRC_NAME:
*
* The name of the templates for the source pad.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_ENCODER_SRC_NAME "src"
* @obj: a #GstVideoEncoder
*
* Gives the pointer to the source #GstPad object of the element.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_ENCODER_SRC_PAD(obj) (((GstVideoEncoder *) (obj))->srcpad)
* @obj: a #GstVideoEncoder
*
* Gives the pointer to the sink #GstPad object of the element.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_ENCODER_SINK_PAD(obj) (((GstVideoEncoder *) (obj))->sinkpad)
* GST_VIDEO_ENCODER_FLOW_NEED_DATA:
*
* Returned while parsing to indicate more data is needed.
- *
- * Since: 0.10.36
**/
#define GST_VIDEO_ENCODER_FLOW_NEED_DATA GST_FLOW_CUSTOM_SUCCESS
* GST_VIDEO_ENCODER_FLOW_DROPPED:
*
* Returned when the event/buffer should be dropped.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_ENCODER_FLOW_DROPPED GST_FLOW_CUSTOM_SUCCESS_1
* @obj: base parse instance
*
* Gives the segment of the element.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_ENCODER_INPUT_SEGMENT(obj) (GST_VIDEO_ENCODER_CAST (obj)->input_segment)
* @obj: base parse instance
*
* Gives the segment of the element.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_ENCODER_OUTPUT_SEGMENT(obj) (GST_VIDEO_ENCODER_CAST (obj)->output_segment)
* @encoder: video encoder instance
*
* Obtain a lock to protect the encoder function from concurrent access.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_ENCODER_STREAM_LOCK(encoder) g_rec_mutex_lock (&GST_VIDEO_ENCODER (encoder)->stream_lock)
* @encoder: video encoder instance
*
* Release the lock that protects the encoder function from concurrent access.
- *
- * Since: 0.10.36
*/
#define GST_VIDEO_ENCODER_STREAM_UNLOCK(encoder) g_rec_mutex_unlock (&GST_VIDEO_ENCODER (encoder)->stream_lock)
* GstVideoEncoder:
*
* The opaque #GstVideoEncoder data structure.
- *
- * Since: 0.10.36
*/
struct _GstVideoEncoder
{
* GstVideoEncoderClass:
* @open: Optional.
* Called when the element changes to GST_STATE_READY.
- * Allows opening external resources. Since: 0.10.37.
+ * Allows opening external resources.
* @close: Optional.
* Called when the element changes to GST_STATE_NULL.
- * Allows closing external resources. Since: 0.10.37.
+ * Allows closing external resources.
* @start: Optional.
* Called when the element starts processing.
* Allows opening external resources.
* Subclasses can override any of the available virtual methods or not, as
* needed. At minimum @handle_frame needs to be overridden, and @set_format
* and @get_caps are likely needed as well.
- *
- * Since: 0.10.36
*/
struct _GstVideoEncoderClass
{
gobject_class->get_property = gst_video_sink_get_property;
/**
- * GstVideoSink:show-preroll-frame
+ * GstVideoSink:show-preroll-frame:
*
* Whether to show video frames during preroll. If set to #FALSE, video
* frames will only be rendered in PLAYING state.
- *
- * Since: 0.10.25
*/
g_object_class_install_property (gobject_class, PROP_SHOW_PREROLL_FRAME,
g_param_spec_boolean ("show-preroll-frame", "Show preroll frame",
* @obj: a #GstVideoSink or derived object
*
* Cast @obj to a #GstVideoSink without runtime type check.
- *
- * Since: 0.10.12
*/
#define GST_VIDEO_SINK_CAST(obj) ((GstVideoSink *) (obj))
* @show_frame: render a video frame. Maps to #GstBaseSinkClass.render() and
* #GstBaseSinkClass.preroll() vfuncs. Rendering during preroll will be
* suppressed if the #GstVideoSink:show-preroll-frame property is set to
- * %FALSE. Since: 0.10.25
+ * %FALSE.
*
* The video sink class structure. Derived classes should override the
* @show_frame virtual function.
* @command: The command to issue
*
* Sends the indicated command to the navigation interface.
- *
- * Since: 0.10.23
*/
void
gst_navigation_send_command (GstNavigation * navigation,
*
* Returns: The #GstNavigationQueryType of the query, or
* #GST_NAVIGATION_QUERY_INVALID
- * Since: 0.10.23
*/
GstNavigationQueryType
gst_navigation_query_get_type (GstQuery * query)
* query the pipeline for the set of currently available commands.
*
* Returns: The new query.
- * Since: 0.10.23
*/
GstQuery *
gst_navigation_query_new_commands (void)
*
* Set the #GstNavigation command query result fields in @query. The number
* of commands passed must be equal to @n_commands.
- *
- * Since: 0.10.23
*/
void
gst_navigation_query_set_commands (GstQuery * query, gint n_cmds, ...)
*
* Set the #GstNavigation command query result fields in @query. The number
* of commands passed must be equal to @n_commands.
- *
- * Since: 0.10.23
*/
void
gst_navigation_query_set_commandsv (GstQuery * query, gint n_cmds,
* Parse the number of commands in the #GstNavigation commands @query.
*
* Returns: %TRUE if the query could be successfully parsed. %FALSE if not.
- * Since: 0.10.23
*/
gboolean
gst_navigation_query_parse_commands_length (GstQuery * query, guint * n_cmds)
* set to #GST_NAVIGATION_COMMAND_INVALID.
*
* Returns: %TRUE if the query could be successfully parsed. %FALSE if not.
- * Since: 0.10.23
*/
gboolean
gst_navigation_query_parse_commands_nth (GstQuery * query, guint nth,
* greater than one in a multiangle video.
*
* Returns: The new query.
- * Since: 0.10.23
*/
GstQuery *
gst_navigation_query_new_angles (void)
* @n_angles: the number of viewing angles to set.
*
* Set the #GstNavigation angles query result field in @query.
- *
- * Since: 0.10.23
*/
void
gst_navigation_query_set_angles (GstQuery * query, guint cur_angle,
* angles into the #guint pointed to by the @n_angles variable.
*
* Returns: %TRUE if the query could be successfully parsed. %FALSE if not.
- * Since: 0.10.23
*/
gboolean
gst_navigation_query_parse_angles (GstQuery * query, guint * cur_angle,
* Returns: The type of the #GstMessage, or
* #GST_NAVIGATION_MESSAGE_INVALID if the message is not a #GstNavigation
* notification.
- *
- * Since: 0.10.23
*/
GstNavigationMessageType
gst_navigation_message_get_type (GstMessage * message)
* #GST_NAVIGATION_MESSAGE_MOUSE_OVER.
*
* Returns: The new #GstMessage.
- * Since: 0.10.23
*/
GstMessage *
gst_navigation_message_new_mouse_over (GstObject * src, gboolean active)
* active, it indicates that the mouse is over a clickable area.
*
* Returns: %TRUE if the message could be successfully parsed. %FALSE if not.
- * Since: 0.10.23
*/
gboolean
gst_navigation_message_parse_mouse_over (GstMessage * message,
* #GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED
*
* Returns: The new #GstMessage.
- * Since: 0.10.23
*/
GstMessage *
gst_navigation_message_new_commands_changed (GstObject * src)
* multiangle video has changed.
*
* Returns: The new #GstMessage.
- * Since: 0.10.23
*/
GstMessage *
gst_navigation_message_new_angles_changed (GstObject * src, guint cur_angle,
* and extract the @cur_angle and @n_angles parameters.
*
* Returns: %TRUE if the message could be successfully parsed. %FALSE if not.
- * Since: 0.10.23
*/
gboolean
gst_navigation_message_parse_angles_changed (GstMessage * message,
*
* Inspect a #GstEvent and return the #GstNavigationEventType of the event, or
* #GST_NAVIGATION_EVENT_INVALID if the event is not a #GstNavigation event.
- *
- * Since: 0.10.23
*/
GstNavigationEventType
gst_navigation_event_get_type (GstEvent * event)
* @key: A pointer to a location to receive the string identifying the key
* press. The returned string is owned by the event, and valid only until the
* event is unreffed.
- *
- * Since: 0.10.23
*/
gboolean
gst_navigation_event_parse_key_event (GstEvent * event, const gchar ** key)
*
* Returns: TRUE if the button number and both coordinates could be extracted,
* otherwise FALSE.
- *
- * Since: 0.10.23
*/
gboolean
gst_navigation_event_parse_mouse_button_event (GstEvent * event, gint * button,
* of the event.
*
* Returns: TRUE if both coordinates could be extracted, otherwise FALSE.
- *
- * Since: 0.10.23
*/
gboolean
gst_navigation_event_parse_mouse_move_event (GstEvent * event, gdouble * x,
* associated command.
*
* Returns: TRUE if the navigation command could be extracted, otherwise FALSE.
- *
- * Since: 0.10.23
*/
gboolean
gst_navigation_event_parse_command (GstEvent * event,
* GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU = @GST_NAVIGATION_COMMAND_MENU5
* GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU = @GST_NAVIGATION_COMMAND_MENU6
* GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU = @GST_NAVIGATION_COMMAND_MENU7
- *
- * Since: 0.10.23
*/
typedef enum {
GST_NAVIGATION_COMMAND_INVALID = 0,
*
* A set of notifications that may be received on the bus when navigation
* related status changes.
- *
- * Since: 0.10.23
*/
typedef enum {
GST_NAVIGATION_MESSAGE_INVALID,
*
* Enum values for the various events that an element implementing the
* GstNavigation interface might send up the pipeline.
- *
- * Since: 0.10.23
*/
typedef enum {
GST_NAVIGATION_EVENT_INVALID = 0,
#define IS_UNKNOWN(ci) (IS_EQUAL (&colorimetry[DEFAULT_UNKNOWN], ci))
/**
- * gst_video_colorimetry_from_string
+ * gst_video_colorimetry_from_string:
* @cinfo: a #GstVideoColorimetry
* @color: a colorimetry string
*
}
/**
- * gst_video_colorimetry_to_string
+ * gst_video_colorimetry_to_string:
* @cinfo: a #GstVideoColorimetry
*
* Make a string representation of @cinfo.
* gst_video_event_parse_still_frame().
*
* Returns: The new GstEvent
- * Since: 0.10.26
*/
GstEvent *
gst_video_event_new_still_frame (gboolean in_still)
* Create a still frame event using gst_video_event_new_still_frame()
*
* Returns: %TRUE if the event is a valid still-frame event. %FALSE if not
- * Since: 0.10.26
*/
gboolean
gst_video_event_parse_still_frame (GstEvent * event, gboolean * in_still)
* gst_video_event_parse_downstream_force_key_unit().
*
* Returns: The new GstEvent
- * Since: 0.10.36
*/
GstEvent *
gst_video_event_new_downstream_force_key_unit (GstClockTime timestamp,
* gst_video_event_parse_downstream_force_key_unit().
*
* Returns: The new GstEvent
- * Since: 0.10.36
*/
GstEvent *
gst_video_event_new_upstream_force_key_unit (GstClockTime running_time,
* and downstream force key unit events.
*
* Returns: %TRUE if the event is a valid force key unit event
- * Since: 0.10.36
*/
gboolean
gst_video_event_is_force_key_unit (GstEvent * event)
* full description of the downstream force key unit event.
*
* Returns: %TRUE if the event is a valid downstream force key unit event.
- * Since: 0.10.36
*/
gboolean
gst_video_event_parse_downstream_force_key_unit (GstEvent * event,
* Create an upstream force key unit event using gst_video_event_new_upstream_force_key_unit()
*
* Returns: %TRUE if the event is a valid upstream force-key-unit event. %FALSE if not
- * Since: 0.10.36
*/
gboolean
gst_video_event_parse_upstream_force_key_unit (GstEvent * event,
* If the FOURCC cannot be represented by #GstVideoFormat,
* #GST_VIDEO_FORMAT_UNKNOWN is returned.
*
- * Since: 0.10.16
- *
* Returns: the #GstVideoFormat describing the FOURCC value
*/
GstVideoFormat
* a few YUV formats have corresponding FOURCC values. If @format has
* no corresponding FOURCC value, 0 is returned.
*
- * Since: 0.10.16
- *
* Returns: the FOURCC corresponding to @format
*/
guint32
* @GST_VIDEO_FORMAT_ABGR: reverse rgb with alpha channel first
* @GST_VIDEO_FORMAT_RGB: rgb
* @GST_VIDEO_FORMAT_BGR: reverse rgb
- * @GST_VIDEO_FORMAT_Y41B: planar 4:1:1 YUV (Since: 0.10.18)
- * @GST_VIDEO_FORMAT_Y42B: planar 4:2:2 YUV (Since: 0.10.18)
- * @GST_VIDEO_FORMAT_YVYU: packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...) (Since: 0.10.23)
- * @GST_VIDEO_FORMAT_Y444: planar 4:4:4 YUV (Since: 0.10.24)
- * @GST_VIDEO_FORMAT_v210: packed 4:2:2 10-bit YUV, complex format (Since: 0.10.24)
- * @GST_VIDEO_FORMAT_v216: packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order (Since: 0.10.24)
- * @GST_VIDEO_FORMAT_NV12: planar 4:2:0 YUV with interleaved UV plane (Since: 0.10.26)
- * @GST_VIDEO_FORMAT_NV21: planar 4:2:0 YUV with interleaved VU plane (Since: 0.10.26)
- * @GST_VIDEO_FORMAT_GRAY8: 8-bit grayscale (Since: 0.10.29)
- * @GST_VIDEO_FORMAT_GRAY16_BE: 16-bit grayscale, most significant byte first (Since: 0.10.29)
- * @GST_VIDEO_FORMAT_GRAY16_LE: 16-bit grayscale, least significant byte first (Since: 0.10.29)
- * @GST_VIDEO_FORMAT_v308: packed 4:4:4 YUV (Since: 0.10.29)
- * @GST_VIDEO_FORMAT_RGB16: rgb 5-6-5 bits per component (Since: 0.10.30)
- * @GST_VIDEO_FORMAT_BGR16: reverse rgb 5-6-5 bits per component (Since: 0.10.30)
- * @GST_VIDEO_FORMAT_RGB15: rgb 5-5-5 bits per component (Since: 0.10.30)
- * @GST_VIDEO_FORMAT_BGR15: reverse rgb 5-5-5 bits per component (Since: 0.10.30)
- * @GST_VIDEO_FORMAT_UYVP: packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...) (Since: 0.10.31)
- * @GST_VIDEO_FORMAT_A420: planar 4:4:2:0 AYUV (Since: 0.10.31)
- * @GST_VIDEO_FORMAT_RGB8P: 8-bit paletted RGB (Since: 0.10.32)
- * @GST_VIDEO_FORMAT_YUV9: planar 4:1:0 YUV (Since: 0.10.32)
- * @GST_VIDEO_FORMAT_YVU9: planar 4:1:0 YUV (like YUV9 but UV planes swapped) (Since: 0.10.32)
- * @GST_VIDEO_FORMAT_IYU1: packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...) (Since: 0.10.32)
- * @GST_VIDEO_FORMAT_ARGB64: rgb with alpha channel first, 16 bits per channel (Since: 0.10.33)
- * @GST_VIDEO_FORMAT_AYUV64: packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...) (Since: 0.10.33)
- * @GST_VIDEO_FORMAT_r210: packed 4:4:4 RGB, 10 bits per channel (Since: 0.10.33)
+ * @GST_VIDEO_FORMAT_Y41B: planar 4:1:1 YUV
+ * @GST_VIDEO_FORMAT_Y42B: planar 4:2:2 YUV
+ * @GST_VIDEO_FORMAT_YVYU: packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...)
+ * @GST_VIDEO_FORMAT_Y444: planar 4:4:4 YUV
+ * @GST_VIDEO_FORMAT_v210: packed 4:2:2 10-bit YUV, complex format
+ * @GST_VIDEO_FORMAT_v216: packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order
+ * @GST_VIDEO_FORMAT_NV12: planar 4:2:0 YUV with interleaved UV plane
+ * @GST_VIDEO_FORMAT_NV21: planar 4:2:0 YUV with interleaved VU plane
+ * @GST_VIDEO_FORMAT_GRAY8: 8-bit grayscale
+ * @GST_VIDEO_FORMAT_GRAY16_BE: 16-bit grayscale, most significant byte first
+ * @GST_VIDEO_FORMAT_GRAY16_LE: 16-bit grayscale, least significant byte first
+ * @GST_VIDEO_FORMAT_v308: packed 4:4:4 YUV
+ * @GST_VIDEO_FORMAT_RGB16: rgb 5-6-5 bits per component
+ * @GST_VIDEO_FORMAT_BGR16: reverse rgb 5-6-5 bits per component
+ * @GST_VIDEO_FORMAT_RGB15: rgb 5-5-5 bits per component
+ * @GST_VIDEO_FORMAT_BGR15: reverse rgb 5-5-5 bits per component
+ * @GST_VIDEO_FORMAT_UYVP: packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...)
+ * @GST_VIDEO_FORMAT_A420: planar 4:4:2:0 AYUV
+ * @GST_VIDEO_FORMAT_RGB8P: 8-bit paletted RGB
+ * @GST_VIDEO_FORMAT_YUV9: planar 4:1:0 YUV
+ * @GST_VIDEO_FORMAT_YVU9: planar 4:1:0 YUV (like YUV9 but UV planes swapped)
+ * @GST_VIDEO_FORMAT_IYU1: packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...)
+ * @GST_VIDEO_FORMAT_ARGB64: rgb with alpha channel first, 16 bits per channel
+ * @GST_VIDEO_FORMAT_AYUV64: packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...)
+ * @GST_VIDEO_FORMAT_r210: packed 4:4:4 RGB, 10 bits per channel
* @GST_VIDEO_FORMAT_I420_10BE: planar 4:2:0 YUV, 10 bits per channel
* @GST_VIDEO_FORMAT_I420_10LE: planar 4:2:0 YUV, 10 bits per channel
*
}
/**
- * gst_video_frame_copy:
+ * gst_video_frame_copy_plane:
* @dest: a #GstVideoFrame
* @src: a #GstVideoFrame
* @plane: a plane
* raw video, GST_FORMAT_DEFAULT corresponds to video frames. This
* function can be used to handle pad queries of the type GST_QUERY_CONVERT.
*
- * Since: 0.10.16
- *
* Returns: TRUE if the conversion was successful.
*/
gboolean
* </itemizedlist>
* </para>
* </refsect2>
- *
- * Since: 0.11.x
*/
/* TODO:
* Sets an overlay composition on a buffer. The buffer will obtain its own
* reference to the composition, meaning this function does not take ownership
* of @comp.
- *
- * Since: 0.11.x
*/
GstVideoOverlayCompositionMeta *
gst_buffer_add_video_overlay_composition_meta (GstBuffer * buf,
*
* Returns: (transfer full): a new #GstVideoOverlayComposition. Unref with
* gst_video_overlay_composition_unref() when no longer needed.
- *
- * Since: 0.11.x
*/
GstVideoOverlayComposition *
gst_video_overlay_composition_new (GstVideoOverlayRectangle * rectangle)
*
* Adds an overlay rectangle to an existing overlay composition object. This
* must be done right after creating the overlay composition.
- *
- * Since: 0.11.x
*/
void
gst_video_overlay_composition_add_rectangle (GstVideoOverlayComposition * comp,
* Returns the number of #GstVideoOverlayRectangle<!-- -->s contained in @comp.
*
* Returns: the number of rectangles
- *
- * Since: 0.11.x
*/
guint
gst_video_overlay_composition_n_rectangles (GstVideoOverlayComposition * comp)
* bounds. Will not return a new reference, the caller will need to
* obtain her own reference using gst_video_overlay_rectangle_ref()
* if needed.
- *
- * Since: 0.11.x
*/
GstVideoOverlayRectangle *
gst_video_overlay_composition_get_rectangle (GstVideoOverlayComposition * comp,
* Blends the overlay rectangles in @comp on top of the raw video data
* contained in @video_buf. The data in @video_buf must be writable and
* mapped appropriately.
- *
- * Since: 0.11.x
*/
gboolean
gst_video_overlay_composition_blend (GstVideoOverlayComposition * comp,
*
* Returns: (transfer full): a new #GstVideoOverlayComposition equivalent
* to @comp.
- *
- * Since: 0.11.x
*/
GstVideoOverlayComposition *
gst_video_overlay_composition_copy (GstVideoOverlayComposition * comp)
*
* Returns: (transfer full): a writable #GstVideoOverlayComposition
* equivalent to @comp.
- *
- * Since: 0.11.x
*/
GstVideoOverlayComposition *
gst_video_overlay_composition_make_writable (GstVideoOverlayComposition * comp)
* a composition).
*
* Returns: the sequence number of @comp
- *
- * Since: 0.11.x
*/
guint
gst_video_overlay_composition_get_seqnum (GstVideoOverlayComposition * comp)
*
* Returns: (transfer full): a new #GstVideoOverlayRectangle. Unref with
* gst_video_overlay_rectangle_unref() when no longer needed.
- *
- * Since: 0.11.x
*/
GstVideoOverlayRectangle *
gst_video_overlay_rectangle_new_argb (GstBuffer * pixels,
* rectangle on the video.
*
* Returns: TRUE if valid render dimensions were retrieved.
- *
- * Since: 0.11.x
*/
gboolean
gst_video_overlay_rectangle_get_render_rectangle (GstVideoOverlayRectangle *
* make the rectangles inside a #GstVideoOverlayComposition writable using
* gst_video_overlay_composition_make_writable() or
* gst_video_overlay_composition_copy().
- *
- * Since: 0.11.x
*/
void
gst_video_overlay_rectangle_set_render_rectangle (GstVideoOverlayRectangle *
* gst_video_overlay_rectangle_get_render_rectangle(). This function does
* not return a reference, the caller should obtain a reference of her own
* with gst_buffer_ref() if needed.
- *
- * Since: 0.11.x
*/
GstBuffer *
gst_video_overlay_rectangle_get_pixels_argb (GstVideoOverlayRectangle *
* Returns: (transfer none): a #GstBuffer holding the ARGB pixel data with
* row stride @stride. This function does not return a reference, the caller
* should obtain a reference of her own with gst_buffer_ref() if needed.
- *
- * Since: 0.11.x
*/
GstBuffer *
gst_video_overlay_rectangle_get_pixels_unscaled_argb (GstVideoOverlayRectangle *
* it is stored in, to avoid unnecessary conversion.
*
* Returns: the #GstVideoOverlayFormatFlags associated with the rectangle.
- *
- * Since: 0.10.37
*/
GstVideoOverlayFormatFlags
gst_video_overlay_rectangle_get_flags (GstVideoOverlayRectangle * rectangle)
* Retrieves the global-alpha value associated with a #GstVideoOverlayRectangle.
*
* Returns: the global-alpha value associated with the rectangle.
- *
- * Since: 0.10.37
*/
gfloat
gst_video_overlay_rectangle_get_global_alpha (GstVideoOverlayRectangle *
* make the rectangles inside a #GstVideoOverlayComposition writable using
* gst_video_overlay_composition_make_writable() or
* gst_video_overlay_composition_copy().
- *
- * Since: 0.10.37
*/
void
gst_video_overlay_rectangle_set_global_alpha (GstVideoOverlayRectangle *
*
* Returns: (transfer full): a new #GstVideoOverlayRectangle equivalent
* to @rectangle.
- *
- * Since: 0.11.x
*/
GstVideoOverlayRectangle *
gst_video_overlay_rectangle_copy (GstVideoOverlayRectangle * rectangle)
* pixel-data.
*
* Returns: the sequence number of @rectangle
- *
- * Since: 0.11.x
*/
guint
gst_video_overlay_rectangle_get_seqnum (GstVideoOverlayRectangle * rectangle)
*
* An opaque video overlay rectangle object. A rectangle contains a single
* overlay rectangle which can be added to a composition.
- *
- * Since: 0.10.36
*/
#define GST_TYPE_VIDEO_OVERLAY_RECTANGLE \
(gst_video_overlay_rectangle_get_type ())
* and not know that that's the case).
*
* Returns: (transfer full): @comp
- *
- * Since: 0.10.36
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC GstVideoOverlayRectangle *
*
* Decreases the refcount of the rectangle. If the refcount reaches 0, the
* rectangle will be freed.
- *
- * Since: 0.10.36
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC void
/**
* GstVideoOverlayFormatFlags:
* @GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE: no flags
- * @GST_VIDEO_OVERLAY_FORMAT_FLAG_PREMULTIPLIED_ALPHA: RGB are premultiplied by A/255. Since: 0.10.37
- * @GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA: a global-alpha value != 1 is set. Since: 0.10.37
+ * @GST_VIDEO_OVERLAY_FORMAT_FLAG_PREMULTIPLIED_ALPHA: RGB are premultiplied by A/255.
+ * @GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA: a global-alpha value != 1 is set.
*
* Overlay format flags.
- *
- * Since: 0.10.36
*/
typedef enum {
GST_VIDEO_OVERLAY_FORMAT_FLAG_NONE = 0,
*
* An opaque video overlay composition object. A composition contains
* multiple overlay rectangles.
- *
- * Since: 0.10.36
*/
#define GST_TYPE_VIDEO_OVERLAY_COMPOSITION \
(gst_video_overlay_composition_get_type ())
* a composition and its rectangles can be modified.
*
* Returns: (transfer full): @comp
- *
- * Since: 0.10.36
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC GstVideoOverlayComposition *
*
* Decreases the refcount of the composition. If the refcount reaches 0, the
* composition will be freed.
- *
- * Since: 0.10.36
*/
#ifdef _FOOL_GTK_DOC_
G_INLINE_FUNC void
* Returns: A boolean indicating success and a calculated Display Ratio in the
* dar_n and dar_d parameters.
* The return value is FALSE in the case of integer overflow or other error.
- *
- * Since: 0.10.7
*/
gboolean
gst_video_calculate_display_ratio (guint * dar_n, guint * dar_d,
*
* The interface allows unified access to control flipping and autocenter
* operation of video-sources or operators.
- *
- * Since: 0.10.11
*/
/* FIXME 0.11: check if we need to add API for sometimes-supportedness
* @flip: return location for the result
*
* Get the horizontal flipping state (%TRUE for flipped) from the given object.
- *
- * Since: 0.10.11
* Returns: %TRUE in case the element supports flipping
*/
gboolean
* @flip: return location for the result
*
* Get the vertical flipping state (%TRUE for flipped) from the given object.
- *
- * Since: 0.10.11
* Returns: %TRUE in case the element supports flipping
*/
gboolean
* @center: return location for the result
*
* Get the horizontal centering offset from the given object.
- *
- * Since: 0.10.11
* Returns: %TRUE in case the element supports centering
*/
gboolean
* @center: return location for the result
*
* Get the vertical centering offset from the given object.
- *
- * Since: 0.10.11
* Returns: %TRUE in case the element supports centering
*/
gboolean
* @flip: use flipping
*
* Set the horizontal flipping state (%TRUE for flipped) for the given object.
- *
- * Since: 0.10.11
* Returns: %TRUE in case the element supports flipping
*/
gboolean
* @flip: use flipping
*
* Set the vertical flipping state (%TRUE for flipped) for the given object.
- *
- * Since: 0.10.11
* Returns: %TRUE in case the element supports flipping
*/
gboolean
* @center: centering offset
*
* Set the horizontal centering offset for the given object.
- *
- * Since: 0.10.11
* Returns: %TRUE in case the element supports centering
*/
gboolean
* @center: centering offset
*
* Set the vertical centering offset for the given object.
- *
- * Since: 0.10.11
* Returns: %TRUE in case the element supports centering
*/
gboolean
* should use this method to tell to a XOverlay to display video output to a
* specific window (e.g. an XWindow on X11). Passing 0 as the @handle will
* tell the overlay to stop using that window and create an internal one.
- *
- * Since: 0.10.31
*/
void
gst_video_overlay_set_window_handle (GstVideoOverlay * overlay, guintptr handle)
* events are not propagated in the window hierarchy if a client is listening
* for them. This method allows you to disable events handling completely
* from the XOverlay.
- *
- * Since: 0.10.12
*/
void
gst_video_overlay_handle_events (GstVideoOverlay * overlay,
* do not support subwindows.
*
* Returns: %FALSE if not supported by the sink.
- *
- * Since: 0.10.29
*/
gboolean
gst_video_overlay_set_render_rectangle (GstVideoOverlay * overlay,
* Convenience function to check if the given message is a
* "prepare-window-handle" message from a #GstVideoOverlay.
*
- * Since: 0.11.2
- *
* Returns: whether @msg is a "prepare-window-handle" message
*/
gboolean
projects / platform / upstream / gstreamer.git / commitdiff