Skip to content

Commit 45e6755

Browse files
committed
correcting usage message
1 parent 7c59459 commit 45e6755

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

README.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -36,19 +36,19 @@ Please install the following additional build tools before proceeding with `./in
3636
After you've downloaded the code from GitHub, you can build it on Mac OS or Ubuntu using `./install-script` (which is inside the `kinesis-video-native-build` directory).
3737

3838
**Important** Change *current working directory* to the `kinesis-video-native-build` directory first. Then run the `./install-script` from that directory.
39-
39+
4040
This will produce the core library, the JNI library, unit tests executable and the sample GStreamer application. The script will download and build the dependent open source components in the 'downloads' directory (within `kinesis-video-native-build` directory)and link against it.
41-
41+
4242
#### Build the binaries using system versions
43-
The bulk of the install script is building the open source dependencies. The project is based on **CMake**. So the open source components building can be skipped if the system versions can be used for linking.
43+
The bulk of the install script is building the open source dependencies. The project is based on **CMake**. So the open source components building can be skipped if the system versions can be used for linking.
4444

45-
Running
45+
Running
4646

4747
```
48-
$ cmake .
48+
$ cmake .
4949
$ make
5050
```
51-
from the `kinesis-video-native-build` directory will build and link the SDK.
51+
from the `kinesis-video-native-build` directory will build and link the SDK.
5252
The `./min-install-script` inside the `kinesis-video-native-build` captures these steps for installing the Kinesis Video Streams Producer SDK with the system versions for linking.
5353

5454
#### Build the binaries using the dependent libraries from source
@@ -98,14 +98,14 @@ Many platforms come with a cert file with a lot of the well-known public certs i
9898
## Install Steps for Ubuntu 17.x using apt-get
9999
The following are the steps to install the build-time prerequisites for Ubuntu 17.x
100100

101-
Install **git**:
101+
Install **git**:
102102

103-
```
103+
```
104104
$ sudo apt-get install git
105105
$ git --version
106106
git version 2.14.1
107107
```
108-
Install **cmake**:
108+
Install **cmake**:
109109
```
110110
$ sudo apt-get install cmake
111111
$ cmake --version
@@ -125,7 +125,7 @@ Copyright (C) 2014 Free Software Foundation, Inc.
125125
This is free software; see the source for copying conditions. There is NO
126126
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
127127
```
128-
Install **automake**:
128+
Install **automake**:
129129
```
130130
$ sudo apt-get install automake
131131
$ automake --version
@@ -138,7 +138,7 @@ There is NO WARRANTY, to the extent permitted by law.
138138
Written by Tom Tromey <[email protected]>
139139
and Alexandre Duret-Lutz <[email protected]>.
140140
```
141-
Install **g++**:
141+
Install **g++**:
142142
```
143143
$ sudo apt-get install g++
144144
$ g++ --version
@@ -147,7 +147,7 @@ Copyright (C) 2017 Free Software Foundation, Inc.
147147
This is free software; see the source for copying conditions. There is NO
148148
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
149149
```
150-
Install **curl**:
150+
Install **curl**:
151151
```
152152
$ sudo apt-get install curl
153153
$ curl --version
@@ -156,13 +156,13 @@ Release-Date: 2017-08-14
156156
Protocols: dict file ftp ftps gopher http https imap imaps ldap ldaps pop3 pop3s rtmp rtsp smb smbs smtp smtps telnet tftp
157157
Features: AsynchDNS IDN IPv6 Largefile GSS-API Kerberos SPNEGO NTLM NTLM_WB SSL libz TLS-SRP UnixSockets HTTPS-proxy PSL
158158
```
159-
Install **pkg-config**:
159+
Install **pkg-config**:
160160
```
161161
$ sudo apt-get install pkg-config
162162
$ pkg-config --version
163163
0.29.1
164164
```
165-
Install **flex**:
165+
Install **flex**:
166166
```
167167
$ sudo apt-get install flex
168168
$ flex --version
@@ -179,19 +179,19 @@ Copyright (C) 2015 Free Software Foundation, Inc.
179179
This is free software; see the source for copying conditions. There is NO
180180
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
181181
```
182-
Install **Open JDK**:
182+
Install **Open JDK**:
183183
```
184184
$ sudo apt-get install openjdk-8-jdk
185185
$ java -showversion
186186
openjdk version "1.8.0_151"
187187
OpenJDK Runtime Environment (build 1.8.0_151-8u151-b12-0ubuntu0.17.10.2-b12)
188188
OpenJDK 64-Bit Server VM (build 25.151-b12, mixed mode)
189189
```
190-
Set **JAVA_HOME** environment variable:
190+
Set **JAVA_HOME** environment variable:
191191
```
192192
$ export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64/
193193
```
194-
Run the build script: (within `kinesis-video-native-build` folder)
194+
Run the build script: (within `kinesis-video-native-build` folder)
195195
```
196196
./install-script
197197
```
@@ -214,10 +214,10 @@ optionally, set `AWS_SESSION_TOKEN` if integrating with temporary token and `AWS
214214
The GStreamer demo app will be built in `kinesis_video_gstreamer_sample_app` in the `kinesis-video-native-build` directory. Launch it with a stream name and it will start streaming from the camera. The user can also supply a streaming resolution (width and height) through command line arguments.
215215

216216
```
217-
Usage: AWS_ACCESS_KEY_ID=<SAMPLEKEY> AWS_SECRET_ACCESS_KEY=<SAMPLESECRET> ./kinesis_video_gstreamer_sample_app <my-stream-name> -w <width> -h <height> -f <framerate> -b <bitrateInKBPS>
217+
Usage: AWS_ACCESS_KEY_ID=<SAMPLEKEY> AWS_SECRET_ACCESS_KEY=<SAMPLESECRET> ./kinesis_video_gstreamer_sample_app -w <width> -h <height> -f <framerate> -b <bitrateInKBPS> <my-stream-name>
218218
```
219219
* **A.** If resolution is provided then the sample will try to check if the camera supports that resolution. If it does detect that the camera can supprt the resolution supplied in command line, then streaming starts; else, it will fail with an error msg `Resolution not supported`
220-
220+
221221
* **B.** If no resolution is specified, the demo will try to use these three resolutions **1920x1080, 1280x720 and 640x480** in that order (highest resolution first) and will **start streaming** once the camera supported resolution is detected.
222222

223223
#### GStreamer RTSP demo application
@@ -240,7 +240,7 @@ Define `HEAP_DEBUG` and `LOG_STREAMING` C-defines by uncommenting the appropriat
240240

241241
#### Additional Examples
242242

243-
For additional examples on using Kinesis Video Streams Java SDK and Kinesis Video Streams Parsing Library refer:
243+
For additional examples on using Kinesis Video Streams Java SDK and Kinesis Video Streams Parsing Library refer:
244244

245245
##### [Kinesis Video Streams Producer Java SDK](https://github.com/awslabs/amazon-kinesis-video-streams-producer-sdk-java/blob/master/README.md)
246246
##### [Kinesis Video Streams Parser Library](https://github.com/aws/amazon-kinesis-video-streams-parser-library/blob/master/README.md)
@@ -253,15 +253,15 @@ For additional examples on using Kinesis Video Streams Java SDK and Kinesis Vid
253253
### Troubleshooting
254254

255255
##### Ubuntu builds link issues
256-
Ubuntu bulds link against the system versions of the open source component libraries or missing .so files (./start in the kinesis-video-native-build directory shows linkage against system versions of the open source libraries).We are working on providing fix but the immediate steps to remedy is to run
256+
Ubuntu bulds link against the system versions of the open source component libraries or missing .so files (./start in the kinesis-video-native-build directory shows linkage against system versions of the open source libraries).We are working on providing fix but the immediate steps to remedy is to run
257257

258258
```
259259
rm -rf ./kinesis-video-native-build/CMakeCache.txt ./kinesis-video-native-build/CMakeFiles
260-
```
261-
and run
260+
```
261+
and run
262262
```
263263
./install-script
264-
```
264+
```
265265
to rebuild and re-link the project only.
266266

267267
##### Raspberry PI failure to load the camera device.
@@ -272,7 +272,7 @@ $ls /dev/video*
272272
{not found}
273273
```
274274
```
275-
$vcgencmd get_camera
275+
$vcgencmd get_camera
276276
```
277277
Example output:
278278
```
@@ -286,7 +286,7 @@ if the driver does not detect the camera then
286286
$sudo modprobe bcm2835-v4l2
287287
```
288288
```
289-
$ls /dev/video*
289+
$ls /dev/video*
290290
{lists the device}
291291
```
292292

@@ -301,7 +301,7 @@ $ sudo reboot
301301
* Raspberry PI GStreamer assertion on gst_value_set_fraction_range_full: assertion 'gst_util_fraction_compare (numerator_start, denominator_start, numerator_end, denominator_end) < 0' failed. The uv4l service running in the background. Kill the service and restart the sample app.
302302

303303

304-
##### Raspberry PI seg fauls after some time running on `libx264.so`.
304+
##### Raspberry PI seg fauls after some time running on `libx264.so`.
305305
Rebuilding the `libx264.so` library and **re-linking the demo application** fixes the issue.
306306

307307
##### Curl SSL issue - "unable to get local issuer certificate"

0 commit comments

Comments
 (0)