Skip to content

Commit 8c6f441

Browse files
authored
Address comments
1 parent f06c893 commit 8c6f441

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ For more info on KVS please see [AWS KVS Documentation](https://docs.aws.amazon.
4343

4444
## Quick Start
4545
### Required Tools
46-
The following packages are required to build the SDK libraries. Using a package manager such as _Homebrew_ (Mac), _APT_ (Linux), and _Chocolatey_ (Windows) is the prefered method of installation.
46+
The following packages are required to build the SDK libraries. Using a package manager such as [_Homebrew_](https://brew.sh/) (Mac), [_APT_](https://en.wikipedia.org/wiki/APT_(software)) (Linux), and [_Chocolatey_](https://chocolatey.org/install) (Windows) is the prefered method of installation.
4747
* C++ Compiler (GNU or Clang recommended)
4848
* `git`
4949
* `CMake`
@@ -89,7 +89,9 @@ Run the following command to display the GStreamer version to confirm the instal
8989
```bash
9090
gst-launch-1.0 --gst-version
9191
```
92-
92+
`
93+
GStreamer Core Library version 1.24.9
94+
`
9395
<br>
9496

9597
### Download
@@ -118,7 +120,7 @@ cmake -G "NMake Makefiles -DBUILD_GSTREAMER_PLUGIN=TRUE" ..
118120

119121

120122
> [!NOTE]
121-
> For more build configuration options, see [Cmake Arguments](#cmake-arguments).
123+
> For more build configuration options, see [CMake Arguments](#cmake-arguments).
122124
123125
#### Compile:
124126
_Mac and Linux_
@@ -156,7 +158,7 @@ export AWS_SESSION_TOKEN=YourSessionToken
156158
<br>
157159

158160
#### GStreamer `appsink` Samples
159-
To stream media from the device's camera and audio sources, create a stream in the [AWS KVS console](https://console.aws.amazon.com/kinesisvideo/home) and run the following sample:
161+
To stream media from the device's camera and microphone sources, create a stream in the [AWS KVS console](https://console.aws.amazon.com/kinesisvideo/home) and run the following sample:
160162
```bash
161163
./kvs_gstreamer_audio_video_sample <your-stream-name>
162164
```
@@ -224,9 +226,8 @@ If playback issues are encountered, pleaser refer to the playback requirements u
224226

225227
## Build Options
226228
### Considerations
227-
- The **`kvssink`** GStreamer plugin and samples, and the **JNI** are _not_ built by default. To build them, include their corresponding cmake command arguments: `cmake .. -DBUILD_GSTREAMER_PLUGIN=ON -DBUILD_JNI=TRUE`
228-
- By default, the **dependency libraries** 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`
229-
- The dependency libraries are Curl, OpenSSL, and Log4Cplus.
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`.
230+
- 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`
230231

231232
### CMake Arguments
232233
You can pass the following additional CMake options:

0 commit comments

Comments
 (0)