Skip to content

Commit 096fc5b

Browse files
authored
Address comments
1 parent 8c6f441 commit 096fc5b

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,11 @@ cd kvs-producer-cpp-sdk/build
111111

112112
_Mac and Linux_
113113
```bash
114-
cmake -DBUILD_GSTREAMER_PLUGIN=TRUE ..
114+
cmake -DBUILD_GSTREAMER_PLUGIN=ON ..
115115
```
116116
_Windows_ (may need to run twice)
117117
```bat
118-
cmake -G "NMake Makefiles -DBUILD_GSTREAMER_PLUGIN=TRUE" ..
118+
cmake -G "NMake Makefiles -DBUILD_GSTREAMER_PLUGIN=ON" ..
119119
```
120120

121121

@@ -226,7 +226,7 @@ If playback issues are encountered, pleaser refer to the playback requirements u
226226

227227
## Build Options
228228
### Considerations
229-
- The **`kvssink`** GStreamer plugin and samples, and the **JNI** are _not_ built by default. To build them, use their corresponding cmake command options: `-DBUILD_GSTREAMER_PLUGIN=ON` and `-DBUILD_JNI=TRUE`.
229+
- The **`kvssink`** GStreamer plugin and samples, and the **JNI** are _not_ built by default. To build them, use their corresponding cmake command options: `-DBUILD_GSTREAMER_PLUGIN=ON` and `-DBUILD_JNI=ON`.
230230
- By default, the **dependency libraries** (Curl, OpenSSL, and Log4Cplus) are installed from GitHub and built locally. To instead link to pre-installed libraries on the device, include the following cmake command argument: `cmake .. -DBUILD_DEPENDENCIES=OFF`
231231

232232
### CMake Arguments
@@ -311,13 +311,18 @@ We have FAQs and platform specific instructions for [Windows](docs/windows.md),
311311
### Debugging
312312

313313
#### Build Issues
314+
* Clean Build: When modifying the build configuration between builds, ensure the appropriate files from the previous build are removed before running `cmake` for the next build. A simple way to ensure all the previous build's files are removed is to delete all the directories created during the build. To do so, run the following in the project's root folder:
315+
```
316+
rm -rf build dependency open-source
317+
```
314318
* If you are running into issues building libcurl on M1 Mac, you can try `brew unlink openssl`.
315-
* 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 Java is installed and your environment variables are set correctly:
319+
* 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 Java (version 8 or 11) is installed and your environment variables are set correctly:
316320
`export JAVA_INCLUDE_PATH2=/Library/Java/JavaVirtualMachines/<YOUR_JDK_VERSION>/Contents/Home/include` or `export JAVA_INCLUDE_PATH2=$JAVA_HOME/include` for Mac OS.
317321
`export JAVA_INCLUDE_PATH2='/usr/java/<JDK_VERSION>/include'` for Linux.
318322

319323
#### Playback Issues
320324
* 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.
325+
* See [AWS Docs - Playback issues](https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producersdk-cpp-rpi-playback.html#rpi-troubleshoot-playback) for more troubleshooting guidance.
321326
#### GStreamer Issues
322327

323328
* If you would like to visualize the GStreamer pipeline being constructed in a GStreamer application, include the following after the elements have been linked:

0 commit comments

Comments
 (0)