mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2024-11-29 13:11:06 +00:00
Code Issues 1 Projects Releases Wiki Activity

gstplay: Fix typos in documentation

Browse source 
Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/6177>
This commit is contained in:
naglis 2024-02-22 09:41:00 +02:00 committed by GStreamer Marge Bot
parent 5d62f408f2
commit 476a34cfdb
2 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
girs/GstPlay-1.0.gir
View file

@ -435,8 +435,8 @@ This option is disabled by default.</doc>
</parameters> </parameters>
</function> </function>
<function name="config_set_position_update_interval" c:identifier="gst_play_config_set_position_update_interval" version="1.20"> <function name="config_set_position_update_interval" c:identifier="gst_play_config_set_position_update_interval" version="1.20">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">set desired interval in milliseconds between two position-updated messages. <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">Set desired interval in milliseconds between two position-updated messages.
pass 0 to stop updating the position.</doc> Pass 0 to stop updating the position.</doc>
<source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.h"/> <source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.h"/>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<type name="none" c:type="void"/> <type name="none" c:type="void"/>
@ -547,7 +547,7 @@ matching #GstPlayVideoInfo.</doc>
<function name="is_play_message" c:identifier="gst_play_is_play_message" version="1.20"> <function name="is_play_message" c:identifier="gst_play_is_play_message" version="1.20">
<source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.h"/> <source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.h"/>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">A #gboolean indicating wheter the passes message represents a #GstPlay message or not.</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">A #gboolean indicating whether the passed message represents a #GstPlay message or not.</doc>
<type name="gboolean" c:type="gboolean"/> <type name="gboolean" c:type="gboolean"/>
</return-value> </return-value>
<parameters> <parameters>
@ -835,7 +835,7 @@ currently-playing stream.</doc>
</parameters> </parameters>
</method> </method>
<method name="get_subtitle_uri" c:identifier="gst_play_get_subtitle_uri" version="1.20"> <method name="get_subtitle_uri" c:identifier="gst_play_get_subtitle_uri" version="1.20">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">current subtitle URI</doc> <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">Current subtitle URI</doc>
<source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.h"/> <source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.h"/>
<return-value transfer-ownership="full" nullable="1"> <return-value transfer-ownership="full" nullable="1">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">URI of the current external subtitle. <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">URI of the current external subtitle.
@ -880,7 +880,7 @@ currently-playing stream. g_free() after usage.</doc>
</method> </method>
<method name="get_video_snapshot" c:identifier="gst_play_get_video_snapshot" version="1.20"> <method name="get_video_snapshot" c:identifier="gst_play_get_video_snapshot" version="1.20">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">Get a snapshot of the currently selected video stream, if any. The format can be <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">Get a snapshot of the currently selected video stream, if any. The format can be
selected with @format and optional configuration is possible with @config selected with @format and optional configuration is possible with @config.
Currently supported settings are: Currently supported settings are:
- width, height of type G_TYPE_INT - width, height of type G_TYPE_INT
- pixel-aspect-ratio of type GST_TYPE_FRACTION - pixel-aspect-ratio of type GST_TYPE_FRACTION
@ -1055,7 +1055,7 @@ value.</doc>
</method> </method>
<method name="set_config" c:identifier="gst_play_set_config" version="1.20"> <method name="set_config" c:identifier="gst_play_set_config" version="1.20">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">Set the configuration of the play. If the play is already configured, and <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">Set the configuration of the play. If the play is already configured, and
the configuration haven't change, this function will return %TRUE. If the the configuration hasn't changed, this function will return %TRUE. If the
play is not in the GST_PLAY_STATE_STOPPED, this method will return %FALSE play is not in the GST_PLAY_STATE_STOPPED, this method will return %FALSE
and active configuration will remain. and active configuration will remain.
@ -1277,7 +1277,7 @@ Sets the video track @stream_index.</doc>
<method name="set_visualization" c:identifier="gst_play_set_visualization" version="1.20"> <method name="set_visualization" c:identifier="gst_play_set_visualization" version="1.20">
<source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.h"/> <source-position filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.h"/>
<return-value transfer-ownership="none"> <return-value transfer-ownership="none">
<doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">%TRUE if the visualizations was set correctly. Otherwise, <doc xml:space="preserve" filename="../subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c">%TRUE if the visualization was set correctly. Otherwise,
%FALSE.</doc> %FALSE.</doc>
<type name="gboolean" c:type="gboolean"/> <type name="gboolean" c:type="gboolean"/>
</return-value> </return-value>

14
subprojects/gst-plugins-bad/gst-libs/gst/play/gstplay.c
View file

@ -3250,7 +3250,7 @@ gst_play_set_subtitle_uri (GstPlay * self, const gchar * suburi)
* gst_play_get_subtitle_uri: * gst_play_get_subtitle_uri:
* @play: #GstPlay instance * @play: #GstPlay instance
* *
* current subtitle URI * Current subtitle URI
* *
* Returns: (transfer full) (nullable): URI of the current external subtitle. * Returns: (transfer full) (nullable): URI of the current external subtitle.
* g_free() after usage. * g_free() after usage.
@ -3752,7 +3752,7 @@ gst_play_set_subtitle_track_enabled (GstPlay * self, gboolean enabled)
* @name: (nullable): visualization element obtained from * @name: (nullable): visualization element obtained from
* #gst_play_visualizations_get() * #gst_play_visualizations_get()
* *
* Returns: %TRUE if the visualizations was set correctly. Otherwise, * Returns: %TRUE if the visualization was set correctly. Otherwise,
* %FALSE. * %FALSE.
* Since: 1.20 * Since: 1.20
*/ */
@ -4332,7 +4332,7 @@ gst_play_error_get_name (GstPlayError error)
* @config: (transfer full): a #GstStructure * @config: (transfer full): a #GstStructure
* *
* Set the configuration of the play. If the play is already configured, and * Set the configuration of the play. If the play is already configured, and
* the configuration haven't change, this function will return %TRUE. If the * the configuration hasn't changed, this function will return %TRUE. If the
* play is not in the GST_PLAY_STATE_STOPPED, this method will return %FALSE * play is not in the GST_PLAY_STATE_STOPPED, this method will return %FALSE
* and active configuration will remain. * and active configuration will remain.
* *
@ -4443,8 +4443,8 @@ gst_play_config_get_user_agent (const GstStructure * config)
* @config: a #GstPlay configuration * @config: a #GstPlay configuration
* @interval: interval in ms * @interval: interval in ms
* *
* set desired interval in milliseconds between two position-updated messages. * Set desired interval in milliseconds between two position-updated messages.
* pass 0 to stop updating the position. * Pass 0 to stop updating the position.
* Since: 1.20 * Since: 1.20
*/ */
void void
@ -4578,7 +4578,7 @@ gst_play_config_get_pipeline_dump_in_error_details (const GstStructure * config)
* @config: (allow-none): Additional configuration * @config: (allow-none): Additional configuration
* *
* Get a snapshot of the currently selected video stream, if any. The format can be * Get a snapshot of the currently selected video stream, if any. The format can be
* selected with @format and optional configuration is possible with @config * selected with @format and optional configuration is possible with @config.
* Currently supported settings are: * Currently supported settings are:
* - width, height of type G_TYPE_INT * - width, height of type G_TYPE_INT
* - pixel-aspect-ratio of type GST_TYPE_FRACTION * - pixel-aspect-ratio of type GST_TYPE_FRACTION
@ -4672,7 +4672,7 @@ gst_play_get_video_snapshot (GstPlay * self,
* gst_play_is_play_message: * gst_play_is_play_message:
* @msg: A #GstMessage * @msg: A #GstMessage
* *
* Returns: A #gboolean indicating wheter the passes message represents a #GstPlay message or not. * Returns: A #gboolean indicating whether the passed message represents a #GstPlay message or not.
* *
* Since: 1.20 * Since: 1.20
*/ */