X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=src%2Fmodules%2Fcore%2Ftransition_region.yml;h=4c548f5a7b43fae2bfa81a780fe3920db93a601e;hb=0232e4e0a64dd3528366510e3385938a886003f4;hp=acfa024ded76a0513a88da3199e650dedbf32973;hpb=9bb7dd62a48fa3d084a4b43b576aed086654b524;p=mlt

diff --git a/src/modules/core/transition_region.yml b/src/modules/core/transition_region.yml
index acfa024d..4c548f5a 100644
--- a/src/modules/core/transition_region.yml
+++ b/src/modules/core/transition_region.yml
@@ -9,3 +9,44 @@ 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: >
+      The default shape is a 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
+    type: properties
+    service-name: transition.composite
+    description: >
+      Properties may be set on the encapsulated composite transition.
+      
+      e.g.: composite.valign=c
+      
+      See "composite" transition for details.
+    readonly: no
+  - identifier: filter_only
+    title: Use region for filtering only
+    type: integer
+    minimum: 0
+    maximum: 1
+    default: 0
+    widget: checkbox