You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`id`| No | No | ID of the output. Positive integer. Starts at 1 and increases by 1 for each new output. | n/a |
10
+
|`uid`| No | No | Unqiue ID - a string in the format 'outputX' where X is the ID | n/a |
9
11
|`type`| Yes | No | The output type, e.g. `rtmp`. | N/A - *REQUIRED*|
10
12
|`state`| Yes (but use the key `initial_state`) | Yes | Either `NULL`, `READY`, `PAUSED` or `PLAYING`. [_What are the four states?_](faq.md#what-are-the-four-states)|`PLAYING`|
11
13
|`source`| Yes | Yes, but only if the output is in the `READY` or `NULL` states. | The source of the output - either an [input](inputs.md), or a [mixer](mixers.md), or `null`. | None (`null`) |
@@ -30,8 +32,6 @@ In addition to the common properties above, this input type also has the followi
30
32
31
33
| Name | Can be set initially? | Can be updated?? | Description | Default value (if not set) |
|`id`| No | No | ID of the overlay. Positive integer. Starts at 1 and increases by 1 for each new mixer. | n/a |
14
+
|`id`| No | No | ID of the overlay. Positive integer. Starts at 1 and increases by 1 for each new overlay. | n/a |
15
15
|`uid`| No | No | Unqiue ID - a string in the format 'overlayX' where X is the ID | n/a |
16
16
|`type`| Yes | No | The name of the overlay type, e.g. `text`. | N/A - **REQUIRED**|
17
17
|`visible`| Yes | Yes | Boolean. Whether the effect is visible on the video. | False |
@@ -27,7 +27,7 @@ Brave currently supports these overlay types:
27
27
### text
28
28
Shows text on the screen.
29
29
30
-
###Additional properties
30
+
###Additional properties
31
31
In addition to the common properties defined above, this overlay also has:
32
32
33
33
| Name | Can be set initially? | Can be updated?? | Description | Default value (if not set) |
@@ -36,13 +36,13 @@ In addition to the common properties defined above, this overlay also has:
36
36
|`valignment`| Yes | Yes | The vertical alignment of the text. Can be `top`, `center` or `bottom`. | Empty string |
37
37
38
38
39
-
###clock
39
+
###clock
40
40
The `clock` overlay shows the current time, and also any other text provided in the `text` property. It is a useful overlay to determine if there is any delay in the video.
41
41
42
42
This overlay shares the same properties as the `text` overlay.
43
43
44
44
45
-
###effect
45
+
###effect
46
46
The `effect` overlay allows a range of video transformation effects to be applied.
47
47
48
48
This overlay has one additional property - `effect_name` - which can be set to one of the following values:
@@ -64,4 +64,4 @@ This overlay has one additional property - `effect_name` - which can be set to o
64
64
*`vertigotv`: VertigoTV (blending effector with rotating and scaling)
0 commit comments