From 2aa5683c155bef38df44353398bf2eb7f5e5675a Mon Sep 17 00:00:00 2001 From: zii Date: Sun, 24 Dec 2023 10:26:52 -0500 Subject: [PATCH] -fixed up the documentation --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 8f56492..3341bf3 100644 --- a/README.md +++ b/README.md @@ -48,12 +48,12 @@ rec_path = /var/footage live_secs = 30 # this is the maximum amount of seconds worth of live footage to keep in # buffer_path before deleting the oldest 2 seconds worth of footage. -# note: each video clip in buffer_path should be 2 seconds long. +# note: each video clip in buffer_path is typically 2 seconds long. # cam_name = cam-1 # this is the optional camera name parameter to identify the camera. this -# name will also be used to as the base directory in buffer_path or -# rec_path. if not defined, the name of the config file will be used. +# name will also be used as the base directory in buffer_path and rec_path. +# if not defined, the name of the config file will be used. # max_event_secs = 30 # this is the maximum amount of secs of video footage that can be recorded @@ -95,9 +95,9 @@ thumbnail_ext = .jpg # for the videos clips recorded to rec_path. # rec_ext = .avi -# this the the file extension this will be used when storaging motion -# footage to rec_path. ffmpeg will also use this to determine what format -# container to use for the video clips. +# this the the file extension that will be used when storing motion footage +# to rec_path. ffmpeg will also use this to determine what format container +# to use for the video clips. # img_thresh = 8000 # this parameter defines the score threshold from img_comp_cmd that will @@ -117,10 +117,11 @@ post_cmd = move_the_ptz_camera.py # this an optional command to run with post_secs. one great use for this # is to move a ptz camera to the next position of it's patrol pattern. # note: the call to this command will be delayed if motion was detected. +# also, motion detection is paused while this command is running. # rec_fps = 30 # this sets the recording frames per second for the footage recorded -# from the camera. this has no affect of using 'copy' as the +# from the camera. this has no affect if using 'copy' as the # stream_codec. # rec_scale = 1280:720