diff --git a/tutorial/ows_pypi.md b/tutorial/ows_pypi.md index ea71df3..98d09a6 100644 --- a/tutorial/ows_pypi.md +++ b/tutorial/ows_pypi.md @@ -26,7 +26,7 @@ pip install opencv-webcam-script==0.4.0 # 以0.4.0为例 ### ⚡ 使用教程 -#### 运行程序 +#### 📝 运行程序 ```python from opencv_webcam.opencv_webcam import webcam_opencv @@ -36,13 +36,13 @@ webcam_opencv(is_autoSaveFrame=True) # 自动保存帧 webcam_opencv(is_autoSaveFrame=True, is_compress=True) # 压缩帧 ``` -#### 常规调用 +#### 📝 常规调用 ```python webcam_opencv() # 常规调用 ``` -#### 选择设备 +#### 📝 选择设备 ```python # 多摄像头切换示例,默认为0 @@ -53,7 +53,7 @@ webcam_opencv(device_index=2) webcam_opencv(device_index="rtsp://username:password@xxx.xxx.xxx") ``` -#### 设置退出键 +#### 📝 设置退出键 ```python # 默认按q键退出 @@ -61,64 +61,64 @@ webcam_opencv(quit_key="z") # 设置z键退出 webcam_opencv(quit_key="k") # 设置k键退出 ``` -#### 自动保存帧 +#### 📝 自动保存帧 ```python webcam_opencv(is_autoSaveFrame=True) ``` -#### 每隔n帧保存一次帧 +#### 📝 每隔n帧保存一次帧 ```python # 每隔10帧保存一次帧 webcam_opencv(is_autoSaveFrame=True, frame_nSave=10) ``` -#### 手动保存帧 +#### 📝 手动保存帧 ```python # 默认按a键捕获一帧 webcam_opencv(is_handSaveFrame=True) ``` -#### 自定义捕获键 +#### 📝 自定义捕获键 ```python # 设置z键为捕获键,默认为a键 webcam_opencv(is_handSaveFrame=True, frame_capKey="z") ``` -#### 重塑帧尺寸(自定义宽高) +#### 📝 重塑帧尺寸(自定义宽高) ```python # 重塑宽度300 高度200 webcam_opencv(is_autoSaveFrame=True, is_resizeFrame=True, resize_frame=[300, 200]) # 自动版 webcam_opencv(is_handSaveFrame=True, is_resizeFrame=True, resize_frame=[300, 200]) # 手动版 ``` -#### 重塑帧尺寸(自定义宽高缩放比) +#### 📝 重塑帧尺寸(自定义宽高缩放比) ```python # 宽高缩放比为0.5 webcam_opencv(is_autoSaveFrame=True, is_resizeFrame=True, resizeRatio_frame=0.5) # 自动版 webcam_opencv(is_handSaveFrame=True, is_resizeFrame=True, resizeRatio_frame=0.5) # 手动版 ``` -#### 自定义保存路径 +#### 📝 自定义保存路径 ```python # 设置保存路径,默认保存路径为./WebcamFrame webcam_opencv(is_autoSaveFrame=True, frame_saveDir="custom_dir") # 以自动版为例 ``` -#### 自定义帧目录名称 +#### 📝 自定义帧目录名称 ```python # 设置帧目录名称,默认保存路径为frames webcam_opencv(is_autoSaveFrame=True, frame_dirName="frames_custom") # 以自动版为例 ``` -#### 自定义帧名前缀 +#### 📝 自定义帧名前缀 ```python # 设置帧图片的前缀名称 webcam_opencv(is_autoSaveFrame=True, frame_namePrefix="webcam") # 以自动版为例 ``` -#### 设置帧保存格式 +#### 📝 设置帧保存格式 ```python # 设置JPG质量为100,默认为95 @@ -127,19 +127,19 @@ webcam_opencv(is_autoSaveFrame=True, frame_saveStyle="jpg", jpg_quality=100) # # 设置PNG质量为5,默认为3 webcam_opencv(is_autoSaveFrame=True, frame_saveStyle="png", png_quality=5) # 以自动版为例 ``` -#### 设置暂停键 +#### 📝 设置暂停键 ```python # 设置w键为暂停键,默认为p键 webcam_opencv(pause_key="w") # 按任意键继续 ``` -#### 设置保存帧数 +#### 📝 设置保存帧数 ```python # 设置保存100帧 webcam_opencv(is_autoSaveFrame=True, auto_frameNum=100) ``` -#### 日志设置 +#### 📝 日志设置 ```python # 日志文件默认保存在项目根目录,ows.log @@ -151,7 +151,7 @@ webcam_opencv(logName="ows02.txt") # 设置日志保存方式,,默认为追加模式 webcam_opencv(logMode="w") # 设置为覆盖模式 ``` -#### 视频帧压缩 +#### 📝 视频帧压缩 ```python # 常规压缩,默认ows.zip(以自动版为例) @@ -168,7 +168,7 @@ webcam_opencv(is_autoSaveFrame=True, is_compress=True, compressMode="a") # 追 webcam_opencv(is_autoSaveFrame=True, is_compress=True, compressStyle="tar", compressMode="w:gz") # tar压缩 ``` -#### 使用参数参考`opencv_webcam.py`源码 +#### 💡 使用参数参考`opencv_webcam.py`源码 ```python def webcam_opencv(device_index="0",