av/revid/README.md

27 lines
859 B
Markdown
Raw Permalink Normal View History

# Readme
Package revid provides an API for a media capture/processing/forwarding
pipeline. The API is exposed in revid.go.
Configuration is handled by the config package.
Pipeline setup is handled in pipeline.go, where components of the pipeline are
pulled mostly from internal packages i.e. lexers, filters, packetisation and
protocols for forwarding.
Sending is handled by "senders", defined in the senders.go file.
Building the revid package requires gocv.io/x/gocv to be installed. On platforms
where this is not available, a reduced functionality package can be built using
the `nocv` build tag.
# Contributing
See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "Contributing"
for information on how to contribute.
# License
See [here](https://bitbucket.org/ausocean/av/src/master/README.md) under "License"
for licensing.