rafaelcaricio/gstreamer-rs
1
0
Fork 0
forked from mirrors/gstreamer-rs
Code Pull requests Activity

regen: use type_ for glib macros

Browse source 
This also includes a new substitution for bool getters:
get_need_... -> needs_...
This commit is contained in:
François Laignel 2021-04-19 21:55:01 +02:00
parent 6cf3771be5
commit 172a4d47ab
302 changed files with 2429 additions and 1014 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/gstreamer-app/docs.md
View file

@ -39,8 +39,8 @@ to avoid polling.
# Implements
[`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`gst::URIHandlerExt`](../gst/trait.URIHandlerExt.html)
<!-- impl AppSink::fn get_buffer_list_support -->
[`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`trait@gst::URIHandlerExt`]
<!-- impl AppSink::fn is_buffer_list_support -->
Check if `self` supports buffer lists.
Feature: `v1_12`
@ -49,13 +49,13 @@ Feature: `v1_12`
# Returns
`true` if `self` supports buffer lists.
<!-- impl AppSink::fn get_caps -->
<!-- impl AppSink::fn caps -->
Get the configured caps on `self`.
# Returns
the `gst::Caps` accepted by the sink. `gst_caps_unref` after usage.
<!-- impl AppSink::fn get_drop -->
<!-- impl AppSink::fn is_drop -->
Check if `self` will drop old buffers when the maximum amount of queued
buffers is reached.
@ -63,20 +63,20 @@ buffers is reached.
`true` if `self` is dropping old buffers when the queue is
filled.
<!-- impl AppSink::fn get_emit_signals -->
<!-- impl AppSink::fn emits_signals -->
Check if appsink will emit the "new-preroll" and "new-sample" signals.
# Returns
`true` if `self` is emitting the "new-preroll" and "new-sample"
signals.
<!-- impl AppSink::fn get_max_buffers -->
<!-- impl AppSink::fn max_buffers -->
Get the maximum amount of buffers that can be queued in `self`.
# Returns
The maximum amount of buffers that can be queued.
<!-- impl AppSink::fn get_wait_on_eos -->
<!-- impl AppSink::fn is_wait_on_eos -->
Check if `self` will wait for all buffers to be consumed when an EOS is
received.
@ -433,7 +433,7 @@ occurs or the state of the appsrc has gone through READY.
# Implements
[`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`gst::URIHandlerExt`](../gst/trait.URIHandlerExt.html)
[`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`trait@gst::URIHandlerExt`]
<!-- impl AppSrc::fn end_of_stream -->
Indicates to the appsrc element that the last buffer queued in the
element is the last buffer of the stream.
@ -442,19 +442,19 @@ element is the last buffer of the stream.
`gst::FlowReturn::Ok` when the EOS was successfully queued.
`gst::FlowReturn::Flushing` when `self` is not PAUSED or PLAYING.
<!-- impl AppSrc::fn get_caps -->
<!-- impl AppSrc::fn caps -->
Get the configured caps on `self`.
# Returns
the `gst::Caps` produced by the source. `gst_caps_unref` after usage.
<!-- impl AppSrc::fn get_current_level_bytes -->
<!-- impl AppSrc::fn current_level_bytes -->
Get the number of currently queued bytes inside `self`.
# Returns
The number of currently queued bytes.
<!-- impl AppSrc::fn get_duration -->
<!-- impl AppSrc::fn duration -->
Get the duration of the stream in nanoseconds. A value of GST_CLOCK_TIME_NONE means that the duration is
not known.
@ -464,33 +464,33 @@ Feature: `v1_10`
# Returns
the duration of the stream previously set with `AppSrc::set_duration`;
<!-- impl AppSrc::fn get_emit_signals -->
<!-- impl AppSrc::fn emits_signals -->
Check if appsrc will emit the "new-preroll" and "new-buffer" signals.
# Returns
`true` if `self` is emitting the "new-preroll" and "new-buffer"
signals.
<!-- impl AppSrc::fn get_latency -->
<!-- impl AppSrc::fn latency -->
Retrieve the min and max latencies in `min` and `max` respectively.
## `min`
the min latency
## `max`
the max latency
<!-- impl AppSrc::fn get_max_bytes -->
<!-- impl AppSrc::fn max_bytes -->
Get the maximum amount of bytes that can be queued in `self`.
# Returns
The maximum amount of bytes that can be queued.
<!-- impl AppSrc::fn get_size -->
<!-- impl AppSrc::fn size -->
Get the size of the stream in bytes. A value of -1 means that the size is
not known.
# Returns
the size of the stream previously set with `AppSrc::set_size`;
<!-- impl AppSrc::fn get_stream_type -->
<!-- impl AppSrc::fn stream_type -->
Get the stream type. Control the stream type of `self`
with `AppSrc::set_stream_type`.

92
docs/gstreamer-audio/docs.md
View file

@ -6,13 +6,13 @@ writing samples to the ringbuffer, synchronisation, clipping and flushing.
# Implements
[`AudioBaseSinkExt`](trait.AudioBaseSinkExt.html), [`gst_base::BaseSinkExt`](../gst_base/trait.BaseSinkExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`AudioBaseSinkExt`](trait@crate::AudioBaseSinkExt), [`trait@gst_base::BaseSinkExt`], [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- trait AudioBaseSinkExt -->
Trait containing all `AudioBaseSink` methods.
# Implementors
[`AudioBaseSink`](struct.AudioBaseSink.html), [`AudioSink`](struct.AudioSink.html)
[`AudioBaseSink`](struct@crate::AudioBaseSink), [`AudioSink`](struct@crate::AudioSink)
<!-- trait AudioBaseSinkExt::fn create_ringbuffer -->
Create and return the `AudioRingBuffer` for `self`. This function will
call the ::create_ringbuffer vmethod and will set `self` as the parent of
@ -21,32 +21,32 @@ the returned buffer (see `gst::ObjectExt::set_parent`).
# Returns
The new ringbuffer of `self`.
<!-- trait AudioBaseSinkExt::fn get_alignment_threshold -->
<!-- trait AudioBaseSinkExt::fn alignment_threshold -->
Get the current alignment threshold, in nanoseconds, used by `self`.
# Returns
The current alignment threshold used by `self`.
<!-- trait AudioBaseSinkExt::fn get_discont_wait -->
<!-- trait AudioBaseSinkExt::fn discont_wait -->
Get the current discont wait, in nanoseconds, used by `self`.
# Returns
The current discont wait used by `self`.
<!-- trait AudioBaseSinkExt::fn get_drift_tolerance -->
<!-- trait AudioBaseSinkExt::fn drift_tolerance -->
Get the current drift tolerance, in microseconds, used by `self`.
# Returns
The current drift tolerance used by `self`.
<!-- trait AudioBaseSinkExt::fn get_provide_clock -->
<!-- trait AudioBaseSinkExt::fn is_provide_clock -->
Queries whether `self` will provide a clock or not. See also
gst_audio_base_sink_set_provide_clock.
# Returns
`true` if `self` will provide a clock.
<!-- trait AudioBaseSinkExt::fn get_slave_method -->
<!-- trait AudioBaseSinkExt::fn slave_method -->
Get the current slave method used by `self`.
# Returns
@ -115,13 +115,13 @@ reading samples from the ringbuffer, synchronisation and flushing.
# Implements
[`AudioBaseSrcExt`](trait.AudioBaseSrcExt.html), [`gst_base::BaseSrcExt`](../gst_base/trait.BaseSrcExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`AudioBaseSrcExt`](trait@crate::AudioBaseSrcExt), [`trait@gst_base::BaseSrcExt`], [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- trait AudioBaseSrcExt -->
Trait containing all `AudioBaseSrc` methods.
# Implementors
[`AudioBaseSrc`](struct.AudioBaseSrc.html), [`AudioSrc`](struct.AudioSrc.html)
[`AudioBaseSrc`](struct@crate::AudioBaseSrc), [`AudioSrc`](struct@crate::AudioSrc)
<!-- trait AudioBaseSrcExt::fn create_ringbuffer -->
Create and return the `AudioRingBuffer` for `self`. This function will call
the ::create_ringbuffer vmethod and will set `self` as the parent of the
@ -130,14 +130,14 @@ returned buffer (see `gst::ObjectExt::set_parent`).
# Returns
The new ringbuffer of `self`.
<!-- trait AudioBaseSrcExt::fn get_provide_clock -->
<!-- trait AudioBaseSrcExt::fn is_provide_clock -->
Queries whether `self` will provide a clock or not. See also
gst_audio_base_src_set_provide_clock.
# Returns
`true` if `self` will provide a clock.
<!-- trait AudioBaseSrcExt::fn get_slave_method -->
<!-- trait AudioBaseSrcExt::fn slave_method -->
Get the current slave method used by `self`.
# Returns
@ -342,13 +342,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`AudioDecoderExt`](trait.AudioDecoderExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`AudioDecoderExtManual`](prelude/trait.AudioDecoderExtManual.html)
[`AudioDecoderExt`](trait@crate::AudioDecoderExt), [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`AudioDecoderExtManual`](trait@crate::AudioDecoderExtManual)
<!-- trait AudioDecoderExt -->
Trait containing all `AudioDecoder` methods.
# Implementors
[`AudioDecoder`](struct.AudioDecoder.html)
[`AudioDecoder`](struct@crate::AudioDecoder)
<!-- trait AudioDecoderExt::fn allocate_output_buffer -->
Helper function that allocates a buffer to hold an audio frame
for `self`'s current output format.
@ -400,7 +400,7 @@ decoded data
# Returns
a `gst::FlowReturn` that should be escalated to caller (of caller)
<!-- trait AudioDecoderExt::fn get_allocator -->
<!-- trait AudioDecoderExt::fn allocator -->
Lets `AudioDecoder` sub-classes to know the memory `allocator`
used by the base class and its `params`.
@ -411,17 +411,17 @@ used
## `params`
the
`gst::AllocationParams` of `allocator`
<!-- trait AudioDecoderExt::fn get_audio_info -->
<!-- trait AudioDecoderExt::fn audio_info -->
# Returns
a `AudioInfo` describing the input audio format
<!-- trait AudioDecoderExt::fn get_delay -->
<!-- trait AudioDecoderExt::fn delay -->
# Returns
currently configured decoder delay
<!-- trait AudioDecoderExt::fn get_drainable -->
<!-- trait AudioDecoderExt::fn is_drainable -->
Queries decoder drain handling.
# Returns
@ -429,24 +429,24 @@ Queries decoder drain handling.
TRUE if drainable handling is enabled.
MT safe.
<!-- trait AudioDecoderExt::fn get_estimate_rate -->
<!-- trait AudioDecoderExt::fn estimate_rate -->
# Returns
currently configured byte to time conversion setting
<!-- trait AudioDecoderExt::fn get_latency -->
<!-- trait AudioDecoderExt::fn latency -->
Sets the variables pointed to by `min` and `max` to the currently configured
latency.
## `min`
a pointer to storage to hold minimum latency
## `max`
a pointer to storage to hold maximum latency
<!-- trait AudioDecoderExt::fn get_max_errors -->
<!-- trait AudioDecoderExt::fn max_errors -->
# Returns
currently configured decoder tolerated error count.
<!-- trait AudioDecoderExt::fn get_min_latency -->
<!-- trait AudioDecoderExt::fn min_latency -->
Queries decoder's latency aggregation.
# Returns
@ -454,7 +454,7 @@ Queries decoder's latency aggregation.
aggregation latency.
MT safe.
<!-- trait AudioDecoderExt::fn get_needs_format -->
<!-- trait AudioDecoderExt::fn needs_format -->
Queries decoder required format handling.
# Returns
@ -462,13 +462,13 @@ Queries decoder required format handling.
TRUE if required format handling is enabled.
MT safe.
<!-- trait AudioDecoderExt::fn get_parse_state -->
<!-- trait AudioDecoderExt::fn parse_state -->
Return current parsing (sync and eos) state.
## `sync`
a pointer to a variable to hold the current sync state
## `eos`
a pointer to a variable to hold the current eos state
<!-- trait AudioDecoderExt::fn get_plc -->
<!-- trait AudioDecoderExt::fn is_plc -->
Queries decoder packet loss concealment handling.
# Returns
@ -476,12 +476,12 @@ Queries decoder packet loss concealment handling.
TRUE if packet loss concealment is enabled.
MT safe.
<!-- trait AudioDecoderExt::fn get_plc_aware -->
<!-- trait AudioDecoderExt::fn plc_aware -->
# Returns
currently configured plc handling
<!-- trait AudioDecoderExt::fn get_tolerance -->
<!-- trait AudioDecoderExt::fn tolerance -->
Queries current audio jitter tolerance threshold.
# Returns
@ -741,13 +741,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`AudioEncoderExt`](trait.AudioEncoderExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`AudioEncoderExtManual`](prelude/trait.AudioEncoderExtManual.html)
[`AudioEncoderExt`](trait@crate::AudioEncoderExt), [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`AudioEncoderExtManual`](trait@crate::AudioEncoderExtManual)
<!-- trait AudioEncoderExt -->
Trait containing all `AudioEncoder` methods.
# Implementors
[`AudioEncoder`](struct.AudioEncoder.html)
[`AudioEncoder`](struct@crate::AudioEncoder)
<!-- trait AudioEncoderExt::fn allocate_output_buffer -->
Helper function that allocates a buffer to hold an encoded audio frame
for `self`'s current output format.
@ -776,7 +776,7 @@ number of samples (per channel) represented by encoded data
# Returns
a `gst::FlowReturn` that should be escalated to caller (of caller)
<!-- trait AudioEncoderExt::fn get_allocator -->
<!-- trait AudioEncoderExt::fn allocator -->
Lets `AudioEncoder` sub-classes to know the memory `allocator`
used by the base class and its `params`.
@ -787,12 +787,12 @@ used
## `params`
the
`gst::AllocationParams` of `allocator`
<!-- trait AudioEncoderExt::fn get_audio_info -->
<!-- trait AudioEncoderExt::fn audio_info -->
# Returns
a `AudioInfo` describing the input audio format
<!-- trait AudioEncoderExt::fn get_drainable -->
<!-- trait AudioEncoderExt::fn is_drainable -->
Queries encoder drain handling.
# Returns
@ -800,22 +800,22 @@ Queries encoder drain handling.
TRUE if drainable handling is enabled.
MT safe.
<!-- trait AudioEncoderExt::fn get_frame_max -->
<!-- trait AudioEncoderExt::fn frame_max -->
# Returns
currently configured maximum handled frames
<!-- trait AudioEncoderExt::fn get_frame_samples_max -->
<!-- trait AudioEncoderExt::fn frame_samples_max -->
# Returns
currently maximum requested samples per frame
<!-- trait AudioEncoderExt::fn get_frame_samples_min -->
<!-- trait AudioEncoderExt::fn frame_samples_min -->
# Returns
currently minimum requested samples per frame
<!-- trait AudioEncoderExt::fn get_hard_min -->
<!-- trait AudioEncoderExt::fn is_hard_min -->
Queries encoder hard minimum handling.
# Returns
@ -823,19 +823,19 @@ Queries encoder hard minimum handling.
TRUE if hard minimum handling is enabled.
MT safe.
<!-- trait AudioEncoderExt::fn get_latency -->
<!-- trait AudioEncoderExt::fn latency -->
Sets the variables pointed to by `min` and `max` to the currently configured
latency.
## `min`
a pointer to storage to hold minimum latency
## `max`
a pointer to storage to hold maximum latency
<!-- trait AudioEncoderExt::fn get_lookahead -->
<!-- trait AudioEncoderExt::fn lookahead -->
# Returns
currently configured encoder lookahead
<!-- trait AudioEncoderExt::fn get_mark_granule -->
<!-- trait AudioEncoderExt::fn is_mark_granule -->
Queries if the encoder will handle granule marking.
# Returns
@ -843,7 +843,7 @@ Queries if the encoder will handle granule marking.
TRUE if granule marking is enabled.
MT safe.
<!-- trait AudioEncoderExt::fn get_perfect_timestamp -->
<!-- trait AudioEncoderExt::fn is_perfect_timestamp -->
Queries encoder perfect timestamp behaviour.
# Returns
@ -851,7 +851,7 @@ Queries encoder perfect timestamp behaviour.
TRUE if perfect timestamp setting enabled.
MT safe.
<!-- trait AudioEncoderExt::fn get_tolerance -->
<!-- trait AudioEncoderExt::fn tolerance -->
Queries current audio jitter tolerance threshold.
# Returns
@ -1109,6 +1109,8 @@ complex layout
<!-- struct AudioFormatFlags::const UNPACK -->
the format can be used in
`GstAudioFormatUnpack` and `GstAudioFormatPack` functions
<!-- struct AudioFormatInfo -->
Information for an audio format.
<!-- struct AudioInfo -->
Information describing audio properties. This information can be filled
in from GstCaps with `AudioInfo::from_caps`.
@ -1286,7 +1288,7 @@ together with `AudioBaseSink` using a default implementation of a
# Implements
[`AudioBaseSinkExt`](trait.AudioBaseSinkExt.html), [`gst_base::BaseSinkExt`](../gst_base/trait.BaseSinkExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`AudioBaseSinkExt`](trait@crate::AudioBaseSinkExt), [`trait@gst_base::BaseSinkExt`], [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- struct AudioSrc -->
This is the most simple base class for audio sources that only requires
subclasses to implement a set of simple functions:
@ -1305,7 +1307,7 @@ together with `AudioBaseSrc` using a default implementation of a
# Implements
[`AudioBaseSrcExt`](trait.AudioBaseSrcExt.html), [`gst_base::BaseSrcExt`](../gst_base/trait.BaseSrcExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`AudioBaseSrcExt`](trait@crate::AudioBaseSrcExt), [`trait@gst_base::BaseSrcExt`], [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- struct AudioStreamAlign -->
`AudioStreamAlign` provides a helper object that helps tracking audio
stream alignment and discontinuities, and detects discontinuities if
@ -1485,13 +1487,13 @@ The volume property is defined to be a linear volume factor.
# Implements
[`StreamVolumeExt`](trait.StreamVolumeExt.html)
[`StreamVolumeExt`](trait@crate::StreamVolumeExt)
<!-- trait StreamVolumeExt -->
Trait containing all `StreamVolume` methods.
# Implementors
[`StreamVolume`](struct.StreamVolume.html)
[`StreamVolume`](struct@crate::StreamVolume)
<!-- impl StreamVolume::fn convert_volume -->
## `from`
`StreamVolumeFormat` to convert from
@ -1503,7 +1505,7 @@ Volume in `from` format that should be converted
# Returns
the converted volume
<!-- trait StreamVolumeExt::fn get_mute -->
<!-- trait StreamVolumeExt::fn is_muted -->
# Returns

70
docs/gstreamer-base/docs.md
View file

@ -103,7 +103,7 @@ buffer pushed in it.
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@glib::object::ObjectExt`]
<!-- impl Adapter::fn new -->
Creates a new `Adapter`. Free with `glib::object::ObjectExt::unref`.
@ -627,7 +627,7 @@ Feature: `v1_14`
# Implements
[`AggregatorExt`](trait.AggregatorExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`AggregatorExtManual`](prelude/trait.AggregatorExtManual.html)
[`AggregatorExt`](trait@crate::AggregatorExt), [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`AggregatorExtManual`](trait@crate::AggregatorExtManual)
<!-- trait AggregatorExt -->
Trait containing all `Aggregator` methods.
@ -635,7 +635,7 @@ Feature: `v1_14`
# Implementors
[`Aggregator`](struct.Aggregator.html)
[`Aggregator`](struct@crate::Aggregator)
<!-- trait AggregatorExt::fn finish_buffer -->
This method will push the provided output buffer downstream. If needed,
mandatory events such as stream-start, caps, and segment events will be
@ -654,7 +654,7 @@ Feature: `v1_18`
## `bufferlist`
the `gst::BufferList` to push.
<!-- trait AggregatorExt::fn get_allocator -->
<!-- trait AggregatorExt::fn allocator -->
Lets `Aggregator` sub-classes get the memory `allocator`
acquired by the base class and its `params`.
@ -668,7 +668,7 @@ used
## `params`
the
`gst::AllocationParams` of `allocator`
<!-- trait AggregatorExt::fn get_buffer_pool -->
<!-- trait AggregatorExt::fn buffer_pool -->
Feature: `v1_14`
@ -677,7 +677,7 @@ Feature: `v1_14`
the instance of the `gst::BufferPool` used
by `trans`; free it after use it
<!-- trait AggregatorExt::fn get_latency -->
<!-- trait AggregatorExt::fn latency -->
Retrieves the latency values reported by `self` in response to the latency
query, or `GST_CLOCK_TIME_NONE` if there is not live source connected and the element
will not wait for the clock.
@ -835,7 +835,7 @@ Feature: `v1_14`
# Implements
[`AggregatorPadExt`](trait.AggregatorPadExt.html), [`gst::PadExt`](../gst/trait.PadExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`AggregatorPadExtManual`](prelude/trait.AggregatorPadExtManual.html)
[`AggregatorPadExt`](trait@crate::AggregatorPadExt), [`trait@gst::PadExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`AggregatorPadExtManual`](trait@crate::AggregatorPadExtManual)
<!-- trait AggregatorPadExt -->
Trait containing all `AggregatorPad` methods.
@ -843,7 +843,7 @@ Feature: `v1_14`
# Implementors
[`AggregatorPad`](struct.AggregatorPad.html)
[`AggregatorPad`](struct@crate::AggregatorPad)
<!-- trait AggregatorPadExt::fn drop_buffer -->
Drop the buffer currently queued in `self`.
@ -1055,13 +1055,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`BaseParseExt`](trait.BaseParseExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`BaseParseExtManual`](prelude/trait.BaseParseExtManual.html)
[`BaseParseExt`](trait@crate::BaseParseExt), [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`BaseParseExtManual`](trait@crate::BaseParseExtManual)
<!-- trait BaseParseExt -->
Trait containing all `BaseParse` methods.
# Implementors
[`BaseParse`](struct.BaseParse.html)
[`BaseParse`](struct@crate::BaseParse)
<!-- trait BaseParseExt::fn add_index_entry -->
Adds an entry to the index associating `offset` to `ts`. It is recommended
to only add keyframe entries. `force` allows to bypass checks, such as
@ -1441,13 +1441,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`BaseSinkExt`](trait.BaseSinkExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`BaseSinkExtManual`](prelude/trait.BaseSinkExtManual.html)
[`BaseSinkExt`](trait@crate::BaseSinkExt), [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`BaseSinkExtManual`](trait@crate::BaseSinkExtManual)
<!-- trait BaseSinkExt -->
Trait containing all `BaseSink` methods.
# Implementors
[`BaseSink`](struct.BaseSink.html)
[`BaseSink`](struct@crate::BaseSink)
<!-- trait BaseSinkExt::fn do_preroll -->
If the `self` spawns its own thread for pulling buffers from upstream it
should call this method after it has pulled a buffer. If the element needed
@ -1462,14 +1462,14 @@ the mini object that caused the preroll
`gst::FlowReturn::Ok` if the preroll completed and processing can
continue. Any other return value should be returned from the render vmethod.
<!-- trait BaseSinkExt::fn get_blocksize -->
<!-- trait BaseSinkExt::fn blocksize -->
Get the number of bytes that the sink will pull when it is operating in pull
mode.
# Returns
the number of bytes `self` will pull in pull mode.
<!-- trait BaseSinkExt::fn get_drop_out_of_segment -->
<!-- trait BaseSinkExt::fn is_drop_out_of_segment -->
Checks if `self` is currently configured to drop buffers which are outside
the current segment
@ -1480,7 +1480,7 @@ Feature: `v1_12`
`true` if the sink is configured to drop buffers outside the
current segment.
<!-- trait BaseSinkExt::fn get_last_sample -->
<!-- trait BaseSinkExt::fn last_sample -->
Get the last sample that arrived in the sink and was used for preroll or for
rendering. This property can be used to generate thumbnails.
@ -1493,19 +1493,19 @@ Free-function: gst_sample_unref
a `gst::Sample`. `gst_sample_unref` after
usage. This function returns `None` when no buffer has arrived in the
sink yet or when the sink is not in PAUSED or PLAYING.
<!-- trait BaseSinkExt::fn get_latency -->
<!-- trait BaseSinkExt::fn latency -->
Get the currently configured latency.
# Returns
The configured latency.
<!-- trait BaseSinkExt::fn get_max_bitrate -->
<!-- trait BaseSinkExt::fn max_bitrate -->
Get the maximum amount of bits per second that the sink will render.
# Returns
the maximum number of bits per second `self` will render.
<!-- trait BaseSinkExt::fn get_max_lateness -->
<!-- trait BaseSinkExt::fn max_lateness -->
Gets the max lateness value. See `BaseSinkExt::set_max_lateness` for
more details.
@ -1514,7 +1514,7 @@ more details.
The maximum time in nanoseconds that a buffer can be late
before it is dropped and not rendered. A value of -1 means an
unlimited time.
<!-- trait BaseSinkExt::fn get_processing_deadline -->
<!-- trait BaseSinkExt::fn processing_deadline -->
Get the processing deadline of `self`. see
`BaseSinkExt::set_processing_deadline` for more information about
the processing deadline.
@ -1525,14 +1525,14 @@ Feature: `v1_16`
# Returns
the processing deadline
<!-- trait BaseSinkExt::fn get_render_delay -->
<!-- trait BaseSinkExt::fn render_delay -->
Get the render delay of `self`. see `BaseSinkExt::set_render_delay` for more
information about the render delay.
# Returns
the render delay of `self`.
<!-- trait BaseSinkExt::fn get_stats -->
<!-- trait BaseSinkExt::fn stats -->
Return various `BaseSink` statistics. This function returns a `gst::Structure`
with name `application/x-gst-base-sink-stats` with the following fields:
@ -1546,21 +1546,21 @@ Feature: `v1_18`
# Returns
pointer to `gst::Structure`
<!-- trait BaseSinkExt::fn get_sync -->
<!-- trait BaseSinkExt::fn is_sync -->
Checks if `self` is currently configured to synchronize against the
clock.
# Returns
`true` if the sink is configured to synchronize against the clock.
<!-- trait BaseSinkExt::fn get_throttle_time -->
<!-- trait BaseSinkExt::fn throttle_time -->
Get the time that will be inserted between frames to control the
maximum buffers per second.
# Returns
the number of nanoseconds `self` will put between frames.
<!-- trait BaseSinkExt::fn get_ts_offset -->
<!-- trait BaseSinkExt::fn ts_offset -->
Get the synchronisation offset of `self`.
# Returns
@ -1965,14 +1965,14 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`BaseSrcExt`](trait.BaseSrcExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`BaseSrcExtManual`](prelude/trait.BaseSrcExtManual.html)
[`BaseSrcExt`](trait@crate::BaseSrcExt), [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`BaseSrcExtManual`](trait@crate::BaseSrcExtManual)
<!-- trait BaseSrcExt -->
Trait containing all `BaseSrc` methods.
# Implementors
[`BaseSrc`](struct.BaseSrc.html), [`PushSrc`](struct.PushSrc.html)
<!-- trait BaseSrcExt::fn get_allocator -->
[`BaseSrc`](struct@crate::BaseSrc), [`PushSrc`](struct@crate::PushSrc)
<!-- trait BaseSrcExt::fn allocator -->
Lets `BaseSrc` sub-classes to know the memory `allocator`
used by the base class and its `params`.
@ -1982,19 +1982,19 @@ the `gst::Allocator`
used
## `params`
the `gst::AllocationParams` of `allocator`
<!-- trait BaseSrcExt::fn get_blocksize -->
<!-- trait BaseSrcExt::fn blocksize -->
Get the number of bytes that `self` will push out with each buffer.
# Returns
the number of bytes pushed with each buffer.
<!-- trait BaseSrcExt::fn get_buffer_pool -->
<!-- trait BaseSrcExt::fn buffer_pool -->
# Returns
the instance of the `gst::BufferPool` used
by the src; unref it after usage.
<!-- trait BaseSrcExt::fn get_do_timestamp -->
<!-- trait BaseSrcExt::fn does_timestamp -->
Query if `self` timestamps outgoing buffers based on the current running_time.
# Returns
@ -2309,14 +2309,14 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`BaseTransformExt`](trait.BaseTransformExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`BaseTransformExtManual`](prelude/trait.BaseTransformExtManual.html)
[`BaseTransformExt`](trait@crate::BaseTransformExt), [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`BaseTransformExtManual`](trait@crate::BaseTransformExtManual)
<!-- trait BaseTransformExt -->
Trait containing all `BaseTransform` methods.
# Implementors
[`BaseTransform`](struct.BaseTransform.html)
<!-- trait BaseTransformExt::fn get_allocator -->
[`BaseTransform`](struct@crate::BaseTransform)
<!-- trait BaseTransformExt::fn allocator -->
Lets `BaseTransform` sub-classes know the memory `allocator`
used by the base class and its `params`.
@ -2326,7 +2326,7 @@ the `gst::Allocator`
used
## `params`
the `gst::AllocationParams` of `allocator`
<!-- trait BaseTransformExt::fn get_buffer_pool -->
<!-- trait BaseTransformExt::fn buffer_pool -->
# Returns
@ -2582,4 +2582,4 @@ base class.
# Implements
[`BaseSrcExt`](trait.BaseSrcExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`BaseSrcExtManual`](prelude/trait.BaseSrcExtManual.html)
[`BaseSrcExt`](trait@crate::BaseSrcExt), [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`BaseSrcExtManual`](trait@crate::BaseSrcExtManual)

1023
docs/gstreamer-check/docs.md
View file

File diff suppressed because it is too large Load diff

30
docs/gstreamer-controller/docs.md
View file

@ -6,13 +6,13 @@ color component off and a value of 1.0 will be the color level.
# Implements
[`ARGBControlBindingExt`](trait.ARGBControlBindingExt.html), [`gst::ControlBindingExt`](../gst/trait.ControlBindingExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html)
[`ARGBControlBindingExt`](trait@crate::ARGBControlBindingExt), [`trait@gst::ControlBindingExt`], [`trait@gst::ObjectExt`]
<!-- trait ARGBControlBindingExt -->
Trait containing all `ARGBControlBinding` methods.
# Implementors
[`ARGBControlBinding`](struct.ARGBControlBinding.html)
[`ARGBControlBinding`](struct@crate::ARGBControlBinding)
<!-- impl ARGBControlBinding::fn new -->
Create a new control-binding that attaches the given `gst::ControlSource` to the
`glib::object::Object` property.
@ -54,13 +54,13 @@ transformations.
# Implements
[`DirectControlBindingExt`](trait.DirectControlBindingExt.html), [`gst::ControlBindingExt`](../gst/trait.ControlBindingExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html)
[`DirectControlBindingExt`](trait@crate::DirectControlBindingExt), [`trait@gst::ControlBindingExt`], [`trait@gst::ObjectExt`]
<!-- trait DirectControlBindingExt -->
Trait containing all `DirectControlBinding` methods.
# Implementors
[`DirectControlBinding`](struct.DirectControlBinding.html)
[`DirectControlBinding`](struct@crate::DirectControlBinding)
<!-- impl DirectControlBinding::fn new -->
Create a new control-binding that attaches the `gst::ControlSource` to the
`glib::object::Object` property. It will map the control source range [0.0 ... 1.0] to
@ -101,13 +101,13 @@ All functions are MT-safe.
# Implements
[`InterpolationControlSourceExt`](trait.InterpolationControlSourceExt.html), [`TimedValueControlSourceExt`](trait.TimedValueControlSourceExt.html), [`gst::ControlSourceExt`](../gst/trait.ControlSourceExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html)
[`InterpolationControlSourceExt`](trait@crate::InterpolationControlSourceExt), [`TimedValueControlSourceExt`](trait@crate::TimedValueControlSourceExt), [`trait@gst::ControlSourceExt`], [`trait@gst::ObjectExt`]
<!-- trait InterpolationControlSourceExt -->
Trait containing all `InterpolationControlSource` methods.
# Implementors
[`InterpolationControlSource`](struct.InterpolationControlSource.html)
[`InterpolationControlSource`](struct@crate::InterpolationControlSource)
<!-- impl InterpolationControlSource::fn new -->
This returns a new, unbound `InterpolationControlSource`.
@ -139,13 +139,13 @@ All functions are MT-safe.
# Implements
[`LFOControlSourceExt`](trait.LFOControlSourceExt.html), [`gst::ControlSourceExt`](../gst/trait.ControlSourceExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html)
[`LFOControlSourceExt`](trait@crate::LFOControlSourceExt), [`trait@gst::ControlSourceExt`], [`trait@gst::ObjectExt`]
<!-- trait LFOControlSourceExt -->
Trait containing all `LFOControlSource` methods.
# Implementors
[`LFOControlSource`](struct.LFOControlSource.html)
[`LFOControlSource`](struct@crate::LFOControlSource)
<!-- impl LFOControlSource::fn new -->
This returns a new, unbound `LFOControlSource`.
@ -203,7 +203,7 @@ Feature: `v1_12`
# Implements
[`gst::ControlBindingExt`](../gst/trait.ControlBindingExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html)
[`trait@gst::ControlBindingExt`], [`trait@gst::ObjectExt`]
<!-- impl ProxyControlBinding::fn new -->
`ProxyControlBinding` forwards all access to data or `sync_values()`
requests from `property_name` on `object` to the control binding at
@ -237,13 +237,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`TimedValueControlSourceExt`](trait.TimedValueControlSourceExt.html), [`gst::ControlSourceExt`](../gst/trait.ControlSourceExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html)
[`TimedValueControlSourceExt`](trait@crate::TimedValueControlSourceExt), [`trait@gst::ControlSourceExt`], [`trait@gst::ObjectExt`]
<!-- trait TimedValueControlSourceExt -->
Trait containing all `TimedValueControlSource` methods.
# Implementors
[`InterpolationControlSource`](struct.InterpolationControlSource.html), [`TimedValueControlSource`](struct.TimedValueControlSource.html), [`TriggerControlSource`](struct.TriggerControlSource.html)
[`InterpolationControlSource`](struct@crate::InterpolationControlSource), [`TimedValueControlSource`](struct@crate::TimedValueControlSource), [`TriggerControlSource`](struct@crate::TriggerControlSource)
<!-- trait TimedValueControlSourceExt::fn find_control_point_iter -->
Find last value before given timestamp in control point list.
If all values in the control point list come after the given
@ -256,7 +256,7 @@ the search key
# Returns
the found `glib::SequenceIter` or `None`
<!-- trait TimedValueControlSourceExt::fn get_all -->
<!-- trait TimedValueControlSourceExt::fn all -->
Returns a read-only copy of the list of `gst::TimedValue` for the given property.
Free the list after done with it.
@ -264,7 +264,7 @@ Free the list after done with it.
a copy
of the list, or `None` if the property isn't handled by the controller
<!-- trait TimedValueControlSourceExt::fn get_count -->
<!-- trait TimedValueControlSourceExt::fn count -->
Get the number of control points that are set.
# Returns
@ -324,13 +324,13 @@ All functions are MT-safe.
# Implements
[`TriggerControlSourceExt`](trait.TriggerControlSourceExt.html), [`TimedValueControlSourceExt`](trait.TimedValueControlSourceExt.html), [`gst::ControlSourceExt`](../gst/trait.ControlSourceExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html)
[`TriggerControlSourceExt`](trait@crate::TriggerControlSourceExt), [`TimedValueControlSourceExt`](trait@crate::TimedValueControlSourceExt), [`trait@gst::ControlSourceExt`], [`trait@gst::ObjectExt`]
<!-- trait TriggerControlSourceExt -->
Trait containing all `TriggerControlSource` methods.
# Implementors
[`TriggerControlSource`](struct.TriggerControlSource.html)
[`TriggerControlSource`](struct@crate::TriggerControlSource)
<!-- impl TriggerControlSource::fn new -->
This returns a new, unbound `TriggerControlSource`.

192
docs/gstreamer-editing-services/docs.md
View file

@ -97,13 +97,13 @@ them with `AssetExt::unproxy`.
# Implements
[`AssetExt`](trait.AssetExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`AssetExt`](trait@crate::AssetExt), [`trait@glib::object::ObjectExt`]
<!-- trait AssetExt -->
Trait containing all `Asset` methods.
# Implementors
[`Asset`](struct.Asset.html), [`Project`](struct.Project.html)
[`Asset`](struct@crate::Asset), [`Project`](struct@crate::Project)
<!-- impl Asset::fn needs_reload -->
Indicate that an existing `Asset` in the cache should be reloaded
upon the next request. This can be used when some condition has
@ -241,32 +241,32 @@ newly created object.
A newly created object, or `None` if an
error occurred.
<!-- trait AssetExt::fn get_error -->
<!-- trait AssetExt::fn error -->
Retrieve the error that was set on the asset when it was loaded.
# Returns
The error set on `asset`, or
`None` if no error occurred when `asset` was loaded.
<!-- trait AssetExt::fn get_extractable_type -->
<!-- trait AssetExt::fn extractable_type -->
Gets the `Asset:extractable-type` of the asset.
# Returns
The extractable type of `self`.
<!-- trait AssetExt::fn get_id -->
<!-- trait AssetExt::fn id -->
Gets the `Asset:id` of the asset.
# Returns
The ID of `self`.
<!-- trait AssetExt::fn get_proxy -->
<!-- trait AssetExt::fn proxy -->
Gets the default `Asset:proxy` of the asset.
# Returns
The default proxy of `self`.
<!-- trait AssetExt::fn get_proxy_target -->
<!-- trait AssetExt::fn proxy_target -->
Gets the `Asset:proxy-target` of the asset.
Note that the proxy target may have loaded with an error, so you should
@ -426,13 +426,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`BaseEffectExt`](trait.BaseEffectExt.html), [`TrackElementExt`](trait.TrackElementExt.html), [`TimelineElementExt`](trait.TimelineElementExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html), [`TimelineElementExtManual`](prelude/trait.TimelineElementExtManual.html)
[`BaseEffectExt`](trait@crate::BaseEffectExt), [`TrackElementExt`](trait@crate::TrackElementExt), [`TimelineElementExt`](trait@crate::TimelineElementExt), [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt), [`TimelineElementExtManual`](trait@crate::TimelineElementExtManual)
<!-- trait BaseEffectExt -->
Trait containing all `BaseEffect` methods.
# Implementors
[`BaseEffect`](struct.BaseEffect.html), [`Effect`](struct.Effect.html)
[`BaseEffect`](struct@crate::BaseEffect), [`Effect`](struct@crate::Effect)
<!-- trait BaseEffectExt::fn is_time_effect -->
Get whether the effect is considered a time effect or not. An effect
with registered time properties or set translation functions is
@ -512,7 +512,7 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`OperationClipExt`](trait.OperationClipExt.html), [`ClipExt`](trait.ClipExt.html), [`GESContainerExt`](trait.GESContainerExt.html), [`TimelineElementExt`](trait.TimelineElementExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html), [`TimelineElementExtManual`](prelude/trait.TimelineElementExtManual.html)
[`OperationClipExt`](trait@crate::OperationClipExt), [`ClipExt`](trait@crate::ClipExt), [`GESContainerExt`](trait@crate::GESContainerExt), [`TimelineElementExt`](trait@crate::TimelineElementExt), [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt), [`TimelineElementExtManual`](trait@crate::TimelineElementExtManual)
<!-- struct Clip -->
`Clip`-s are the core objects of a `Layer`. Each clip may exist in
a single layer but may control several `TrackElement`-s that span
@ -696,13 +696,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`ClipExt`](trait.ClipExt.html), [`GESContainerExt`](trait.GESContainerExt.html), [`TimelineElementExt`](trait.TimelineElementExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html), [`TimelineElementExtManual`](prelude/trait.TimelineElementExtManual.html)
[`ClipExt`](trait@crate::ClipExt), [`GESContainerExt`](trait@crate::GESContainerExt), [`TimelineElementExt`](trait@crate::TimelineElementExt), [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt), [`TimelineElementExtManual`](trait@crate::TimelineElementExtManual)
<!-- trait ClipExt -->
Trait containing all `Clip` methods.
# Implementors
[`Clip`](struct.Clip.html), [`OperationClip`](struct.OperationClip.html)
[`Clip`](struct@crate::Clip), [`OperationClip`](struct@crate::OperationClip)
<!-- trait ClipExt::fn add_asset -->
Extracts a `TrackElement` from an asset and adds it to the clip.
This can be used to add effects that derive from the asset to the
@ -831,7 +831,7 @@ match any type
A list of all
the `TrackElement`-s controlled by `self`, in `track` or of the given
`track_type`, and of the given `type_`.
<!-- trait ClipExt::fn get_duration_limit -->
<!-- trait ClipExt::fn duration_limit -->
Gets the `Clip:duration-limit` of the clip.
Feature: `v1_18`
@ -892,14 +892,14 @@ A time in the timeline time coordinates
The time in the internal coordinates of `child` corresponding
to `timeline_time`, or `GST_CLOCK_TIME_NONE` if the conversion could not
be performed.
<!-- trait ClipExt::fn get_layer -->
<!-- trait ClipExt::fn layer -->
Gets the `Clip:layer` of the clip.
# Returns
The layer `self` is in, or `None` if
`self` is not in any layer.
<!-- trait ClipExt::fn get_supported_formats -->
<!-- trait ClipExt::fn supported_formats -->
Gets the `Clip:supported-formats` of the clip.
# Returns
@ -999,7 +999,7 @@ The effect we want to get the index of
# Returns
The index of `effect` in `self`, or -1 if something went wrong.
<!-- trait ClipExt::fn get_top_effects -->
<!-- trait ClipExt::fn top_effects -->
Gets the `BaseEffect`-s that have been added to the clip. The
returned list is ordered by their internal index in the clip. See
`ClipExt::get_top_effect_index`.
@ -1172,13 +1172,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`GESContainerExt`](trait.GESContainerExt.html), [`TimelineElementExt`](trait.TimelineElementExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html), [`TimelineElementExtManual`](prelude/trait.TimelineElementExtManual.html)
[`GESContainerExt`](trait@crate::GESContainerExt), [`TimelineElementExt`](trait@crate::TimelineElementExt), [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt), [`TimelineElementExtManual`](trait@crate::TimelineElementExtManual)
<!-- trait GESContainerExt -->
Trait containing all `Container` methods.
# Implementors
[`Clip`](struct.Clip.html), [`Container`](struct.Container.html), [`Group`](struct.Group.html)
[`Clip`](struct@crate::Clip), [`Container`](struct@crate::Container), [`Group`](struct@crate::Group)
<!-- impl Container::fn group -->
Groups the containers into a single container by merging them. The
containers must all belong to the same `TimelineElement:timeline`.
@ -1470,13 +1470,13 @@ GES will always request at most one sinkpad per effect (when required).
# Implements
[`EffectExt`](trait.EffectExt.html), [`BaseEffectExt`](trait.BaseEffectExt.html), [`TrackElementExt`](trait.TrackElementExt.html), [`TimelineElementExt`](trait.TimelineElementExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html), [`TimelineElementExtManual`](prelude/trait.TimelineElementExtManual.html)
[`EffectExt`](trait@crate::EffectExt), [`BaseEffectExt`](trait@crate::BaseEffectExt), [`TrackElementExt`](trait@crate::TrackElementExt), [`TimelineElementExt`](trait@crate::TimelineElementExt), [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt), [`TimelineElementExtManual`](trait@crate::TimelineElementExtManual)
<!-- trait EffectExt -->
Trait containing all `Effect` methods.
# Implementors
[`Effect`](struct.Effect.html)
[`Effect`](struct@crate::Effect)
<!-- impl Effect::fn new -->
Creates a new `Effect` from the description of the bin. It should be
possible to determine the type of the effect through the element
@ -1521,21 +1521,21 @@ came from, which you can retrieve using `Extractable::get_asset`.
# Implements
[`ExtractableExt`](trait.ExtractableExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`ExtractableExt`](trait@crate::ExtractableExt), [`trait@glib::object::ObjectExt`]
<!-- trait ExtractableExt -->
Trait containing all `Extractable` methods.
# Implementors
[`BaseEffect`](struct.BaseEffect.html), [`BaseTransitionClip`](struct.BaseTransitionClip.html), [`Clip`](struct.Clip.html), [`Container`](struct.Container.html), [`Effect`](struct.Effect.html), [`Extractable`](struct.Extractable.html), [`Group`](struct.Group.html), [`Layer`](struct.Layer.html), [`OperationClip`](struct.OperationClip.html), [`TimelineElement`](struct.TimelineElement.html), [`Timeline`](struct.Timeline.html), [`TrackElement`](struct.TrackElement.html), [`TransitionClip`](struct.TransitionClip.html), [`UriClip`](struct.UriClip.html)
<!-- trait ExtractableExt::fn get_asset -->
[`BaseEffect`](struct@crate::BaseEffect), [`BaseTransitionClip`](struct@crate::BaseTransitionClip), [`Clip`](struct@crate::Clip), [`Container`](struct@crate::Container), [`Effect`](struct@crate::Effect), [`Extractable`](struct@crate::Extractable), [`Group`](struct@crate::Group), [`Layer`](struct@crate::Layer), [`OperationClip`](struct@crate::OperationClip), [`TimelineElement`](struct@crate::TimelineElement), [`Timeline`](struct@crate::Timeline), [`TrackElement`](struct@crate::TrackElement), [`TransitionClip`](struct@crate::TransitionClip), [`UriClip`](struct@crate::UriClip)
<!-- trait ExtractableExt::fn asset -->
Get the asset that has been set on the extractable object.
# Returns
The asset set on `self`, or `None`
if no asset has been set.
<!-- trait ExtractableExt::fn get_id -->
<!-- trait ExtractableExt::fn id -->
Gets the `Asset:id` of some associated asset. It may be the case
that the object has no set asset, or even that such an asset does not
yet exist in the GES cache. Instead, this will return the asset
@ -1604,13 +1604,13 @@ smallest) of all the layers it spans.
# Implements
[`GroupExt`](trait.GroupExt.html), [`GESContainerExt`](trait.GESContainerExt.html), [`TimelineElementExt`](trait.TimelineElementExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html), [`TimelineElementExtManual`](prelude/trait.TimelineElementExtManual.html)
[`GroupExt`](trait@crate::GroupExt), [`GESContainerExt`](trait@crate::GESContainerExt), [`TimelineElementExt`](trait@crate::TimelineElementExt), [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt), [`TimelineElementExtManual`](trait@crate::TimelineElementExtManual)
<!-- trait GroupExt -->
Trait containing all `Group` methods.
# Implementors
[`Group`](struct.Group.html)
[`Group`](struct@crate::Group)
<!-- impl Group::fn new -->
Created a new empty group. You may wish to use
`Container::group` instead, which can return a different
@ -1681,13 +1681,13 @@ layers will simply play in addition.
# Implements
[`LayerExt`](trait.LayerExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html)
[`LayerExt`](trait@crate::LayerExt), [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt)
<!-- trait LayerExt -->
Trait containing all `Layer` methods.
# Implementors
[`Layer`](struct.Layer.html)
[`Layer`](struct@crate::Layer)
<!-- impl Layer::fn new -->
Creates a new layer.
@ -1778,13 +1778,13 @@ The `Track` to check if `self` is currently active for
# Returns
`true` if `self` is active for `track`, or `false` otherwise.
<!-- trait LayerExt::fn get_auto_transition -->
<!-- trait LayerExt::fn is_auto_transition -->
Gets the `Layer:auto-transition` of the layer.
# Returns
`true` if transitions are automatically added to `self`.
<!-- trait LayerExt::fn get_clips -->
<!-- trait LayerExt::fn clips -->
Get the `Clip`-s contained in this layer.
# Returns
@ -1802,7 +1802,7 @@ End of the interval
A list of `Clip`-s
that intersect the interval `[start, end)` in `self`.
<!-- trait LayerExt::fn get_duration -->
<!-- trait LayerExt::fn duration -->
Retrieves the duration of the layer, which is the difference
between the start of the layer (always time 0) and the end (which will
be the end time of the final clip).
@ -1810,14 +1810,14 @@ be the end time of the final clip).
# Returns
The duration of `self`.
<!-- trait LayerExt::fn get_priority -->
<!-- trait LayerExt::fn priority -->
Get the priority of the layer. When inside a timeline, this is its
index in the timeline. See `TimelineExt::move_layer`.
# Returns
The priority of `self` within its timeline.
<!-- trait LayerExt::fn get_timeline -->
<!-- trait LayerExt::fn timeline -->
Gets the timeline that the layer is a part of.
# Returns
@ -1956,7 +1956,7 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`ClipExt`](trait.ClipExt.html), [`GESContainerExt`](trait.GESContainerExt.html), [`TimelineElementExt`](trait.TimelineElementExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html), [`TimelineElementExtManual`](prelude/trait.TimelineElementExtManual.html)
[`ClipExt`](trait@crate::ClipExt), [`GESContainerExt`](trait@crate::GESContainerExt), [`TimelineElementExt`](trait@crate::TimelineElementExt), [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt), [`TimelineElementExtManual`](trait@crate::TimelineElementExtManual)
<!-- struct Pipeline -->
A `Pipeline` can take an audio-video `Timeline` and conveniently
link its `Track`-s to an internal `playsink` element, for
@ -1972,20 +1972,20 @@ You can set the encoding and save location used in rendering by calling
# Implements
[`GESPipelineExt`](trait.GESPipelineExt.html), [`gst::PipelineExt`](../gst/trait.PipelineExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`GESPipelineExt`](trait@crate::GESPipelineExt), [`trait@gst::PipelineExt`], [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- trait GESPipelineExt -->
Trait containing all `Pipeline` methods.
# Implementors
[`Pipeline`](struct.Pipeline.html)
[`Pipeline`](struct@crate::Pipeline)
<!-- impl Pipeline::fn new -->
Creates a new pipeline.
# Returns
The newly created pipeline.
<!-- trait GESPipelineExt::fn get_mode -->
<!-- trait GESPipelineExt::fn mode -->
Gets the `Pipeline:mode` of the pipeline.
# Returns
@ -2223,13 +2223,13 @@ the same temporary location.
# Implements
[`ProjectExt`](trait.ProjectExt.html), [`AssetExt`](trait.AssetExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`ProjectExt`](trait@crate::ProjectExt), [`AssetExt`](trait@crate::AssetExt), [`trait@glib::object::ObjectExt`]
<!-- trait ProjectExt -->
Trait containing all `Project` methods.
# Implementors
[`Project`](struct.Project.html)
[`Project`](struct@crate::Project)
<!-- impl Project::fn new -->
Creates a new `Project` and sets its uri to `uri` if provided. Note that
if `uri` is not valid or `None`, the uri of the project will then be set
@ -2306,7 +2306,7 @@ to retrieve from `object`
The `Asset` with
`id` or `None` if no asset with `id` as an ID
<!-- trait ProjectExt::fn get_loading_assets -->
<!-- trait ProjectExt::fn loading_assets -->
Get the assets that are being loaded
# Returns
@ -2314,7 +2314,7 @@ Get the assets that are being loaded
A set of loading asset
that will be added to `self`. Note that those Asset are *not* loaded yet,
and thus can not be used
<!-- trait ProjectExt::fn get_uri -->
<!-- trait ProjectExt::fn uri -->
Retrieve the uri that is currently set on `self`
# Returns
@ -2545,13 +2545,13 @@ content, or render it to a file.
# Implements
[`TimelineExt`](trait.TimelineExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html)
[`TimelineExt`](trait@crate::TimelineExt), [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt)
<!-- trait TimelineExt -->
Trait containing all `Timeline` methods.
# Implementors
[`Timeline`](struct.Timeline.html)
[`Timeline`](struct@crate::Timeline)
<!-- impl Timeline::fn new -->
Creates a new empty timeline.
@ -2566,7 +2566,7 @@ single `VideoTrack`.
The new timeline, or `None` if the tracks
could not be created and added.
<!-- impl Timeline::fn new_from_uri -->
<!-- impl Timeline::fn from_uri -->
Creates a timeline from the given URI.
## `uri`
The URI to load from
@ -2659,13 +2659,13 @@ See `TimelineExt::commit`.
`true` if pending changes were committed, or `false` if nothing
needed to be committed.
<!-- trait TimelineExt::fn get_auto_transition -->
<!-- trait TimelineExt::fn is_auto_transition -->
Gets `Timeline:auto-transition` for the timeline.
# Returns
The auto-transition of `self_`.
<!-- trait TimelineExt::fn get_duration -->
<!-- trait TimelineExt::fn duration -->
Get the current `Timeline:duration` of the timeline
# Returns
@ -2707,7 +2707,7 @@ The frame number to get the corresponding timestamp of in the
# Returns
The timestamp corresponding to `frame_number` in the output of `self`.
<!-- trait TimelineExt::fn get_groups -->
<!-- trait TimelineExt::fn groups -->
Get the list of `Group`-s present in the timeline.
# Returns
@ -2727,7 +2727,7 @@ The layer with the given
`priority`, or `None` if none was found.
Since 1.6
<!-- trait TimelineExt::fn get_layers -->
<!-- trait TimelineExt::fn layers -->
Get the list of `Layer`-s present in the timeline.
# Returns
@ -2744,7 +2744,7 @@ A track
The pad corresponding to `track`,
or `None` if there is an error.
<!-- trait TimelineExt::fn get_snapping_distance -->
<!-- trait TimelineExt::fn snapping_distance -->
Gets the `Timeline:snapping-distance` for the timeline.
# Returns
@ -2759,7 +2759,7 @@ A pad
The track corresponding to `pad`,
or `None` if there is an error.
<!-- trait TimelineExt::fn get_tracks -->
<!-- trait TimelineExt::fn tracks -->
Get the list of `Track`-s used by the timeline.
# Returns
@ -3137,13 +3137,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`TimelineElementExt`](trait.TimelineElementExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html), [`TimelineElementExtManual`](prelude/trait.TimelineElementExtManual.html)
[`TimelineElementExt`](trait@crate::TimelineElementExt), [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt), [`TimelineElementExtManual`](trait@crate::TimelineElementExtManual)
<!-- trait TimelineElementExt -->
Trait containing all `TimelineElement` methods.
# Implementors
[`Container`](struct.Container.html), [`TimelineElement`](struct.TimelineElement.html), [`TrackElement`](struct.TrackElement.html)
[`Container`](struct@crate::Container), [`TimelineElement`](struct@crate::TimelineElement), [`TrackElement`](struct@crate::TrackElement)
<!-- trait TimelineElementExt::fn add_child_property -->
Register a property of a child of the element to allow it to be
written with `TimelineElementExt::set_child_property` and read with
@ -3293,19 +3293,19 @@ The name of the first child property to get
## `var_args`
The return location for the first property, followed
optionally by more name/return location pairs, followed by `None`
<!-- trait TimelineElementExt::fn get_duration -->
<!-- trait TimelineElementExt::fn duration -->
Gets the `TimelineElement:duration` for the element.
# Returns
The duration of `self` (in nanoseconds).
<!-- trait TimelineElementExt::fn get_inpoint -->
<!-- trait TimelineElementExt::fn inpoint -->
Gets the `TimelineElement:in-point` for the element.
# Returns
The in-point of `self` (in nanoseconds).
<!-- trait TimelineElementExt::fn get_layer_priority -->
<!-- trait TimelineElementExt::fn layer_priority -->
Gets the priority of the layer the element is in. A `Group` may span
several layers, so this would return the highest priority (numerically,
the smallest) amongst them.
@ -3318,19 +3318,19 @@ Feature: `v1_16`
The priority of the layer `self` is in, or
`GES_TIMELINE_ELEMENT_NO_LAYER_PRIORITY` if `self` does not exist in a
layer.
<!-- trait TimelineElementExt::fn get_max_duration -->
<!-- trait TimelineElementExt::fn max_duration -->
Gets the `TimelineElement:max-duration` for the element.
# Returns
The max-duration of `self` (in nanoseconds).
<!-- trait TimelineElementExt::fn get_name -->
<!-- trait TimelineElementExt::fn name -->
Gets the `TimelineElement:name` for the element.
# Returns
The name of `self`.
<!-- trait TimelineElementExt::fn get_natural_framerate -->
<!-- trait TimelineElementExt::fn natural_framerate -->
Get the "natural" framerate of `self`. This is to say, for example
for a `VideoUriSource` the framerate of the source.
@ -3353,39 +3353,39 @@ The framerate denominator
Whether `self` has a natural framerate or not, `framerate_n`
and `framerate_d` will be set to, respectively, 0 and -1 if it is
not the case.
<!-- trait TimelineElementExt::fn get_parent -->
<!-- trait TimelineElementExt::fn parent -->
Gets the `TimelineElement:parent` for the element.
# Returns
The parent of `self`, or `None` if
`self` has no parent.
<!-- trait TimelineElementExt::fn get_priority -->
<!-- trait TimelineElementExt::fn priority -->
Gets the `TimelineElement:priority` for the element.
# Returns
The priority of `self`.
<!-- trait TimelineElementExt::fn get_start -->
<!-- trait TimelineElementExt::fn start -->
Gets the `TimelineElement:start` for the element.
# Returns
The start of `self` (in nanoseconds).
<!-- trait TimelineElementExt::fn get_timeline -->
<!-- trait TimelineElementExt::fn timeline -->
Gets the `TimelineElement:timeline` for the element.
# Returns
The timeline of `self`, or `None`
if `self` has no timeline.
<!-- trait TimelineElementExt::fn get_toplevel_parent -->
<!-- trait TimelineElementExt::fn toplevel_parent -->
Gets the toplevel `TimelineElement:parent` of the element.
# Returns
The toplevel parent of `self`.
<!-- trait TimelineElementExt::fn get_track_types -->
<!-- trait TimelineElementExt::fn track_types -->
Gets the track types that the element can interact with, i.e. the type
of `Track` it can exist in, or will create `TrackElement`-s for.
@ -3880,13 +3880,13 @@ updating them.
# Implements
[`GESTrackExt`](trait.GESTrackExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`GESTrackExt`](trait@crate::GESTrackExt), [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- trait GESTrackExt -->
Trait containing all `Track` methods.
# Implementors
[`Track`](struct.Track.html)
[`Track`](struct@crate::Track)
<!-- impl Track::fn new -->
Creates a new track with the given track-type and caps.
@ -3958,13 +3958,13 @@ tracks, so you are unlikely to need to use this directly.
`true` if pending changes were committed, or `false` if nothing
needed to be committed.
<!-- trait GESTrackExt::fn get_caps -->
<!-- trait GESTrackExt::fn caps -->
Get the `Track:caps` of the track.
# Returns
The caps of `self`.
<!-- trait GESTrackExt::fn get_elements -->
<!-- trait GESTrackExt::fn elements -->
Gets the track elements contained in the track. The returned list is
sorted by the element's `TimelineElement:priority` and
`TimelineElement:start`.
@ -3973,13 +3973,13 @@ sorted by the element's `TimelineElement:priority` and
A list of
all the `TrackElement`-s in `self`.
<!-- trait GESTrackExt::fn get_mixing -->
<!-- trait GESTrackExt::fn is_mixing -->
Gets the `Track:mixing` of the track.
# Returns
Whether `self` is mixing.
<!-- trait GESTrackExt::fn get_restriction_caps -->
<!-- trait GESTrackExt::fn restriction_caps -->
Gets the `Track:restriction-caps` of the track.
Feature: `v1_18`
@ -3988,7 +3988,7 @@ Feature: `v1_18`
# Returns
The restriction-caps of `self`.
<!-- trait GESTrackExt::fn get_timeline -->
<!-- trait GESTrackExt::fn timeline -->
Get the timeline this track belongs to.
# Returns
@ -4206,13 +4206,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`TrackElementExt`](trait.TrackElementExt.html), [`TimelineElementExt`](trait.TimelineElementExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html), [`TimelineElementExtManual`](prelude/trait.TimelineElementExtManual.html)
[`TrackElementExt`](trait@crate::TrackElementExt), [`TimelineElementExt`](trait@crate::TimelineElementExt), [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt), [`TimelineElementExtManual`](trait@crate::TimelineElementExtManual)
<!-- trait TrackElementExt -->
Trait containing all `TrackElement` methods.
# Implementors
[`TrackElement`](struct.TrackElement.html)
[`TrackElement`](struct@crate::TrackElement)
<!-- trait TrackElementExt::fn add_children_props -->
Adds all the properties of a `gst::Element` that match the criteria as
children properties of the track element. If the name of `element`'s
@ -4277,7 +4277,7 @@ The edit position: a new location for the edge of `self`
# Returns
`true` if the edit of `self` completed, `false` on failure.
<!-- trait TrackElementExt::fn get_all_control_bindings -->
<!-- trait TrackElementExt::fn all_control_bindings -->
Get all the control bindings that have been created for the children
properties of the track element using
`TrackElementExt::set_control_source`. The keys used in the returned
@ -4290,7 +4290,7 @@ corresponding created `gst::ControlBinding`.
A
hash table containing all child-property-name/control-binding pairs
for `self`.
<!-- trait TrackElementExt::fn get_auto_clamp_control_sources -->
<!-- trait TrackElementExt::fn is_auto_clamp_control_sources -->
Gets `TrackElement:auto-clamp-control-sources`.
Feature: `v1_18`
@ -4370,7 +4370,7 @@ binding of
The control binding that was
created for the specified child property of `self`, or `None` if
`property_name` does not correspond to any control binding.
<!-- trait TrackElementExt::fn get_element -->
<!-- trait TrackElementExt::fn element -->
Get the `gst::Element` that the track element's underlying nleobject
controls.
@ -4378,7 +4378,7 @@ controls.
The `gst::Element` being controlled by the
nleobject that `self` wraps.
<!-- trait TrackElementExt::fn get_gnlobject -->
<!-- trait TrackElementExt::fn gnlobject -->
Get the GNonLin object this object is controlling.
# Deprecated
@ -4388,20 +4388,20 @@ use `TrackElementExt::get_nleobject` instead.
# Returns
The GNonLin object this object is controlling.
<!-- trait TrackElementExt::fn get_nleobject -->
<!-- trait TrackElementExt::fn nleobject -->
Get the nleobject that this element wraps.
# Returns
The nleobject that `self` wraps.
<!-- trait TrackElementExt::fn get_track -->
<!-- trait TrackElementExt::fn track -->
Get the `TrackElement:track` for the element.
# Returns
The track that `self` belongs to,
or `None` if it does not belong to a track.
<!-- trait TrackElementExt::fn get_track_type -->
<!-- trait TrackElementExt::fn track_type -->
Gets the `TrackElement:track-type` for the element.
# Returns
@ -4776,13 +4776,13 @@ will be updated when needed.
# Implements
[`TransitionClipExt`](trait.TransitionClipExt.html), [`BaseTransitionClipExt`](trait.BaseTransitionClipExt.html), [`OperationClipExt`](trait.OperationClipExt.html), [`ClipExt`](trait.ClipExt.html), [`GESContainerExt`](trait.GESContainerExt.html), [`TimelineElementExt`](trait.TimelineElementExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html), [`TimelineElementExtManual`](prelude/trait.TimelineElementExtManual.html)
[`TransitionClipExt`](trait@crate::TransitionClipExt), [`BaseTransitionClipExt`](trait@crate::BaseTransitionClipExt), [`OperationClipExt`](trait@crate::OperationClipExt), [`ClipExt`](trait@crate::ClipExt), [`GESContainerExt`](trait@crate::GESContainerExt), [`TimelineElementExt`](trait@crate::TimelineElementExt), [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt), [`TimelineElementExtManual`](trait@crate::TimelineElementExtManual)
<!-- trait TransitionClipExt -->
Trait containing all `TransitionClip` methods.
# Implementors
[`TransitionClip`](struct.TransitionClip.html)
[`TransitionClip`](struct@crate::TransitionClip)
<!-- impl TransitionClip::fn new -->
Creates a new `TransitionClip`.
## `vtype`
@ -4792,7 +4792,7 @@ the type of transition to create
a newly created `TransitionClip`,
or `None` if something went wrong.
<!-- impl TransitionClip::fn new_for_nick -->
<!-- impl TransitionClip::fn for_nick -->
Creates a new `TransitionClip` for the provided `nick`.
## `nick`
a string representing the type of transition to create
@ -4811,13 +4811,13 @@ the URI points to a file of some type.
# Implements
[`UriClipExt`](trait.UriClipExt.html), [`ClipExt`](trait.ClipExt.html), [`GESContainerExt`](trait.GESContainerExt.html), [`TimelineElementExt`](trait.TimelineElementExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`ExtractableExt`](trait.ExtractableExt.html), [`TimelineElementExtManual`](prelude/trait.TimelineElementExtManual.html)
[`UriClipExt`](trait@crate::UriClipExt), [`ClipExt`](trait@crate::ClipExt), [`GESContainerExt`](trait@crate::GESContainerExt), [`TimelineElementExt`](trait@crate::TimelineElementExt), [`trait@glib::object::ObjectExt`], [`ExtractableExt`](trait@crate::ExtractableExt), [`TimelineElementExtManual`](trait@crate::TimelineElementExtManual)
<!-- trait UriClipExt -->
Trait containing all `UriClip` methods.
# Implementors
[`UriClip`](struct.UriClip.html)
[`UriClip`](struct@crate::UriClip)
<!-- impl UriClip::fn new -->
Creates a new `UriClip` for the provided `uri`.
@ -4832,7 +4832,7 @@ the URI the source should control
The newly created `UriClip`, or
`None` if there was an error.
<!-- trait UriClipExt::fn get_uri -->
<!-- trait UriClipExt::fn uri -->
Get the location of the resource.
# Returns
@ -4877,13 +4877,13 @@ The location of the file/resource to use.
# Implements
[`UriClipAssetExt`](trait.UriClipAssetExt.html), [`AssetExt`](trait.AssetExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`UriClipAssetExt`](trait@crate::UriClipAssetExt), [`AssetExt`](trait@crate::AssetExt), [`trait@glib::object::ObjectExt`]
<!-- trait UriClipAssetExt -->
Trait containing all `UriClipAsset` methods.
# Implementors
[`UriClipAsset`](struct.UriClipAsset.html)
[`UriClipAsset`](struct@crate::UriClipAsset)
<!-- impl UriClipAsset::fn finish -->
Finalize the request of an async `UriClipAsset`
@ -4944,19 +4944,19 @@ You can also use multi file uris for `MultiFileSource`.
A reference to the requested asset or `None` if
an error happened
<!-- trait UriClipAssetExt::fn get_duration -->
<!-- trait UriClipAssetExt::fn duration -->
Gets duration of the file represented by `self`
# Returns
The duration of `self`
<!-- trait UriClipAssetExt::fn get_info -->
<!-- trait UriClipAssetExt::fn info -->
Gets `gst_pbutils::DiscovererInfo` about the file
# Returns
`gst_pbutils::DiscovererInfo` of specified asset
<!-- trait UriClipAssetExt::fn get_max_duration -->
<!-- trait UriClipAssetExt::fn max_duration -->
Gets maximum duration of the file represented by `self`,
it is usually the same as GESUriClipAsset::duration,
but in the case of nested timelines, for example, they
@ -4968,7 +4968,7 @@ Feature: `v1_18`
# Returns
The maximum duration of `self`
<!-- trait UriClipAssetExt::fn get_stream_assets -->
<!-- trait UriClipAssetExt::fn stream_assets -->
Get the GESUriSourceAsset `self` containes
# Returns
@ -5001,20 +5001,20 @@ by `UriClipAsset`-s.
# Implements
[`UriSourceAssetExt`](trait.UriSourceAssetExt.html), [`AssetExt`](trait.AssetExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`UriSourceAssetExt`](trait@crate::UriSourceAssetExt), [`AssetExt`](trait@crate::AssetExt), [`trait@glib::object::ObjectExt`]
<!-- trait UriSourceAssetExt -->
Trait containing all `UriSourceAsset` methods.
# Implementors
[`UriSourceAsset`](struct.UriSourceAsset.html)
<!-- trait UriSourceAssetExt::fn get_filesource_asset -->
[`UriSourceAsset`](struct@crate::UriSourceAsset)
<!-- trait UriSourceAssetExt::fn filesource_asset -->
Get the `UriClipAsset` `self_` is contained in
# Returns
a `UriClipAsset`
<!-- trait UriSourceAssetExt::fn get_stream_info -->
<!-- trait UriSourceAssetExt::fn stream_info -->
Get the `gst_pbutils::DiscovererStreamInfo` user by `self`
# Returns

282
docs/gstreamer-gl/docs.md
View file

@ -67,13 +67,13 @@ context is available and current in the calling thread.
# Implements
[`GLBaseFilterExt`](trait.GLBaseFilterExt.html), [`gst_base::BaseTransformExt`](../gst_base/trait.BaseTransformExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`GLBaseFilterExt`](trait@crate::GLBaseFilterExt), [`trait@gst_base::BaseTransformExt`], [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- trait GLBaseFilterExt -->
Trait containing all `GLBaseFilter` methods.
# Implementors
[`GLBaseFilter`](struct.GLBaseFilter.html), [`GLFilter`](struct.GLFilter.html)
[`GLBaseFilter`](struct@crate::GLBaseFilter), [`GLFilter`](struct@crate::GLFilter)
<!-- trait GLBaseFilterExt::fn find_gl_context -->
Feature: `v1_16`
@ -82,7 +82,7 @@ Feature: `v1_16`
# Returns
Whether an OpenGL context could be retrieved or created successfully
<!-- trait GLBaseFilterExt::fn get_gl_context -->
<!-- trait GLBaseFilterExt::fn gl_context -->
Feature: `v1_18`
@ -149,7 +149,15 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`gst::AllocatorExt`](../gst/trait.AllocatorExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst::AllocatorExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- struct GLBuffer -->
GstGLBuffer is a `gst::Memory` subclass providing support for the mapping of
GL buffers.
Data is uploaded or downloaded from the GPU as is necessary.
<!-- impl GLBuffer::fn init_once -->
Initializes the GL Buffer allocator. It is safe to call this function
multiple times. This must be called before any other `GLBuffer` operation.
<!-- struct GLColorConvert -->
`GLColorConvert` is an object that converts between color spaces and/or
formats using OpenGL Shaders.
@ -163,7 +171,7 @@ The glcolorconvertelement provides a GStreamer element that uses
# Implements
[`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl GLColorConvert::fn new -->
## `context`
a `GLContext`
@ -231,13 +239,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`GLContextExt`](trait.GLContextExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`GLContextExtManual`](prelude/trait.GLContextExtManual.html)
[`GLContextExt`](trait@crate::GLContextExt), [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`GLContextExtManual`](trait@crate::GLContextExtManual)
<!-- trait GLContextExt -->
Trait containing all `GLContext` methods.
# Implementors
[`GLContext`](struct.GLContext.html)
[`GLContext`](struct@crate::GLContext)
<!-- impl GLContext::fn new -->
Create a new `GLContext` with the specified `display`
## `display`
@ -405,12 +413,12 @@ called for this context.
Fills `self`'s info (version, extensions, vtable, etc) from the GL
context in the current thread. Typically used with wrapped contexts to
allow wrapped contexts to be used as regular `GLContext`'s.
<!-- trait GLContextExt::fn get_display -->
<!-- trait GLContextExt::fn display -->
# Returns
the `GLDisplay` associated with this `self`
<!-- trait GLContextExt::fn get_gl_api -->
<!-- trait GLContextExt::fn gl_api -->
Get the currently enabled OpenGL api.
The currently available API may be limited by the `GLDisplay` in use and/or
@ -419,26 +427,26 @@ the `GLWindow` chosen.
# Returns
the available OpenGL api
<!-- trait GLContextExt::fn get_gl_context -->
<!-- trait GLContextExt::fn gl_context -->
Gets the backing OpenGL context used by `self`.
# Returns
The platform specific backing OpenGL context
<!-- trait GLContextExt::fn get_gl_platform -->
<!-- trait GLContextExt::fn gl_platform -->
Gets the OpenGL platform that used by `self`.
# Returns
The platform specific backing OpenGL context
<!-- trait GLContextExt::fn get_gl_platform_version -->
<!-- trait GLContextExt::fn gl_platform_version -->
Get the version of the OpenGL platform (GLX, EGL, etc) used. Only valid
after a call to `GLContextExt::create`.
## `major`
return for the major version
## `minor`
return for the minor version
<!-- trait GLContextExt::fn get_gl_version -->
<!-- trait GLContextExt::fn gl_version -->
Returns the OpenGL version implemented by `self`. See
`GLContextExt::get_gl_api` for retrieving the OpenGL api implemented by
`self`.
@ -478,7 +486,7 @@ a function pointer or `None`
# Returns
The `glib::Thread`, `self` is current in or NULL
<!-- trait GLContextExt::fn get_window -->
<!-- trait GLContextExt::fn window -->
# Returns
@ -584,13 +592,13 @@ platform and window system specific functionality.
# Implements
[`GLDisplayExt`](trait.GLDisplayExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`GLDisplayExt`](trait@crate::GLDisplayExt), [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- trait GLDisplayExt -->
Trait containing all `GLDisplay` methods.
# Implementors
[`GLDisplay`](struct.GLDisplay.html)
[`GLDisplay`](struct@crate::GLDisplay)
<!-- impl GLDisplay::fn new -->
# Returns
@ -643,7 +651,7 @@ a comparison function to run
The first `GLWindow` that causes a match
from `compare_func`
<!-- trait GLDisplayExt::fn get_gl_api -->
<!-- trait GLDisplayExt::fn gl_api -->
see `GLDisplayExt::filter_gl_api` for what the returned value represents
# Returns
@ -663,7 +671,7 @@ Must be called with the object lock held.
# Returns
the native handle for the display
<!-- trait GLDisplayExt::fn get_handle_type -->
<!-- trait GLDisplayExt::fn handle_type -->
# Returns
@ -737,13 +745,13 @@ single input and producing a single output with a `GLFramebuffer`
# Implements
[`GLFilterExt`](trait.GLFilterExt.html), [`GLBaseFilterExt`](trait.GLBaseFilterExt.html), [`gst_base::BaseTransformExt`](../gst_base/trait.BaseTransformExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`GLFilterExt`](trait@crate::GLFilterExt), [`GLBaseFilterExt`](trait@crate::GLBaseFilterExt), [`trait@gst_base::BaseTransformExt`], [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- trait GLFilterExt -->
Trait containing all `GLFilter` methods.
# Implementors
[`GLFilter`](struct.GLFilter.html)
[`GLFilter`](struct@crate::GLFilter)
<!-- trait GLFilterExt::fn draw_fullscreen_quad -->
Render a fullscreen quad using the current GL state. The only GL state this
modifies is the necessary vertex/index buffers and, if necessary, a
@ -842,13 +850,13 @@ between multiple OpenGL contexts.
# Implements
[`GLFramebufferExt`](trait.GLFramebufferExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`GLFramebufferExt`](trait@crate::GLFramebufferExt), [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- trait GLFramebufferExt -->
Trait containing all `GLFramebuffer` methods.
# Implementors
[`GLFramebuffer`](struct.GLFramebuffer.html)
[`GLFramebuffer`](struct@crate::GLFramebuffer)
<!-- impl GLFramebuffer::fn new -->
## `context`
a `GLContext`
@ -856,7 +864,7 @@ a `GLContext`
# Returns
a new `GLFramebuffer`
<!-- impl GLFramebuffer::fn new_with_default_depth -->
<!-- impl GLFramebuffer::fn with_default_depth -->
## `context`
a `GLContext`
## `width`
@ -888,24 +896,162 @@ data to pass to `func`
# Returns
the result of executing `func`
<!-- trait GLFramebufferExt::fn get_effective_dimensions -->
<!-- trait GLFramebufferExt::fn effective_dimensions -->
Retrieve the effective dimensions from the current attachments attached to
`self`.
## `width`
output width
## `height`
output height
<!-- trait GLFramebufferExt::fn get_id -->
<!-- trait GLFramebufferExt::fn id -->
# Returns
the OpenGL id for `self`
<!-- struct GLMemory -->
GstGLMemory is a `GLBaseMemory` subclass providing support for the mapping of
OpenGL textures.
`GLMemory` is created or wrapped through `GLBaseMemory::alloc`
with `GLVideoAllocationParams`.
Data is uploaded or downloaded from the GPU as is necessary.
The `gst::Caps` that is used for `GLMemory` based buffers should contain
the `GST_CAPS_FEATURE_MEMORY_GL_MEMORY` as a `gst::CapsFeatures` and should
contain a 'texture-target' field with one of the `GLTextureTarget` values
as a string, i.e. some combination of 'texture-target=(string){2D,
rectangle, external-oes}'.
<!-- impl GLMemory::fn copy_into -->
Copies `self` into the texture specified by `tex_id`. The format of `tex_id`
is specified by `tex_format`, `width` and `height`.
## `tex_id`
OpenGL texture id
## `target`
the `GLTextureTarget`
## `tex_format`
the `GLFormat`
## `width`
width of `tex_id`
## `height`
height of `tex_id`
# Returns
Whether the copy succeeded
<!-- impl GLMemory::fn copy_teximage -->
Copies the texture in `GLMemory` into the texture specified by `tex_id`,
`out_target`, `out_tex_format`, `out_width` and `out_height`.
## `tex_id`
the destination texture id
## `out_target`
the destination `GLTextureTarget`
## `out_tex_format`
the destination `GLFormat`
## `out_width`
the destination width
## `out_height`
the destination height
# Returns
whether the copy succeeded.
<!-- impl GLMemory::fn get_texture_format -->
# Returns
the `GLFormat` of `self`
<!-- impl GLMemory::fn get_texture_height -->
# Returns
the texture height of `self`
<!-- impl GLMemory::fn get_texture_id -->
# Returns
the OpenGL texture handle of `self`
<!-- impl GLMemory::fn get_texture_target -->
# Returns
the `GLTextureTarget` of `self`
<!-- impl GLMemory::fn get_texture_width -->
# Returns
the texture width of `self`
<!-- impl GLMemory::fn init -->
Initializes `self` with the required parameters. `info` is assumed to have
already have been modified with `gst_video::VideoInfo::align`.
## `allocator`
the `gst::Allocator` to initialize with
## `parent`
the parent `gst::Memory` to initialize with
## `context`
the `GLContext` to initialize with
## `target`
the `GLTextureTarget` for this `GLMemory`
## `tex_format`
the `GLFormat` for this `GLMemory`
## `params`
the [`crate::gst::AllocationParams`] (XXX: @-reference does not belong to GLMemory!) to initialize with
## `info`
the `gst_video::VideoInfo` for this `GLMemory`
## `plane`
the plane number (starting from 0) for this `GLMemory`
## `valign`
optional `gst_video::VideoAlignment` parameters
## `user_data`
user data to call `notify` with
## `notify`
a `GDestroyNotify`
<!-- impl GLMemory::fn read_pixels -->
Reads the texture in `GLMemory` into `write_pointer` if no buffer is bound
to `GL_PIXEL_PACK_BUFFER`. Otherwise `write_pointer` is the byte offset into
the currently bound `GL_PIXEL_PACK_BUFFER` buffer to store the result of
glReadPixels. See the OpenGL specification for glReadPixels for more
details.
## `write_pointer`
the data pointer to pass to glReadPixels
# Returns
whether theread operation succeeded
<!-- impl GLMemory::fn texsubimage -->
Reads the texture in `read_pointer` into `self`.
See `GLMemory::read_pixels` for what `read_pointer` signifies.
## `read_pointer`
the data pointer to pass to glTexSubImage
<!-- impl GLMemory::fn init_once -->
Initializes the GL Base Texture allocator. It is safe to call this function
multiple times. This must be called before any other GstGLMemory operation.
<!-- impl GLMemory::fn setup_buffer -->
## `allocator`
the [`crate::GLMemoryAllocator`] (XXX: @-reference does not belong to GLMemory!) to allocate from
## `buffer`
a `gst::Buffer` to setup
## `params`
the `GLVideoAllocationParams` to allocate with
## `tex_formats`
a list of `GLFormat`'s to allocate with.
## `wrapped_data`
a list of wrapped data pointers
## `n_wrapped_pointers`
the number of elements in `tex_formats` and `wrapped_data`
# Returns
whether the buffer was correctly setup
<!-- struct GLMemoryAllocator -->
Opaque `GLMemoryAllocator` struct
# Implements
[`GLBaseMemoryAllocatorExt`](trait.GLBaseMemoryAllocatorExt.html), [`gst::AllocatorExt`](../gst/trait.AllocatorExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`GLBaseMemoryAllocatorExt`](trait@crate::GLBaseMemoryAllocatorExt), [`trait@gst::AllocatorExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl GLMemoryAllocator::fn get_default -->
## `context`
a `GLContext`
@ -919,7 +1065,7 @@ Opaque `GLOverlayCompositor` object
# Implements
[`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- struct GLPlatform -->
<!-- struct GLPlatform::const NONE -->
no platform
@ -936,6 +1082,54 @@ the CGL platform used primarily on OS X
the EAGL platform used primarily on iOS
<!-- struct GLPlatform::const ANY -->
any OpenGL platform
<!-- struct GLQuery -->
A `GLQuery` represents and holds an OpenGL query object. Various types of
queries can be run or counters retrieved.
<!-- impl GLQuery::fn counter -->
Record the result of a counter
<!-- impl GLQuery::fn end -->
End counting the query
<!-- impl GLQuery::fn free -->
Frees a `GLQuery`
<!-- impl GLQuery::fn init -->
## `context`
a `GLContext`
## `query_type`
the `GLQueryType`
<!-- impl GLQuery::fn result -->
# Returns
the result of the query
<!-- impl GLQuery::fn start -->
Start counting the query
<!-- impl GLQuery::fn unset -->
Free any dynamically allocated resources
<!-- impl GLQuery::fn local_gl_context -->
Performs a GST_QUERY_CONTEXT query of type "gst.gl.local_context" on all
`GstPads` in `element` of `direction` for the local OpenGL context used by
GStreamer elements.
## `element`
a `gst::Element` to query from
## `direction`
the `gst::PadDirection` to query
## `context_ptr`
location containing the current and/or resulting
`GLContext`
# Returns
whether `context_ptr` contains a `GLContext`
<!-- impl GLQuery::fn new -->
Free with `GLQuery::free`
## `context`
a `GLContext`
## `query_type`
the `GLQueryType` to create
# Returns
a new `GLQuery`
<!-- enum GLQueryType -->
<!-- enum GLQueryType::variant None -->
no query
@ -968,7 +1162,7 @@ any OpenGL/OpenGL|ES profile
# Implements
[`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl GLSLStage::fn new -->
## `context`
a `GLContext`
@ -978,7 +1172,7 @@ the GL enum shader stage type
# Returns
a new `GLSLStage` of the specified `type_`
<!-- impl GLSLStage::fn new_with_string -->
<!-- impl GLSLStage::fn with_string -->
## `context`
a `GLContext`
## `type_`
@ -993,7 +1187,7 @@ a shader string
# Returns
a new `GLSLStage` of the specified `type_`
<!-- impl GLSLStage::fn new_with_strings -->
<!-- impl GLSLStage::fn with_strings -->
## `context`
a `GLContext`
## `type_`
@ -1016,22 +1210,22 @@ a new `GLSLStage` of the specified `type_`
# Returns
whether the compilation succeeded
<!-- impl GLSLStage::fn get_handle -->
<!-- impl GLSLStage::fn handle -->
# Returns
The GL handle for this shader stage
<!-- impl GLSLStage::fn get_profile -->
<!-- impl GLSLStage::fn profile -->
# Returns
The GLSL profile for the current shader stage
<!-- impl GLSLStage::fn get_shader_type -->
<!-- impl GLSLStage::fn shader_type -->
# Returns
The GL shader type for this shader stage
<!-- impl GLSLStage::fn get_version -->
<!-- impl GLSLStage::fn version -->
# Returns
@ -1087,7 +1281,7 @@ version 450 (valid for compatibility/core desktop GL)
# Implements
[`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl GLShader::fn new -->
Note: must be called in the GL thread
## `context`
@ -1118,7 +1312,7 @@ a `glib::Error`
# Returns
a new `shader` with the specified stages.
<!-- impl GLShader::fn new_with_stages -->
<!-- impl GLShader::fn with_stages -->
Each stage will attempt to be compiled and attached to `shader`. On error,
`None` will be returned and `error` will contain the details of the error.
@ -1250,7 +1444,7 @@ name of the attribute
# Returns
the attribute index for `name` in `self` or -1 on failure
<!-- impl GLShader::fn get_program_handle -->
<!-- impl GLShader::fn program_handle -->
# Returns
@ -1538,7 +1732,7 @@ A `GLUpload` can be created with `GLUpload::new`
# Implements
[`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl GLUpload::fn new -->
## `context`
a `GLContext`
@ -1546,7 +1740,7 @@ a `GLContext`
# Returns
a new `GLUpload` object
<!-- impl GLUpload::fn get_caps -->
<!-- impl GLUpload::fn caps -->
## `in_caps`
the input `gst::Caps`
## `out_caps`
@ -1736,7 +1930,7 @@ Convert stereoscopic/multiview video using fragment shaders.
# Implements
[`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl GLViewConvert::fn new -->
# Returns
@ -1814,13 +2008,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`GLWindowExt`](trait.GLWindowExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`GLWindowExt`](trait@crate::GLWindowExt), [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- trait GLWindowExt -->
Trait containing all `GLWindow` methods.
# Implementors
[`GLWindow`](struct.GLWindow.html)
[`GLWindow`](struct@crate::GLWindow)
<!-- impl GLWindow::fn new -->
## `display`
a `GLDisplay`
@ -1839,7 +2033,7 @@ Feature: `v1_16`
`true` if `self` controls the GL viewport, otherwise `false`
<!-- trait GLWindowExt::fn draw -->
Redraw the window contents. Implementations should invoke the draw callback.
<!-- trait GLWindowExt::fn get_context -->
<!-- trait GLWindowExt::fn context -->
# Returns
@ -1849,7 +2043,7 @@ the `GLContext` associated with this `self`
# Returns
the windowing system display handle for this `self`
<!-- trait GLWindowExt::fn get_surface_dimensions -->
<!-- trait GLWindowExt::fn surface_dimensions -->
## `width`
resulting surface width
## `height`

2
docs/gstreamer-gl/egl/docs.md
View file

@ -5,7 +5,7 @@ through the provided API
# Implements
[`gst_gl::GLDisplayExt`](../gst_gl/trait.GLDisplayExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst_gl::GLDisplayExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl GLDisplayEGL::fn new -->
Create a new `GLDisplayEGL` using the default EGL_DEFAULT_DISPLAY.

4
docs/gstreamer-gl/wayland/docs.md
View file

@ -5,7 +5,7 @@ through the provided API
# Implements
[`gst_gl::GLDisplayExt`](../gst_gl/trait.GLDisplayExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst_gl::GLDisplayExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl GLDisplayWayland::fn new -->
Create a new `GLDisplayWayland` from the wayland display name. See `wl_display_connect`()
for details on what is a valid name.
@ -15,7 +15,7 @@ a display name
# Returns
a new `GLDisplayWayland` or `None`
<!-- impl GLDisplayWayland::fn new_with_display -->
<!-- impl GLDisplayWayland::fn with_display -->
Creates a new display connection from a wl_display Display.
## `display`
an existing, wayland display

4
docs/gstreamer-gl/x11/docs.md
View file

@ -5,7 +5,7 @@ through the provided API
# Implements
[`gst_gl::GLDisplayExt`](../gst_gl/trait.GLDisplayExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst_gl::GLDisplayExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl GLDisplayX11::fn new -->
Create a new `GLDisplayX11` from the x11 display name. See `XOpenDisplay`()
for details on what is a valid name.
@ -15,7 +15,7 @@ a display name
# Returns
a new `GLDisplayX11` or `None`
<!-- impl GLDisplayX11::fn new_with_display -->
<!-- impl GLDisplayX11::fn with_display -->
Creates a new display connection from a X11 Display.
## `display`
an existing, x11 display

8
docs/gstreamer-net/docs.md
View file

@ -25,7 +25,7 @@ statistics about clock accuracy and network traffic.
# Implements
[`gst::ClockExt`](../gst/trait.ClockExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst::ClockExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl NetClientClock::fn new -->
Create a new `NetClientClock` that will report the time
provided by the `NetTimeProvider` on `remote_address` and
@ -56,7 +56,7 @@ The `NetTimeProvider` typically wraps the clock used by a `gst::Pipeline`.
# Implements
[`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl NetTimeProvider::fn new -->
Allows network clients to get the current time of `clock`.
## `clock`
@ -75,7 +75,7 @@ the new `NetTimeProvider`, or NULL on error
# Implements
[`NetClientClockExt`](trait.NetClientClockExt.html), [`gst::ClockExt`](../gst/trait.ClockExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`NetClientClockExt`](trait@crate::NetClientClockExt), [`trait@gst::ClockExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl NtpClock::fn new -->
Create a new `NtpClock` that will report the time provided by
the NTPv4 server on `remote_address` and `remote_port`.
@ -117,7 +117,7 @@ synchronization.
# Implements
[`gst::ClockExt`](../gst/trait.ClockExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst::ClockExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl PtpClock::fn new -->
Creates a new PTP clock instance that exports the PTP time of the master
clock in `domain`. This clock can be slaved to other clocks as needed.

150
docs/gstreamer-pbutils/docs.md
View file

@ -19,7 +19,7 @@ All the information is returned in a `DiscovererInfo` structure.
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@glib::object::ObjectExt`]
<!-- impl Discoverer::fn new -->
Creates a new `Discoverer` with the provided timeout.
## `timeout`
@ -110,13 +110,13 @@ set on the result flags.
# Implements
[`DiscovererStreamInfoExt`](trait.DiscovererStreamInfoExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
<!-- impl DiscovererAudioInfo::fn get_bitrate -->
[`DiscovererStreamInfoExt`](trait@crate::DiscovererStreamInfoExt), [`trait@glib::object::ObjectExt`]
<!-- impl DiscovererAudioInfo::fn bitrate -->
# Returns
the average or nominal bitrate of the stream in bits/second.
<!-- impl DiscovererAudioInfo::fn get_channel_mask -->
<!-- impl DiscovererAudioInfo::fn channel_mask -->
Feature: `v1_14`
@ -126,27 +126,27 @@ Feature: `v1_14`
the channel-mask of the stream, refer to
`gst_audio_channel_positions_from_mask` for more
information.
<!-- impl DiscovererAudioInfo::fn get_channels -->
<!-- impl DiscovererAudioInfo::fn channels -->
# Returns
the number of channels in the stream.
<!-- impl DiscovererAudioInfo::fn get_depth -->
<!-- impl DiscovererAudioInfo::fn depth -->
# Returns
the number of bits used per sample in each channel.
<!-- impl DiscovererAudioInfo::fn get_language -->
<!-- impl DiscovererAudioInfo::fn language -->
# Returns
the language of the stream, or NULL if unknown.
<!-- impl DiscovererAudioInfo::fn get_max_bitrate -->
<!-- impl DiscovererAudioInfo::fn max_bitrate -->
# Returns
the maximum bitrate of the stream in bits/second.
<!-- impl DiscovererAudioInfo::fn get_sample_rate -->
<!-- impl DiscovererAudioInfo::fn sample_rate -->
# Returns
@ -156,8 +156,8 @@ the sample rate of the stream in Hertz.
# Implements
[`DiscovererStreamInfoExt`](trait.DiscovererStreamInfoExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
<!-- impl DiscovererContainerInfo::fn get_streams -->
[`DiscovererStreamInfoExt`](trait@crate::DiscovererStreamInfoExt), [`trait@glib::object::ObjectExt`]
<!-- impl DiscovererContainerInfo::fn streams -->
# Returns
@ -169,7 +169,7 @@ Structure containing the information of a URI analyzed by `Discoverer`.
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@glib::object::ObjectExt`]
<!-- impl DiscovererInfo::fn from_variant -->
Parses a `glib::Variant` as produced by `DiscovererInfo::to_variant`
back to a `DiscovererInfo`.
@ -184,7 +184,7 @@ A newly-allocated `DiscovererInfo`.
# Returns
A copy of the `DiscovererInfo`
<!-- impl DiscovererInfo::fn get_audio_streams -->
<!-- impl DiscovererInfo::fn audio_streams -->
Finds all the `DiscovererAudioInfo` contained in `self`
# Returns
@ -192,7 +192,7 @@ Finds all the `DiscovererAudioInfo` contained in `self`
A `glib::List` of
matching `DiscovererStreamInfo`. The caller should free it with
`DiscovererStreamInfo::list_free`.
<!-- impl DiscovererInfo::fn get_container_streams -->
<!-- impl DiscovererInfo::fn container_streams -->
Finds all the `DiscovererContainerInfo` contained in `self`
# Returns
@ -200,12 +200,12 @@ Finds all the `DiscovererContainerInfo` contained in `self`
A `glib::List` of
matching `DiscovererStreamInfo`. The caller should free it with
`DiscovererStreamInfo::list_free`.
<!-- impl DiscovererInfo::fn get_duration -->
<!-- impl DiscovererInfo::fn duration -->
# Returns
the duration of the URI in `gst::ClockTime` (nanoseconds).
<!-- impl DiscovererInfo::fn get_live -->
<!-- impl DiscovererInfo::fn is_live -->
Feature: `v1_14`
@ -213,7 +213,7 @@ Feature: `v1_14`
# Returns
whether the URI is live.
<!-- impl DiscovererInfo::fn get_misc -->
<!-- impl DiscovererInfo::fn misc -->
# Deprecated
@ -225,7 +225,7 @@ This functions is deprecated since version 1.4, use
Miscellaneous information stored as a `gst::Structure`
(for example: information about missing plugins). If you wish to use the
`gst::Structure` after the life-time of `self`, you will need to copy it.
<!-- impl DiscovererInfo::fn get_missing_elements_installer_details -->
<!-- impl DiscovererInfo::fn missing_elements_installer_details -->
Get the installer details for missing elements
# Returns
@ -234,17 +234,17 @@ An array of strings
containing information about how to install the various missing elements
for `self` to be usable. If you wish to use the strings after the life-time
of `self`, you will need to copy them.
<!-- impl DiscovererInfo::fn get_result -->
<!-- impl DiscovererInfo::fn result -->
# Returns
the result of the discovery as a `DiscovererResult`.
<!-- impl DiscovererInfo::fn get_seekable -->
<!-- impl DiscovererInfo::fn is_seekable -->
# Returns
the whether the URI is seekable.
<!-- impl DiscovererInfo::fn get_stream_info -->
<!-- impl DiscovererInfo::fn stream_info -->
# Returns
@ -252,7 +252,7 @@ the structure (or topology) of the URI as a
`DiscovererStreamInfo`.
This structure can be traversed to see the original hierarchy. Unref with
`gst_discoverer_stream_info_unref` after usage.
<!-- impl DiscovererInfo::fn get_stream_list -->
<!-- impl DiscovererInfo::fn stream_list -->
# Returns
@ -270,7 +270,7 @@ a `glib::Type` derived from `DiscovererStreamInfo`
A `glib::List` of
matching `DiscovererStreamInfo`. The caller should free it with
`DiscovererStreamInfo::list_free`.
<!-- impl DiscovererInfo::fn get_subtitle_streams -->
<!-- impl DiscovererInfo::fn subtitle_streams -->
Finds all the `DiscovererSubtitleInfo` contained in `self`
# Returns
@ -278,25 +278,25 @@ Finds all the `DiscovererSubtitleInfo` contained in `self`
A `glib::List` of
matching `DiscovererStreamInfo`. The caller should free it with
`DiscovererStreamInfo::list_free`.
<!-- impl DiscovererInfo::fn get_tags -->
<!-- impl DiscovererInfo::fn tags -->
# Returns
all tags contained in the URI. If you wish to use
the tags after the life-time of `self`, you will need to copy them.
<!-- impl DiscovererInfo::fn get_toc -->
<!-- impl DiscovererInfo::fn toc -->
# Returns
TOC contained in the URI. If you wish to use
the TOC after the life-time of `self`, you will need to copy it.
<!-- impl DiscovererInfo::fn get_uri -->
<!-- impl DiscovererInfo::fn uri -->
# Returns
the URI to which this information corresponds to.
Copy it if you wish to use it after the life-time of `self`.
<!-- impl DiscovererInfo::fn get_video_streams -->
<!-- impl DiscovererInfo::fn video_streams -->
Finds all the `DiscovererVideoInfo` contained in `self`
# Returns
@ -365,25 +365,25 @@ for the audio and video streams respectively.
# Implements
[`DiscovererStreamInfoExt`](trait.DiscovererStreamInfoExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`DiscovererStreamInfoExt`](trait@crate::DiscovererStreamInfoExt), [`trait@glib::object::ObjectExt`]
<!-- trait DiscovererStreamInfoExt -->
Trait containing all `DiscovererStreamInfo` methods.
# Implementors
[`DiscovererAudioInfo`](struct.DiscovererAudioInfo.html), [`DiscovererContainerInfo`](struct.DiscovererContainerInfo.html), [`DiscovererStreamInfo`](struct.DiscovererStreamInfo.html), [`DiscovererSubtitleInfo`](struct.DiscovererSubtitleInfo.html), [`DiscovererVideoInfo`](struct.DiscovererVideoInfo.html)
[`DiscovererAudioInfo`](struct@crate::DiscovererAudioInfo), [`DiscovererContainerInfo`](struct@crate::DiscovererContainerInfo), [`DiscovererStreamInfo`](struct@crate::DiscovererStreamInfo), [`DiscovererSubtitleInfo`](struct@crate::DiscovererSubtitleInfo), [`DiscovererVideoInfo`](struct@crate::DiscovererVideoInfo)
<!-- impl DiscovererStreamInfo::fn list_free -->
Decrements the reference count of all contained `DiscovererStreamInfo`
and fress the `glib::List`.
## `infos`
a `glib::List` of `DiscovererStreamInfo`
<!-- trait DiscovererStreamInfoExt::fn get_caps -->
<!-- trait DiscovererStreamInfoExt::fn caps -->
# Returns
the `gst::Caps` of the stream. Unref with
`gst_caps_unref` after usage.
<!-- trait DiscovererStreamInfoExt::fn get_misc -->
<!-- trait DiscovererStreamInfoExt::fn misc -->
# Deprecated
@ -395,39 +395,39 @@ This functions is deprecated since version 1.4, use
additional information regarding the stream (for
example codec version, profile, etc..). If you wish to use the `gst::Structure`
after the life-time of `self` you will need to copy it.
<!-- trait DiscovererStreamInfoExt::fn get_next -->
<!-- trait DiscovererStreamInfoExt::fn next -->
# Returns
the next `DiscovererStreamInfo` in a chain. `None`
for final streams.
Unref with `gst_discoverer_stream_info_unref` after usage.
<!-- trait DiscovererStreamInfoExt::fn get_previous -->
<!-- trait DiscovererStreamInfoExt::fn previous -->
# Returns
the previous `DiscovererStreamInfo` in a chain.
`None` for starting points. Unref with `gst_discoverer_stream_info_unref`
after usage.
<!-- trait DiscovererStreamInfoExt::fn get_stream_id -->
<!-- trait DiscovererStreamInfoExt::fn stream_id -->
# Returns
the stream ID of this stream. If you wish to
use the stream ID after the life-time of `self` you will need to copy it.
<!-- trait DiscovererStreamInfoExt::fn get_stream_type_nick -->
<!-- trait DiscovererStreamInfoExt::fn stream_type_nick -->
# Returns
a human readable name for the stream type of the given `self` (ex : "audio",
"container",...).
<!-- trait DiscovererStreamInfoExt::fn get_tags -->
<!-- trait DiscovererStreamInfoExt::fn tags -->
# Returns
the tags contained in this stream. If you wish to
use the tags after the life-time of `self` you will need to copy them.
<!-- trait DiscovererStreamInfoExt::fn get_toc -->
<!-- trait DiscovererStreamInfoExt::fn toc -->
# Returns
@ -439,8 +439,8 @@ image based ones).
# Implements
[`DiscovererStreamInfoExt`](trait.DiscovererStreamInfoExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
<!-- impl DiscovererSubtitleInfo::fn get_language -->
[`DiscovererStreamInfoExt`](trait@crate::DiscovererStreamInfoExt), [`trait@glib::object::ObjectExt`]
<!-- impl DiscovererSubtitleInfo::fn language -->
# Returns
@ -450,48 +450,48 @@ the language of the stream, or NULL if unknown.
# Implements
[`DiscovererStreamInfoExt`](trait.DiscovererStreamInfoExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
<!-- impl DiscovererVideoInfo::fn get_bitrate -->
[`DiscovererStreamInfoExt`](trait@crate::DiscovererStreamInfoExt), [`trait@glib::object::ObjectExt`]
<!-- impl DiscovererVideoInfo::fn bitrate -->
# Returns
the average or nominal bitrate of the video stream in bits/second.
<!-- impl DiscovererVideoInfo::fn get_depth -->
<!-- impl DiscovererVideoInfo::fn depth -->
# Returns
the depth in bits of the video stream.
<!-- impl DiscovererVideoInfo::fn get_framerate_denom -->
<!-- impl DiscovererVideoInfo::fn framerate_denom -->
# Returns
the framerate of the video stream (denominator).
<!-- impl DiscovererVideoInfo::fn get_framerate_num -->
<!-- impl DiscovererVideoInfo::fn framerate_num -->
# Returns
the framerate of the video stream (numerator).
<!-- impl DiscovererVideoInfo::fn get_height -->
<!-- impl DiscovererVideoInfo::fn height -->
# Returns
the height of the video stream in pixels.
<!-- impl DiscovererVideoInfo::fn get_max_bitrate -->
<!-- impl DiscovererVideoInfo::fn max_bitrate -->
# Returns
the maximum bitrate of the video stream in bits/second.
<!-- impl DiscovererVideoInfo::fn get_par_denom -->
<!-- impl DiscovererVideoInfo::fn par_denom -->
# Returns
the Pixel Aspect Ratio (PAR) of the video stream (denominator).
<!-- impl DiscovererVideoInfo::fn get_par_num -->
<!-- impl DiscovererVideoInfo::fn par_num -->
# Returns
the Pixel Aspect Ratio (PAR) of the video stream (numerator).
<!-- impl DiscovererVideoInfo::fn get_width -->
<!-- impl DiscovererVideoInfo::fn width -->
# Returns
@ -512,7 +512,7 @@ Variant of `EncodingProfile` for audio streams.
# Implements
[`EncodingProfileExt`](trait.EncodingProfileExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`EncodingProfileExt`](trait@crate::EncodingProfileExt), [`trait@glib::object::ObjectExt`]
<!-- impl EncodingAudioProfile::fn new -->
Creates a new `EncodingAudioProfile`
@ -537,7 +537,7 @@ Encoding profiles for containers. Keeps track of a list of `EncodingProfile`
# Implements
[`EncodingProfileExt`](trait.EncodingProfileExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`EncodingProfileExt`](trait@crate::EncodingProfileExt), [`trait@glib::object::ObjectExt`]
<!-- impl EncodingContainerProfile::fn new -->
Creates a new `EncodingContainerProfile`.
## `name`
@ -574,7 +574,7 @@ a `EncodingProfile`
`true` if `self` contains a `EncodingProfile` identical
to `profile`, else `false`.
<!-- impl EncodingContainerProfile::fn get_profiles -->
<!-- impl EncodingContainerProfile::fn profiles -->
# Returns
@ -586,13 +586,13 @@ information like name, description, format and preset.
# Implements
[`EncodingProfileExt`](trait.EncodingProfileExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`EncodingProfileExt`](trait@crate::EncodingProfileExt), [`trait@glib::object::ObjectExt`]
<!-- trait EncodingProfileExt -->
Trait containing all `EncodingProfile` methods.
# Implementors
[`EncodingAudioProfile`](struct.EncodingAudioProfile.html), [`EncodingContainerProfile`](struct.EncodingContainerProfile.html), [`EncodingProfile`](struct.EncodingProfile.html), [`EncodingVideoProfile`](struct.EncodingVideoProfile.html)
[`EncodingAudioProfile`](struct@crate::EncodingAudioProfile), [`EncodingContainerProfile`](struct@crate::EncodingContainerProfile), [`EncodingProfile`](struct@crate::EncodingProfile), [`EncodingVideoProfile`](struct@crate::EncodingVideoProfile)
<!-- impl EncodingProfile::fn find -->
Find the `EncodingProfile` with the specified name and category.
## `targetname`
@ -625,55 +625,55 @@ Feature: `v1_12`
# Returns
The copy of `self`
<!-- trait EncodingProfileExt::fn get_allow_dynamic_output -->
<!-- trait EncodingProfileExt::fn allows_dynamic_output -->
Get whether the format that has been negotiated in at some point can be renegotiated
later during the encoding.
<!-- trait EncodingProfileExt::fn get_description -->
<!-- trait EncodingProfileExt::fn description -->
# Returns
the description of the profile, can be `None`.
<!-- trait EncodingProfileExt::fn get_file_extension -->
<!-- trait EncodingProfileExt::fn file_extension -->
# Returns
a suitable file extension for `self`, or NULL.
<!-- trait EncodingProfileExt::fn get_format -->
<!-- trait EncodingProfileExt::fn format -->
# Returns
the `gst::Caps` corresponding to the media format used
in the profile. Unref after usage.
<!-- trait EncodingProfileExt::fn get_input_caps -->
<!-- trait EncodingProfileExt::fn input_caps -->
Computes the full output caps that this `self` will be able to consume.
# Returns
The full caps the given `self` can consume. Call
`gst_caps_unref` when you are done with the caps.
<!-- trait EncodingProfileExt::fn get_name -->
<!-- trait EncodingProfileExt::fn name -->
# Returns
the name of the profile, can be `None`.
<!-- trait EncodingProfileExt::fn get_presence -->
<!-- trait EncodingProfileExt::fn presence -->
# Returns
The number of times the profile is used in its parent
container profile. If 0, it is not a mandatory stream.
<!-- trait EncodingProfileExt::fn get_preset -->
<!-- trait EncodingProfileExt::fn preset -->
# Returns
the name of the `gst::Preset` to be used in the profile.
This is the name that has been set when saving the preset.
<!-- trait EncodingProfileExt::fn get_preset_name -->
<!-- trait EncodingProfileExt::fn preset_name -->
# Returns
the name of the `gst::Preset` factory to be used in the profile.
<!-- trait EncodingProfileExt::fn get_restriction -->
<!-- trait EncodingProfileExt::fn restriction -->
# Returns
@ -683,7 +683,7 @@ properties of the raw stream (that is before encoding), such as height and
width for video and depth and sampling rate for audio. Does not apply to
`EncodingContainerProfile` (since there is no corresponding raw stream).
Can be `None`. Unref after usage.
<!-- trait EncodingProfileExt::fn get_single_segment -->
<!-- trait EncodingProfileExt::fn is_single_segment -->
Feature: `v1_18`
@ -693,7 +693,7 @@ Feature: `v1_18`
`true` if the stream represented by `self` should use a single
segment before the encoder, `false` otherwise. This means that buffers will be retimestamped
and segments will be eat so as to appear as one segment.
<!-- trait EncodingProfileExt::fn get_type_nick -->
<!-- trait EncodingProfileExt::fn type_nick -->
# Returns
@ -771,7 +771,7 @@ When being stored/loaded, targets come from a specific category, like
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@glib::object::ObjectExt`]
<!-- impl EncodingTarget::fn new -->
Creates a new `EncodingTarget`.
@ -838,23 +838,23 @@ the `EncodingProfile` to add
# Returns
`true` if the profile was added, else `false`.
<!-- impl EncodingTarget::fn get_category -->
<!-- impl EncodingTarget::fn category -->
# Returns
The category of the `self`. For example:
`GST_ENCODING_CATEGORY_DEVICE`.
<!-- impl EncodingTarget::fn get_description -->
<!-- impl EncodingTarget::fn description -->
# Returns
The description of the `self`.
<!-- impl EncodingTarget::fn get_name -->
<!-- impl EncodingTarget::fn name -->
# Returns
The name of the `self`.
<!-- impl EncodingTarget::fn get_path -->
<!-- impl EncodingTarget::fn path -->
Feature: `v1_18`
@ -869,7 +869,7 @@ the name of the profile to retrieve
# Returns
The matching `EncodingProfile`, or `None`.
<!-- impl EncodingTarget::fn get_profiles -->
<!-- impl EncodingTarget::fn profiles -->
# Returns
@ -894,7 +894,7 @@ Variant of `EncodingProfile` for video streams, allows specifying the `pass`.
# Implements
[`EncodingProfileExt`](trait.EncodingProfileExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`EncodingProfileExt`](trait@crate::EncodingProfileExt), [`trait@glib::object::ObjectExt`]
<!-- impl EncodingVideoProfile::fn new -->
Creates a new `EncodingVideoProfile`
@ -920,14 +920,14 @@ the number of time this stream must be used. 0 means any number of
# Returns
the newly created `EncodingVideoProfile`.
<!-- impl EncodingVideoProfile::fn get_pass -->
<!-- impl EncodingVideoProfile::fn pass -->
Get the pass number if this is part of a multi-pass profile.
# Returns
The pass number. Starts at 1 for multi-pass. 0 if this is
not a multi-pass profile
<!-- impl EncodingVideoProfile::fn get_variableframerate -->
<!-- impl EncodingVideoProfile::fn is_variableframerate -->
> *NOTE*: Fixed framerate won't be enforced when `encodebin:avoid-reencoding`
> is set.

128
docs/gstreamer-player/docs.md
View file

@ -4,7 +4,7 @@
# Implements
[`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl Player::fn new -->
Creates a new `Player` instance that uses `signal_dispatcher` to dispatch
signals to some event loop system, or emits signals directly if NULL is
@ -109,7 +109,7 @@ a `None` terminated array of `PlayerVisualization` to free
a `None` terminated array containing all available
visualizations. Use `Player::visualizations_free` after
usage.
<!-- impl Player::fn get_audio_video_offset -->
<!-- impl Player::fn audio_video_offset -->
Retrieve the current value of audio-video-offset property
# Returns
@ -124,7 +124,7 @@ Retrieve the current value of the indicated `type_`.
The current value of `type_`, between [0,1]. In case of
error -1 is returned.
<!-- impl Player::fn get_config -->
<!-- impl Player::fn config -->
Get a copy of the current configuration of the player. This configuration
can either be modified and used for the `Player::set_config` call
or it must be freed after usage.
@ -133,7 +133,7 @@ or it must be freed after usage.
a copy of the current configuration of `self`. Use
`gst::Structure::free` after usage or `Player::set_config`.
<!-- impl Player::fn get_current_audio_track -->
<!-- impl Player::fn current_audio_track -->
A Function to get current audio `PlayerAudioInfo` instance.
# Returns
@ -141,7 +141,7 @@ A Function to get current audio `PlayerAudioInfo` instance.
current audio track.
The caller should free it with `glib::object::ObjectExt::unref`
<!-- impl Player::fn get_current_subtitle_track -->
<!-- impl Player::fn current_subtitle_track -->
A Function to get current subtitle `PlayerSubtitleInfo` instance.
# Returns
@ -149,7 +149,7 @@ A Function to get current subtitle `PlayerSubtitleInfo` instance.
current subtitle track.
The caller should free it with `glib::object::ObjectExt::unref`
<!-- impl Player::fn get_current_video_track -->
<!-- impl Player::fn current_video_track -->
A Function to get current video `PlayerVideoInfo` instance.
# Returns
@ -157,20 +157,20 @@ A Function to get current video `PlayerVideoInfo` instance.
current video track.
The caller should free it with `glib::object::ObjectExt::unref`
<!-- impl Player::fn get_current_visualization -->
<!-- impl Player::fn current_visualization -->
# Returns
Name of the currently enabled visualization.
`g_free` after usage.
<!-- impl Player::fn get_duration -->
<!-- impl Player::fn duration -->
Retrieves the duration of the media stream that self represents.
# Returns
the duration of the currently-playing media stream, in
nanoseconds.
<!-- impl Player::fn get_media_info -->
<!-- impl Player::fn media_info -->
A Function to get the current media info `PlayerMediaInfo` instance.
# Returns
@ -178,47 +178,47 @@ A Function to get the current media info `PlayerMediaInfo` instance.
media info instance.
The caller should free it with `glib::object::ObjectExt::unref`
<!-- impl Player::fn get_multiview_flags -->
<!-- impl Player::fn multiview_flags -->
Retrieve the current value of the indicated `type_`.
# Returns
The current value of `type_`, Default: 0x00000000 "none
<!-- impl Player::fn get_multiview_mode -->
<!-- impl Player::fn multiview_mode -->
Retrieve the current value of the indicated `type_`.
# Returns
The current value of `type_`, Default: -1 "none"
<!-- impl Player::fn get_mute -->
<!-- impl Player::fn is_muted -->
# Returns
`true` if the currently-playing stream is muted.
<!-- impl Player::fn get_pipeline -->
<!-- impl Player::fn pipeline -->
# Returns
The internal playbin instance
<!-- impl Player::fn get_position -->
<!-- impl Player::fn position -->
# Returns
the absolute position time, in nanoseconds, of the
currently-playing stream.
<!-- impl Player::fn get_rate -->
<!-- impl Player::fn rate -->
# Returns
current playback rate
<!-- impl Player::fn get_subtitle_uri -->
<!-- impl Player::fn subtitle_uri -->
current subtitle URI
# Returns
URI of the current external subtitle.
`g_free` after usage.
<!-- impl Player::fn get_subtitle_video_offset -->
<!-- impl Player::fn subtitle_video_offset -->
Retrieve the current value of subtitle-video-offset property
Feature: `v1_16`
@ -227,7 +227,7 @@ Feature: `v1_16`
# Returns
The current value of subtitle-video-offset in nanoseconds
<!-- impl Player::fn get_uri -->
<!-- impl Player::fn uri -->
Gets the URI of the currently-playing stream.
# Returns
@ -249,7 +249,7 @@ Additional configuration
# Returns
Current video snapshot sample or `None` on failure
<!-- impl Player::fn get_volume -->
<!-- impl Player::fn volume -->
Returns the current volume level, as a percentage between 0 and 1.
# Returns
@ -397,28 +397,28 @@ in the stream.
# Implements
[`PlayerStreamInfoExt`](trait.PlayerStreamInfoExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
<!-- impl PlayerAudioInfo::fn get_bitrate -->
[`PlayerStreamInfoExt`](trait@crate::PlayerStreamInfoExt), [`trait@glib::object::ObjectExt`]
<!-- impl PlayerAudioInfo::fn bitrate -->
# Returns
the audio bitrate in `PlayerAudioInfo`.
<!-- impl PlayerAudioInfo::fn get_channels -->
<!-- impl PlayerAudioInfo::fn channels -->
# Returns
the number of audio channels in `PlayerAudioInfo`.
<!-- impl PlayerAudioInfo::fn get_language -->
<!-- impl PlayerAudioInfo::fn language -->
# Returns
the language of the stream, or NULL if unknown.
<!-- impl PlayerAudioInfo::fn get_max_bitrate -->
<!-- impl PlayerAudioInfo::fn max_bitrate -->
# Returns
the audio maximum bitrate in `PlayerAudioInfo`.
<!-- impl PlayerAudioInfo::fn get_sample_rate -->
<!-- impl PlayerAudioInfo::fn sample_rate -->
# Returns
@ -441,7 +441,7 @@ generic error.
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`PlayerSignalDispatcherExt`](trait.PlayerSignalDispatcherExt.html)
[`trait@glib::object::ObjectExt`], [`PlayerSignalDispatcherExt`](trait@crate::PlayerSignalDispatcherExt)
<!-- impl PlayerGMainContextSignalDispatcher::fn new -->
Creates a new GstPlayerSignalDispatcher that uses `application_context`,
or the thread default one if `None` is used. See `Player::new`.
@ -456,78 +456,78 @@ Structure containing the media information of a URI.
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
<!-- impl PlayerMediaInfo::fn get_audio_streams -->
[`trait@glib::object::ObjectExt`]
<!-- impl PlayerMediaInfo::fn audio_streams -->
# Returns
A `glib::List` of
matching `PlayerAudioInfo`.
<!-- impl PlayerMediaInfo::fn get_container_format -->
<!-- impl PlayerMediaInfo::fn container_format -->
# Returns
the container format.
<!-- impl PlayerMediaInfo::fn get_duration -->
<!-- impl PlayerMediaInfo::fn duration -->
# Returns
duration of the media.
<!-- impl PlayerMediaInfo::fn get_image_sample -->
<!-- impl PlayerMediaInfo::fn image_sample -->
Function to get the image (or preview-image) stored in taglist.
Application can use `gst_sample_*_()` API's to get caps, buffer etc.
# Returns
GstSample or NULL.
<!-- impl PlayerMediaInfo::fn get_number_of_audio_streams -->
<!-- impl PlayerMediaInfo::fn number_of_audio_streams -->
# Returns
number of audio streams.
<!-- impl PlayerMediaInfo::fn get_number_of_streams -->
<!-- impl PlayerMediaInfo::fn number_of_streams -->
# Returns
number of total streams.
<!-- impl PlayerMediaInfo::fn get_number_of_subtitle_streams -->
<!-- impl PlayerMediaInfo::fn number_of_subtitle_streams -->
# Returns
number of subtitle streams.
<!-- impl PlayerMediaInfo::fn get_number_of_video_streams -->
<!-- impl PlayerMediaInfo::fn number_of_video_streams -->
# Returns
number of video streams.
<!-- impl PlayerMediaInfo::fn get_stream_list -->
<!-- impl PlayerMediaInfo::fn stream_list -->
# Returns
A `glib::List` of
matching `PlayerStreamInfo`.
<!-- impl PlayerMediaInfo::fn get_subtitle_streams -->
<!-- impl PlayerMediaInfo::fn subtitle_streams -->
# Returns
A `glib::List` of
matching `PlayerSubtitleInfo`.
<!-- impl PlayerMediaInfo::fn get_tags -->
<!-- impl PlayerMediaInfo::fn tags -->
# Returns
the tags contained in media info.
<!-- impl PlayerMediaInfo::fn get_title -->
<!-- impl PlayerMediaInfo::fn title -->
# Returns
the media title.
<!-- impl PlayerMediaInfo::fn get_uri -->
<!-- impl PlayerMediaInfo::fn uri -->
# Returns
the URI associated with `PlayerMediaInfo`.
<!-- impl PlayerMediaInfo::fn get_video_streams -->
<!-- impl PlayerMediaInfo::fn video_streams -->
# Returns
@ -548,13 +548,13 @@ matching `PlayerVideoInfo`.
# Implements
[`PlayerSignalDispatcherExt`](trait.PlayerSignalDispatcherExt.html)
[`PlayerSignalDispatcherExt`](trait@crate::PlayerSignalDispatcherExt)
<!-- trait PlayerSignalDispatcherExt -->
Trait containing all `PlayerSignalDispatcher` methods.
# Implementors
[`PlayerGMainContextSignalDispatcher`](struct.PlayerGMainContextSignalDispatcher.html), [`PlayerSignalDispatcher`](struct.PlayerSignalDispatcher.html)
[`PlayerGMainContextSignalDispatcher`](struct@crate::PlayerGMainContextSignalDispatcher), [`PlayerSignalDispatcher`](struct@crate::PlayerSignalDispatcher)
<!-- enum PlayerSnapshotFormat -->
<!-- enum PlayerState -->
<!-- enum PlayerState::variant Stopped -->
@ -575,38 +575,38 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`PlayerStreamInfoExt`](trait.PlayerStreamInfoExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`PlayerStreamInfoExt`](trait@crate::PlayerStreamInfoExt), [`trait@glib::object::ObjectExt`]
<!-- trait PlayerStreamInfoExt -->
Trait containing all `PlayerStreamInfo` methods.
# Implementors
[`PlayerAudioInfo`](struct.PlayerAudioInfo.html), [`PlayerStreamInfo`](struct.PlayerStreamInfo.html), [`PlayerSubtitleInfo`](struct.PlayerSubtitleInfo.html), [`PlayerVideoInfo`](struct.PlayerVideoInfo.html)
<!-- trait PlayerStreamInfoExt::fn get_caps -->
[`PlayerAudioInfo`](struct@crate::PlayerAudioInfo), [`PlayerStreamInfo`](struct@crate::PlayerStreamInfo), [`PlayerSubtitleInfo`](struct@crate::PlayerSubtitleInfo), [`PlayerVideoInfo`](struct@crate::PlayerVideoInfo)
<!-- trait PlayerStreamInfoExt::fn caps -->
# Returns
the `gst::Caps` of the stream.
<!-- trait PlayerStreamInfoExt::fn get_codec -->
<!-- trait PlayerStreamInfoExt::fn codec -->
A string describing codec used in `PlayerStreamInfo`.
# Returns
codec string or NULL on unknown.
<!-- trait PlayerStreamInfoExt::fn get_index -->
<!-- trait PlayerStreamInfoExt::fn index -->
Function to get stream index from `PlayerStreamInfo` instance.
# Returns
the stream index of this stream.
<!-- trait PlayerStreamInfoExt::fn get_stream_type -->
<!-- trait PlayerStreamInfoExt::fn stream_type -->
Function to return human readable name for the stream type
of the given `self` (ex: "audio", "video", "subtitle")
# Returns
a human readable name
<!-- trait PlayerStreamInfoExt::fn get_tags -->
<!-- trait PlayerStreamInfoExt::fn tags -->
# Returns
@ -616,8 +616,8 @@ the tags contained in this stream.
# Implements
[`PlayerStreamInfoExt`](trait.PlayerStreamInfoExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
<!-- impl PlayerSubtitleInfo::fn get_language -->
[`PlayerStreamInfoExt`](trait@crate::PlayerStreamInfoExt), [`trait@glib::object::ObjectExt`]
<!-- impl PlayerSubtitleInfo::fn language -->
# Returns
@ -627,34 +627,34 @@ the language of the stream, or NULL if unknown.
# Implements
[`PlayerStreamInfoExt`](trait.PlayerStreamInfoExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
<!-- impl PlayerVideoInfo::fn get_bitrate -->
[`PlayerStreamInfoExt`](trait@crate::PlayerStreamInfoExt), [`trait@glib::object::ObjectExt`]
<!-- impl PlayerVideoInfo::fn bitrate -->
# Returns
the current bitrate of video in `PlayerVideoInfo`.
<!-- impl PlayerVideoInfo::fn get_framerate -->
<!-- impl PlayerVideoInfo::fn framerate -->
## `fps_n`
Numerator of frame rate
## `fps_d`
Denominator of frame rate
<!-- impl PlayerVideoInfo::fn get_height -->
<!-- impl PlayerVideoInfo::fn height -->
# Returns
the height of video in `PlayerVideoInfo`.
<!-- impl PlayerVideoInfo::fn get_max_bitrate -->
<!-- impl PlayerVideoInfo::fn max_bitrate -->
# Returns
the maximum bitrate of video in `PlayerVideoInfo`.
<!-- impl PlayerVideoInfo::fn get_pixel_aspect_ratio -->
<!-- impl PlayerVideoInfo::fn pixel_aspect_ratio -->
Returns the pixel aspect ratio in `par_n` and `par_d`
## `par_n`
numerator
## `par_d`
denominator
<!-- impl PlayerVideoInfo::fn get_width -->
<!-- impl PlayerVideoInfo::fn width -->
# Returns
@ -664,7 +664,7 @@ the width of video in `PlayerVideoInfo`.
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`PlayerVideoRendererExt`](trait.PlayerVideoRendererExt.html)
[`trait@glib::object::ObjectExt`], [`PlayerVideoRendererExt`](trait@crate::PlayerVideoRendererExt)
<!-- impl PlayerVideoOverlayVideoRenderer::fn new -->
## `window_handle`
Window handle to use or `None`
@ -676,7 +676,7 @@ the custom video_sink element to be set for the video renderer
<!-- impl PlayerVideoOverlayVideoRenderer::fn expose -->
Tell an overlay that it has been exposed. This will redraw the current frame
in the drawable even if the pipeline is PAUSED.
<!-- impl PlayerVideoOverlayVideoRenderer::fn get_render_rectangle -->
<!-- impl PlayerVideoOverlayVideoRenderer::fn render_rectangle -->
Return the currently configured render rectangle. See `PlayerVideoOverlayVideoRenderer::set_render_rectangle`
for details.
## `x`
@ -687,7 +687,7 @@ the vertical offset of the render area inside the window
the width of the render area inside the window
## `height`
the height of the render area inside the window
<!-- impl PlayerVideoOverlayVideoRenderer::fn get_window_handle -->
<!-- impl PlayerVideoOverlayVideoRenderer::fn window_handle -->
# Returns
@ -722,13 +722,13 @@ handle referencing to the platform specific window
# Implements
[`PlayerVideoRendererExt`](trait.PlayerVideoRendererExt.html)
[`PlayerVideoRendererExt`](trait@crate::PlayerVideoRendererExt)
<!-- trait PlayerVideoRendererExt -->
Trait containing all `PlayerVideoRenderer` methods.
# Implementors
[`PlayerVideoOverlayVideoRenderer`](struct.PlayerVideoOverlayVideoRenderer.html), [`PlayerVideoRenderer`](struct.PlayerVideoRenderer.html)
[`PlayerVideoOverlayVideoRenderer`](struct@crate::PlayerVideoOverlayVideoRenderer), [`PlayerVideoRenderer`](struct@crate::PlayerVideoRenderer)
<!-- struct PlayerVisualization -->
A `PlayerVisualization` descriptor.
<!-- impl PlayerVisualization::fn copy -->

271
docs/gstreamer-rtsp-server/docs.md
View file

@ -29,13 +29,13 @@ An address pool, all member are private
# Implements
[`RTSPAddressPoolExt`](trait.RTSPAddressPoolExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`RTSPAddressPoolExtManual`](prelude/trait.RTSPAddressPoolExtManual.html)
[`RTSPAddressPoolExt`](trait@crate::RTSPAddressPoolExt), [`trait@glib::object::ObjectExt`], [`RTSPAddressPoolExtManual`](trait@crate::RTSPAddressPoolExtManual)
<!-- trait RTSPAddressPoolExt -->
Trait containing all `RTSPAddressPool` methods.
# Implementors
[`RTSPAddressPool`](struct.RTSPAddressPool.html)
[`RTSPAddressPool`](struct@crate::RTSPAddressPool)
<!-- impl RTSPAddressPool::fn new -->
Make a new `RTSPAddressPool`.
@ -132,13 +132,13 @@ The authentication structure.
# Implements
[`RTSPAuthExt`](trait.RTSPAuthExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`RTSPAuthExtManual`](prelude/trait.RTSPAuthExtManual.html)
[`RTSPAuthExt`](trait@crate::RTSPAuthExt), [`trait@glib::object::ObjectExt`], [`RTSPAuthExtManual`](trait@crate::RTSPAuthExtManual)
<!-- trait RTSPAuthExt -->
Trait containing all `RTSPAuth` methods.
# Implementors
[`RTSPAuth`](struct.RTSPAuth.html)
[`RTSPAuth`](struct@crate::RTSPAuth)
<!-- impl RTSPAuth::fn new -->
Create a new `RTSPAuth` instance.
@ -183,7 +183,7 @@ the digest user name
the digest password
## `token`
authorisation token
<!-- trait RTSPAuthExt::fn get_default_token -->
<!-- trait RTSPAuthExt::fn default_token -->
Get the default token for `self`. This token will be used for unauthenticated
users.
@ -191,7 +191,7 @@ users.
the `RTSPToken` of `self`. `gst_rtsp_token_unref` after
usage.
<!-- trait RTSPAuthExt::fn get_realm -->
<!-- trait RTSPAuthExt::fn realm -->
Feature: `v1_16`
@ -199,7 +199,7 @@ Feature: `v1_16`
# Returns
the `realm` of `self`
<!-- trait RTSPAuthExt::fn get_supported_methods -->
<!-- trait RTSPAuthExt::fn supported_methods -->
Gets the supported authentication methods of `self`.
Feature: `v1_12`
@ -208,20 +208,20 @@ Feature: `v1_12`
# Returns
The supported authentication methods
<!-- trait RTSPAuthExt::fn get_tls_authentication_mode -->
<!-- trait RTSPAuthExt::fn tls_authentication_mode -->
Get the `gio::TlsAuthenticationMode`.
# Returns
the `gio::TlsAuthenticationMode`.
<!-- trait RTSPAuthExt::fn get_tls_certificate -->
<!-- trait RTSPAuthExt::fn tls_certificate -->
Get the `gio::TlsCertificate` used for negotiating TLS `self`.
# Returns
the `gio::TlsCertificate` of `self`. `glib::object::ObjectExt::unref` after
usage.
<!-- trait RTSPAuthExt::fn get_tls_database -->
<!-- trait RTSPAuthExt::fn tls_database -->
Get the `gio::TlsDatabase` used for verifying client certificate.
# Returns
@ -312,13 +312,13 @@ The client object represents the connection and its state with a client.
# Implements
[`RTSPClientExt`](trait.RTSPClientExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`RTSPClientExtManual`](prelude/trait.RTSPClientExtManual.html)
[`RTSPClientExt`](trait@crate::RTSPClientExt), [`trait@glib::object::ObjectExt`], [`RTSPClientExtManual`](trait@crate::RTSPClientExtManual)
<!-- trait RTSPClientExt -->
Trait containing all `RTSPClient` methods.
# Implementors
[`RTSPClient`](struct.RTSPClient.html)
[`RTSPClient`](struct@crate::RTSPClient)
<!-- impl RTSPClient::fn new -->
Create a new `RTSPClient` instance.
@ -340,21 +340,21 @@ a `glib::MainContext`
the ID (greater than 0) for the source within the GMainContext.
<!-- trait RTSPClientExt::fn close -->
Close the connection of `self` and remove all media it was managing.
<!-- trait RTSPClientExt::fn get_auth -->
<!-- trait RTSPClientExt::fn auth -->
Get the `RTSPAuth` used as the authentication manager of `self`.
# Returns
the `RTSPAuth` of `self`.
`glib::object::ObjectExt::unref` after usage.
<!-- trait RTSPClientExt::fn get_connection -->
<!-- trait RTSPClientExt::fn connection -->
Get the `gst_rtsp::RTSPConnection` of `self`.
# Returns
the `gst_rtsp::RTSPConnection` of `self`.
The connection object returned remains valid until the client is freed.
<!-- trait RTSPClientExt::fn get_content_length_limit -->
<!-- trait RTSPClientExt::fn content_length_limit -->
Get the Content-Length limit of `self`.
Feature: `v1_18`
@ -363,13 +363,13 @@ Feature: `v1_18`
# Returns
the Content-Length limit.
<!-- trait RTSPClientExt::fn get_mount_points -->
<!-- trait RTSPClientExt::fn mount_points -->
Get the `RTSPMountPoints` object that `self` uses to manage its sessions.
# Returns
a `RTSPMountPoints`, unref after usage.
<!-- trait RTSPClientExt::fn get_session_pool -->
<!-- trait RTSPClientExt::fn session_pool -->
Get the `RTSPSessionPool` object that `self` uses to manage its sessions.
# Returns
@ -388,7 +388,7 @@ Feature: `v1_18`
# Returns
the `RTSPStreamTransport` associated with `channel`.
<!-- trait RTSPClientExt::fn get_thread_pool -->
<!-- trait RTSPClientExt::fn thread_pool -->
Get the `RTSPThreadPool` used as the thread pool of `self`.
# Returns
@ -668,6 +668,21 @@ a `RTSPContext`
a `RTSPContext`
<!-- trait RTSPClientExt::fn connect_teardown_request -->
## `ctx`
a `RTSPContext`
<!-- struct RTSPContext -->
Information passed around containing the context of a request.
<!-- impl RTSPContext::fn pop_current -->
Pops `self` off the context stack (verifying that `self`
is on the top of the stack).
<!-- impl RTSPContext::fn push_current -->
Pushes `self` onto the context stack. The current
context can then be received using `RTSPContext::get_current`.
<!-- impl RTSPContext::fn get_current -->
Get the current `RTSPContext`. This object is retrieved from the
current thread that is handling the request for a client.
# Returns
a `RTSPContext`
<!-- enum RTSPFilterResult -->
Possible return values for `RTSPSessionPoolExt::filter`.
@ -685,13 +700,13 @@ This object is usually created from a `RTSPMediaFactory`.
# Implements
[`RTSPMediaExt`](trait.RTSPMediaExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`RTSPMediaExtManual`](prelude/trait.RTSPMediaExtManual.html)
[`RTSPMediaExt`](trait@crate::RTSPMediaExt), [`trait@glib::object::ObjectExt`], [`RTSPMediaExtManual`](trait@crate::RTSPMediaExtManual)
<!-- trait RTSPMediaExt -->
Trait containing all `RTSPMedia` methods.
# Implementors
[`RTSPMedia`](struct.RTSPMedia.html)
[`RTSPMedia`](struct@crate::RTSPMedia)
<!-- impl RTSPMedia::fn new -->
Create a new `RTSPMedia` instance. `element` is the bin element that
provides the different streams. The `RTSPMedia` object contains the
@ -748,14 +763,14 @@ the control of the stream
the `RTSPStream` with
control uri `control` or `None` when a stream with that control did
not exist.
<!-- trait RTSPMediaExt::fn get_address_pool -->
<!-- trait RTSPMediaExt::fn address_pool -->
Get the `RTSPAddressPool` used as the address pool of `self`.
# Returns
the `RTSPAddressPool` of `self`.
`glib::object::ObjectExt::unref` after usage.
<!-- trait RTSPMediaExt::fn get_base_time -->
<!-- trait RTSPMediaExt::fn base_time -->
Get the base_time that is used by the pipeline in `self`.
`self` must be prepared before this method returns a valid base_time.
@ -763,13 +778,13 @@ Get the base_time that is used by the pipeline in `self`.
# Returns
the base_time used by `self`.
<!-- trait RTSPMediaExt::fn get_buffer_size -->
<!-- trait RTSPMediaExt::fn buffer_size -->
Get the kernel UDP buffer size.
# Returns
the kernel UDP buffer size.
<!-- trait RTSPMediaExt::fn get_clock -->
<!-- trait RTSPMediaExt::fn clock -->
Get the clock that is used by the pipeline in `self`.
`self` must be prepared before this method returns a valid clock object.
@ -777,7 +792,7 @@ Get the clock that is used by the pipeline in `self`.
# Returns
the `gst::Clock` used by `self`. unref after usage.
<!-- trait RTSPMediaExt::fn get_do_retransmission -->
<!-- trait RTSPMediaExt::fn does_retransmission -->
Feature: `v1_16`
@ -785,7 +800,7 @@ Feature: `v1_16`
# Returns
Whether retransmission requests will be sent
<!-- trait RTSPMediaExt::fn get_dscp_qos -->
<!-- trait RTSPMediaExt::fn dscp_qos -->
Get the configured DSCP QoS of attached media.
Feature: `v1_18`
@ -794,19 +809,19 @@ Feature: `v1_18`
# Returns
the DSCP QoS value of attached streams or -1 if disabled.
<!-- trait RTSPMediaExt::fn get_element -->
<!-- trait RTSPMediaExt::fn element -->
Get the element that was used when constructing `self`.
# Returns
a `gst::Element`. Unref after usage.
<!-- trait RTSPMediaExt::fn get_latency -->
<!-- trait RTSPMediaExt::fn latency -->
Get the latency that is used for receiving media.
# Returns
latency in milliseconds
<!-- trait RTSPMediaExt::fn get_max_mcast_ttl -->
<!-- trait RTSPMediaExt::fn max_mcast_ttl -->
Get the the maximum time-to-live value of outgoing multicast packets.
Feature: `v1_16`
@ -815,32 +830,32 @@ Feature: `v1_16`
# Returns
the maximum time-to-live value of outgoing multicast packets.
<!-- trait RTSPMediaExt::fn get_multicast_iface -->
<!-- trait RTSPMediaExt::fn multicast_iface -->
Get the multicast interface used for `self`.
# Returns
the multicast interface for `self`.
`g_free` after usage.
<!-- trait RTSPMediaExt::fn get_permissions -->
<!-- trait RTSPMediaExt::fn permissions -->
Get the permissions object from `self`.
# Returns
a `RTSPPermissions` object, unref after usage.
<!-- trait RTSPMediaExt::fn get_profiles -->
<!-- trait RTSPMediaExt::fn profiles -->
Get the allowed profiles of `self`.
# Returns
a `gst_rtsp::RTSPProfile`
<!-- trait RTSPMediaExt::fn get_protocols -->
<!-- trait RTSPMediaExt::fn protocols -->
Get the allowed protocols of `self`.
# Returns
a `gst_rtsp::RTSPLowerTrans`
<!-- trait RTSPMediaExt::fn get_publish_clock_mode -->
<!-- trait RTSPMediaExt::fn publish_clock_mode -->
Gets if and how the media clock should be published according to RFC7273.
# Returns
@ -857,7 +872,7 @@ the unit to use for the string
# Returns
The range as a string, `g_free` after usage.
<!-- trait RTSPMediaExt::fn get_rate_control -->
<!-- trait RTSPMediaExt::fn is_rate_control -->
Feature: `v1_18`
@ -866,7 +881,7 @@ Feature: `v1_18`
whether `self` will follow the Rate-Control=no behaviour as specified
in the ONVIF replay spec.
<!-- trait RTSPMediaExt::fn get_rates -->
<!-- trait RTSPMediaExt::fn rates -->
Get the rate and applied_rate of the current segment.
Feature: `v1_18`
@ -881,13 +896,13 @@ the applied_rate of the current segment
`false` if looking up the rate and applied rate failed. Otherwise
`true` is returned and `rate` and `applied_rate` are set to the rate and
applied_rate of the current segment.
<!-- trait RTSPMediaExt::fn get_retransmission_time -->
<!-- trait RTSPMediaExt::fn retransmission_time -->
Get the amount of time to store retransmission data.
# Returns
the amount of time to store retransmission data.
<!-- trait RTSPMediaExt::fn get_status -->
<!-- trait RTSPMediaExt::fn status -->
Get the status of `self`. When `self` is busy preparing, this function waits
until `self` is prepared or in error.
@ -903,7 +918,7 @@ the stream index
the `RTSPStream` at index
`idx` or `None` when a stream with that index did not exist.
<!-- trait RTSPMediaExt::fn get_suspend_mode -->
<!-- trait RTSPMediaExt::fn suspend_mode -->
Get how `self` will be suspended.
# Returns
@ -920,7 +935,7 @@ a port or 0
# Returns
the `gst_net::NetTimeProvider` of `self`.
<!-- trait RTSPMediaExt::fn get_transport_mode -->
<!-- trait RTSPMediaExt::fn transport_mode -->
Check if the pipeline for `self` can be used for PLAY or RECORD methods.
# Returns
@ -1266,13 +1281,13 @@ can contain multiple streams like audio and video.
# Implements
[`RTSPMediaFactoryExt`](trait.RTSPMediaFactoryExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`RTSPMediaFactoryExtManual`](prelude/trait.RTSPMediaFactoryExtManual.html)
[`RTSPMediaFactoryExt`](trait@crate::RTSPMediaFactoryExt), [`trait@glib::object::ObjectExt`], [`RTSPMediaFactoryExtManual`](trait@crate::RTSPMediaFactoryExtManual)
<!-- trait RTSPMediaFactoryExt -->
Trait containing all `RTSPMediaFactory` methods.
# Implementors
[`RTSPMediaFactoryURI`](struct.RTSPMediaFactoryURI.html), [`RTSPMediaFactory`](struct.RTSPMediaFactory.html)
[`RTSPMediaFactoryURI`](struct@crate::RTSPMediaFactoryURI), [`RTSPMediaFactory`](struct@crate::RTSPMediaFactory)
<!-- impl RTSPMediaFactory::fn new -->
Create a new `RTSPMediaFactory` instance.
@ -1323,27 +1338,27 @@ the url used
# Returns
a new `gst::Element`.
<!-- trait RTSPMediaFactoryExt::fn get_address_pool -->
<!-- trait RTSPMediaFactoryExt::fn address_pool -->
Get the `RTSPAddressPool` used as the address pool of `self`.
# Returns
the `RTSPAddressPool` of `self`. `glib::object::ObjectExt::unref` after
usage.
<!-- trait RTSPMediaFactoryExt::fn get_buffer_size -->
<!-- trait RTSPMediaFactoryExt::fn buffer_size -->
Get the kernel UDP buffer size.
# Returns
the kernel UDP buffer size.
<!-- trait RTSPMediaFactoryExt::fn get_clock -->
<!-- trait RTSPMediaFactoryExt::fn clock -->
Returns the clock that is going to be used by the pipelines
of all medias created from this factory.
# Returns
The GstClock
<!-- trait RTSPMediaFactoryExt::fn get_do_retransmission -->
<!-- trait RTSPMediaFactoryExt::fn does_retransmission -->
Feature: `v1_16`
@ -1351,7 +1366,7 @@ Feature: `v1_16`
# Returns
Whether retransmission requests will be sent for receiving media
<!-- trait RTSPMediaFactoryExt::fn get_dscp_qos -->
<!-- trait RTSPMediaFactoryExt::fn dscp_qos -->
Get the configured media DSCP QoS.
Feature: `v1_18`
@ -1360,13 +1375,13 @@ Feature: `v1_18`
# Returns
the media DSCP QoS value or -1 if disabled.
<!-- trait RTSPMediaFactoryExt::fn get_latency -->
<!-- trait RTSPMediaFactoryExt::fn latency -->
Get the latency that is used for receiving media
# Returns
latency in milliseconds
<!-- trait RTSPMediaFactoryExt::fn get_launch -->
<!-- trait RTSPMediaFactoryExt::fn launch -->
Get the `gst_parse_launch` pipeline description that will be used in the
default prepare vmethod.
@ -1374,7 +1389,7 @@ default prepare vmethod.
the configured launch description. `g_free` after
usage.
<!-- trait RTSPMediaFactoryExt::fn get_max_mcast_ttl -->
<!-- trait RTSPMediaFactoryExt::fn max_mcast_ttl -->
Get the the maximum time-to-live value of outgoing multicast packets.
Feature: `v1_16`
@ -1383,53 +1398,53 @@ Feature: `v1_16`
# Returns
the maximum time-to-live value of outgoing multicast packets.
<!-- trait RTSPMediaFactoryExt::fn get_media_gtype -->
<!-- trait RTSPMediaFactoryExt::fn media_gtype -->
Return the GType of the GstRTSPMedia subclass this
factory will create.
<!-- trait RTSPMediaFactoryExt::fn get_multicast_iface -->
<!-- trait RTSPMediaFactoryExt::fn multicast_iface -->
Get the multicast interface used for `self`.
# Returns
the multicast interface for `self`. `g_free` after
usage.
<!-- trait RTSPMediaFactoryExt::fn get_permissions -->
<!-- trait RTSPMediaFactoryExt::fn permissions -->
Get the permissions object from `self`.
# Returns
a `RTSPPermissions` object, unref after usage.
<!-- trait RTSPMediaFactoryExt::fn get_profiles -->
<!-- trait RTSPMediaFactoryExt::fn profiles -->
Get the allowed profiles of `self`.
# Returns
a `gst_rtsp::RTSPProfile`
<!-- trait RTSPMediaFactoryExt::fn get_protocols -->
<!-- trait RTSPMediaFactoryExt::fn protocols -->
Get the allowed protocols of `self`.
# Returns
a `gst_rtsp::RTSPLowerTrans`
<!-- trait RTSPMediaFactoryExt::fn get_publish_clock_mode -->
<!-- trait RTSPMediaFactoryExt::fn publish_clock_mode -->
Gets if and how the media clock should be published according to RFC7273.
# Returns
The GstRTSPPublishClockMode
<!-- trait RTSPMediaFactoryExt::fn get_retransmission_time -->
<!-- trait RTSPMediaFactoryExt::fn retransmission_time -->
Get the time that is stored for retransmission purposes
# Returns
a `gst::ClockTime`
<!-- trait RTSPMediaFactoryExt::fn get_suspend_mode -->
<!-- trait RTSPMediaFactoryExt::fn suspend_mode -->
Get how media created from this factory will be suspended.
# Returns
a `RTSPSuspendMode`.
<!-- trait RTSPMediaFactoryExt::fn get_transport_mode -->
<!-- trait RTSPMediaFactoryExt::fn transport_mode -->
Get if media created from this factory can be used for PLAY or RECORD
methods.
@ -1576,20 +1591,20 @@ A media factory that creates a pipeline to play any uri.
# Implements
[`RTSPMediaFactoryURIExt`](trait.RTSPMediaFactoryURIExt.html), [`RTSPMediaFactoryExt`](trait.RTSPMediaFactoryExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`RTSPMediaFactoryExtManual`](prelude/trait.RTSPMediaFactoryExtManual.html)
[`RTSPMediaFactoryURIExt`](trait@crate::RTSPMediaFactoryURIExt), [`RTSPMediaFactoryExt`](trait@crate::RTSPMediaFactoryExt), [`trait@glib::object::ObjectExt`], [`RTSPMediaFactoryExtManual`](trait@crate::RTSPMediaFactoryExtManual)
<!-- trait RTSPMediaFactoryURIExt -->
Trait containing all `RTSPMediaFactoryURI` methods.
# Implementors
[`RTSPMediaFactoryURI`](struct.RTSPMediaFactoryURI.html)
[`RTSPMediaFactoryURI`](struct@crate::RTSPMediaFactoryURI)
<!-- impl RTSPMediaFactoryURI::fn new -->
Create a new `RTSPMediaFactoryURI` instance.
# Returns
a new `RTSPMediaFactoryURI` object.
<!-- trait RTSPMediaFactoryURIExt::fn get_uri -->
<!-- trait RTSPMediaFactoryURIExt::fn uri -->
Get the URI that will provide media for this factory.
# Returns
@ -1619,13 +1634,13 @@ Creates a `RTSPMediaFactory` object for a given url.
# Implements
[`RTSPMountPointsExt`](trait.RTSPMountPointsExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`RTSPMountPointsExt`](trait@crate::RTSPMountPointsExt), [`trait@glib::object::ObjectExt`]
<!-- trait RTSPMountPointsExt -->
Trait containing all `RTSPMountPoints` methods.
# Implementors
[`RTSPMountPoints`](struct.RTSPMountPoints.html)
[`RTSPMountPoints`](struct@crate::RTSPMountPoints)
<!-- impl RTSPMountPoints::fn new -->
Make a new mount points object.
@ -1683,13 +1698,13 @@ it.
# Implements
[`RTSPServerExt`](trait.RTSPServerExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`RTSPServerExtManual`](prelude/trait.RTSPServerExtManual.html)
[`RTSPServerExt`](trait@crate::RTSPServerExt), [`trait@glib::object::ObjectExt`], [`RTSPServerExtManual`](trait@crate::RTSPServerExtManual)
<!-- trait RTSPServerExt -->
Trait containing all `RTSPServer` methods.
# Implementors
[`RTSPServer`](struct.RTSPServer.html)
[`RTSPServer`](struct@crate::RTSPServer)
<!-- impl RTSPServer::fn new -->
Create a new `RTSPServer` instance.
@ -1780,32 +1795,32 @@ a `gio::Cancellable` or `None`.
the `glib::Source` for `self` or `None` when an error
occurred. Free with g_source_unref ()
<!-- trait RTSPServerExt::fn get_address -->
<!-- trait RTSPServerExt::fn address -->
Get the address on which the server will accept connections.
# Returns
the server address. `g_free` after usage.
<!-- trait RTSPServerExt::fn get_auth -->
<!-- trait RTSPServerExt::fn auth -->
Get the `RTSPAuth` used as the authentication manager of `self`.
# Returns
the `RTSPAuth` of `self`. `glib::object::ObjectExt::unref` after
usage.
<!-- trait RTSPServerExt::fn get_backlog -->
<!-- trait RTSPServerExt::fn backlog -->
The maximum amount of queued requests for the server.
# Returns
the server backlog.
<!-- trait RTSPServerExt::fn get_bound_port -->
<!-- trait RTSPServerExt::fn bound_port -->
Get the port number where the server was bound to.
# Returns
the port number
<!-- trait RTSPServerExt::fn get_content_length_limit -->
<!-- trait RTSPServerExt::fn content_length_limit -->
Get the Content-Length limit of `self`.
Feature: `v1_18`
@ -1814,27 +1829,27 @@ Feature: `v1_18`
# Returns
the Content-Length limit.
<!-- trait RTSPServerExt::fn get_mount_points -->
<!-- trait RTSPServerExt::fn mount_points -->
Get the `RTSPMountPoints` used as the mount points of `self`.
# Returns
the `RTSPMountPoints` of `self`. `glib::object::ObjectExt::unref` after
usage.
<!-- trait RTSPServerExt::fn get_service -->
<!-- trait RTSPServerExt::fn service -->
Get the service on which the server will accept connections.
# Returns
the service. use `g_free` after usage.
<!-- trait RTSPServerExt::fn get_session_pool -->
<!-- trait RTSPServerExt::fn session_pool -->
Get the `RTSPSessionPool` used as the session pool of `self`.
# Returns
the `RTSPSessionPool` used for sessions. `glib::object::ObjectExt::unref` after
usage.
<!-- trait RTSPServerExt::fn get_thread_pool -->
<!-- trait RTSPServerExt::fn thread_pool -->
Get the `RTSPThreadPool` used as the thread pool of `self`.
# Returns
@ -1912,13 +1927,13 @@ identified with the url of a media.
# Implements
[`RTSPSessionExt`](trait.RTSPSessionExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`RTSPSessionExt`](trait@crate::RTSPSessionExt), [`trait@glib::object::ObjectExt`]
<!-- trait RTSPSessionExt -->
Trait containing all `RTSPSession` methods.
# Implementors
[`RTSPSession`](struct.RTSPSession.html)
[`RTSPSession`](struct@crate::RTSPSession)
<!-- impl RTSPSession::fn new -->
Create a new `RTSPSession` instance with `sessionid`.
## `sessionid`
@ -1955,7 +1970,7 @@ user data passed to `func`
a GList with all
media for which `func` returned `RTSPFilterResult::Ref`. After usage, each
element in the `glib::List` should be unreffed before the list is freed.
<!-- trait RTSPSessionExt::fn get_header -->
<!-- trait RTSPSessionExt::fn header -->
Get the string that can be placed in the Session header field.
# Returns
@ -1973,14 +1988,14 @@ the amount of matched characters
# Returns
the configuration for `path` in `self`.
<!-- trait RTSPSessionExt::fn get_sessionid -->
<!-- trait RTSPSessionExt::fn sessionid -->
Get the sessionid of `self`.
# Returns
the sessionid of `self`.
The value remains valid as long as `self` is alive.
<!-- trait RTSPSessionExt::fn get_timeout -->
<!-- trait RTSPSessionExt::fn timeout -->
Get the timeout value of `self`.
# Returns
@ -2061,13 +2076,13 @@ State of a client session regarding a specific media identified by path.
# Implements
[`RTSPSessionMediaExt`](trait.RTSPSessionMediaExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`RTSPSessionMediaExt`](trait@crate::RTSPSessionMediaExt), [`trait@glib::object::ObjectExt`]
<!-- trait RTSPSessionMediaExt -->
Trait containing all `RTSPSessionMedia` methods.
# Implementors
[`RTSPSessionMedia`](struct.RTSPSessionMedia.html)
[`RTSPSessionMedia`](struct@crate::RTSPSessionMedia)
<!-- impl RTSPSessionMedia::fn new -->
Create a new `RTSPSessionMedia` that manages the streams
in `media` for `path`. `media` should be prepared.
@ -2090,20 +2105,20 @@ a `gst_rtsp::RTSPRange`
# Returns
`true` on success.
<!-- trait RTSPSessionMediaExt::fn get_base_time -->
<!-- trait RTSPSessionMediaExt::fn base_time -->
Get the base_time of the `RTSPMedia` in `self`
# Returns
the base_time of the media.
<!-- trait RTSPSessionMediaExt::fn get_media -->
<!-- trait RTSPSessionMediaExt::fn media -->
Get the `RTSPMedia` that was used when constructing `self`
# Returns
the `RTSPMedia` of `self`.
Remains valid as long as `self` is valid.
<!-- trait RTSPSessionMediaExt::fn get_rtpinfo -->
<!-- trait RTSPSessionMediaExt::fn rtpinfo -->
Retrieve the RTP-Info header string for all streams in `self`
with configured transports.
@ -2111,7 +2126,7 @@ with configured transports.
The RTP-Info as a string or
`None` when no RTP-Info could be generated, `g_free` after usage.
<!-- trait RTSPSessionMediaExt::fn get_rtsp_state -->
<!-- trait RTSPSessionMediaExt::fn rtsp_state -->
Get the current RTSP state of `self`.
# Returns
@ -2126,7 +2141,7 @@ the stream index
a `RTSPStreamTransport` that is
valid until the session of `self` is unreffed.
<!-- trait RTSPSessionMediaExt::fn get_transports -->
<!-- trait RTSPSessionMediaExt::fn transports -->
Get a list of all available `RTSPStreamTransport` in this session.
Feature: `v1_14`
@ -2175,13 +2190,13 @@ attached to a `RTSPServer` object to manage the sessions in that server.
# Implements
[`RTSPSessionPoolExt`](trait.RTSPSessionPoolExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`RTSPSessionPoolExtManual`](prelude/trait.RTSPSessionPoolExtManual.html)
[`RTSPSessionPoolExt`](trait@crate::RTSPSessionPoolExt), [`trait@glib::object::ObjectExt`], [`RTSPSessionPoolExtManual`](trait@crate::RTSPSessionPoolExtManual)
<!-- trait RTSPSessionPoolExt -->
Trait containing all `RTSPSessionPool` methods.
# Implementors
[`RTSPSessionPool`](struct.RTSPSessionPool.html)
[`RTSPSessionPool`](struct@crate::RTSPSessionPool)
<!-- impl RTSPSessionPool::fn new -->
Create a new `RTSPSessionPool` instance.
@ -2244,14 +2259,14 @@ the session id
the `RTSPSession` with `sessionid`
or `None` when the session did not exist. `glib::object::ObjectExt::unref` after usage.
<!-- trait RTSPSessionPoolExt::fn get_max_sessions -->
<!-- trait RTSPSessionPoolExt::fn max_sessions -->
Get the maximum allowed number of sessions in `self`. 0 means an unlimited
amount of sessions.
# Returns
the maximum allowed number of sessions.
<!-- trait RTSPSessionPoolExt::fn get_n_sessions -->
<!-- trait RTSPSessionPoolExt::fn n_sessions -->
Get the amount of active sessions in `self`.
# Returns
@ -2275,13 +2290,13 @@ The definition of a media stream.
# Implements
[`RTSPStreamExt`](trait.RTSPStreamExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`RTSPStreamExtManual`](prelude/trait.RTSPStreamExtManual.html)
[`RTSPStreamExt`](trait@crate::RTSPStreamExt), [`trait@glib::object::ObjectExt`], [`RTSPStreamExtManual`](trait@crate::RTSPStreamExtManual)
<!-- trait RTSPStreamExt -->
Trait containing all `RTSPStream` methods.
# Implementors
[`RTSPStream`](struct.RTSPStream.html)
[`RTSPStream`](struct@crate::RTSPStream)
<!-- impl RTSPStream::fn new -->
Create a new media stream with index `idx` that handles RTP data on
`pad` and has a payloader element `payloader` if `pad` is a source pad
@ -2353,51 +2368,51 @@ a `gst_rtsp::RTSPTransport`
# Returns
`true` if the stream has been sucessfully updated.
<!-- trait RTSPStreamExt::fn get_address_pool -->
<!-- trait RTSPStreamExt::fn address_pool -->
Get the `RTSPAddressPool` used as the address pool of `self`.
# Returns
the `RTSPAddressPool` of `self`.
`glib::object::ObjectExt::unref` after usage.
<!-- trait RTSPStreamExt::fn get_buffer_size -->
<!-- trait RTSPStreamExt::fn buffer_size -->
Get the size of the UDP transmission buffer (in bytes)
# Returns
the size of the UDP TX buffer
<!-- trait RTSPStreamExt::fn get_caps -->
<!-- trait RTSPStreamExt::fn caps -->
Retrieve the current caps of `self`.
# Returns
the `gst::Caps` of `self`.
use `gst_caps_unref` after usage.
<!-- trait RTSPStreamExt::fn get_control -->
<!-- trait RTSPStreamExt::fn control -->
Get the control string to identify this stream.
# Returns
the control string. `g_free` after usage.
<!-- trait RTSPStreamExt::fn get_dscp_qos -->
<!-- trait RTSPStreamExt::fn dscp_qos -->
Get the configured DSCP QoS in of the outgoing sockets.
# Returns
the DSCP QoS value of the outgoing sockets, or -1 if disbled.
<!-- trait RTSPStreamExt::fn get_index -->
<!-- trait RTSPStreamExt::fn index -->
Get the stream index.
# Returns
the stream index.
<!-- trait RTSPStreamExt::fn get_joined_bin -->
<!-- trait RTSPStreamExt::fn joined_bin -->
Get the previous joined bin with `RTSPStreamExt::join_bin` or NULL.
# Returns
the joined bin or NULL.
<!-- trait RTSPStreamExt::fn get_max_mcast_ttl -->
<!-- trait RTSPStreamExt::fn max_mcast_ttl -->
Get the the maximum time-to-live value of outgoing multicast packets.
Feature: `v1_16`
@ -2406,7 +2421,7 @@ Feature: `v1_16`
# Returns
the maximum time-to-live value of outgoing multicast packets.
<!-- trait RTSPStreamExt::fn get_mtu -->
<!-- trait RTSPStreamExt::fn mtu -->
Get the configured MTU in the payloader of `self`.
# Returns
@ -2424,7 +2439,7 @@ the `gio::SocketFamily`
the `RTSPAddress` of `self`
or `None` when no address could be allocated. `RTSPAddress::free`
after usage.
<!-- trait RTSPStreamExt::fn get_multicast_client_addresses -->
<!-- trait RTSPStreamExt::fn multicast_client_addresses -->
Get all multicast client addresses that RTP data will be sent to
Feature: `v1_16`
@ -2433,38 +2448,38 @@ Feature: `v1_16`
# Returns
A comma separated list of host:port pairs with destinations
<!-- trait RTSPStreamExt::fn get_multicast_iface -->
<!-- trait RTSPStreamExt::fn multicast_iface -->
Get the multicast interface used for `self`.
# Returns
the multicast interface for `self`.
`g_free` after usage.
<!-- trait RTSPStreamExt::fn get_profiles -->
<!-- trait RTSPStreamExt::fn profiles -->
Get the allowed profiles of `self`.
# Returns
a `gst_rtsp::RTSPProfile`
<!-- trait RTSPStreamExt::fn get_protocols -->
<!-- trait RTSPStreamExt::fn protocols -->
Get the allowed protocols of `self`.
# Returns
a `gst_rtsp::RTSPLowerTrans`
<!-- trait RTSPStreamExt::fn get_pt -->
<!-- trait RTSPStreamExt::fn pt -->
Get the stream payload type.
# Returns
the stream payload type.
<!-- trait RTSPStreamExt::fn get_publish_clock_mode -->
<!-- trait RTSPStreamExt::fn publish_clock_mode -->
Gets if and how the stream clock should be published according to RFC7273.
# Returns
The GstRTSPPublishClockMode
<!-- trait RTSPStreamExt::fn get_rate_control -->
<!-- trait RTSPStreamExt::fn is_rate_control -->
Feature: `v1_18`
@ -2473,7 +2488,7 @@ Feature: `v1_18`
whether `self` will follow the Rate-Control=no behaviour as specified
in the ONVIF replay spec.
<!-- trait RTSPStreamExt::fn get_rates -->
<!-- trait RTSPStreamExt::fn rates -->
Retrieve the current rate and/or applied_rate.
Feature: `v1_18`
@ -2486,13 +2501,13 @@ the configured applied_rate
# Returns
`true` if rate and/or applied_rate could be determined.
<!-- trait RTSPStreamExt::fn get_retransmission_pt -->
<!-- trait RTSPStreamExt::fn retransmission_pt -->
Get the payload-type used for retransmission of this stream
# Returns
The retransmission PT.
<!-- trait RTSPStreamExt::fn get_retransmission_time -->
<!-- trait RTSPStreamExt::fn retransmission_time -->
Get the amount of time to store retransmission data.
# Returns
@ -2542,7 +2557,7 @@ the socket family
the RTP socket or `None` if no
socket could be allocated for `family`. Unref after usage
<!-- trait RTSPStreamExt::fn get_rtpinfo -->
<!-- trait RTSPStreamExt::fn rtpinfo -->
Retrieve the current rtptime, seq and running-time. This is used to
construct a RTPInfo reply header.
## `rtptime`
@ -2557,7 +2572,7 @@ result running-time
# Returns
`true` when rtptime, seq and running-time could be determined.
<!-- trait RTSPStreamExt::fn get_rtpsession -->
<!-- trait RTSPStreamExt::fn rtpsession -->
Get the RTP session of this stream.
# Returns
@ -2570,30 +2585,30 @@ only be called when `self` has been joined.
result server port
## `family`
the port family to get
<!-- trait RTSPStreamExt::fn get_sinkpad -->
<!-- trait RTSPStreamExt::fn sinkpad -->
Get the sinkpad associated with `self`.
# Returns
the sinkpad. Unref after usage.
<!-- trait RTSPStreamExt::fn get_srcpad -->
<!-- trait RTSPStreamExt::fn srcpad -->
Get the srcpad associated with `self`.
# Returns
the srcpad. Unref after usage.
<!-- trait RTSPStreamExt::fn get_srtp_encoder -->
<!-- trait RTSPStreamExt::fn srtp_encoder -->
Get the SRTP encoder for this stream.
# Returns
The SRTP encoder for this stream. Unref after usage.
<!-- trait RTSPStreamExt::fn get_ssrc -->
<!-- trait RTSPStreamExt::fn ssrc -->
Get the SSRC used by the RTP session of this stream. This function can only
be called when `self` has been joined.
## `ssrc`
result ssrc
<!-- trait RTSPStreamExt::fn get_ulpfec_percentage -->
<!-- trait RTSPStreamExt::fn ulpfec_percentage -->
Feature: `v1_16`
@ -2602,7 +2617,7 @@ Feature: `v1_16`
the amount of redundancy applied when creating ULPFEC
protection packets.
<!-- trait RTSPStreamExt::fn get_ulpfec_pt -->
<!-- trait RTSPStreamExt::fn ulpfec_pt -->
Feature: `v1_16`
@ -2983,13 +2998,13 @@ A Transport description for a stream
# Implements
[`RTSPStreamTransportExt`](trait.RTSPStreamTransportExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`RTSPStreamTransportExtManual`](prelude/trait.RTSPStreamTransportExtManual.html)
[`RTSPStreamTransportExt`](trait@crate::RTSPStreamTransportExt), [`trait@glib::object::ObjectExt`], [`RTSPStreamTransportExtManual`](trait@crate::RTSPStreamTransportExtManual)
<!-- trait RTSPStreamTransportExt -->
Trait containing all `RTSPStreamTransport` methods.
# Implementors
[`RTSPStreamTransport`](struct.RTSPStreamTransport.html)
[`RTSPStreamTransport`](struct@crate::RTSPStreamTransport)
<!-- impl RTSPStreamTransport::fn new -->
Create a new `RTSPStreamTransport` that can be used to manage
`stream` with transport `tr`.
@ -3011,20 +3026,20 @@ a star time
the RTPInfo string for `self`
and `start_time` or `None` when the RTP-Info could not be
determined. `g_free` after usage.
<!-- trait RTSPStreamTransportExt::fn get_stream -->
<!-- trait RTSPStreamTransportExt::fn stream -->
Get the `RTSPStream` used when constructing `self`.
# Returns
the stream used when constructing `self`.
<!-- trait RTSPStreamTransportExt::fn get_transport -->
<!-- trait RTSPStreamTransportExt::fn transport -->
Get the transport configured in `self`.
# Returns
the transport configured in `self`. It remains
valid for as long as `self` is valid.
<!-- trait RTSPStreamTransportExt::fn get_url -->
<!-- trait RTSPStreamTransportExt::fn url -->
Get the url configured in `self`.
# Returns
@ -3200,13 +3215,13 @@ The thread pool structure.
# Implements
[`RTSPThreadPoolExt`](trait.RTSPThreadPoolExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`RTSPThreadPoolExt`](trait@crate::RTSPThreadPoolExt), [`trait@glib::object::ObjectExt`]
<!-- trait RTSPThreadPoolExt -->
Trait containing all `RTSPThreadPool` methods.
# Implementors
[`RTSPThreadPool`](struct.RTSPThreadPool.html)
[`RTSPThreadPool`](struct@crate::RTSPThreadPool)
<!-- impl RTSPThreadPool::fn new -->
Create a new `RTSPThreadPool` instance.
@ -3217,7 +3232,7 @@ a new `RTSPThreadPool`
Wait for all tasks to be stopped and free all allocated resources. This is
mainly used in test suites to ensure proper cleanup of internal data
structures.
<!-- trait RTSPThreadPoolExt::fn get_max_threads -->
<!-- trait RTSPThreadPoolExt::fn max_threads -->
Get the maximum number of threads used for client connections.
See `RTSPThreadPoolExt::set_max_threads`.

223
docs/gstreamer-video/docs.md
View file

@ -158,7 +158,7 @@ Offset to define more flags
# Implements
[`gst::BufferPoolExt`](../gst/trait.BufferPoolExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst::BufferPoolExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- impl VideoBufferPool::fn new -->
Create a new bufferpool that can allocate video frames. This bufferpool
supports all the video bufferpool options.
@ -353,6 +353,42 @@ unknown range
<!-- enum VideoColorRange::variant 16235 -->
[16..235] for 8 bit components. Chroma has
[16..240] range.
<!-- struct VideoColorimetry -->
Structure describing the color info.
<!-- impl VideoColorimetry::fn from_string -->
Parse the colorimetry string and update `self` with the parsed
values.
## `color`
a colorimetry string
# Returns
`true` if `color` points to valid colorimetry info.
<!-- impl VideoColorimetry::fn is_equal -->
Compare the 2 colorimetry sets for equality
## `other`
another `VideoColorimetry`
# Returns
`true` if `self` and `other` are equal.
<!-- impl VideoColorimetry::fn matches -->
Check if the colorimetry information in `info` matches that of the
string `color`.
## `color`
a colorimetry string
# Returns
`true` if `color` conveys the same colorimetry info as the color
information in `info`.
<!-- impl VideoColorimetry::fn to_string -->
Make a string representation of `self`.
# Returns
a string representation of `self`
or `None` if all the entries of `self` are unknown values.
<!-- struct VideoDecoder -->
This base class is for video decoders turning encoded data into raw video
frames.
@ -462,13 +498,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`VideoDecoderExt`](trait.VideoDecoderExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`VideoDecoderExtManual`](prelude/trait.VideoDecoderExtManual.html)
[`VideoDecoderExt`](trait@crate::VideoDecoderExt), [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`VideoDecoderExtManual`](trait@crate::VideoDecoderExtManual)
<!-- trait VideoDecoderExt -->
Trait containing all `VideoDecoder` methods.
# Implementors
[`VideoDecoder`](struct.VideoDecoder.html)
[`VideoDecoder`](struct@crate::VideoDecoder)
<!-- trait VideoDecoderExt::fn add_to_frame -->
Removes next `n_bytes` of input data and adds it to currently parsed frame.
## `n_bytes`
@ -536,7 +572,7 @@ a decoded `VideoCodecFrame`
# Returns
a `gst::FlowReturn` resulting from sending data downstream
<!-- trait VideoDecoderExt::fn get_allocator -->
<!-- trait VideoDecoderExt::fn allocator -->
Lets `VideoDecoder` sub-classes to know the memory `allocator`
used by the base class and its `params`.
@ -547,13 +583,13 @@ used
## `params`
the
`gst::AllocationParams` of `allocator`
<!-- trait VideoDecoderExt::fn get_buffer_pool -->
<!-- trait VideoDecoderExt::fn buffer_pool -->
# Returns
the instance of the `gst::BufferPool` used
by the decoder; free it after use it
<!-- trait VideoDecoderExt::fn get_estimate_rate -->
<!-- trait VideoDecoderExt::fn estimate_rate -->
# Returns
@ -566,13 +602,13 @@ system_frame_number of a frame
# Returns
pending unfinished `VideoCodecFrame` identified by `frame_number`.
<!-- trait VideoDecoderExt::fn get_frames -->
<!-- trait VideoDecoderExt::fn frames -->
Get all pending unfinished `VideoCodecFrame`
# Returns
pending unfinished `VideoCodecFrame`.
<!-- trait VideoDecoderExt::fn get_latency -->
<!-- trait VideoDecoderExt::fn latency -->
Query the configured decoder latency. Results will be returned via
`min_latency` and `max_latency`.
## `min_latency`
@ -592,44 +628,44 @@ a `VideoCodecFrame`
# Returns
max decoding time.
<!-- trait VideoDecoderExt::fn get_max_errors -->
<!-- trait VideoDecoderExt::fn max_errors -->
# Returns
currently configured decoder tolerated error count.
<!-- trait VideoDecoderExt::fn get_needs_format -->
<!-- trait VideoDecoderExt::fn needs_format -->
Queries decoder required format handling.
# Returns
`true` if required format handling is enabled.
<!-- trait VideoDecoderExt::fn get_oldest_frame -->
<!-- trait VideoDecoderExt::fn oldest_frame -->
Get the oldest pending unfinished `VideoCodecFrame`
# Returns
oldest pending unfinished `VideoCodecFrame`.
<!-- trait VideoDecoderExt::fn get_output_state -->
<!-- trait VideoDecoderExt::fn output_state -->
Get the `VideoCodecState` currently describing the output stream.
# Returns
`VideoCodecState` describing format of video data.
<!-- trait VideoDecoderExt::fn get_packetized -->
<!-- trait VideoDecoderExt::fn is_packetized -->
Queries whether input data is considered packetized or not by the
base class.
# Returns
TRUE if input data is considered packetized.
<!-- trait VideoDecoderExt::fn get_pending_frame_size -->
<!-- trait VideoDecoderExt::fn pending_frame_size -->
Returns the number of bytes previously added to the current frame
by calling `VideoDecoderExt::add_to_frame`.
# Returns
The number of bytes pending for the current frame
<!-- trait VideoDecoderExt::fn get_qos_proportion -->
<!-- trait VideoDecoderExt::fn qos_proportion -->
# Returns
@ -876,13 +912,13 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`VideoEncoderExt`](trait.VideoEncoderExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`VideoEncoderExtManual`](prelude/trait.VideoEncoderExtManual.html)
[`VideoEncoderExt`](trait@crate::VideoEncoderExt), [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`], [`VideoEncoderExtManual`](trait@crate::VideoEncoderExtManual)
<!-- trait VideoEncoderExt -->
Trait containing all `VideoEncoder` methods.
# Implementors
[`VideoEncoder`](struct.VideoEncoder.html)
[`VideoEncoder`](struct@crate::VideoEncoder)
<!-- trait VideoEncoderExt::fn allocate_output_buffer -->
Helper function that allocates a buffer to hold an encoded video frame
for `self`'s current `VideoCodecState`.
@ -942,7 +978,7 @@ a `VideoCodecFrame` being encoded
# Returns
a `gst::FlowReturn` resulting from pushing the buffer downstream.
<!-- trait VideoEncoderExt::fn get_allocator -->
<!-- trait VideoEncoderExt::fn allocator -->
Lets `VideoEncoder` sub-classes to know the memory `allocator`
used by the base class and its `params`.
@ -961,13 +997,13 @@ system_frame_number of a frame
# Returns
pending unfinished `VideoCodecFrame` identified by `frame_number`.
<!-- trait VideoEncoderExt::fn get_frames -->
<!-- trait VideoEncoderExt::fn frames -->
Get all pending unfinished `VideoCodecFrame`
# Returns
pending unfinished `VideoCodecFrame`.
<!-- trait VideoEncoderExt::fn get_latency -->
<!-- trait VideoEncoderExt::fn latency -->
Query the configured encoding latency. Results will be returned via
`min_latency` and `max_latency`.
## `min_latency`
@ -993,7 +1029,7 @@ a `VideoCodecFrame`
# Returns
max decoding time.
<!-- trait VideoEncoderExt::fn get_min_force_key_unit_interval -->
<!-- trait VideoEncoderExt::fn min_force_key_unit_interval -->
Returns the minimum force-keyunit interval, see `VideoEncoderExt::set_min_force_key_unit_interval`
for more details.
@ -1003,13 +1039,13 @@ Feature: `v1_18`
# Returns
the minimum force-keyunit interval
<!-- trait VideoEncoderExt::fn get_oldest_frame -->
<!-- trait VideoEncoderExt::fn oldest_frame -->
Get the oldest unfinished pending `VideoCodecFrame`
# Returns
oldest unfinished pending `VideoCodecFrame`
<!-- trait VideoEncoderExt::fn get_output_state -->
<!-- trait VideoEncoderExt::fn output_state -->
Get the current `VideoCodecState`
# Returns
@ -1156,7 +1192,7 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`gst_base::BaseTransformExt`](../gst_base/trait.BaseTransformExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@gst_base::BaseTransformExt`], [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- struct VideoFlags -->
Extra video flags
<!-- struct VideoFlags::const NONE -->
@ -1402,6 +1438,125 @@ This format can be used in a
<!-- struct VideoFormatFlags::const TILED -->
The format is tiled, there is tiling information
in the last plane.
<!-- struct VideoFormatInfo -->
Information for a video format.
Feature: `v1_18`
<!-- impl VideoFormatInfo::fn component -->
Fill `components` with the number of all the components packed in plane `p`
for the format `self`. A value of -1 in `components` indicates that no more
components are packed in the plane.
Feature: `v1_18`
## `plane`
a plane number
## `components`
array used to store component numbers
<!-- struct VideoFrame -->
A video frame obtained from `VideoFrame::map`
<!-- impl VideoFrame::fn copy -->
Copy the contents from `src` to `self`.
Note: Since: 1.18, `self` dimensions are allowed to be
smaller than `src` dimensions.
## `src`
a `VideoFrame`
# Returns
TRUE if the contents could be copied.
<!-- impl VideoFrame::fn copy_plane -->
Copy the plane with index `plane` from `src` to `self`.
Note: Since: 1.18, `self` dimensions are allowed to be
smaller than `src` dimensions.
## `src`
a `VideoFrame`
## `plane`
a plane
# Returns
TRUE if the contents could be copied.
<!-- impl VideoFrame::fn map -->
Use `info` and `buffer` to fill in the values of `self`. `self` is usually
allocated on the stack, and you will pass the address to the `VideoFrame`
structure allocated on the stack; `VideoFrame::map` will then fill in
the structures with the various video-specific information you need to access
the pixels of the video buffer. You can then use accessor macros such as
GST_VIDEO_FRAME_COMP_DATA(), GST_VIDEO_FRAME_PLANE_DATA(),
GST_VIDEO_FRAME_COMP_STRIDE(), GST_VIDEO_FRAME_PLANE_STRIDE() etc.
to get to the pixels.
```C
GstVideoFrame vframe;
...
// set RGB pixels to black one at a time
if (gst_video_frame_map (&amp;vframe, video_info, video_buffer, GST_MAP_WRITE)) {
guint8 *pixels = GST_VIDEO_FRAME_PLANE_DATA (vframe, 0);
guint stride = GST_VIDEO_FRAME_PLANE_STRIDE (vframe, 0);
guint pixel_stride = GST_VIDEO_FRAME_COMP_PSTRIDE (vframe, 0);
for (h = 0; h < height; ++h) {
for (w = 0; w < width; ++w) {
guint8 *pixel = pixels + h * stride + w * pixel_stride;
memset (pixel, 0, pixel_stride);
}
}
gst_video_frame_unmap (&amp;vframe);
}
...
```
All video planes of `buffer` will be mapped and the pointers will be set in
`self`->data.
The purpose of this function is to make it easy for you to get to the video
pixels in a generic way, without you having to worry too much about details
such as whether the video data is allocated in one contiguous memory chunk
or multiple memory chunks (e.g. one for each plane); or if custom strides
and custom plane offsets are used or not (as signalled by GstVideoMeta on
each buffer). This function will just fill the `VideoFrame` structure
with the right values and if you use the accessor macros everything will
just work and you can access the data easily. It also maps the underlying
memory chunks for you.
## `info`
a `VideoInfo`
## `buffer`
the buffer to map
## `flags`
`gst::MapFlags`
# Returns
`true` on success.
<!-- impl VideoFrame::fn map_id -->
Use `info` and `buffer` to fill in the values of `self` with the video frame
information of frame `id`.
When `id` is -1, the default frame is mapped. When `id` != -1, this function
will return `false` when there is no GstVideoMeta with that id.
All video planes of `buffer` will be mapped and the pointers will be set in
`self`->data.
## `info`
a `VideoInfo`
## `buffer`
the buffer to map
## `id`
the frame id to map
## `flags`
`gst::MapFlags`
# Returns
`true` on success.
<!-- impl VideoFrame::fn unmap -->
Unmap the memory previously mapped with gst_video_frame_map.
<!-- struct VideoFrameFlags -->
Extra video frame flags
<!-- struct VideoFrameFlags::const NONE -->
@ -1737,14 +1892,14 @@ operation of video-sources or operators.
# Implements
[`VideoOrientationExt`](trait.VideoOrientationExt.html)
[`VideoOrientationExt`](trait@crate::VideoOrientationExt)
<!-- trait VideoOrientationExt -->
Trait containing all `VideoOrientation` methods.
# Implementors
[`VideoOrientation`](struct.VideoOrientation.html)
<!-- trait VideoOrientationExt::fn get_hcenter -->
[`VideoOrientation`](struct@crate::VideoOrientation)
<!-- trait VideoOrientationExt::fn hcenter -->
Get the horizontal centering offset from the given object.
## `center`
return location for the result
@ -1752,7 +1907,7 @@ return location for the result
# Returns
`true` in case the element supports centering
<!-- trait VideoOrientationExt::fn get_hflip -->
<!-- trait VideoOrientationExt::fn hflip -->
Get the horizontal flipping state (`true` for flipped) from the given object.
## `flip`
return location for the result
@ -1760,7 +1915,7 @@ return location for the result
# Returns
`true` in case the element supports flipping
<!-- trait VideoOrientationExt::fn get_vcenter -->
<!-- trait VideoOrientationExt::fn vcenter -->
Get the vertical centering offset from the given object.
## `center`
return location for the result
@ -1768,7 +1923,7 @@ return location for the result
# Returns
`true` in case the element supports centering
<!-- trait VideoOrientationExt::fn get_vflip -->
<!-- trait VideoOrientationExt::fn vflip -->
Get the vertical flipping state (`true` for flipped) from the given object.
## `flip`
return location for the result
@ -2098,13 +2253,13 @@ int main(int argc, char *argv[])
# Implements
[`VideoOverlayExt`](trait.VideoOverlayExt.html), [`VideoOverlayExtManual`](prelude/trait.VideoOverlayExtManual.html)
[`VideoOverlayExt`](trait@crate::VideoOverlayExt), [`VideoOverlayExtManual`](trait@crate::VideoOverlayExtManual)
<!-- trait VideoOverlayExt -->
Trait containing all `VideoOverlay` methods.
# Implementors
[`VideoOverlay`](struct.VideoOverlay.html)
[`VideoOverlay`](struct@crate::VideoOverlay)
<!-- impl VideoOverlay::fn install_properties -->
This helper shall be used by classes implementing the `VideoOverlay`
interface that want the render rectangle to be controllable using
@ -2245,13 +2400,13 @@ observing out-of-sync frames.
# Implements
[`VideoSinkExt`](trait.VideoSinkExt.html), [`gst_base::BaseSinkExt`](../gst_base/trait.BaseSinkExt.html), [`gst::ElementExt`](../gst/trait.ElementExt.html), [`gst::ObjectExt`](../gst/trait.ObjectExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`VideoSinkExt`](trait@crate::VideoSinkExt), [`trait@gst_base::BaseSinkExt`], [`trait@gst::ElementExt`], [`trait@gst::ObjectExt`], [`trait@glib::object::ObjectExt`]
<!-- trait VideoSinkExt -->
Trait containing all `VideoSink` methods.
# Implementors
[`VideoSink`](struct.VideoSink.html)
[`VideoSink`](struct@crate::VideoSink)
<!-- impl VideoSink::fn center_rect -->
Takes `src` rectangle and position it at the center of `dst` rectangle with or
without `scaling`. It handles clipping if the `src` rectangle is bigger than

12
docs/gstreamer-webrtc/docs.md
View file

@ -23,7 +23,7 @@ recvonly
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@glib::object::ObjectExt`]
<!-- enum WebRTCDTLSTransportState -->
<!-- enum WebRTCDTLSTransportState::variant New -->
new
@ -44,7 +44,7 @@ Feature: `v1_18`
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@glib::object::ObjectExt`]
<!-- impl WebRTCDataChannel::fn close -->
Close the `self`.
@ -176,7 +176,7 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@glib::object::ObjectExt`]
<!-- enum WebRTCICETransportPolicy -->
GST_WEBRTC_ICE_TRANSPORT_POLICY_ALL: all
GST_WEBRTC_ICE_TRANSPORT_POLICY_RELAY: relay
@ -213,13 +213,13 @@ Feature: `v1_16`
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@glib::object::ObjectExt`]
<!-- struct WebRTCRTPSender -->
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@glib::object::ObjectExt`]
<!-- struct WebRTCRTPTransceiver -->
@ -227,7 +227,7 @@ This is an Abstract Base Class, you cannot instantiate it.
# Implements
[`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html)
[`trait@glib::object::ObjectExt`]
<!-- impl WebRTCRTPTransceiver::fn get_property_direction -->
Direction of the transceiver.

342
docs/gstreamer/docs.md
View file

File diff suppressed because it is too large Load diff

2
gstreamer-app/src/auto/app_sink.rs
View file

@ -15,7 +15,7 @@ glib::wrapper! {
pub struct AppSink(Object<ffi::GstAppSink, ffi::GstAppSinkClass>) @extends gst::Element, gst::Object, @implements gst::URIHandler;
match fn {
get_type => || ffi::gst_app_sink_get_type(),
type_ => || ffi::gst_app_sink_get_type(),
}
}

2
gstreamer-app/src/auto/app_src.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct AppSrc(Object<ffi::GstAppSrc, ffi::GstAppSrcClass>) @extends gst::Element, gst::Object, @implements gst::URIHandler;
match fn {
get_type => || ffi::gst_app_src_get_type(),
type_ => || ffi::gst_app_src_get_type(),
}
}

2
gstreamer-app/src/auto/versions.txt
View file

@ -1,3 +1,3 @@
Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)

2
gstreamer-app/sys/build.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-app/sys/src/lib.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-app/sys/tests/abi.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-app/sys/tests/constant.c
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-app/sys/tests/layout.c
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-audio/src/auto/audio_base_sink.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct AudioBaseSink(Object<ffi::GstAudioBaseSink, ffi::GstAudioBaseSinkClass>) @extends gst_base::BaseSink, gst::Element, gst::Object;
match fn {
get_type => || ffi::gst_audio_base_sink_get_type(),
type_ => || ffi::gst_audio_base_sink_get_type(),
}
}

2
gstreamer-audio/src/auto/audio_base_src.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct AudioBaseSrc(Object<ffi::GstAudioBaseSrc, ffi::GstAudioBaseSrcClass>) @extends gst_base::BaseSrc, gst::Element, gst::Object;
match fn {
get_type => || ffi::gst_audio_base_src_get_type(),
type_ => || ffi::gst_audio_base_src_get_type(),
}
}

6
gstreamer-audio/src/auto/audio_decoder.rs
View file

@ -17,7 +17,7 @@ glib::wrapper! {
pub struct AudioDecoder(Object<ffi::GstAudioDecoder, ffi::GstAudioDecoderClass>) @extends gst::Element, gst::Object;
match fn {
get_type => || ffi::gst_audio_decoder_get_type(),
type_ => || ffi::gst_audio_decoder_get_type(),
}
}
@ -52,7 +52,7 @@ pub trait AudioDecoderExt: 'static {
fn min_latency(&self) -> gst::ClockTime;
#[doc(alias = "gst_audio_decoder_get_needs_format")]
fn is_needs_format(&self) -> bool;
fn needs_format(&self) -> bool;
#[doc(alias = "gst_audio_decoder_get_parse_state")]
fn parse_state(&self) -> (bool, bool);
@ -192,7 +192,7 @@ impl<O: IsA<AudioDecoder>> AudioDecoderExt for O {
}
}
fn is_needs_format(&self) -> bool {
fn needs_format(&self) -> bool {
unsafe {
from_glib(ffi::gst_audio_decoder_get_needs_format(
self.as_ref().to_glib_none().0,

2
gstreamer-audio/src/auto/audio_encoder.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct AudioEncoder(Object<ffi::GstAudioEncoder, ffi::GstAudioEncoderClass>) @extends gst::Element, gst::Object;
match fn {
get_type => || ffi::gst_audio_encoder_get_type(),
type_ => || ffi::gst_audio_encoder_get_type(),
}
}

2
gstreamer-audio/src/auto/audio_sink.rs
View file

@ -9,7 +9,7 @@ glib::wrapper! {
pub struct AudioSink(Object<ffi::GstAudioSink, ffi::GstAudioSinkClass>) @extends AudioBaseSink, gst_base::BaseSink, gst::Element, gst::Object;
match fn {
get_type => || ffi::gst_audio_sink_get_type(),
type_ => || ffi::gst_audio_sink_get_type(),
}
}

2
gstreamer-audio/src/auto/audio_src.rs
View file

@ -9,7 +9,7 @@ glib::wrapper! {
pub struct AudioSrc(Object<ffi::GstAudioSrc, ffi::GstAudioSrcClass>) @extends AudioBaseSrc, gst_base::BaseSrc, gst::Element, gst::Object;
match fn {
get_type => || ffi::gst_audio_src_get_type(),
type_ => || ffi::gst_audio_src_get_type(),
}
}

2
gstreamer-audio/src/auto/audio_stream_align.rs
View file

@ -12,7 +12,7 @@ glib::wrapper! {
match fn {
copy => |ptr| ffi::gst_audio_stream_align_copy(ptr),
free => |ptr| ffi::gst_audio_stream_align_free(ptr),
get_type => || ffi::gst_audio_stream_align_get_type(),
type_ => || ffi::gst_audio_stream_align_get_type(),
}
}

2
gstreamer-audio/src/auto/stream_volume.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct StreamVolume(Interface<ffi::GstStreamVolume, ffi::GstStreamVolumeInterface>);
match fn {
get_type => || ffi::gst_stream_volume_get_type(),
type_ => || ffi::gst_stream_volume_get_type(),
}
}

2
gstreamer-audio/src/auto/versions.txt
View file

@ -1,3 +1,3 @@
Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)

2
gstreamer-audio/sys/build.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-audio/sys/src/lib.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-audio/sys/tests/abi.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-audio/sys/tests/constant.c
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-audio/sys/tests/layout.c
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-base/src/auto/adapter.rs
View file

@ -11,7 +11,7 @@ glib::wrapper! {
pub struct Adapter(Object<ffi::GstAdapter, ffi::GstAdapterClass>);
match fn {
get_type => || ffi::gst_adapter_get_type(),
type_ => || ffi::gst_adapter_get_type(),
}
}

2
gstreamer-base/src/auto/aggregator.rs
View file

@ -22,7 +22,7 @@ glib::wrapper! {
pub struct Aggregator(Object<ffi::GstAggregator, ffi::GstAggregatorClass>) @extends gst::Element, gst::Object;
match fn {
get_type => || ffi::gst_aggregator_get_type(),
type_ => || ffi::gst_aggregator_get_type(),
}
}

2
gstreamer-base/src/auto/aggregator_pad.rs
View file

@ -18,7 +18,7 @@ glib::wrapper! {
pub struct AggregatorPad(Object<ffi::GstAggregatorPad, ffi::GstAggregatorPadClass>) @extends gst::Pad, gst::Object;
match fn {
get_type => || ffi::gst_aggregator_pad_get_type(),
type_ => || ffi::gst_aggregator_pad_get_type(),
}
}

2
gstreamer-base/src/auto/base_parse.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct BaseParse(Object<ffi::GstBaseParse, ffi::GstBaseParseClass>) @extends gst::Element, gst::Object;
match fn {
get_type => || ffi::gst_base_parse_get_type(),
type_ => || ffi::gst_base_parse_get_type(),
}
}

2
gstreamer-base/src/auto/base_sink.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct BaseSink(Object<ffi::GstBaseSink, ffi::GstBaseSinkClass>) @extends gst::Element, gst::Object;
match fn {
get_type => || ffi::gst_base_sink_get_type(),
type_ => || ffi::gst_base_sink_get_type(),
}
}

2
gstreamer-base/src/auto/base_src.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct BaseSrc(Object<ffi::GstBaseSrc, ffi::GstBaseSrcClass>) @extends gst::Element, gst::Object;
match fn {
get_type => || ffi::gst_base_src_get_type(),
type_ => || ffi::gst_base_src_get_type(),
}
}

2
gstreamer-base/src/auto/base_transform.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct BaseTransform(Object<ffi::GstBaseTransform, ffi::GstBaseTransformClass>) @extends gst::Element, gst::Object;
match fn {
get_type => || ffi::gst_base_transform_get_type(),
type_ => || ffi::gst_base_transform_get_type(),
}
}

2
gstreamer-base/src/auto/push_src.rs
View file

@ -9,7 +9,7 @@ glib::wrapper! {
pub struct PushSrc(Object<ffi::GstPushSrc, ffi::GstPushSrcClass>) @extends BaseSrc, gst::Element, gst::Object;
match fn {
get_type => || ffi::gst_push_src_get_type(),
type_ => || ffi::gst_push_src_get_type(),
}
}

2
gstreamer-base/src/auto/versions.txt
View file

@ -1,3 +1,3 @@
Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)

2
gstreamer-base/sys/build.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-base/sys/src/lib.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-base/sys/tests/abi.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-base/sys/tests/constant.c
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-base/sys/tests/layout.c
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-check/src/auto/test_clock.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct TestClock(Object<ffi::GstTestClock, ffi::GstTestClockClass>) @extends gst::Clock, gst::Object;
match fn {
get_type => || ffi::gst_test_clock_get_type(),
type_ => || ffi::gst_test_clock_get_type(),
}
}

2
gstreamer-check/src/auto/versions.txt
View file

@ -1,3 +1,3 @@
Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)

2
gstreamer-check/sys/build.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-check/sys/src/lib.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-check/sys/tests/abi.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-check/sys/tests/constant.c
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-check/sys/tests/layout.c
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-controller/src/auto/argb_control_binding.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct ARGBControlBinding(Object<ffi::GstARGBControlBinding, ffi::GstARGBControlBindingClass>) @extends gst::ControlBinding, gst::Object;
match fn {
get_type => || ffi::gst_argb_control_binding_get_type(),
type_ => || ffi::gst_argb_control_binding_get_type(),
}
}

2
gstreamer-controller/src/auto/direct_control_binding.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct DirectControlBinding(Object<ffi::GstDirectControlBinding, ffi::GstDirectControlBindingClass>) @extends gst::ControlBinding, gst::Object;
match fn {
get_type => || ffi::gst_direct_control_binding_get_type(),
type_ => || ffi::gst_direct_control_binding_get_type(),
}
}

2
gstreamer-controller/src/auto/interpolation_control_source.rs
View file

@ -18,7 +18,7 @@ glib::wrapper! {
pub struct InterpolationControlSource(Object<ffi::GstInterpolationControlSource, ffi::GstInterpolationControlSourceClass>) @extends TimedValueControlSource, gst::ControlSource, gst::Object;
match fn {
get_type => || ffi::gst_interpolation_control_source_get_type(),
type_ => || ffi::gst_interpolation_control_source_get_type(),
}
}

2
gstreamer-controller/src/auto/lfo_control_source.rs
View file

@ -17,7 +17,7 @@ glib::wrapper! {
pub struct LFOControlSource(Object<ffi::GstLFOControlSource, ffi::GstLFOControlSourceClass>) @extends gst::ControlSource, gst::Object;
match fn {
get_type => || ffi::gst_lfo_control_source_get_type(),
type_ => || ffi::gst_lfo_control_source_get_type(),
}
}

2
gstreamer-controller/src/auto/proxy_control_binding.rs
View file

@ -11,7 +11,7 @@ glib::wrapper! {
pub struct ProxyControlBinding(Object<ffi::GstProxyControlBinding, ffi::GstProxyControlBindingClass>) @extends gst::ControlBinding, gst::Object;
match fn {
get_type => || ffi::gst_proxy_control_binding_get_type(),
type_ => || ffi::gst_proxy_control_binding_get_type(),
}
}

2
gstreamer-controller/src/auto/timed_value_control_source.rs
View file

@ -16,7 +16,7 @@ glib::wrapper! {
pub struct TimedValueControlSource(Object<ffi::GstTimedValueControlSource, ffi::GstTimedValueControlSourceClass>) @extends gst::ControlSource, gst::Object;
match fn {
get_type => || ffi::gst_timed_value_control_source_get_type(),
type_ => || ffi::gst_timed_value_control_source_get_type(),
}
}

2
gstreamer-controller/src/auto/trigger_control_source.rs
View file

@ -17,7 +17,7 @@ glib::wrapper! {
pub struct TriggerControlSource(Object<ffi::GstTriggerControlSource, ffi::GstTriggerControlSourceClass>) @extends TimedValueControlSource, gst::ControlSource, gst::Object;
match fn {
get_type => || ffi::gst_trigger_control_source_get_type(),
type_ => || ffi::gst_trigger_control_source_get_type(),
}
}

2
gstreamer-controller/src/auto/versions.txt
View file

@ -1,3 +1,3 @@
Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)

2
gstreamer-controller/sys/build.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-controller/sys/src/lib.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-controller/sys/tests/abi.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-controller/sys/tests/constant.c
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-controller/sys/tests/layout.c
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-editing-services/src/auto/asset.rs
View file

@ -18,7 +18,7 @@ glib::wrapper! {
pub struct Asset(Object<ffi::GESAsset, ffi::GESAssetClass>);
match fn {
get_type => || ffi::ges_asset_get_type(),
type_ => || ffi::ges_asset_get_type(),
}
}

2
gstreamer-editing-services/src/auto/base_effect.rs
View file

@ -15,7 +15,7 @@ glib::wrapper! {
pub struct BaseEffect(Object<ffi::GESBaseEffect, ffi::GESBaseEffectClass>) @extends TrackElement, TimelineElement, @implements Extractable;
match fn {
get_type => || ffi::ges_base_effect_get_type(),
type_ => || ffi::ges_base_effect_get_type(),
}
}

2
gstreamer-editing-services/src/auto/base_transition_clip.rs
View file

@ -13,7 +13,7 @@ glib::wrapper! {
pub struct BaseTransitionClip(Object<ffi::GESBaseTransitionClip, ffi::GESBaseTransitionClipClass>) @extends OperationClip, Clip, Container, TimelineElement, @implements Extractable;
match fn {
get_type => || ffi::ges_base_transition_clip_get_type(),
type_ => || ffi::ges_base_transition_clip_get_type(),
}
}

2
gstreamer-editing-services/src/auto/clip.rs
View file

@ -30,7 +30,7 @@ glib::wrapper! {
pub struct Clip(Object<ffi::GESClip, ffi::GESClipClass>) @extends Container, TimelineElement, @implements Extractable;
match fn {
get_type => || ffi::ges_clip_get_type(),
type_ => || ffi::ges_clip_get_type(),
}
}

2
gstreamer-editing-services/src/auto/container.rs
View file

@ -21,7 +21,7 @@ glib::wrapper! {
pub struct Container(Object<ffi::GESContainer, ffi::GESContainerClass>) @extends TimelineElement, @implements Extractable;
match fn {
get_type => || ffi::ges_container_get_type(),
type_ => || ffi::ges_container_get_type(),
}
}

2
gstreamer-editing-services/src/auto/effect.rs
View file

@ -15,7 +15,7 @@ glib::wrapper! {
pub struct Effect(Object<ffi::GESEffect, ffi::GESEffectClass>) @extends BaseEffect, TrackElement, TimelineElement, @implements Extractable;
match fn {
get_type => || ffi::ges_effect_get_type(),
type_ => || ffi::ges_effect_get_type(),
}
}

2
gstreamer-editing-services/src/auto/extractable.rs
View file

@ -11,7 +11,7 @@ glib::wrapper! {
pub struct Extractable(Interface<ffi::GESExtractable, ffi::GESExtractableInterface>);
match fn {
get_type => || ffi::ges_extractable_get_type(),
type_ => || ffi::ges_extractable_get_type(),
}
}

2
gstreamer-editing-services/src/auto/group.rs
View file

@ -19,7 +19,7 @@ glib::wrapper! {
pub struct Group(Object<ffi::GESGroup, ffi::GESGroupClass>) @extends Container, TimelineElement, @implements Extractable;
match fn {
get_type => || ffi::ges_group_get_type(),
type_ => || ffi::ges_group_get_type(),
}
}

2
gstreamer-editing-services/src/auto/layer.rs
View file

@ -26,7 +26,7 @@ glib::wrapper! {
pub struct Layer(Object<ffi::GESLayer, ffi::GESLayerClass>) @implements Extractable;
match fn {
get_type => || ffi::ges_layer_get_type(),
type_ => || ffi::ges_layer_get_type(),
}
}

2
gstreamer-editing-services/src/auto/operation_clip.rs
View file

@ -12,7 +12,7 @@ glib::wrapper! {
pub struct OperationClip(Object<ffi::GESOperationClip, ffi::GESOperationClipClass>) @extends Clip, Container, TimelineElement, @implements Extractable;
match fn {
get_type => || ffi::ges_operation_clip_get_type(),
type_ => || ffi::ges_operation_clip_get_type(),
}
}

2
gstreamer-editing-services/src/auto/pipeline.rs
View file

@ -19,7 +19,7 @@ glib::wrapper! {
pub struct Pipeline(Object<ffi::GESPipeline, ffi::GESPipelineClass>) @extends gst::Pipeline, gst::Element, gst::Object;
match fn {
get_type => || ffi::ges_pipeline_get_type(),
type_ => || ffi::ges_pipeline_get_type(),
}
}

2
gstreamer-editing-services/src/auto/project.rs
View file

@ -18,7 +18,7 @@ glib::wrapper! {
pub struct Project(Object<ffi::GESProject, ffi::GESProjectClass>) @extends Asset;
match fn {
get_type => || ffi::ges_project_get_type(),
type_ => || ffi::ges_project_get_type(),
}
}

2
gstreamer-editing-services/src/auto/timeline.rs
View file

@ -29,7 +29,7 @@ glib::wrapper! {
pub struct Timeline(Object<ffi::GESTimeline, ffi::GESTimelineClass>) @extends gst::Element, gst::Object, @implements Extractable;
match fn {
get_type => || ffi::ges_timeline_get_type(),
type_ => || ffi::ges_timeline_get_type(),
}
}

2
gstreamer-editing-services/src/auto/timeline_element.rs
View file

@ -34,7 +34,7 @@ glib::wrapper! {
pub struct TimelineElement(Object<ffi::GESTimelineElement, ffi::GESTimelineElementClass>) @implements Extractable;
match fn {
get_type => || ffi::ges_timeline_element_get_type(),
type_ => || ffi::ges_timeline_element_get_type(),
}
}

2
gstreamer-editing-services/src/auto/track.rs
View file

@ -22,7 +22,7 @@ glib::wrapper! {
pub struct Track(Object<ffi::GESTrack, ffi::GESTrackClass>) @extends gst::Element, gst::Object;
match fn {
get_type => || ffi::ges_track_get_type(),
type_ => || ffi::ges_track_get_type(),
}
}

2
gstreamer-editing-services/src/auto/track_element.rs
View file

@ -22,7 +22,7 @@ glib::wrapper! {
pub struct TrackElement(Object<ffi::GESTrackElement, ffi::GESTrackElementClass>) @extends TimelineElement, @implements Extractable;
match fn {
get_type => || ffi::ges_track_element_get_type(),
type_ => || ffi::ges_track_element_get_type(),
}
}

2
gstreamer-editing-services/src/auto/transition_clip.rs
View file

@ -23,7 +23,7 @@ glib::wrapper! {
pub struct TransitionClip(Object<ffi::GESTransitionClip, ffi::GESTransitionClipClass>) @extends BaseTransitionClip, OperationClip, Clip, Container, TimelineElement, @implements Extractable;
match fn {
get_type => || ffi::ges_transition_clip_get_type(),
type_ => || ffi::ges_transition_clip_get_type(),
}
}

2
gstreamer-editing-services/src/auto/uri_clip.rs
View file

@ -19,7 +19,7 @@ glib::wrapper! {
pub struct UriClip(Object<ffi::GESUriClip, ffi::GESUriClipClass>) @extends Clip, Container, TimelineElement, @implements Extractable;
match fn {
get_type => || ffi::ges_uri_clip_get_type(),
type_ => || ffi::ges_uri_clip_get_type(),
}
}

2
gstreamer-editing-services/src/auto/uri_clip_asset.rs
View file

@ -21,7 +21,7 @@ glib::wrapper! {
pub struct UriClipAsset(Object<ffi::GESUriClipAsset, ffi::GESUriClipAssetClass>) @extends Asset;
match fn {
get_type => || ffi::ges_uri_clip_asset_get_type(),
type_ => || ffi::ges_uri_clip_asset_get_type(),
}
}

2
gstreamer-editing-services/src/auto/uri_source_asset.rs
View file

@ -12,7 +12,7 @@ glib::wrapper! {
pub struct UriSourceAsset(Object<ffi::GESUriSourceAsset, ffi::GESUriSourceAssetClass>) @extends Asset;
match fn {
get_type => || ffi::ges_uri_source_asset_get_type(),
type_ => || ffi::ges_uri_source_asset_get_type(),
}
}

2
gstreamer-editing-services/src/auto/versions.txt
View file

@ -1,3 +1,3 @@
Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)

2
gstreamer-editing-services/sys/build.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-editing-services/sys/src/lib.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-editing-services/sys/tests/abi.rs
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-editing-services/sys/tests/constant.c
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-editing-services/sys/tests/layout.c
View file

@ -1,4 +1,4 @@
// Generated by gir (https://github.com/gtk-rs/gir @ 3c6ebf4)
// Generated by gir (https://github.com/gtk-rs/gir @ 3d17b67)
// from gir-files (https://github.com/gtk-rs/gir-files @ 6088bb6)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git @ 208138a)
// DO NOT EDIT

2
gstreamer-gl/egl/src/auto/gl_display_egl.rs
View file

@ -10,7 +10,7 @@ glib::wrapper! {
pub struct GLDisplayEGL(Object<ffi::GstGLDisplayEGL, ffi::GstGLDisplayEGLClass>) @extends gst_gl::GLDisplay, gst::Object;
match fn {
get_type => || ffi::gst_gl_display_egl_get_type(),
type_ => || ffi::gst_gl_display_egl_get_type(),
}
}

Some files were not shown because too many files have changed in this diff Show more