Skip to content

Commit f68a506

Browse files
disa6302disa6302
committed
Pull in frame rate changes from PIC and correct documentation
1 parent e4805c9 commit f68a506

File tree

8 files changed

+49
-79
lines changed

8 files changed

+49
-79
lines changed

‎CMake/Dependencies/libkvscproducer-CMakeLists.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include(ExternalProject)
77
# clone repo only
88
ExternalProject_Add(libkvscproducer-download
99
GIT_REPOSITORY https://github.com/awslabs/amazon-kinesis-video-streams-producer-c.git
10-
GIT_TAG f2a97fe6eaf78cbffd46ccfa5994bee2bebf99bf
10+
GIT_TAG 6e5cbcca5f4ab4ee7a2987465906634237361b14
1111
SOURCE_DIR "${CMAKE_CURRENT_BINARY_DIR}/kvscproducer-src"
1212
BINARY_DIR "${CMAKE_CURRENT_BINARY_DIR}/kvscproducer-build"
1313
CONFIGURE_COMMAND ""

‎docs/linux.md‎

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -102,19 +102,19 @@ gst-launch-1.0 -v v4l2src device=/dev/video0 ! h264parse ! video/x-h264,stream-f
102102
```
103103

104104
##### Running the GStreamer webcam sample application
105-
The sample application `kinesis_video_gstreamer_sample_app` in the `build` directory uses GStreamer pipeline to get video data from the camera. 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.
105+
The sample application `kvs_gstreamer_sample` in the `build` directory uses GStreamer pipeline to get video data from the camera. 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.
106106

107107
```
108-
Usage: AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app <my_stream_name> -w <width> -h <height> -f <framerate> -b <bitrateInKBPS>
108+
Usage: AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_sample <my_stream_name> -w <width> -h <height> -f <framerate> -b <bitrateInKBPS>
109109
```
110110
* **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 support the resolution supplied in command line, then streaming starts; else, it will fail with an error message `Resolution not supported`.
111111
* **B.** If **no resolution is specified**, the sample application will try to use these three resolutions **640x480, 1280x720 and 1920x1080** and will **start streaming** once the camera supported resolution is detected.
112112

113113
##### Running the GStreamer RTSP sample application
114-
`kinesis_video_gstreamer_sample_app` supports sending video from a RTSP URL (IP camera). You can find the RTSP URL from your IP camera manual or manufacturers product page. Change your current working direcctory to `build` directory. Launch it with a stream name and `rtsp_url` and it will start streaming.
114+
`kvs_gstreamer_sample` supports sending video from a RTSP URL (IP camera). You can find the RTSP URL from your IP camera manual or manufacturers product page. Change your current working direcctory to `build` directory. Launch it with a stream name and `rtsp_url` and it will start streaming.
115115

116116
```
117-
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app <my-rtsp-stream> <my_rtsp_url>
117+
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_sample <my-rtsp-stream> <my_rtsp_url>
118118
```
119119

120120
##### Running the GStreamer sample application to upload a *video* file
@@ -124,22 +124,22 @@ AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./ki
124124
Change your current working directory to `build`. Launch the sample application with a stream name and a path to the file and it will start streaming.
125125

126126
```
127-
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app <my-stream> </path/to/file>
127+
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_sample <my-stream> </path/to/file>
128128
```
129129

130130
##### Running the GStreamer sample application to upload a *audio and video* file
131131

132-
`kinesis_video_gstreamer_audio_video_sample_app` supports uploading a video that is either MKV, MPEGTS, or MP4. The sample application expects the video is encoded in H264 and audio is encoded in AAC format. Note: If your media uses a different format, then you can revise the pipeline elements in the sample application to suit your media format.
132+
`kvs_gstreamer_audio_video_sample` supports uploading a video that is either MKV, MPEGTS, or MP4. The sample application expects the video is encoded in H264 and audio is encoded in AAC format. Note: If your media uses a different format, then you can revise the pipeline elements in the sample application to suit your media format.
133133

134134
Change your current working directory to `build`. Launch the sample application with a stream name and a path to the file and it will start streaming.
135135

136136
```
137-
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_audio_video_sample_app <my-stream> </path/to/file>
137+
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_audio_video_sample <my-stream> </path/to/file>
138138
```
139139

140140
##### Running the GStreamer sample application to stream audio and video from live source
141141

142-
`kinesis_video_gstreamer_audio_video_sample_app` supports streaming audio and video from live sources such as a audio enabled webcam. First you need to figure out what your audio device is using the steps mentioned above and export it as environment variable like such:
142+
`kvs_gstreamer_audio_video_sample` supports streaming audio and video from live sources such as a audio enabled webcam. First you need to figure out what your audio device is using the steps mentioned above and export it as environment variable like such:
143143

144144
`export AWS_KVS_AUDIO_DEVICE=hw:1,0`
145145

@@ -150,18 +150,9 @@ You can also choose to use other video devices by doing
150150
If no `AWS_KVS_VIDEO_DEVICE` environment variable was detected, the sample application will use the default video device.
151151
After the environment variables are set, launch the sample application with a stream name and it will start streaming.
152152
```
153-
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_audio_video_sample_app <my-stream>
153+
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_audio_video_sample <my-stream>
154154
```
155155

156-
### How to run sample applications for sending H264 video files to KVS
157-
158-
The sample application `kinesis_video_cproducer_video_only_sample` sends h264 video frames inside the folder `kinesis-video-c-producer/samples/h264SampleFrames` to KVS.
159-
The following command sends the video frames in a loop for ten seconds to KVS.
160-
`./kinesis_video_cproducer_video_only_sample YourStreamName 10`
161-
162-
If you want to send H264 files from another folder (`MyH264FramesFolder`) you can run the sample with the following arguments
163-
`./kinesis_video_cproducer_video_only_sample YourStreamName 10 MyH264FramesFolder`
164-
165156
##### Additional examples
166157

167158
For additional examples on using Kinesis Video Streams Java SDK and Kinesis Video Streams Parsing Library refer:

‎docs/macos.md‎

Lines changed: 9 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -64,26 +64,26 @@ gst-launch-1.0 -v avfvideosrc device-index=1 ! videoconvert ! vtenc_h264_hw allo
6464
The sample application `kinesis_video_gstreamer_sample_app` in the `build` directory uses GStreamer pipeline to get video data from the camera. 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.
6565

6666
```
67-
Usage: AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app <my_stream_name> -w <width> -h <height> -f <framerate> -b <bitrateInKBPS>
67+
Usage: AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_sample <my_stream_name> -w <width> -h <height> -f <framerate> -b <bitrateInKBPS>
6868
```
6969
* **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 support the resolution supplied in command line, then streaming starts; else, it will fail with an error message `Resolution not supported`.
7070
* **B.** If **no resolution is specified**, the sample application will try to use these three resolutions **640x480, 1280x720 and 1920x1080** and will **start streaming** once the camera supported resolution is detected.
7171

7272
##### Running the GStreamer RTSP sample application
73-
`kinesis_video_gstreamer_sample_app` supports sending video from a RTSP URL (IP camera). You can find the RTSP URL from your IP camera manual or manufacturers product page. Change your current working direcctory to `build` directory. Launch it with a stream name and `rtsp_url` and it will start streaming.
73+
`kvs_gstreamer_sample` supports sending video from a RTSP URL (IP camera). You can find the RTSP URL from your IP camera manual or manufacturers product page. Change your current working direcctory to `build` directory. Launch it with a stream name and `rtsp_url` and it will start streaming.
7474

7575
```
76-
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app <my-rtsp-stream> <my_rtsp_url>
76+
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_sample <my-rtsp-stream> <my_rtsp_url>
7777
```
7878

7979
##### Running the GStreamer sample application to upload a *video* file
8080

81-
`kinesis_video_gstreamer_sample_app` supports uploading a video that is either MKV, MPEGTS, or MP4. The sample application expects the video is encoded in H264.
81+
`kvs_gstreamer_sample` supports uploading a video that is either MKV, MPEGTS, or MP4. The sample application expects the video is encoded in H264.
8282

8383
Change your current working directory to `build`. Launch the sample application with a stream name and a path to the file and it will start streaming.
8484

8585
```
86-
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app <my-stream> </path/to/file>
86+
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_sample <my-stream> </path/to/file>
8787
```
8888

8989
###### Running the `gst-launch-1.0` command to upload [MKV](https://www.matroska.org/) file that contains both *audio and video* in **Mac-OS**. Note that video should be H264 encoded and audio should be AAC encoded.
@@ -106,17 +106,17 @@ gst-launch-1.0 -v filesrc location="YourAudioVideo.ts" ! tsdemux name=demux ! q
106106

107107
##### Running the GStreamer sample application to upload a *audio and video* file
108108

109-
`kinesis_video_gstreamer_audio_video_sample_app` supports uploading a video that is either MKV, MPEGTS, or MP4. The sample application expects the video is encoded in H264 and audio is encoded in AAC format. Note: If your media uses a different format, then you can revise the pipeline elements in the sample application to suit your media format.
109+
`kvs_gstreamer_audio_video_sample` supports uploading a video that is either MKV, MPEGTS, or MP4. The sample application expects the video is encoded in H264 and audio is encoded in AAC format. Note: If your media uses a different format, then you can revise the pipeline elements in the sample application to suit your media format.
110110

111111
Change your current working directory to `build`. Launch the sample application with a stream name and a path to the file and it will start streaming.
112112

113113
```
114-
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_audio_video_sample_app <my-stream> </path/to/file>
114+
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_audio_video_sample <my-stream> </path/to/file>
115115
```
116116

117117
##### Running the GStreamer sample application to stream audio and video from live source
118118

119-
`kinesis_video_gstreamer_audio_video_sample_app` supports streaming audio and video from live sources such as a audio enabled webcam. First you need to figure out what your audio device is using the steps mentioned above and export it as environment variable like such:
119+
`kvs_gstreamer_audio_video_sample` supports streaming audio and video from live sources such as a audio enabled webcam. First you need to figure out what your audio device is using the steps mentioned above and export it as environment variable like such:
120120

121121
`export AWS_KVS_AUDIO_DEVICE=67`
122122

@@ -127,20 +127,9 @@ You can also choose to use other video devices by doing
127127
If no `AWS_KVS_VIDEO_DEVICE` or `AWS_KVS_AUDIO_DEVICE` environment variable was detected, the sample app will use the default device.
128128
After the environment variables are set, launch the sample application with a stream name and it will start streaming.
129129
```
130-
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_audio_video_sample_app <my-stream>
130+
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_audio_video_sample <my-stream>
131131
```
132132

133-
### How to run sample applications for sending H264 video files to KVS
134-
135-
The sample application `kinesis_video_cproducer_video_only_sample` sends h264 video frames inside the folder `kinesis-video-c-producer/samples/h264SampleFrames` to KVS.
136-
The following command sends the video frames in a loop for ten seconds to KVS.
137-
you can run `./kinesis_video_cproducer_video_only_sample YourStreamName 10`
138-
`./kinesis_video_cproducer_video_only_sample YourStreamName 10`
139-
140-
If you want to send H264 files from another folder (`MyH264FramesFolder`) you can run the sample with the following arguments
141-
`./kinesis_video_cproducer_video_only_sample YourStreamName 10 MyH264FramesFolder`
142-
143-
144133
##### Additional examples
145134
For additional examples on using Kinesis Video Streams Java SDK and Kinesis Video Streams Parsing Library refer:
146135

‎docs/raspberry-pi.md‎

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -129,29 +129,29 @@ gst-launch-1.0 -v v4l2src device=/dev/video0 ! h264parse ! video/x-h264,stream-f
129129
```
130130

131131
##### Running the GStreamer webcam sample application
132-
The sample application `kinesis_video_gstreamer_sample_app` in the `build` directory uses GStreamer pipeline to get video data from the camera. 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.
132+
The sample application `kvs_gstreamer_sample` in the `build` directory uses GStreamer pipeline to get video data from the camera. 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.
133133

134134
```
135-
Usage: AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app <my_stream_name> -w <width> -h <height> -f <framerate> -b <bitrateInKBPS>
135+
Usage: AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_sample <my_stream_name> -w <width> -h <height> -f <framerate> -b <bitrateInKBPS>
136136
```
137137
* **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 support the resolution supplied in command line, then streaming starts; else, it will fail with an error message `Resolution not supported`.
138138
* **B.** If **no resolution is specified**, the sample application will try to use these three resolutions **640x480, 1280x720 and 1920x1080** and will **start streaming** once the camera supported resolution is detected.
139139

140140
##### Running the GStreamer RTSP sample application
141-
`kinesis_video_gstreamer_sample_app` supports sending video from a RTSP URL (IP camera). You can find the RTSP URL from your IP camera manual or manufacturers product page. Change your current working direcctory to `build` directory. Launch it with a stream name and `rtsp_url` and it will start streaming.
141+
`kvs_gstreamer_sample` supports sending video from a RTSP URL (IP camera). You can find the RTSP URL from your IP camera manual or manufacturers product page. Change your current working direcctory to `build` directory. Launch it with a stream name and `rtsp_url` and it will start streaming.
142142

143143
```
144-
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app <my-rtsp-stream> <my_rtsp_url>
144+
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_sample <my-rtsp-stream> <my_rtsp_url>
145145
```
146146

147147
##### Running the GStreamer sample application to upload a *video* file
148148

149-
`kinesis_video_gstreamer_sample_app` supports uploading a video that is either MKV, MPEGTS, or MP4. The sample application expects the video is encoded in H264.
149+
`kvs_gstreamer_sample` supports uploading a video that is either MKV, MPEGTS, or MP4. The sample application expects the video is encoded in H264.
150150

151151
Change your current working directory to `build`. Launch the sample application with a stream name and a path to the file and it will start streaming.
152152

153153
```
154-
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_sample_app <my-stream> </path/to/file>
154+
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_sample <my-stream> </path/to/file>
155155
```
156156

157157
###### Running the `gst-launch-1.0` command to upload [MKV](https://www.matroska.org/) file that contains both *audio and video* in **Raspberry-PI**. Note that video should be H264 encoded and audio should be AAC encoded.
@@ -179,12 +179,12 @@ gst-launch-1.0 -v filesrc location="YourAudioVideo.ts" ! tsdemux name=demux ! q
179179
Change your current working directory to `build`. Launch the sample application with a stream name and a path to the file and it will start streaming.
180180

181181
```
182-
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_audio_video_sample_app <my-stream> </path/to/file>
182+
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_audio_video_sample <my-stream> </path/to/file>
183183
```
184184

185185
##### Running the GStreamer sample application to stream audio and video from live source
186186

187-
`kinesis_video_gstreamer_audio_video_sample_app` supports streaming audio and video from live sources such as a audio enabled webcam. First you need to figure out what your audio device is using the steps mentioned above and export it as environment variable like such:
187+
`kvs_gstreamer_audio_video_sample` supports streaming audio and video from live sources such as a audio enabled webcam. First you need to figure out what your audio device is using the steps mentioned above and export it as environment variable like such:
188188

189189
`export AWS_KVS_AUDIO_DEVICE=hw:1,0`
190190

@@ -195,18 +195,9 @@ You can also choose to use other video devices by doing
195195
If no `AWS_KVS_VIDEO_DEVICE` environment variable was detected, the sample application will use the default video device.
196196
After the environment variables are set, launch the sample application with a stream name and it will start streaming.
197197
```
198-
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kinesis_video_gstreamer_audio_video_sample_app <my-stream>
198+
AWS_ACCESS_KEY_ID=YourAccessKeyId AWS_SECRET_ACCESS_KEY=YourSecretAccessKey ./kvs_gstreamer_audio_video_sample <my-stream>
199199
```
200200

201-
### How to run sample applications for sending H264 video files to KVS
202-
203-
The sample application `kinesis_video_cproducer_video_only_sample` sends h264 video frames inside the folder `kinesis-video-c-producer/samples/h264SampleFrames` to KVS.
204-
The following command sends the video frames in a loop for ten seconds to KVS.
205-
`./kinesis_video_cproducer_video_only_sample YourStreamName 10`
206-
207-
If you want to send H264 files from another folder (`MyH264FramesFolder`) you can run the sample with the following arguments
208-
`./kinesis_video_cproducer_video_only_sample YourStreamName 10 MyH264FramesFolder`
209-
210201
##### Additional examples
211202

212203
For additional examples on using Kinesis Video Streams Java SDK and Kinesis Video Streams Parsing Library refer:

0 commit comments

Comments
 (0)