Skip to content

Commit 9745591

Browse files
authored
Add ReadMe sections from /master (#1255)
1 parent e9f84ec commit 9745591

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -226,6 +226,28 @@ If playback issues are encountered, pleaser refer to the playback requirements u
226226

227227
<br>
228228

229+
### Using `putEventMetadata` for Events and S3 Image Generation
230+
231+
The image generation feature is available in the _kvs_gstreamer_audio_video_sample.cpp_ sample. To enable it, include the argument `-e <event_option>` where `<event option>` is a string that can be:
232+
233+
- `notification` - for a notification event
234+
- `image` - for an image event
235+
- `both` - for both
236+
237+
The addition of event metadata will begin on the 2nd key frame and recur every 200 key frames. To modify this frequency, you can adjust the sample accordingly.
238+
239+
<br>
240+
241+
### Using a File Source
242+
In the _kvs_gstreamer_audio_video_sample.cpp_ sample, if you would like to upload from a file, include the `-f <file_path>` argument.
243+
244+
<br>
245+
246+
### Running in Offline Mode
247+
By default, the samples run in near-realtime mode. To use offline mode, set `streamInfo.streamCaps.streamingType` to `STREAMING_TYPE_OFFLINE`, where, `streamInfo` is of type `StreamInfo`, `streamCaps` is of type `StreamCaps` and `streamingType` is of type `STREAMING_TYPE`.
248+
249+
<br>
250+
229251
## Build Options
230252
### Considerations
231253
- 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`.

0 commit comments

Comments
 (0)