tutorial pypi update 04

This commit is contained in:
13339479676 2022-01-30 13:03:21 +08:00
parent 74d196396e
commit c507766414
3 changed files with 25 additions and 25 deletions

View File

@ -97,7 +97,7 @@ conda activate ows # Activate the virtual environment
pip install -r ./requirements.txt -U # Install OpenCV Webcam Script
```
- Steps 2 and 3 can also be performed via `setup.sh`
- Steps 2 and 3 can also be performed via [setup.sh](./setup.sh)
```shell
bash ./setup.sh

View File

@ -97,7 +97,7 @@ conda activate ows # 激活虚拟环境
pip install -r ./requirements.txt -U # 安装OpenCV Webcam脚本
```
- 第二步和第三步也可以通过`setup.sh` 执行
- 第二步和第三步也可以通过[setup.sh](./setup.sh) 执行
```shell
bash ./setup.sh

View File

@ -4,9 +4,9 @@
### ⚡ 安装教程
<h3 align="center">🚀 安装教程</h3>
- 第一步:创建虚拟环境
#### 📌 第一步:创建虚拟环境
```shell
# 创建conda虚拟环境以python 3.8为例
@ -14,19 +14,19 @@ conda create -n ows python==3.8 # 虚拟环境名称为ows
conda activate ows # 激活虚拟环境
```
- 第二步安装
#### 📌 第二步:安装
```shell
pip install opencv-webcam-script==0.4.0 # 以0.4.0为例
```
- 注意:`==`后面一定要加**版本号**。如果执行`pip install opencv-webcam-script` 可能安装为测试版,会影响使用。
注意:`==`后面一定要加**版本号**。如果执行`pip install opencv-webcam-script` 可能安装为测试版,会影响使用。
### ⚡ 使用教程
<h3 align="center">⚡ 使用教程</h3>
#### 📝 运行程序
#### 运行程序
```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以自动版为例