Skip to content

Commit 382469b

Browse files
committedJan 7, 2019
Doc layout fixes
1 parent dfe06cc commit 382469b

File tree

3 files changed

+9
-7
lines changed

3 files changed

+9
-7
lines changed
 

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ Example usage includes:
1919

2020
Brave is based on GStreamer. It is, in one sense, a RESTful API for GStreamer (for live audio/video handling).
2121

22+
Read on to learn more, or see the [FAQ](docs/faq.md), [API guide](docs/api.md) and [Config file guide](docs/config_file.md).
23+
2224
### Architecture diagram
2325
![Architecture diagram](docs/assets/arch.png "Architecture diagram")
2426

‎docs/outputs.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ All outputs have the following properties:
66

77
| Name | Can be set initially? | Can be updated?? | Description | Default value (if not set) |
88
| ---- | --------------------- | ---------------- | ----------- | -------------------------- |
9+
| `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 |
911
| `type` | Yes | No | The output type, e.g. `rtmp`. | N/A - *REQUIRED* |
1012
| `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` |
1113
| `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
3032

3133
| Name | Can be set initially? | Can be updated?? | Description | Default value (if not set) |
3234
| ---- | --------------------- | ---------------- | ----------- | -------------------------- |
33-
| `id` | No | No | ID of the output. Positive integer. Starts at 1 and increases by 1 for each new output. | n/a |
34-
| `uid` | No | No | Unqiue ID - a string in the format 'outputX' where X is the ID | n/a |
3535
| `uri` | Yes | The URI of the content | n/a (required) |
3636
| `width` and `height` | No | Width and height of video | Whatever the source is |
3737

‎docs/overlays.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ All types of overlays have the following properties:
1111

1212
| Name | Can be set initially? | Can be updated?? | Description | Default value (if not set) |
1313
| ---- | --------------------- | ---------------- | ----------- | -------------------------- |
14-
| `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 |
1515
| `uid` | No | No | Unqiue ID - a string in the format 'overlayX' where X is the ID | n/a |
1616
| `type` | Yes | No | The name of the overlay type, e.g. `text`. | N/A - **REQUIRED** |
1717
| `visible` | Yes | Yes | Boolean. Whether the effect is visible on the video. | False |
@@ -27,7 +27,7 @@ Brave currently supports these overlay types:
2727
### text
2828
Shows text on the screen.
2929

30-
### Additional properties
30+
### Additional properties
3131
In addition to the common properties defined above, this overlay also has:
3232

3333
| 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:
3636
| `valignment` | Yes | Yes | The vertical alignment of the text. Can be `top`, `center` or `bottom`. | Empty string |
3737

3838

39-
### clock
39+
### clock
4040
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.
4141

4242
This overlay shares the same properties as the `text` overlay.
4343

4444

45-
### effect
45+
### effect
4646
The `effect` overlay allows a range of video transformation effects to be applied.
4747

4848
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
6464
* `vertigotv`: VertigoTV (blending effector with rotating and scaling)
6565
* `warptv`: WarpTV (goo\'ing of the video)
6666

67-
If omitted, the default is `edgetv`.
67+
If omitted, the default is `edgetv`.

0 commit comments

Comments
 (0)
Please sign in to comment.