]> git.sesse.net Git - casparcg/blob - source/consumers/decklink.rst
(no commit message)
[casparcg] / source / consumers / decklink.rst
1 *****************\r
2 Decklink Consumer\r
3 *****************\r
4 \r
5 -----------\r
6 Diagnostics\r
7 -----------\r
8 \r
9 ffmpeg[*filename*]\r
10 \r
11 +---------------+-----------------------------------------------+--------------+\r
12 | Graph         | Description                                   |  Scale       |\r
13 +===============+===============================================+==============+\r
14 | frame-time    | Time spent decoding the current frame.        | fps/2        |\r
15 +---------------+-----------------------------------------------+--------------+\r
16 | sync-time     | Time spent waiting for sync.                  | fps/2        |\r
17 +---------------+-----------------------------------------------+--------------+\r
18 | tick-time     | Time between frames frame.                    | fps/2        |\r
19 +---------------+-----------------------------------------------+--------------+\r
20 | dropped-frame | Frame was dropped.                            |  N/A         |\r
21 +---------------+-----------------------------------------------+--------------+\r
22 | late-frame    | Frame was late.                               |  N/A         |\r
23 +---------------+-----------------------------------------------+--------------+\r
24 | buffered-video| Frame was dropped.                            |  fps         |\r
25 +---------------+-----------------------------------------------+--------------+\r
26 | buffered-audio| Frame was late.                               |  cadence*2   |\r
27 +---------------+-----------------------------------------------+--------------+\r
28                 \r
29 ----------\r
30 Parameters\r
31 ----------\r
32 \r
33 ^^^^^^\r
34 DEVICE\r
35 ^^^^^^\r
36 \r
37 Which BlueFish device to attach.\r
38 \r
39 Syntax::\r
40 \r
41         [device:int]\r
42     \r
43 Configuration Syntax::\r
44 \r
45     <device>[1..]</device>\r
46         \r
47 Example::\r
48         \r
49         << ADD 1 BLUEFISH 1\r
50     \r
51     \r
52 ^^^^^^^^^^^^^^\r
53 EMBEDDED_AUDIO\r
54 ^^^^^^^^^^^^^^\r
55 \r
56 Enables embedded-audio.\r
57 \r
58 Syntax::\r
59 \r
60         EMBEDDED_AUDIO\r
61     \r
62 Default::\r
63 \r
64     Disabled\r
65     \r
66 Configuration Syntax::\r
67 \r
68     <embedded-audio>[true|false]</embedded-audio>\r
69         \r
70 Example::\r
71         \r
72         << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO\r
73     \r
74 ^^^^^^^^\r
75 KEY_ONLY\r
76 ^^^^^^^^\r
77 \r
78 Displays key as fill.\r
79 \r
80 Default::\r
81 \r
82     Disabled\r
83 \r
84 Syntax::\r
85 \r
86         KEY_ONLY\r
87     \r
88 Configuration Syntax::\r
89 \r
90     <key-only>[true|false]</key-only>\r
91             \r
92 Example::\r
93         \r
94         << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO KEY_ONLY    \r
95     \r
96 ^^^^^^^\r
97 LATENCY\r
98 ^^^^^^^\r
99 \r
100 Set latency mode.\r
101 \r
102 Default::\r
103 \r
104     normal\r
105 \r
106 Configuration Syntax::\r
107 \r
108     <latency>[normal|low|default]</latency>\r
109         \r
110 ^^^^^\r
111 KEYER\r
112 ^^^^^\r
113 \r
114 Set keyer mode.\r
115 \r
116 Default::\r
117 \r
118     external\r
119 \r
120 Configuration Syntax::\r
121 \r
122     <keyer>[external|internal|default]</keyer>\r
123     \r
124 ^^^^^^^^^^^^\r
125 BUFFER_DEPTH\r
126 ^^^^^^^^^^^^\r
127 \r
128 Set buffer depth. Settings this value to low can cause output distortion.\r
129 \r
130 Default::\r
131 \r
132     3\r
133 \r
134 Configuration Syntax::\r
135 \r
136     <buffer-depth>[1..]</buffer-depth>