Skip to content

Commit

Permalink
Doc layout fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
matthew1000 committed Jan 7, 2019
1 parent dfe06cc commit 382469b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Example usage includes:

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

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).

### Architecture diagram
![Architecture diagram](docs/assets/arch.png "Architecture diagram")

Expand Down
4 changes: 2 additions & 2 deletions docs/outputs.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ All outputs have the following properties:

| Name | Can be set initially? | Can be updated?? | Description | Default value (if not set) |
| ---- | --------------------- | ---------------- | ----------- | -------------------------- |
| `id` | No | No | ID of the output. Positive integer. Starts at 1 and increases by 1 for each new output. | n/a |
| `uid` | No | No | Unqiue ID - a string in the format 'outputX' where X is the ID | n/a |
| `type` | Yes | No | The output type, e.g. `rtmp`. | N/A - *REQUIRED* |
| `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` |
| `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`) |
Expand All @@ -30,8 +32,6 @@ In addition to the common properties above, this input type also has the followi

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

Expand Down
10 changes: 5 additions & 5 deletions docs/overlays.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ All types of overlays have the following properties:

| 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 |
| `id` | No | No | ID of the overlay. Positive integer. Starts at 1 and increases by 1 for each new overlay. | n/a |
| `uid` | No | No | Unqiue ID - a string in the format 'overlayX' where X is the ID | n/a |
| `type` | Yes | No | The name of the overlay type, e.g. `text`. | N/A - **REQUIRED** |
| `visible` | Yes | Yes | Boolean. Whether the effect is visible on the video. | False |
Expand All @@ -27,7 +27,7 @@ Brave currently supports these overlay types:
### text
Shows text on the screen.

### Additional properties
### Additional properties
In addition to the common properties defined above, this overlay also has:

| Name | Can be set initially? | Can be updated?? | Description | Default value (if not set) |
Expand All @@ -36,13 +36,13 @@ In addition to the common properties defined above, this overlay also has:
| `valignment` | Yes | Yes | The vertical alignment of the text. Can be `top`, `center` or `bottom`. | Empty string |


### clock
### clock
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.

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


### effect
### effect
The `effect` overlay allows a range of video transformation effects to be applied.

This overlay has one additional property - `effect_name` - which can be set to one of the following values:
Expand All @@ -64,4 +64,4 @@ This overlay has one additional property - `effect_name` - which can be set to o
* `vertigotv`: VertigoTV (blending effector with rotating and scaling)
* `warptv`: WarpTV (goo\'ing of the video)

If omitted, the default is `edgetv`.
If omitted, the default is `edgetv`.

0 comments on commit 382469b

Please sign in to comment.