7 [playback-time=(double,string)],
8 container-name=(string),
9 position=(double or string),
12 [new-layer-priority=(int)];
15 Allows to edit a container (like a GESClip), for more details, have a look at:
16 ges_container_edit documentation, Note that the timeline will
17 be commited, and flushed so that the edition is taken into account
18 * Implementer namespace: ges
24 * `playback-time`:(optional): The playback time at which the action will be executed
28 * `position`: The current position in the stream
30 * `duration`: The duration of the stream
32 Possible types: `double,string`
36 * `on-message`:(optional): Specify on what message type the action will be executed.
37 If both 'playback-time' and 'on-message' is specified, the action will be executed
38 on whatever happens first.
40 Possible types: `string`
44 * `container-name`:(mandatory): The name of the GESContainer to edit
46 Possible types: `string`
48 * `position`:(mandatory): The new position of the GESContainer
52 * position: The current position in the stream
54 * duration: The duration of the stream
56 Possible types: `double or string`
58 * `edit-mode`:(optional): The GESEditMode to use to edit @container-name
60 Possible types: `string`
64 * `edge`:(optional): The GESEdge to use to edit @container-name
65 should be in [ edge_start, edge_end, edge_none ]
67 Possible types: `string`
71 * `new-layer-priority`:(optional): The priority of the layer @container should land in.
72 If the layer you're trying to move the container to doesn't exist, it will
73 be created automatically. -1 means no move.
84 [playback-time=(double,string)],
89 Allows to add an asset to the current project
90 * Implementer namespace: ges
96 * `playback-time`:(optional): The playback time at which the action will be executed
100 * `position`: The current position in the stream
102 * `duration`: The duration of the stream
104 Possible types: `double,string`
108 * `on-message`:(optional): Specify on what message type the action will be executed.
109 If both 'playback-time' and 'on-message' is specified, the action will be executed
110 on whatever happens first.
112 Possible types: `string`
116 * `id`:(mandatory): Adds an asset to a project.
118 * `type`:(mandatory): The type of asset to add
123 ``` validate-scenario
125 [playback-time=(double,string)],
130 Allows to remove an asset from the current project
131 * Implementer namespace: ges
137 * `playback-time`:(optional): The playback time at which the action will be executed
141 * `position`: The current position in the stream
143 * `duration`: The duration of the stream
145 Possible types: `double,string`
149 * `on-message`:(optional): Specify on what message type the action will be executed.
150 If both 'playback-time' and 'on-message' is specified, the action will be executed
151 on whatever happens first.
153 Possible types: `string`
157 * `id`:(mandatory): The ID of the clip to remove
159 * `type`:(mandatory): The type of asset to remove
164 ``` validate-scenario
166 [playback-time=(double,string)],
170 Allows to add a layer to the current timeline
171 * Implementer namespace: ges
177 * `playback-time`:(optional): The playback time at which the action will be executed
181 * `position`: The current position in the stream
183 * `duration`: The duration of the stream
185 Possible types: `double,string`
189 * `on-message`:(optional): Specify on what message type the action will be executed.
190 If both 'playback-time' and 'on-message' is specified, the action will be executed
191 on whatever happens first.
193 Possible types: `string`
197 * `priority`:(optional): The priority of the new layer to add,if not specified, the new layer will be appended to the timeline
204 ``` validate-scenario
206 [playback-time=(double,string)],
208 [auto-transition=(boolean)];
211 Allows to remove a layer from the current timeline
212 * Implementer namespace: ges
218 * `playback-time`:(optional): The playback time at which the action will be executed
222 * `position`: The current position in the stream
224 * `duration`: The duration of the stream
226 Possible types: `double,string`
230 * `on-message`:(optional): Specify on what message type the action will be executed.
231 If both 'playback-time' and 'on-message' is specified, the action will be executed
232 on whatever happens first.
234 Possible types: `string`
238 * `priority`:(mandatory): The priority of the layer to remove
240 * `auto-transition`:(optional): Wheter auto-transition is activated on the new layer.
242 Possible types: `boolean`
249 ``` validate-scenario
251 [playback-time=(double,string)],
253 layer-priority=(int),
256 [start=(double or string)],
257 [inpoint=(double or string)],
258 [duration=(double or string)];
261 Allows to add a clip to a given layer
262 * Implementer namespace: ges
268 * `playback-time`:(optional): The playback time at which the action will be executed
272 * `position`: The current position in the stream
274 * `duration`: The duration of the stream
276 Possible types: `double,string`
280 * `on-message`:(optional): Specify on what message type the action will be executed.
281 If both 'playback-time' and 'on-message' is specified, the action will be executed
282 on whatever happens first.
284 Possible types: `string`
288 * `name`:(mandatory): The name of the clip to add
290 Possible types: `string`
292 * `layer-priority`:(mandatory): The priority of the clip to add
294 Possible types: `int`
296 * `asset-id`:(mandatory): The id of the asset from which to extract the clip
298 Possible types: `string`
300 * `type`:(mandatory): The type of the clip to create
302 Possible types: `string`
304 * `start`:(optional): The start value to set on the new GESClip.
306 Possible types: `double or string`
310 * `inpoint`:(optional): The inpoint value to set on the new GESClip
312 Possible types: `double or string`
316 * `duration`:(optional): The duration value to set on the new GESClip
318 Possible types: `double or string`
325 ``` validate-scenario
327 [playback-time=(double,string)],
331 Allows to remove a clip from a given layer
332 * Implementer namespace: ges
338 * `playback-time`:(optional): The playback time at which the action will be executed
342 * `position`: The current position in the stream
344 * `duration`: The duration of the stream
346 Possible types: `double,string`
350 * `on-message`:(optional): Specify on what message type the action will be executed.
351 If both 'playback-time' and 'on-message' is specified, the action will be executed
352 on whatever happens first.
354 Possible types: `string`
358 * `name`:(mandatory): The name of the clip to remove
360 Possible types: `string`
365 ``` validate-scenario
367 [playback-time=(double,string)],
372 * Implementer namespace: ges
378 * `playback-time`:(optional): The playback time at which the action will be executed
382 * `position`: The current position in the stream
384 * `duration`: The duration of the stream
386 Possible types: `double,string`
390 * `on-message`:(optional): Specify on what message type the action will be executed.
391 If both 'playback-time' and 'on-message' is specified, the action will be executed
392 on whatever happens first.
394 Possible types: `string`
398 * `uri`:(mandatory): The uri where to store the serialized project
400 Possible types: `string`
402 ## set-child-property
405 ``` validate-scenario
407 [playback-time=(double,string)],
408 element-name=(string),
413 Allows to change child property of an object
414 * Implementer namespace: ges
420 * `playback-time`:(optional): The playback time at which the action will be executed
424 * `position`: The current position in the stream
426 * `duration`: The duration of the stream
428 Possible types: `double,string`
432 * `on-message`:(optional): Specify on what message type the action will be executed.
433 If both 'playback-time' and 'on-message' is specified, the action will be executed
434 on whatever happens first.
436 Possible types: `string`
440 * `element-name`:(mandatory): The name of the element on which to modify the property
442 Possible types: `string`
444 * `property`:(mandatory): The name of the property to modify
446 Possible types: `string`
448 * `value`:(mandatory): The value of the property
450 Possible types: `gvalue`
455 ``` validate-scenario
457 [playback-time=(double,string)],
459 position=(double or string);
462 Split a clip at a specified position.
463 * Implementer namespace: ges
469 * `playback-time`:(optional): The playback time at which the action will be executed
473 * `position`: The current position in the stream
475 * `duration`: The duration of the stream
477 Possible types: `double,string`
481 * `on-message`:(optional): Specify on what message type the action will be executed.
482 If both 'playback-time' and 'on-message' is specified, the action will be executed
483 on whatever happens first.
485 Possible types: `string`
489 * `clip-name`:(mandatory): The name of the clip to split
491 Possible types: `string`
493 * `position`:(mandatory): The position at which to split the clip
495 Possible types: `double or string`
497 ## set-track-restriction-caps
500 ``` validate-scenario
501 set-track-restriction-caps,
502 [playback-time=(double,string)],
507 Sets restriction caps on tracks of a specific type.
508 * Implementer namespace: ges
514 * `playback-time`:(optional): The playback time at which the action will be executed
518 * `position`: The current position in the stream
520 * `duration`: The duration of the stream
522 Possible types: `double,string`
526 * `on-message`:(optional): Specify on what message type the action will be executed.
527 If both 'playback-time' and 'on-message' is specified, the action will be executed
528 on whatever happens first.
530 Possible types: `string`
534 * `track-type`:(mandatory): The type of track to set restriction caps on
536 Possible types: `string`
538 * `caps`:(mandatory): The caps to set on the track
540 Possible types: `string`
545 ``` validate-scenario
547 [playback-time=(double,string)],
548 element-name=(string),
552 Sets restriction caps on tracks of a specific type.
553 * Implementer namespace: ges
559 * `playback-time`:(optional): The playback time at which the action will be executed
563 * `position`: The current position in the stream
565 * `duration`: The duration of the stream
567 Possible types: `double,string`
571 * `on-message`:(optional): Specify on what message type the action will be executed.
572 If both 'playback-time' and 'on-message' is specified, the action will be executed
573 on whatever happens first.
575 Possible types: `string`
579 * `element-name`:(mandatory): The name of the TimelineElement to set an asset on
581 Possible types: `string`
583 * `asset-id`:(mandatory): The id of the asset from which to extract the clip
585 Possible types: `string`
587 ## container-add-child
590 ``` validate-scenario
592 [playback-time=(double,string)],
593 container-name=(string),
594 [child-name=(string)],
596 [child-type=(string)];
599 Add a child to @container-name. If asset-id and child-type are specified, the child will be created and added. Otherwize @child-name has to be specified and will be added to the container.
600 * Implementer namespace: ges
606 * `playback-time`:(optional): The playback time at which the action will be executed
610 * `position`: The current position in the stream
612 * `duration`: The duration of the stream
614 Possible types: `double,string`
618 * `on-message`:(optional): Specify on what message type the action will be executed.
619 If both 'playback-time' and 'on-message' is specified, the action will be executed
620 on whatever happens first.
622 Possible types: `string`
626 * `container-name`:(mandatory): The name of the GESContainer to add a child to
628 Possible types: `string`
630 * `child-name`:(optional): The name of the child to add to @container-name
632 Possible types: `string`
636 * `asset-id`:(mandatory): The id of the asset from which to extract the child
638 Possible types: `string`
640 * `child-type`:(optional): The type of the child to create
642 Possible types: `string`
646 ## container-remove-child
649 ``` validate-scenario
650 container-remove-child,
651 [playback-time=(double,string)],
652 container-name=(string),
656 Remove a child from @container-name.
657 * Implementer namespace: ges
663 * `playback-time`:(optional): The playback time at which the action will be executed
667 * `position`: The current position in the stream
669 * `duration`: The duration of the stream
671 Possible types: `double,string`
675 * `on-message`:(optional): Specify on what message type the action will be executed.
676 If both 'playback-time' and 'on-message' is specified, the action will be executed
677 on whatever happens first.
679 Possible types: `string`
683 * `container-name`:(mandatory): The name of the GESContainer to remove a child from
685 Possible types: `string`
687 * `child-name`:(mandatory): The name of the child to reomve from @container-name
689 Possible types: `string`
694 ``` validate-scenario
696 [playback-time=(double,string)],
697 container-name=(string),
698 [recursive=(boolean)];
701 Ungroup children of @container-name.
702 * Implementer namespace: ges
708 * `playback-time`:(optional): The playback time at which the action will be executed
712 * `position`: The current position in the stream
714 * `duration`: The duration of the stream
716 Possible types: `double,string`
720 * `on-message`:(optional): Specify on what message type the action will be executed.
721 If both 'playback-time' and 'on-message' is specified, the action will be executed
722 on whatever happens first.
724 Possible types: `string`
728 * `container-name`:(mandatory): The name of the GESContainer to ungroup children from
730 Possible types: `string`
732 * `recursive`:(optional): Wether to recurse ungrouping or not.
734 Possible types: `boolean`
738 ## set-control-source
741 ``` validate-scenario
743 [playback-time=(double,string)],
744 element-name=(string),
745 property-name=(string),
746 [binding-type=(string)],
747 [source-type=(string)],
748 [interpolation-mode=(string)];
751 Adds a GstControlSource on @element-name::@property-name allowing you to then add keyframes on that property.
752 * Implementer namespace: ges
758 * `playback-time`:(optional): The playback time at which the action will be executed
762 * `position`: The current position in the stream
764 * `duration`: The duration of the stream
766 Possible types: `double,string`
770 * `on-message`:(optional): Specify on what message type the action will be executed.
771 If both 'playback-time' and 'on-message' is specified, the action will be executed
772 on whatever happens first.
774 Possible types: `string`
778 * `element-name`:(mandatory): The name of the GESTrackElement to set the control source on
780 Possible types: `string`
782 * `property-name`:(mandatory): The name of the property for which to set a control source
784 Possible types: `string`
786 * `binding-type`:(optional): The name of the type of binding to use
788 Possible types: `string`
792 * `source-type`:(optional): The name of the type of ControlSource to use
794 Possible types: `string`
796 Default: interpolation
798 * `interpolation-mode`:(optional): The name of the GstInterpolationMode to on the source
800 Possible types: `string`
807 ``` validate-scenario
809 [playback-time=(double,string)],
810 element-name=(string),
811 property-name=(string),
812 timestamp=(string or float),
816 Remove a child from @container-name.
817 * Implementer namespace: ges
823 * `playback-time`:(optional): The playback time at which the action will be executed
827 * `position`: The current position in the stream
829 * `duration`: The duration of the stream
831 Possible types: `double,string`
835 * `on-message`:(optional): Specify on what message type the action will be executed.
836 If both 'playback-time' and 'on-message' is specified, the action will be executed
837 on whatever happens first.
839 Possible types: `string`
843 * `element-name`:(mandatory): The name of the GESTrackElement to add a keyframe on
845 Possible types: `string`
847 * `property-name`:(mandatory): The name of the property for which to add a keyframe on
849 Possible types: `string`
851 * `timestamp`:(mandatory): The timestamp of the keyframe
853 Possible types: `string or float`
855 * `value`:(mandatory): The value of the keyframe
857 Possible types: `float`
862 ``` validate-scenario
864 [playback-time=(double,string)],
865 element-name=(string),
867 position=(string or float),
868 [paste-name=(string)];
871 Remove a child from @container-name.
872 * Implementer namespace: ges
878 * `playback-time`:(optional): The playback time at which the action will be executed
882 * `position`: The current position in the stream
884 * `duration`: The duration of the stream
886 Possible types: `double,string`
890 * `on-message`:(optional): Specify on what message type the action will be executed.
891 If both 'playback-time' and 'on-message' is specified, the action will be executed
892 on whatever happens first.
894 Possible types: `string`
898 * `element-name`:(mandatory): The name of the GESTtimelineElement to copy
900 Possible types: `string`
902 * `recurse`:(optional): Copy recursively or not
904 Possible types: `boolean`
908 * `position`:(mandatory): The time where to paste the element
910 Possible types: `string or float`
912 * `paste-name`:(optional): The name of the copied element
914 Possible types: `string`
921 ``` validate-scenario
923 [playback-time=(double,string)],
924 element-name=(string),
925 property-name=(string),
926 timestamp=(string or float);
929 Remove a child from @container-name.
930 * Implementer namespace: ges
936 * `playback-time`:(optional): The playback time at which the action will be executed
940 * `position`: The current position in the stream
942 * `duration`: The duration of the stream
944 Possible types: `double,string`
948 * `on-message`:(optional): Specify on what message type the action will be executed.
949 If both 'playback-time' and 'on-message' is specified, the action will be executed
950 on whatever happens first.
952 Possible types: `string`
956 * `element-name`:(mandatory): The name of the GESTrackElement to add a keyframe on
958 Possible types: `string`
960 * `property-name`:(mandatory): The name of the property for which to add a keyframe on
962 Possible types: `string`
964 * `timestamp`:(mandatory): The timestamp of the keyframe
966 Possible types: `string or float`
971 ``` validate-scenario
973 [playback-time=(double,string)],
977 Loads a project either from its content passed in the serialized-content field.
978 Note that it will completely clean the previous timeline
979 * Implementer namespace: ges
985 * `playback-time`:(optional): The playback time at which the action will be executed
989 * `position`: The current position in the stream
991 * `duration`: The duration of the stream
993 Possible types: `double,string`
997 * `on-message`:(optional): Specify on what message type the action will be executed.
998 If both 'playback-time' and 'on-message' is specified, the action will be executed
999 on whatever happens first.
1001 Possible types: `string`
1005 * `serialized-content`:(mandatory): The full content of the XML describing project in XGES formet.
1010 ``` validate-scenario
1012 [playback-time=(double,string)];
1015 Commit the timeline.
1016 * Implementer namespace: ges
1022 * `playback-time`:(optional): The playback time at which the action will be executed
1026 * `position`: The current position in the stream
1028 * `duration`: The duration of the stream
1030 Possible types: `double,string`
1034 * `on-message`:(optional): Specify on what message type the action will be executed.
1035 If both 'playback-time' and 'on-message' is specified, the action will be executed
1036 on whatever happens first.
1038 Possible types: `string`