Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nytamin authored Mar 30, 2020
1 parent 3f6a46a commit 2341936
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,20 @@
# Casparcg Image Provider

Provides images from CasparCG channels & layers on a HTTP interface.
Sacrifices one of more channels in CasparCG for creating a grid, in order to provide several streams on one stream.
Streams CasparCG content to web clients, using Motion-JPEG.
Sacrifices a channel in CasparCG to create a grid, in order to provide several (low-quality-) streams on a single stream to the client.

Using a channel for snapshotting
## Usage

## Development
Run from source or download an executable from [Releases](https://github.com/SuperFlyTV/casparCG-image-provider/releases).

On initial startup a config file (`casparcg-image-provider.config`) will be created.
By default, the LAST channel in CasparCG will be used to create a 3-by-3 grid, allowing up to 9 previews to be streamed to the client.
Custom configuration is possible, and described [here](https://github.com/SuperFlyTV/casparCG-image-provider/blob/master/src/config.ts).

After having started the application, head over to [http:localhost:5255](http:localhost:5255) to explore the API.


## For developers
### Prerequisites

* yarn global add nodemon ts-node
Expand All @@ -22,7 +31,6 @@ Windows: `yarn pkg-win32`

### Ref implementation

Reference implementations for client-side can be accessed at
Reference implementation for client-side can be accessed at

* http://localhost:5255/channel/1/view-stream
* http://localhost:5255/channel/1/view-image

0 comments on commit 2341936

Please sign in to comment.