Skip to content

Commit 867f254

Browse files
Update readme (#744)
* Fix typo in readme * Update Readme Debug section: add solution to cmake error "could not find JNI" Co-authored-by: Hassan Sahibzada <[email protected]>
1 parent 2b9436d commit 867f254

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -83,23 +83,23 @@ You can pass the following options to `cmake ..`.
8383

8484
#### To Include JNI
8585

86-
JNI examples are NOT built by default. If you wish to build JNI you MUST add -DBUILD_JNI=TRUE when running cmake:
86+
JNI examples are NOT built by default. If you wish to build JNI you MUST add `-DBUILD_JNI=TRUE` when running `cmake`:
8787

8888
```
8989
cmake -DBUILD_JNI=TRUE
9090
```
9191

9292
#### To Include Building GStreamer Sample Programs
9393

94-
The GStreamer plugin and samples are NOT built by default. If you wish to build them you MUST add -DBUILD_GSTREAMER_PLUGIN=TRUE when running cmake:
94+
The GStreamer plugin and samples are NOT built by default. If you wish to build them you MUST add `-DBUILD_GSTREAMER_PLUGIN=TRUE` when running cmake:
9595

9696
```
9797
cmake -DBUILD_GSTREAMER_PLUGIN=TRUE ..
9898
```
9999

100100
### Compiling
101101

102-
After running cmake, in the same build directior run make:
102+
After running cmake, in the same build directory run `make`:
103103

104104
```
105105
make
@@ -174,6 +174,9 @@ For examples of common use cases you can look at [Example: Kinesis Video Streams
174174
* The sample docker scripts for RTSP plugin, raspberry pi and linux can be found in the [Kinesis demos repository](https://github.com/aws-samples/amazon-kinesis-video-streams-demos/tree/master/producer-cpp).
175175

176176
## DEBUG
177+
* When building the JNI, if you run into a cmake error `Could NOT find JNI (missing: JAVA_INCLUDE_PATH JAVA_INCLUDE_PATH2 JAVA_AWT_INCLUDE_PATH)`, make sure your environment variables are set correctly:
178+
`export JAVA_INCLUDE_PATH2=/Library/Java/JavaVirtualMachines/<YOUR_JDK_VERSION>/Contents/Home/include` or `export JAVA_INCLUDE_PATH2=$JAVA_HOME/include` for Mac OS.
179+
`export JAVA_INCLUDE_PATH2='/usr/java/<JDK_VERSION>/include'` for Linux.
177180
* If you are successfully streaming but run into issue with playback. You can do `export KVS_DEBUG_DUMP_DATA_FILE_DIR=/path/to/directory` before streaming. Producer will then dump MKV files into that path. The file is exactly what KVS will receive. You can use [MKVToolNIX](https://mkvtoolnix.download/index.html) to check that everything looks correct. You can also try to play the MKV file in compatible players.
178181

179182
## FAQ

0 commit comments

Comments
 (0)