git.sesse.net Git - casparcg/blob - build/html/_sources/consumers/consumers.txt

   1 #########\r
   2 Consumers\r
   3 #########\r
   4 \r
   5 =============\r
   6 File Consumer\r
   7 =============\r
   8 \r
   9 -----------\r
  10 Diagnostics\r
  11 -----------\r
  12 \r
  13 ffmpeg[*filename*]\r
  14 \r
  15 +---------------+-----------------------------------------------+--------+\r
  16 | Graph         | Description                                   |  Scale |\r
  17 +===============+===============================================+========+\r
  18 | frame-time    | Time spent decoding the current frame.        | fps/2  |\r
  19 +---------------+-----------------------------------------------+--------+\r
  20                 \r
  21 ----------\r
  22 Parameters\r
  23 ----------\r
  24 \r
  25 The file consumer uses the same option syntax as ffmpeg. \r
  26 \r
  27 Note, not all options supported by ffmpeg have been implemented.\r
  28 \r
  29     \r
  30 ^^^^^^^^\r
  31 FILENAME\r
  32 ^^^^^^^^\r
  33 \r
  34 Target filename.\r
  35 \r
  36 Syntax::\r
  37 \r
  38     [filename:string]\r
  39     \r
  40 Example::\r
  41 \r
  42     ADD 1 FILE test.mov -vcodec libx264 -crf 5 -preset ultrafast -tune fastdecode -s 1280x720 -r 50 -acodec aac -ab 128k \r
  43     REMOVE 1 FILE    \r
  44         \r
  45 =================\r
  46 Bluefish Consumer\r
  47 =================\r
  48 \r
  49 -----------\r
  50 Diagnostics\r
  51 -----------\r
  52 \r
  53 ffmpeg[*filename*]\r
  54 \r
  55 +---------------+-----------------------------------------------+--------+\r
  56 | Graph         | Description                                   |  Scale |\r
  57 +===============+===============================================+========+\r
  58 | frame-time    | Time spent decoding the current frame.        | fps/2  |\r
  59 +---------------+-----------------------------------------------+--------+\r
  60 | sync-time     | Time spent waiting for sync.                  | fps/2  |\r
  61 +---------------+-----------------------------------------------+--------+\r
  62 | tick-time     | Time between frames frame.                    | fps/2  |\r
  63 +---------------+-----------------------------------------------+--------+\r
  64                 \r
  65 ----------\r
  66 Parameters\r
  67 ----------\r
  68 \r
  69 ^^^^^^\r
  70 DEVICE\r
  71 ^^^^^^\r
  72 \r
  73 Which BlueFish device to attach.\r
  74 \r
  75 Syntax::\r
  76 \r
  77         [device:int]\r
  78     \r
  79 Configuration Syntax::\r
  80 \r
  81     <device>[1..]</device>\r
  82         \r
  83 Example::\r
  84         \r
  85         << ADD 1 BLUEFISH 1\r
  86     \r
  87     \r
  88 ^^^^^^^^^^^^^^\r
  89 EMBEDDED_AUDIO\r
  90 ^^^^^^^^^^^^^^\r
  91 \r
  92 Enables embedded-audio.\r
  93 \r
  94 Syntax::\r
  95 \r
  96         EMBEDDED_AUDIO\r
  97     \r
  98 Default::\r
  99 \r
 100     Disabled\r
 101     \r
 102 Configuration Syntax::\r
 103 \r
 104     <embedded-audio>[true|false]</embedded-audio>\r
 105         \r
 106 Example::\r
 107         \r
 108         << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO\r
 109     \r
 110 ^^^^^^^^\r
 111 KEY_ONLY\r
 112 ^^^^^^^^\r
 113 \r
 114 Displays key as fill.\r
 115 \r
 116 Default::\r
 117 \r
 118     Disabled\r
 119 \r
 120 Syntax::\r
 121 \r
 122         KEY_ONLY\r
 123     \r
 124 Configuration Syntax::\r
 125 \r
 126     <key-only>[true|false]</key-only>\r
 127             \r
 128 Example::\r
 129         \r
 130         << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO KEY_ONLY\r
 131     \r
 132 \r
 133 =================\r
 134 Decklink Consumer\r
 135 =================\r
 136 \r
 137 -----------\r
 138 Diagnostics\r
 139 -----------\r
 140 \r
 141 ffmpeg[*filename*]\r
 142 \r
 143 +---------------+-----------------------------------------------+--------------+\r
 144 | Graph         | Description                                   |  Scale       |\r
 145 +===============+===============================================+==============+\r
 146 | frame-time    | Time spent decoding the current frame.        | fps/2        |\r
 147 +---------------+-----------------------------------------------+--------------+\r
 148 | sync-time     | Time spent waiting for sync.                  | fps/2        |\r
 149 +---------------+-----------------------------------------------+--------------+\r
 150 | tick-time     | Time between frames frame.                    | fps/2        |\r
 151 +---------------+-----------------------------------------------+--------------+\r
 152 | dropped-frame | Frame was dropped.                            |  N/A         |\r
 153 +---------------+-----------------------------------------------+--------------+\r
 154 | late-frame    | Frame was late.                               |  N/A         |\r
 155 +---------------+-----------------------------------------------+--------------+\r
 156 | buffered-video| Frame was dropped.                            |  fps         |\r
 157 +---------------+-----------------------------------------------+--------------+\r
 158 | buffered-audio| Frame was late.                               |  cadence*2   |\r
 159 +---------------+-----------------------------------------------+--------------+\r
 160                 \r
 161 ----------\r
 162 Parameters\r
 163 ----------\r
 164 \r
 165 ^^^^^^\r
 166 DEVICE\r
 167 ^^^^^^\r
 168 \r
 169 Which BlueFish device to attach.\r
 170 \r
 171 Syntax::\r
 172 \r
 173         [device:int]\r
 174     \r
 175 Configuration Syntax::\r
 176 \r
 177     <device>[1..]</device>\r
 178         \r
 179 Example::\r
 180         \r
 181         << ADD 1 BLUEFISH 1\r
 182     \r
 183     \r
 184 ^^^^^^^^^^^^^^\r
 185 EMBEDDED_AUDIO\r
 186 ^^^^^^^^^^^^^^\r
 187 \r
 188 Enables embedded-audio.\r
 189 \r
 190 Syntax::\r
 191 \r
 192         EMBEDDED_AUDIO\r
 193     \r
 194 Default::\r
 195 \r
 196     Disabled\r
 197     \r
 198 Configuration Syntax::\r
 199 \r
 200     <embedded-audio>[true|false]</embedded-audio>\r
 201         \r
 202 Example::\r
 203         \r
 204         << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO\r
 205     \r
 206 ^^^^^^^^\r
 207 KEY_ONLY\r
 208 ^^^^^^^^\r
 209 \r
 210 Displays key as fill.\r
 211 \r
 212 Default::\r
 213 \r
 214     Disabled\r
 215 \r
 216 Syntax::\r
 217 \r
 218         KEY_ONLY\r
 219     \r
 220 Configuration Syntax::\r
 221 \r
 222     <key-only>[true|false]</key-only>\r
 223             \r
 224 Example::\r
 225         \r
 226         << ADD 1 BLUEFISH 1 EMBEDDED_AUDIO KEY_ONLY    \r
 227     \r
 228 ^^^^^^^\r
 229 LATENCY\r
 230 ^^^^^^^\r
 231 \r
 232 Set latency mode.\r
 233 \r
 234 Default::\r
 235 \r
 236     normal\r
 237 \r
 238 Configuration Syntax::\r
 239 \r
 240     <latency>[normal|low|default]</latency>\r
 241         \r
 242 ^^^^^\r
 243 KEYER\r
 244 ^^^^^\r
 245 \r
 246 Set keyer mode.\r
 247 \r
 248 Default::\r
 249 \r
 250     external\r
 251 \r
 252 Configuration Syntax::\r
 253 \r
 254     <keyer>[external|internal|default]</keyer>\r
 255     \r
 256 ^^^^^^^^^^^^\r
 257 BUFFER_DEPTH\r
 258 ^^^^^^^^^^^^\r
 259 \r
 260 Set buffer depth. Settings this value to low can cause output distortion.\r
 261 \r
 262 Default::\r
 263 \r
 264     3\r
 265 \r
 266 Configuration Syntax::\r
 267 \r
 268     <buffer-depth>[1..]</buffer-depth>\r
 269     \r
 270 ===============\r
 271 Screen Consumer\r
 272 ===============\r
 273 \r
 274 =====================\r
 275 System Audio Consumer\r
 276 =====================