Skip to content

Commit 99ec126

Browse files
committed
Update README.md
1 parent 4762b42 commit 99ec126

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

+20-12
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
[![wercker status](https://app.wercker.com/status/4db748e2b586121e924f83ef991a5f7b/s "wercker status")](https://app.wercker.com/project/bykey/4db748e2b586121e924f83ef991a5f7b)
22

3-
# OpenCV plug-in for SensorBee
3+
# OpenCV plugin for SensorBee
44

5-
This plug-in is a library to use [OpenCV](http://opencv.org) library, User can use a part of OpenCV functions. For example user can create source component to generate stream video capturing.
5+
This is the [OpenCV](http://opencv.org) plugin for SensorBee.
66

7-
# Require
7+
This plugin currently supports following features of OpenCV:
88

9-
* OpenCV
10-
* attention that ffmpeg version.
11-
* ex) Mac OS X `brew install opencv --with-ffmpeg`
9+
* Inputting video stream from a file or a camera
10+
* Encoding JPEG
11+
* Cascade classifier
12+
13+
# Requirements
14+
15+
* OpenCV with ffmpeg enabled for video input sources
16+
* Example on Mac OS X: `brew install homebrew/science/opencv --with-ffmpeg`
1217
* SensorBee
13-
* later v0.5
18+
* v0.5 or later
1419

1520
# Usage
1621

17-
## Registering plug-in
22+
## Plugin Registration
1823

19-
`build_sensorbee` with build.yaml set `gopkg.in/sensorbee/opencv.v0/plugin`
24+
Add `gopkg.in/sensorbee/opencv.v0/plugin` to build.yaml for the `build_sensorbee` command.
2025

2126
### build.yaml
2227

@@ -25,9 +30,9 @@ plugins:
2530
- gopkg.in/sensorbee/opencv.v0/plugin
2631
```
2732
28-
## Using from BQLs sample
33+
## BQL examples
2934
30-
### Capturing video source and streaming frames
35+
### Capturing frames from a video file
3136
3237
```sql
3338
-- capturing
@@ -36,8 +41,11 @@ CREATE PAUSED SOURCE camera1_avi TYPE opencv_capture_from_uri WITH
3641
frame_skip=4, next_frame_error=false;
3742
```
3843

39-
will start generating stream from "video/camera1.avi" after execute `RESUME` query.
44+
This source will start generating a stream from "video/camera1.avi" after executing `RESUME` query.
4045

4146
```
4247
RESUME SOURCE camera1_avi;
4348
```
49+
50+
Note that `PAUSED` should not be specified when capturing from a webcam, which
51+
keeps generating a video stream.

0 commit comments

Comments
 (0)