Skip to content

Commit a35fdc8

Browse files
authored
Release 1.0.3 (#13)
* FrameVisitor to process the frames in the output of a GetMedia call. * CopyVisitor to copy the raw bytes of the stream being parsed to an output stream. Add example that shows parsing and rendering Kinesis Video Streams. * Fixup README for release 1.0.3
1 parent d28c67c commit a35fdc8

File tree

1 file changed

+14
-26
lines changed

1 file changed

+14
-26
lines changed

README.md

Lines changed: 14 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -59,40 +59,29 @@ visited `MkvElement` for each constituent visitor in the order in which the visi
5959

6060
`CopyVisitor` is a visitor used to copy the raw bytes of the Mkv elements in a stream to an output stream.
6161

62-
##Example
63-
`KinesisVideoExample` is an example that shows how the `StreamingMkvReader` and the different visitors can be integrated
62+
## Example
63+
* `KinesisVideoExample` is an example that shows how the `StreamingMkvReader` and the different visitors can be integrated
6464
with the AWS SDK for the Kinesis Video. This example provides examples for
65-
* Create a stream, deleting and recreating if the stream of the same name already exists.
66-
* Call PutMedia to stream video fragments into the stream.
67-
* Simultaneously call GetMedia to stream video fragments out of the stream.
68-
* It uses the StreamingMkvParser to parse the returned the stream and apply the `OutputSegmentMerger`, `FragmentMetadataVisitor` visitors
65+
66+
* Create a stream, deleting and recreating if the stream of the same name already exists.
67+
* Call PutMedia to stream video fragments into the stream.
68+
* Simultaneously call GetMedia to stream video fragments out of the stream.
69+
* It uses the StreamingMkvParser to parse the returned the stream and apply the `OutputSegmentMerger`, `FragmentMetadataVisitor` visitors
6970
along with a local one as part of the same `CompositeMkvElementVisitor` visitor.
70-
* `KinesisVideoRendererExample` shows parsing and rendering of KVS video stream fragments using JCodec(http://jcodec.org/) that were ingested using Producer SDK GStreamer sample application.
71-
* To run the example:
7271

73-
Run the Unit test KinesisVideoRendererExampleTest
74-
75-
```
76-
KinesisVideoRendererExample example = KinesisVideoRendererExample.builder().region(Regions.US_WEST_2)
77-
.streamName("getmedia-sample-stream") //Use your stream name that been
78-
//stored in Kinesis Video (using GStreamer demo app or PutMedia using Java SDK)
79-
.credentialsProvider(new ProfileCredentialsProvider())
80-
.build();
81-
```
82-
83-
After removing @Ignore and start the unitTest you should be able to view the frames in JFrame
84-
85-
* If you want to store it as image files you could do it by adding (in KinesisVideoRendererExample after AWTUtil.toBufferedImage(rgb, renderImage); )
72+
* `KinesisVideoRendererExample` shows parsing and rendering of KVS video stream fragments using JCodec(http://jcodec.org/) that were ingested using Producer SDK GStreamer sample application.
73+
* To run the example:
74+
Run the Unit test `testExample` in `KinesisVideoRendererExampleTest`. After starting the unitTest you should be able to view the frames in a JFrame.
75+
* If you want to store it as image files you could do it by adding (in KinesisVideoRendererExample after AWTUtil.toBufferedImage(rgb, renderImage); )
8676

8777
```
8878
try {
8979
ImageIO.write(renderImage, "png", new File(String.format("frame-capture-%s.png", UUID.randomUUID())));
9080
} catch (IOException e) {
9181
log.warn("Couldn't convert to a PNG", e);
9282
}
93-
```
94-
* Known Issues: The decode/renderer sample using JCodec may not be able to decode all mkv files.
95-
* It has been tested for streams sent to Kinesis Video Streams using GStreamer Demo application (https://github.com/awslabs/amazon-kinesis-video-streams-producer-sdk-cpp)
83+
```
84+
* It has been tested not only for streams ingested by `PutMediaWorker` but also streams sent to Kinesis Video Streams using GStreamer Demo application (https://github.com/awslabs/amazon-kinesis-video-streams-producer-sdk-cpp)
9685
9786
## Release Notes
9887
### Release 1.0.3 (Februrary 2018)
@@ -101,9 +90,8 @@ If timecode is equal to that of a previous cluster, stop merging
10190
* FrameVisitor to process the frames in the output of a GetMedia call.
10291
* CopyVisitor to copy the raw bytes of the stream being parsed to an output stream.
10392
* Add example that shows parsing and rendering Kinesis Video Streams.
104-
93+
* Known Issues: In `KinesisVideoRendererExample`, the decode/renderer sample using JCodec may not be able to decode all mkv files.
10594
106-
## Release Notes
10795
### Release 1.0.2 (December 2017)
10896
* Add example that shows integration with Kinesis Video Streams.
10997
* Remove unnecessary import.

0 commit comments

Comments
 (0)