revid: simplified comments for Start, Stop and Update.

This commit is contained in:
Saxon 2019-04-24 13:00:20 +09:30
parent 1b06dae078
commit 74379ea047
1 changed files with 3 additions and 6 deletions

View File

@ -277,8 +277,7 @@ func (r *Revid) setupPipeline(mtsEnc, flvEnc func(dst io.WriteCloser, rate int)
// Start invokes a Revid to start processing video from a defined input
// and packetising (if theres packetization) to a defined output.
//
// This is not intended, nor is it safe, to be used concurrently with any other
// exported functionalilty from this file.
// Start is not safe for concurrent use.
func (r *Revid) Start() error {
if r.isRunning {
r.config.Logger.Log(logger.Warning, pkg+"start called, but revid already running")
@ -296,8 +295,7 @@ func (r *Revid) Start() error {
// Stop closes down the pipeline. This closes encoders and sender output routines,
// connections, and/or files.
//
// This is not intended, nor is it safe, to be used concurrently with any other
// exported functionalilty from this file.
// Stop is not safe for concurrent use.
func (r *Revid) Stop() {
if !r.isRunning {
r.config.Logger.Log(logger.Warning, pkg+"stop called but revid isn't running")
@ -321,8 +319,7 @@ func (r *Revid) Stop() {
// Update takes a map of variables and their values and edits the current config
// if the variables are recognised as valid parameters.
//
// This is not intended, nor is it safe, to be used concurrently with any other
// exported functionalilty from this file.
// Update is not safe for concurrent use.
func (r *Revid) Update(vars map[string]string) error {
if r.isRunning {
r.Stop()