revid: sectioned constants and added some commenting

revid/revid.go

@@ -48,19 +48,27 @@ import (
 	"bitbucket.org/ausocean/utils/ring"
 )
 
-// Misc constants
+// Ring buffer sizes and read/write timeouts.
+const (
+	ringBufferSize        = 10000
+	ringBufferElementSize = 150000
+	writeTimeout          = 10 * time.Millisecond
+	readTimeout           = 10 * time.Millisecond
+)
+
+// Rtmp connection properties.
 const (
-	clipDuration           = 1 * time.Second
-	ringBufferSize         = 10000
-	ringBufferElementSize  = 150000
-	writeTimeout           = 10 * time.Millisecond
-	readTimeout            = 10 * time.Millisecond
-	bitrateTime            = 1 * time.Minute
-	ffmpegPath             = "/usr/local/bin/ffmpeg"
-	rtmpConnectionTimeout  = 10
-	sendFailedDelay        = 5 * time.Millisecond
 	rtmpConnectionMaxTries = 5
-	pkg                    = "revid:"
+	rtmpConnectionTimeout  = 10
+)
+
+// Misc Constants
+const (
+	clipDuration    = 1 * time.Second      // Duration of video for each clip sent out.
+	bitrateTime     = 1 * time.Minute      // Time duration between bitrate checks.
+	sendFailedDelay = 5 * time.Millisecond // After a send fail, this is the delay before another send.
+	ffmpegPath      = "/usr/local/bin/ffmpeg"
+	pkg             = "revid:"
 )
 
 // Log Types