Top | ![]() |
![]() |
![]() |
![]() |
GstValidateScenarioGstValidateScenario — A GstValidateScenario represents a set of actions to be executed on a pipeline. |
gboolean | handles-states | Read |
GstValidateRunner * | validate-runner | Read / Write / Construct Only |
struct | GstValidateAction |
struct | GstValidateActionParameter |
struct | GstValidateScenario |
struct | GstValidateScenarioClass |
A GstValidateScenario represents the scenario that will be executed on a GstPipeline. It is basically an ordered list of GstValidateAction that will be executed during the execution of the pipeline.
gboolean (*GstValidateExecuteAction) (GstValidateScenario *scenario
,GstValidateAction *action
);
This function that executes a GstValidateAction
scenario |
The GstValidateScenario from which the |
|
action |
The GstValidateAction being executed |
gboolean gst_validate_print_action_types (const gchar **wanted_types
,gint num_wanted_types
);
Prints the action types details wanted in wanted_types
gboolean gst_validate_list_scenarios (gchar **scenarios
,gint num_scenarios
,gchar *output_file
);
void gst_validate_add_action_type (const gchar *type_name
,const gchar *implementer_namespace
,GstValidateExecuteAction function
,GstValidateActionParameter *parameters
,const gchar *description
,gboolean is_config
);
Register a new action type to the action type system. If the action type already exists, it will be overriden by that new definition
type_name |
The name of the new action type to add |
|
implementer_namespace |
The namespace of the implementer of the action type |
|
function |
The function to be called to execute the action. |
[scope notified] |
parameters |
The GstValidateActionParameter usable as parameter of the type |
|
description |
A description of the new type |
|
is_config |
Whether the action is a config action or not. A config action will be executed even before the pipeline starts processing |
gboolean gst_validate_action_get_clocktime (GstValidateScenario *scenario
,GstValidateAction *action
,const gchar *name
,GstClockTime *retval
);
Get a time value for the name
parameter of an action. This
method should be called to retrived and compute a timed value of a given
action. It will first try to retrieve the value as a double,
then get it as a string and execute any formula taking into account
the 'position' and 'duration' variables. And it will always convert that
value to a GstClockTime.
scenario |
The GstValidateScenario from which to get a time for a parameter of an action |
|
action |
The action from which to retrieve the time for |
|
name |
The name of the parameter for which to retrive a time |
|
retval |
The return value for the wanted time. |
[out] |
gboolean gst_validate_scenario_execute_seek (GstValidateScenario *scenario
,GstValidateAction *action
,gdouble rate
,GstFormat format
,GstSeekFlags flags
,GstSeekType start_type
,GstClockTime start
,GstSeekType stop_type
,GstClockTime stop
);
Executes a seek event on the scenario' pipeline. You should always use that method when you want to execute a seek inside a new action types so that the scenario state is updated taking into account that seek.
For more information you should have a look at gst_event_new_seek
scenario |
The GstValidateScenario for which to execute a seek action |
|
action |
The seek action to execute |
|
rate |
The playback rate of the seek |
|
format |
The GstFormat of the seek |
|
flags |
The GstSeekFlags of the seek |
|
start_type |
The GstSeekType of the start value of the seek |
|
start |
The start time of the seek |
|
stop_type |
The GstSeekType of the stop value of the seek |
|
stop |
The stop time of the seek |
struct GstValidateAction { GstMiniObject mini_object; const gchar *type; const gchar *name; GstStructure *structure; };
The GstValidateAction defined to be executed as part of a scenario
GstMiniObject |
||
const gchar * |
The type of the GstValidateAction, which is the name of the GstValidateActionType registered with gst_validate_add_action_type |
|
const gchar * |
The name of the action, set from the user in the scenario |
|
GstStructure * |
the GstStructure defining the action |
struct GstValidateActionParameter { const gchar *name; const gchar *description; gboolean mandatory; const gchar *types; const gchar *possible_variables; const gchar *def; };
const gchar * |
The name of the parameter |
|
const gchar * |
The description of the parameter |
|
gboolean |
Whether the parameter is mandatory for a specific action type |
|
const gchar * |
The types the parameter can take described as a string. It can be precisely describing how the typing works using '\n' between the various acceptable types. |
|
const gchar * |
The name of the variables that can be used to compute the value of the parameter. For example for the start value of a seek action, we will accept to take 'duration' which will be replace by the total duration of the stream on which the action is executed. |
|
const gchar * |
The default value of a parametter as a string, should be |
“handles-states”
property“handles-states” gboolean
True if the application should not set handle the first state change False if it is application responsibility.
Flags: Read
Default value: FALSE
“validate-runner”
property“validate-runner” GstValidateRunner *
The Validate runner to report errors to.
Flags: Read / Write / Construct Only