]> git.sesse.net Git - mlt/blobdiff - src/modules/core/transition_region.yml
Transcribe service metadata from services.txt to corresponding yml
[mlt] / src / modules / core / transition_region.yml
index acfa024ded76a0513a88da3199e650dedbf32973..aea23243ce83906fe3da30d34d441a14709232a3 100644 (file)
@@ -9,3 +9,35 @@ license: LGPLv2.1
 language: en
 tags:
   - Video
+description: >
+   Apply zero or more filters to B frame as it is composited onto a region of 
+   the A frame. The "shape" of the region can be defined by the alpha channel 
+   of a third producer.
+parameters:
+  - identifier: argument
+    title: Shape producer
+    type: string
+    description: >
+       Nothing (unspecified) is rectangle, "circle" is a pixbuf-generated SVG 
+       circle, anything else is loaded by the factory.
+  - identifier: factory
+    title: Factory
+    type: string
+    description: >
+       The service that creates the shape producer.
+    default: 'loader'
+  - identifier: filter[N]
+    title: Filter
+    type: string
+    description: >
+       One or more filters to apply. All filter properties are passed using the 
+       same filter "key".
+  - identifier: composite.*
+    title: Composite
+    description: >
+      Properties may be set on the encapsulated composite transition.
+      
+      e.g.: composite.valign=c
+      
+      See "composite" transition for details.
+    readonly: no