]> git.sesse.net Git - mlt/blob - src/modules/core/transition_region.yml
Transcribe service metadata from services.txt to corresponding yml
[mlt] / src / modules / core / transition_region.yml
1 schema_version: 0.1
2 type: transition
3 identifier: region
4 title: Regionalize
5 version: 1
6 copyright: Ushodaya Enterprises Limited
7 creator: Charles Yates
8 license: LGPLv2.1
9 language: en
10 tags:
11   - Video
12 description: >
13    Apply zero or more filters to B frame as it is composited onto a region of 
14    the A frame. The "shape" of the region can be defined by the alpha channel 
15    of a third producer.
16 parameters:
17   - identifier: argument
18     title: Shape producer
19     type: string
20     description: >
21        Nothing (unspecified) is rectangle, "circle" is a pixbuf-generated SVG 
22        circle, anything else is loaded by the factory.
23   - identifier: factory
24     title: Factory
25     type: string
26     description: >
27        The service that creates the shape producer.
28     default: 'loader'
29   - identifier: filter[N]
30     title: Filter
31     type: string
32     description: >
33        One or more filters to apply. All filter properties are passed using the 
34        same filter "key".
35   - identifier: composite.*
36     title: Composite
37     description: >
38       Properties may be set on the encapsulated composite transition.
39       
40       e.g.: composite.valign=c
41       
42       See "composite" transition for details.
43     readonly: no