]> git.sesse.net Git - mlt/blob - src/modules/decklink/consumer_decklink.yml
a4af6e0c36bfc72f452b2f44c58dcb08a37fdd8d
[mlt] / src / modules / decklink / consumer_decklink.yml
1 schema_version: 0.1
2 type: consumer
3 identifier: decklink
4 title: Blackmagic Design DeckLink Output
5 version: 2
6 copyright: Copyright (C) 2011 Daniel R. Dennedy
7 license: LGPL
8 language: en
9 creator: Dan Dennedy
10 tags:
11   - Audio
12   - Video
13 description: >
14   Output audio and video using Blackmagic Design DeckLink SDI or Intensity
15   HDMI cards.
16 notes: >
17   Please ensure that you use a MLT profile that is compatible with a broadcast
18   standard which the card you are using supports.
19 bugs:
20   - Only internal keying is supported at this time.
21   - Only 8-bit Y'CbCr or RGBA (key) is supported at this time.
22 parameters:
23   - identifier: argument
24     title: Card
25     type: integer
26     readonly: no
27     required: no
28     mutable: no
29     default: 0
30     minimum: 0
31     widget: spinner
32
33   - identifier: preroll
34     title: Pre-roll Count
35     type: integer
36     description: >
37       This controls the amount of buffering in the DeckLink driver/library.
38       Increase this if you get video tearing or choppy audio. However, as
39       you increase the amount, you increase the risk of audio and video
40       becoming out of synchronization.
41     readonly: no
42     required: no
43     mutable: no
44     default: 3
45     minimum: 2
46     unit: frames
47     widget: spinner
48
49   - identifier: keyer
50     title: Enable Keyer
51     type: integer
52     description: >
53       Keying is the process of compositing MLT output over a live SDI input.
54       The alpha channel of the MLT video controls the transparent areas, and
55       the keyer supports alpha-blending. You can not control the compositing
56       rectangle. Rather, the entire MLT output overlays the entire video
57       input. Therefore, you must use MLT's compositing services to control
58       the size and position.
59     readonly: no
60     required: no
61     mutable: no
62     default: 0
63     minimum: 0
64     maximum: 1
65     widget: checkbox
66
67   - identifier: keyer_level
68     title: Key Opacity
69     type: float
70     description: >
71       This controls the level of blending between the key and the input video.
72       1 is fully opaque and something near 0 is transparent. However, absolute
73       0 is considered as "not supplied" and also fully opaque. 0.5 is an
74       evenly balanced blending of the key and input video.
75     readonly: no
76     required: no
77     mutable: no
78     minimum: 0
79     maximum: 1
80     default: 1
81     widget: slider