Public Member Functions | List of all members
Aws::Kinesis::StreamDefinitionProvider Class Reference

#include <stream_definition_provider.h>

Inheritance diagram for Aws::Kinesis::StreamDefinitionProvider:
Inheritance graph
[legend]

Public Member Functions

virtual KinesisManagerStatus GetCodecPrivateData (const Aws::Client::ParameterPath &prefix, const Aws::Client::ParameterReaderInterface &reader, PBYTE *out_codec_private_data, uint32_t *out_codec_private_data_size) const
 
virtual std::unique_ptr< com::amazonaws::kinesis::video::StreamDefinition > GetStreamDefinition (const Aws::Client::ParameterPath &prefix, const Aws::Client::ParameterReaderInterface &reader, const PBYTE codec_private_data, uint32_t codec_private_data_size) const
 
 ~StreamDefinitionProvider ()=default
 

Detailed Description

Responsible for creating stream definition objects by using a parameter reader to get the relevant data.

See also
https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-data.html

Definition at line 28 of file stream_definition_provider.h.

Constructor & Destructor Documentation

Aws::Kinesis::StreamDefinitionProvider::~StreamDefinitionProvider ( )
default

Member Function Documentation

KinesisManagerStatus Aws::Kinesis::StreamDefinitionProvider::GetCodecPrivateData ( const Aws::Client::ParameterPath prefix,
const Aws::Client::ParameterReaderInterface reader,
PBYTE *  out_codec_private_data,
uint32_t *  out_codec_private_data_size 
) const
virtual

Reads a base64-encoded codecPrivateData using the given Parameter Reader.

Parameters
prefixa ParameterPath object representing the path of the parameter's prefix.
readerimplementing ParameterReaderInterface
out_codec_private_data- newly allocated buffer containing the codec private data.
Note
The pointer remains unchanged in case of an error or if no codec data was provided.
The caller of GetCodecPrivateData is responsible for freeing up this buffer.
Parameters
out_codec_private_data_size- the actual size of the allocated buffer will be stored here.
Returns
kinesis_manager_status_t with KINESIS_MANAGER_SUCCESS on success or if no codec data was provided

Definition at line 32 of file stream_definition_provider.cpp.

unique_ptr< StreamDefinition > Aws::Kinesis::StreamDefinitionProvider::GetStreamDefinition ( const Aws::Client::ParameterPath prefix,
const Aws::Client::ParameterReaderInterface reader,
const PBYTE  codec_private_data,
uint32_t  codec_private_data_size 
) const
virtual

Creates a StreamDefinition by using a given Parameter Reader. Uses sensible defaults in case the parameter is not configured.

See also
https://github.com/awslabs/amazon-kinesis-video-streams-producer-sdk-cpp/blob/master/kinesis-video-producer/src/StreamDefinition.h and https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-data.html
Parameters
prefixa ParameterPath object representing the path of the parameter's prefix.
readerimplementing ParameterReaderInterface
codec_private_datathe picture and sequence parameter sets of the stream (optional).
codec_private_data_sizesize in bytes of codec_private_data.
Returns
unique_ptr to StreamDefinition on success or nullptr on failure.

Reimplemented in StreamDefinitionProviderFullMock.

Definition at line 61 of file stream_definition_provider.cpp.


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


kinesis_manager
Author(s): AWS RoboMaker
autogenerated on Thu Mar 4 2021 03:28:41