mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-10-22 02:13:46 +00:00
validate: scenario: fix documentation for GstValidateAction
Additionally: Improve GstValidatePrepareAction documentation Correct one-off use of 'eos' instead of EOS.
This commit is contained in:
parent
fd796d2976
commit
d6169ccb9f
2 changed files with 6 additions and 6 deletions
|
@ -763,7 +763,7 @@ _execute_stop (GstValidateScenario * scenario, GstValidateAction * action)
|
||||||
static gboolean
|
static gboolean
|
||||||
_execute_eos (GstValidateScenario * scenario, GstValidateAction * action)
|
_execute_eos (GstValidateScenario * scenario, GstValidateAction * action)
|
||||||
{
|
{
|
||||||
GST_DEBUG ("Sending eos to pipeline at %" GST_TIME_FORMAT,
|
GST_DEBUG ("Sending EOS to pipeline at %" GST_TIME_FORMAT,
|
||||||
GST_TIME_ARGS (action->playback_time));
|
GST_TIME_ARGS (action->playback_time));
|
||||||
|
|
||||||
return gst_element_send_event (scenario->pipeline, gst_event_new_eos ());
|
return gst_element_send_event (scenario->pipeline, gst_event_new_eos ());
|
||||||
|
|
|
@ -68,11 +68,11 @@ typedef GstValidateExecuteActionReturn (*GstValidateExecuteAction) (GstValidateS
|
||||||
* @action: The #GstValidateAction to prepare before execution
|
* @action: The #GstValidateAction to prepare before execution
|
||||||
*
|
*
|
||||||
* A function that prepares @action so it can be executed right after.
|
* A function that prepares @action so it can be executed right after.
|
||||||
* Most of the time that function is used to parse and set field with
|
* Most of the time this function is used to parse and set fields with
|
||||||
* equations in the action structure.
|
* equations in the action structure.
|
||||||
*
|
*
|
||||||
* Returns: a %TRUE if the action could be prepared and is ready to be run
|
* Returns: %TRUE if the action could be prepared and is ready to be run
|
||||||
* %FALSE otherwise
|
* , %FALSE otherwise
|
||||||
*/
|
*/
|
||||||
typedef gboolean (*GstValidatePrepareAction) (GstValidateAction * action);
|
typedef gboolean (*GstValidatePrepareAction) (GstValidateAction * action);
|
||||||
|
|
||||||
|
@ -86,8 +86,8 @@ typedef struct _GstValidateActionPrivate GstValidateActionPrivate;
|
||||||
* #gst_validate_register_action_type
|
* #gst_validate_register_action_type
|
||||||
* @name: The name of the action, set from the user in the scenario
|
* @name: The name of the action, set from the user in the scenario
|
||||||
* @structure: the #GstStructure defining the action
|
* @structure: the #GstStructure defining the action
|
||||||
* @scenario: The scenario for this action. This is not thread
|
* @scenario: The scenario for this action. This is not thread-safe
|
||||||
* safe and should be accessed exculsively from the main thread.
|
* and should be accessed exclusively from the main thread.
|
||||||
* If you need to access it from another thread use the
|
* If you need to access it from another thread use the
|
||||||
* #gst_validate_action_get_scenario method
|
* #gst_validate_action_get_scenario method
|
||||||
*
|
*
|
||||||
|
|
Loading…
Reference in a new issue