Aws::Kinesis::KinesisVideoStreamImpl Class Reference

#include <kinesis_video_stream_interface.h>

Inheritance diagram for Aws::Kinesis::KinesisVideoStreamImpl:

Public Member Functions
virtual std::shared_ptr< com::amazonaws::kinesis::video::KinesisVideoStream >	GetKinesisVideoStream () override
virtual bool	IsReady () const override
	KinesisVideoStreamImpl (std::shared_ptr< com::amazonaws::kinesis::video::KinesisVideoStream > video_stream)
virtual bool	PutFragmentMetadata (const std::string &name, const std::string &value, bool persistent=true) override
virtual bool	PutFrame (com::amazonaws::kinesis::video::KinesisVideoFrame frame) const override
virtual bool	Stop () override
Public Member Functions inherited from Aws::Kinesis::KinesisVideoStreamInterface
virtual	~KinesisVideoStreamInterface ()

Private Attributes
std::shared_ptr< com::amazonaws::kinesis::video::KinesisVideoStream >	video_stream_

Detailed Description

Definition at line 70 of file kinesis_video_stream_interface.h.

Constructor & Destructor Documentation

Aws::Kinesis::KinesisVideoStreamImpl::KinesisVideoStreamImpl ( std::shared_ptr< com::amazonaws::kinesis::video::KinesisVideoStream >  video_stream )

inline

Definition at line 73 of file kinesis_video_stream_interface.h.

Member Function Documentation

std::shared_ptr< com::amazonaws::kinesis::video::KinesisVideoStream > Aws::Kinesis::KinesisVideoStreamImpl::GetKinesisVideoStream ( )

overridevirtual

Reimplemented from Aws::Kinesis::KinesisVideoStreamInterface.

Definition at line 44 of file kinesis_video_stream_interface.cpp.

bool Aws::Kinesis::KinesisVideoStreamImpl::IsReady ( ) const

overridevirtual

Returns

true if the stream is ready, false otherwise.

Implements Aws::Kinesis::KinesisVideoStreamInterface.

Definition at line 21 of file kinesis_video_stream_interface.cpp.

bool Aws::Kinesis::KinesisVideoStreamImpl::PutFragmentMetadata ( const std::string &  name, const std::string &  value, bool  persistent = true  )

overridevirtual

Appends a "metadata" - a key/value string pair into the stream.

NOTE: The metadata is modeled as MKV tags and are not immediately put into the stream as it might break the fragment. This is a limitation of MKV format as Tags are level 1 elements. Instead, they will be accumulated and inserted in-between the fragments and at the end of the stream.

Parameters

1	name - the metadata name.
2	value - the metadata value.
3	persistent - whether the metadata is persistent.

Implements Aws::Kinesis::KinesisVideoStreamInterface.

Definition at line 37 of file kinesis_video_stream_interface.cpp.

bool Aws::Kinesis::KinesisVideoStreamImpl::PutFrame ( com::amazonaws::kinesis::video::KinesisVideoFrame  frame ) const

overridevirtual

Packages and streams the frame to Kinesis Video service.

Parameters

frame

The frame to be packaged and streamed.

Returns

true if the encoder accepted the frame and false otherwise.

Implements Aws::Kinesis::KinesisVideoStreamInterface.

Definition at line 31 of file kinesis_video_stream_interface.cpp.

bool Aws::Kinesis::KinesisVideoStreamImpl::Stop ( )

overridevirtual

Stops the the stream. Consecutive calls will fail until start is called again.

NOTE: The function is async and will return immediately but the stream buffer will continue emptying until it's finished and the close stream will be called.

Implements Aws::Kinesis::KinesisVideoStreamInterface.

Definition at line 26 of file kinesis_video_stream_interface.cpp.

Member Data Documentation

std::shared_ptr<com::amazonaws::kinesis::video::KinesisVideoStream> Aws::Kinesis::KinesisVideoStreamImpl::video_stream_

private

Definition at line 86 of file kinesis_video_stream_interface.h.

---

The documentation for this class was generated from the following files:

• kinesis_video_stream_interface.h
• kinesis_video_stream_interface.cpp