Aws::Kinesis::KinesisVideoStreamInterface Class Reference

#include <kinesis_video_stream_interface.h>

Inheritance diagram for Aws::Kinesis::KinesisVideoStreamInterface:

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

Detailed Description

Definition at line 23 of file kinesis_video_stream_interface.h.

Constructor & Destructor Documentation

virtual Aws::Kinesis::KinesisVideoStreamInterface::~KinesisVideoStreamInterface ( )

inlinevirtual

Definition at line 67 of file kinesis_video_stream_interface.h.

Member Function Documentation

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

inlinevirtual

Reimplemented in Aws::Kinesis::KinesisVideoStreamImpl.

Definition at line 63 of file kinesis_video_stream_interface.h.

virtual bool Aws::Kinesis::KinesisVideoStreamInterface::IsReady ( ) const

pure virtual

Returns

true if the stream is ready, false otherwise.

Implemented in Aws::Kinesis::KinesisVideoStreamImpl.

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

pure virtual

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.

Implemented in Aws::Kinesis::KinesisVideoStreamImpl.

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

pure virtual

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.

Implemented in Aws::Kinesis::KinesisVideoStreamImpl.

virtual bool Aws::Kinesis::KinesisVideoStreamInterface::Stop ( )

pure virtual

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.

Implemented in Aws::Kinesis::KinesisVideoStreamImpl.

---

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

• kinesis_video_stream_interface.h