mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2025-02-17 03:35:21 +00:00
gst-plugins-base: Fix several annotations
Add annotations for virtual methods when possible. Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/1965>
This commit is contained in:
parent
15a75b99df
commit
a5249f7c5f
7 changed files with 27 additions and 7 deletions
|
@ -272,6 +272,11 @@ struct _GstAudioDecoderClass
|
||||||
gboolean (*set_format) (GstAudioDecoder *dec,
|
gboolean (*set_format) (GstAudioDecoder *dec,
|
||||||
GstCaps *caps);
|
GstCaps *caps);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GstAudioDecoderClass::parse:
|
||||||
|
* @offset: (out):
|
||||||
|
* @length: (out):
|
||||||
|
*/
|
||||||
GstFlowReturn (*parse) (GstAudioDecoder *dec,
|
GstFlowReturn (*parse) (GstAudioDecoder *dec,
|
||||||
GstAdapter *adapter,
|
GstAdapter *adapter,
|
||||||
gint *offset, gint *length);
|
gint *offset, gint *length);
|
||||||
|
|
|
@ -1675,7 +1675,7 @@ not_started:
|
||||||
/**
|
/**
|
||||||
* gst_audio_ring_buffer_commit:
|
* gst_audio_ring_buffer_commit:
|
||||||
* @buf: the #GstAudioRingBuffer to commit
|
* @buf: the #GstAudioRingBuffer to commit
|
||||||
* @sample: the sample position of the data
|
* @sample: (inout): the sample position of the data
|
||||||
* @data: (array length=in_samples): the data to commit
|
* @data: (array length=in_samples): the data to commit
|
||||||
* @in_samples: the number of samples in the data to commit
|
* @in_samples: the number of samples in the data to commit
|
||||||
* @out_samples: the number of samples to write to the ringbuffer
|
* @out_samples: the number of samples to write to the ringbuffer
|
||||||
|
|
|
@ -98,7 +98,12 @@ struct _GstAudioSinkClass {
|
||||||
gboolean (*unprepare) (GstAudioSink *sink);
|
gboolean (*unprepare) (GstAudioSink *sink);
|
||||||
/* close the device */
|
/* close the device */
|
||||||
gboolean (*close) (GstAudioSink *sink);
|
gboolean (*close) (GstAudioSink *sink);
|
||||||
/* write samples to the device */
|
/**
|
||||||
|
* GstAudioSinkClass::write:
|
||||||
|
* @data: (type guint8) (array length=length): the sample data
|
||||||
|
*
|
||||||
|
* Write samples to the device.
|
||||||
|
*/
|
||||||
gint (*write) (GstAudioSink *sink, gpointer data, guint length);
|
gint (*write) (GstAudioSink *sink, gpointer data, guint length);
|
||||||
/* get number of frames queued in the device */
|
/* get number of frames queued in the device */
|
||||||
guint (*delay) (GstAudioSink *sink);
|
guint (*delay) (GstAudioSink *sink);
|
||||||
|
|
|
@ -84,7 +84,13 @@ struct _GstAudioSrcClass {
|
||||||
gboolean (*unprepare) (GstAudioSrc *src);
|
gboolean (*unprepare) (GstAudioSrc *src);
|
||||||
/* close the device */
|
/* close the device */
|
||||||
gboolean (*close) (GstAudioSrc *src);
|
gboolean (*close) (GstAudioSrc *src);
|
||||||
/* read samples from the device */
|
/**
|
||||||
|
* GstAudioSrcClass::read:
|
||||||
|
* @data: (type guint8) (array length=length): the sample data
|
||||||
|
* @timestamp: (out): a #GstClockTime
|
||||||
|
*
|
||||||
|
* Read samples from the device.
|
||||||
|
*/
|
||||||
guint (*read) (GstAudioSrc *src, gpointer data, guint length,
|
guint (*read) (GstAudioSrc *src, gpointer data, guint length,
|
||||||
GstClockTime *timestamp);
|
GstClockTime *timestamp);
|
||||||
/* get number of frames queued in the device */
|
/* get number of frames queued in the device */
|
||||||
|
|
|
@ -310,6 +310,10 @@ struct _GstVideoAggregatorClass
|
||||||
GstBuffer * outbuffer);
|
GstBuffer * outbuffer);
|
||||||
GstFlowReturn (*create_output_buffer) (GstVideoAggregator * videoaggregator,
|
GstFlowReturn (*create_output_buffer) (GstVideoAggregator * videoaggregator,
|
||||||
GstBuffer ** outbuffer);
|
GstBuffer ** outbuffer);
|
||||||
|
/**
|
||||||
|
* GstVideoAggregatorClass::find_best_format:
|
||||||
|
* @at_least_one_alpha: (out):
|
||||||
|
*/
|
||||||
void (*find_best_format) (GstVideoAggregator * vagg,
|
void (*find_best_format) (GstVideoAggregator * vagg,
|
||||||
GstCaps * downstream_caps,
|
GstCaps * downstream_caps,
|
||||||
GstVideoInfo * best_info,
|
GstVideoInfo * best_info,
|
||||||
|
|
|
@ -1111,8 +1111,8 @@ gst_video_chroma_resample_new (GstVideoChromaMethod method,
|
||||||
/**
|
/**
|
||||||
* gst_video_chroma_resample_get_info:
|
* gst_video_chroma_resample_get_info:
|
||||||
* @resample: a #GstVideoChromaResample
|
* @resample: a #GstVideoChromaResample
|
||||||
* @n_lines: the number of input lines
|
* @n_lines: (out) (optional): the number of input lines
|
||||||
* @offset: the first line
|
* @offset: (out) (optional): the first line
|
||||||
*
|
*
|
||||||
* The resampler must be fed @n_lines at a time. The first line should be
|
* The resampler must be fed @n_lines at a time. The first line should be
|
||||||
* at @offset.
|
* at @offset.
|
||||||
|
|
|
@ -302,8 +302,8 @@ gst_video_scaler_get_max_taps (GstVideoScaler * scale)
|
||||||
* gst_video_scaler_get_coeff:
|
* gst_video_scaler_get_coeff:
|
||||||
* @scale: a #GstVideoScaler
|
* @scale: a #GstVideoScaler
|
||||||
* @out_offset: an output offset
|
* @out_offset: an output offset
|
||||||
* @in_offset: result input offset
|
* @in_offset: (out) (optional): result input offset
|
||||||
* @n_taps: result n_taps
|
* @n_taps: (out) (optional): result n_taps
|
||||||
*
|
*
|
||||||
* For a given pixel at @out_offset, get the first required input pixel at
|
* For a given pixel at @out_offset, get the first required input pixel at
|
||||||
* @in_offset and the @n_taps filter coefficients.
|
* @in_offset and the @n_taps filter coefficients.
|
||||||
|
|
Loading…
Reference in a new issue