VisibilityHandler #3
18
README.md
18
README.md
|
@ -183,7 +183,6 @@ Valid top-level keys and their expected values are:
|
||||||
video. Relative to `upload_dir`.
|
video. Relative to `upload_dir`.
|
||||||
Details under the heading [Slides](#slides).
|
Details under the heading [Slides](#slides).
|
||||||
|
|
||||||
|
|
||||||
### Subtitles
|
### Subtitles
|
||||||
|
|
||||||
There are two top-level keys that deal with subtitles: `subtitles` and
|
There are two top-level keys that deal with subtitles: `subtitles` and
|
||||||
|
@ -265,13 +264,18 @@ These are the valid keys for a source object:
|
||||||
only have a `true` value for one stream per presentation. If omitted on
|
only have a `true` value for one stream per presentation. If omitted on
|
||||||
stream creation, this will defauilt to `false`.
|
stream creation, this will defauilt to `false`.
|
||||||
|
|
||||||
|
* `enabled`: `bool`
|
||||||
|
Whether this stream will be displayed in the player. At least one stream
|
||||||
|
must be enabled. If omitted on stream creation, this will deafult to `true`.
|
||||||
|
|
||||||
A `sources` object would look like this:
|
A `sources` object would look like this:
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"asourcename": {
|
"asourcename": {
|
||||||
"video": "some/path",
|
"video": "some/path",
|
||||||
"poster": "some/other/path",
|
"poster": "some/other/path",
|
||||||
"playAudio": someBool
|
"playAudio": someBool,
|
||||||
|
"enabled": somebool,
|
||||||
},
|
},
|
||||||
"anothersource": {...},
|
"anothersource": {...},
|
||||||
...
|
...
|
||||||
|
@ -377,12 +381,14 @@ This is a job specification that has all keys and values:
|
||||||
"main": {
|
"main": {
|
||||||
"video": "videos/myvideo.mp4",
|
"video": "videos/myvideo.mp4",
|
||||||
"poster": "aposter.jpg",
|
"poster": "aposter.jpg",
|
||||||
"playAudio": true
|
"playAudio": true,
|
||||||
|
"enabled": true
|
||||||
},
|
},
|
||||||
"second": {
|
"second": {
|
||||||
"video": "myothervideo.mp4",
|
"video": "myothervideo.mp4",
|
||||||
"poster": "anotherposter.jpg",
|
"poster": "anotherposter.jpg",
|
||||||
"playAudio": false
|
"playAudio": false,
|
||||||
|
"enabled": false
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"slides": {
|
"slides": {
|
||||||
|
@ -580,3 +586,7 @@ A source definition is a JSON object with the following keys:
|
||||||
* `playAudio`: `bool`
|
* `playAudio`: `bool`
|
||||||
A boolean value denoting whether to this stream's audio track. This will
|
A boolean value denoting whether to this stream's audio track. This will
|
||||||
only be set to `true` for one source in a given package.
|
only be set to `true` for one source in a given package.
|
||||||
|
|
||||||
|
* `enabled`: `bool`
|
||||||
|
Whether this stream will be displayed in the player. At least one stream
|
||||||
|
will be enabled.
|
||||||
|
|
Loading…
Reference in New Issue
Block a user