Skip to content

docs: updated README #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
tobbee wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: updated README #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 9 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,21 +66,20 @@ The example content in this repo all have a GoP duration of 2000ms.

## Compatibility

Currently, this server works towards `ew-vod2cbm` version 0.10.
It is assumed to be at
`localhost:8090`, but another address can be set in the `main.go` file.
Currently, this server works towards version 1.2.0 pf `ew-vod2cbm`.
It is assumed to be at `localhost:8090`, but another address can be set
in the `main.go` file.
The `ew-vod2cbm` must have access to the `assets` directory.

The media tracks being produced are described in the `content template` file
`content_template.json`, and the input tracks must be compatible
with what is to be generated.

with that file when it comes to GoP duration. Other conditions like the
number of tracks don't need to be fully aligned.

## How to run the program

You need to have an `ESB-3015/ew-vod2cbm` server running at `localhost:8090`. It needs a config file, which currently (v0.8) needs
a value for `defaultGopDurMS`. Such a config file is provided as
`ew-vod2cbm-config/config_2s_gops.json`.
You need to have an `ESB-3015/ew-vod2cbm` server running at `localhost:8090` with
no configuration file.

To run the program you need `go` installed. You can also get a compiled binary that you can
run on any platform.
Expand All @@ -103,5 +102,5 @@ A very simple EPG is available at `http://localhost:8090/epg/ch1`.

## Further documentation

The `ew-vod2cbm` service is not yet generally released, but there is online documentation
describing it and its API at https://docs.agilecontent.com/docs/acp/esb3019.
The online documentation for `ew-vod2cbm` and its API can be found
at https://docs.agilecontent.com/docs/acp/esb3019.