Skip to content

Commit

Permalink
Update descriptions in README [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
@sarxos
sarxos committed Jun 24, 2014
1 parent 29aad01 commit 2c828ab
Show file tree
Hide file tree
Showing 5 changed files with 185 additions and 74 deletions.
11 changes: 6 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,15 @@ Below is the newest stable version ZIP containing main project
JAR with additional documents, examples and all required 3rd-party
dependencies:

* **Latest stable version** - [webcam-capture-0.3.10-RC6-dist.zip](http://www.sarxos.pl/repo/maven2/com/github/sarxos/webcam-capture/0.3.10-RC6/webcam-capture-0.3.10-RC6-dist.zip)
* **Latest stable version** - [webcam-capture-0.3.10-RC7-dist.zip](https://github.com/sarxos/webcam-capture/releases/download/webcam-capture-parent-0.3.10-RC7/webcam-capture-0.3.10-RC7-dist.zip)

Other releases:

* Previous stable version - [webcam-capture-0.3.9-dist.zip](http://www.sarxos.pl/repo/maven2/com/github/sarxos/webcam-capture/0.3.9/webcam-capture-0.3.9-dist.zip)
* Latest SNAPSHOT version - [webcam-capture-0.3.10-SNAPSHOT-dist.zip](http://www.sarxos.pl/repo/maven2/com/github/sarxos/webcam-capture/0.3.10-SNAPSHOT/webcam-capture-0.3.10-SNAPSHOT-dist.zip)
* List of all releases ever made - [click](http://www.sarxos.pl/repo/maven2/index.php?dir=com%2Fgithub%2Fsarxos%2Fwebcam-capture%2F)

The latest development version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.sarxos&a=webcam-capture&v=0.3.10-SNAPSHOT).

## Maven

For those who use Maven and would like to add Webcam Capture dependency
Expand Down Expand Up @@ -59,7 +60,7 @@ in their own projects.
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture</artifactId>
<version>0.3.10-RC6</version>
<version>0.3.10-RC7</version>
</dependency>
```

Expand All @@ -81,8 +82,8 @@ in their own projects.
```

If you would like to use the newest SNAPSHOT version, please be aware -
sometimes it can be unstable. Add the above repository and dependency
into your ```pom.xml```.
sometimes it may be unstable. If you are OK with this, just add the above
repository and dependency into your ```pom.xml```.

## Contribution

Expand Down
60 changes: 40 additions & 20 deletions webcam-capture-drivers/driver-fswebcam/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,46 @@ To install fswebcam:
sudo apt-get install fswebcam
```

## Download

The latest **development** version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.sarxos&a=webcam-capture-driver-fswebcam&v=0.3.10-SNAPSHOT).

The latest **stable** ZIP bundle can be downloaded [here](http://repo.sarxos.pl/maven2/com/github/sarxos/webcam-capture-driver-fswebcam/0.3.10-RC7/webcam-capture-driver-fswebcam-0.3.10-RC7-dist.zip).

## Maven

Stable:

```xml
<repository>
<id>SarXos Repository</id>
<url>http://www.sarxos.pl/repo/maven2</url>
</repository>
```
```xml
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-fswebcam</artifactId>
<version>0.3.10-RC7</version>
</dependency>
```

Snapshot:

```xml
<repository>
<id>Sonatype OSS Snapshot Repository</id>
<url>http://oss.sonatype.org/content/repositories/snapshots</url>
</repository>
```
```xml
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-fswebcam</artifactId>
<version>0.3.10-SNAPSHOT</version>
</dependency>
```

## How To Use

Set capture driver before you start using Webcam class:
Expand Down Expand Up @@ -42,26 +82,6 @@ public class TakePictureExample {
}
```

The snapshot version is available in the Sonatype Snapshot Maven repository:

<repository>
<id>Sonatype OSS Snapshot Repository</id>
<url>http://oss.sonatype.org/content/repositories/snapshots</url>
</repository>

Dependency:

<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-fswebcam</artifactId>
<version>0.3.10-SNAPSHOT</version>
</dependency>

It can be also downloaded manually from:

https://oss.sonatype.org/content/repositories/snapshots/com/github/sarxos/webcam-capture-driver-fswebcam/0.3.10-SNAPSHOT


## Issues

There are several known issues. If you have an idea of how those can
Expand Down
62 changes: 48 additions & 14 deletions webcam-capture-drivers/driver-gstreamer/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,60 @@
# webcam-capture-driver-gstreamer

This is GStreamer driver for Webcam Capture project. It allows Webcam Capture to
handle pictures from build-in or USB-connected webcams. It has been designed to
work with Windows and Linux **only**. To make use of it user have to
[download](http://code.google.com/p/ossbuild/) and install GStreamer application
This is capture driver which gives Webcam Capture API possibility to use
[GStreamer](http://gstreamer.freedesktop.org/documentation/gstreamer010.html)
as a middleware accessing webcam devices (build-in or USB enabled).

It has been designed to work with Windows and Linux **only**. To make use of it user have to
[download](http://code.google.com/p/ossbuild/) GStreamer application installer
on Windows or use _apt-get_, _yum_ or other packages manager to install it on Linux.

Currently supported GStreamer version is 0.10.x, so make sure you are installing
the correct one! It is **not** compatible with GStreamer 1.0 and above!

## Supported

* Windows
* Linux

## Download

Below is the newest stable version ZIP containing main project
JAR with additional documents, examples and all required 3rd-party
dependencies:
The latest **development** version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.sarxos&a=webcam-capture-driver-gstreamer&v=0.3.10-SNAPSHOT).

The latest **stable** version ZIP bundle can be downloaded [here](http://repo.sarxos.pl/maven2/com/github/sarxos/webcam-capture-driver-gstreamer/0.3.10-RC7/webcam-capture-driver-gstreamer-0.3.10-RC7-dist.zip).

## Maven

* **Latest stable version** - [webcam-capture-driver-gstreamer-0.3.10-RC6-dist.zip](http://www.sarxos.pl/repo/maven2/com/github/sarxos/webcam-capture-driver-gstreamer/0.3.10-RC6/webcam-capture-driver-gstreamer-0.3.10-RC6-dist.zip)
Stable:

```xml
<repository>
<id>SarXos Repository</id>
<url>http://www.sarxos.pl/repo/maven2</url>
</repository>
```
```xml
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-gstreamer</artifactId>
<version>0.3.10-RC7</version>
</dependency>
```

Snapshot:

```xml
<repository>
<id>Sonatype OSS Snapshot Repository</id>
<url>http://oss.sonatype.org/content/repositories/snapshots</url>
</repository>
```
```xml
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-gstreamer</artifactId>
<version>0.3.10-SNAPSHOT</version>
</dependency>
```

## Example

Expand All @@ -26,12 +64,8 @@ static {
}

public static void main(String[] args) {

WebcamPanel panel = new WebcamPanel(Webcam.getWebcams().get(0));
panel.setFPSDisplayed(true);

JFrame frame = new JFrame("GStreamer Webcam Capture Driver Demo");
frame.add(panel);
frame.add(new WebcamPanel(Webcam.getDefault()));
frame.pack();
frame.setVisible(true);
frame.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
Expand All @@ -40,7 +74,7 @@ public static void main(String[] args) {

## License

Copyright (C) 2012 - 2013 Bartosz Firyn
Copyright (C) 2012 - 2014 Bartosz Firyn

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
52 changes: 27 additions & 25 deletions webcam-capture-drivers/driver-ipcam/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# webcam-capture-driver-ipcam

This is IP camera driver for Webcam Capture project. It allows Webcam Capture to
This is capture driver which gives Webcam Capture API possibility to
access IP camera devices. It allows it to
handle pictures from IP cameras supporting JPEG and MJPEG (Motion JPEG) compression
and therefore can work in two modes - ```PULL``` for JPEG and ```PUSH``` for MJPEG.
and can work in two modes - ```PULL``` for JPEG and ```PUSH``` for MJPEG.

What are the differences between those two modes:
What are the differences between these two modes:

* ```PULL``` - will request new JPEG image each time when it is required,
* ```PUSH``` - stream Motion JPEG in real time and serve newest image on-demand.
Expand All @@ -24,17 +25,13 @@ help :) Later, when your class is ready, I will be happy to merge it with offici

## Download

Below is the newest stable version ZIP containing main project
JAR with additional documents, examples and all required 3rd-party
dependencies:

* **Latest stable version** - [webcam-capture-driver-ipcam-0.3.10-RC6-dist.zip](http://www.sarxos.pl/repo/maven2/com/github/sarxos/webcam-capture-driver-ipcam/0.3.10-RC6/webcam-capture-driver-ipcam-0.3.10-RC6-dist.zip)
* Previous stable version - [webcam-capture-driver-ipcam-0.3.9-dist.zip](http://www.sarxos.pl/repo/maven2/com/github/sarxos/webcam-capture-driver-ipcam/0.3.9/webcam-capture-driver-ipcam-0.3.9-dist.zip)
The latest **development** version JAR (aka SNAPSHOT) can be downloaded [here](https://oss.sonatype.org/service/local/artifact/maven/redirect?r=snapshots&g=com.github.sarxos&a=webcam-capture-driver-ipcam&v=0.3.10-SNAPSHOT).

The latest **stable** version ZIP bundle can be downloaded [here](http://repo.sarxos.pl/maven2/com/github/sarxos/webcam-capture-driver-ipcam/0.3.10-RC7/webcam-capture-driver-ipcam-0.3.10-RC7-dist.zip).

## Maven

Latest stable version:
Stable:

```xml
<repository>
Expand All @@ -46,7 +43,23 @@ Latest stable version:
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-ipcam</artifactId>
<version>0.3.10-RC6</version>
<version>0.3.10-RC7</version>
</dependency>
```

Snapshot:

```xml
<repository>
<id>Sonatype OSS Snapshot Repository</id>
<url>http://oss.sonatype.org/content/repositories/snapshots</url>
</repository>
```
```xml
<dependency>
<groupId>com.github.sarxos</groupId>
<artifactId>webcam-capture-driver-ipcam</artifactId>
<version>0.3.10-SNAPSHOT</version>
</dependency>
```

Expand All @@ -64,25 +77,14 @@ as MJPEG stream (this is refered as PUSH mode, because camera push new images
to the client as soon as new one is available).

```java
/**
* Remember to add IP camera driver JAR to the application classpath!
* Otherwise you will not be able to use IP camera driver features. Driver
* has to be set at the very beginning, before any webcam-capture related
* method is being invoked.
*/
static {
Webcam.setDriver(new IpCamDriver());
}

public static void main(String[] args) throws MalformedURLException {

IpCamDeviceRegistry.register(new IpCamDevice("Lignano", "http://88.37.116.138/mjpg/video.mjpg", IpCamMode.PUSH));

WebcamPanel panel = new WebcamPanel(Webcam.getWebcams().get(0));
panel.setFPS(1);

JFrame f = new JFrame("Live Views From Lignano Beach");
f.add(panel);
f.add(new WebcamPanel(Webcam.getDefault()));
f.pack();
f.setVisible(true);
f.setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
Expand Down Expand Up @@ -122,7 +124,7 @@ public static void main(String[] args) throws MalformedURLException {
WebcamPanel panel = new WebcamPanel(webcam, new Dimension(256, 144), false);
panel.setFillArea(true);
panel.setFPSLimited(true);
panel.setFPS(0.2); // 0.2 FPS = 1 frame per 5 seconds
panel.setFPS(0.2); // 0.1 FPS = 1 frame per 10 seconds
panel.setBorder(BorderFactory.createEmptyBorder());

f.add(panel);
Expand Down Expand Up @@ -156,7 +158,7 @@ And here is the cameras.xml file used in the above example:

## License

Copyright (C) 2012 Bartosz Firyn
Copyright (C) 2012 - 2014 Bartosz Firyn

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
Loading

0 comments on commit 2c828ab

Please sign in to comment.