Aws::Kinesis Namespace Reference

Namespaces
	Model

Classes
class	DefaultClientCallbackProvider
class	DefaultStreamCallbackProvider
class	KinesisClientFacade
class	KinesisStreamManager
class	KinesisStreamManagerInterface
class	KinesisVideoProducerImpl
class	KinesisVideoProducerInterface
class	KinesisVideoStreamImpl
class	KinesisVideoStreamInterface
class	ProducerSdkAWSCredentialsProvider
class	StreamDefinitionProvider
struct	StreamSubscriptionDescriptor
class	StreamSubscriptionInstaller

Typedefs
typedef enum Aws::Kinesis::kinesis_manager_status_e	KinesisManagerStatus
typedef int	KinesisStreamInputType
typedef std::function< bool(const StreamSubscriptionDescriptor &descriptor)>	SubscriberSetupFn

Enumerations
enum	kinesis_manager_status_e {   KINESIS_MANAGER_STATUS_SUCCESS = 0, KINESIS_MANAGER_STATUS_ERROR_BASE = 0x1000, KINESIS_MANAGER_STATUS_BASE64DECODE_FAILED, KINESIS_MANAGER_STATUS_MALLOC_FAILED,   KINESIS_MANAGER_STATUS_INVALID_INPUT, KINESIS_MANAGER_STATUS_CREATESTREAMSYNC_FAILED, KINESIS_MANAGER_STATUS_PUTFRAME_STREAM_NOT_FOUND, KINESIS_MANAGER_STATUS_PUTFRAME_FAILED,   KINESIS_MANAGER_STATUS_PUTMETADATA_STREAM_NOT_FOUND, KINESIS_MANAGER_STATUS_PUTMETADATA_FAILED, KINESIS_MANAGER_STATUS_VIDEO_PRODUCER_NOT_INITIALIZED, KINESIS_MANAGER_STATUS_VIDEO_PRODUCER_ALREADY_INITIALIZED,   KINESIS_MANAGER_STATUS_DEFAULT_CREDENTIAL_PROVIDER_CREATION_FAILED, KINESIS_MANAGER_STATUS_EMPTY_STREAM_NAME, KINESIS_MANAGER_STATUS_STREAM_ALREADY_EXISTS, KINESIS_MANAGER_STATUS_SUBSCRIPTION_INSTALLATION_FAILED,   KINESIS_MANAGER_STATUS_SUBSCRIPTION_INSTALLER_NOT_FOUND, KINESIS_MANAGER_STATUS_PROCESS_CODEC_DATA_STREAM_CONFIG_NOT_FOUND, KINESIS_MANAGER_STATUS_GET_STREAM_DEFINITION_FAILED, KINESIS_MANAGER_STATUS_NO_STREAMS_SPECIFIED,   KINESIS_MANAGER_STATUS_LIST_SHARDS_FAILED, KINESIS_MANAGER_STATUS_LIST_SHARDS_EMPTY, KINESIS_MANAGER_STATUS_GET_SHARD_ITERATOR_FAILED, KINESIS_MANAGER_STATUS_GET_RECORDS_FAILED,   KINESIS_MANAGER_STATUS_GET_RECORDS_THROTTLED }

Functions
std::unique_ptr< com::amazonaws::kinesis::video::CredentialProvider >	CreateDefaultCredentialProvider ()
Aws::Client::ParameterPath	GetKinesisVideoParameter (const char *parameter_name)
Aws::Client::ParameterPath	GetStreamParameterPath (int stream_idx, const char *parameter_name)
Aws::Client::ParameterPath	GetStreamParameterPrefix (int stream_idx)

Variables
constexpr uint32_t	kDefaultMessageQueueSize = 1000
constexpr uint16_t	kDefaultRecordsLimitForRekognitionResults = 50
struct {
const char *   Aws::Kinesis::log4cplus_config
const char *   Aws::Kinesis::message_queue_size
const char *   Aws::Kinesis::prefix
const char *   Aws::Kinesis::rekognition_data_stream
const char *   Aws::Kinesis::rekognition_topic_name
const char *   Aws::Kinesis::stream_count
const char *   Aws::Kinesis::stream_name
const char *   Aws::Kinesis::stream_namespace
const char *   Aws::Kinesis::topic_name
const char *   Aws::Kinesis::topic_type
}	kinesis_video
struct {
const char *   Aws::Kinesis::log4cplus_config
const char *   Aws::Kinesis::message_queue_size
const char *   Aws::Kinesis::prefix
const char *   Aws::Kinesis::rekognition_data_stream
const char *   Aws::Kinesis::rekognition_topic_name
const char *   Aws::Kinesis::stream_count
const char *   Aws::Kinesis::stream_name
const char *   Aws::Kinesis::stream_namespace
const char *   Aws::Kinesis::topic_name
const char *   Aws::Kinesis::topic_type
}	stream
struct {
const char *   Aws::Kinesis::log4cplus_config
const char *   Aws::Kinesis::message_queue_size
const char *   Aws::Kinesis::prefix
const char *   Aws::Kinesis::rekognition_data_stream
const char *   Aws::Kinesis::rekognition_topic_name
const char *   Aws::Kinesis::stream_count
const char *   Aws::Kinesis::stream_name
const char *   Aws::Kinesis::stream_namespace
const char *   Aws::Kinesis::topic_name
const char *   Aws::Kinesis::topic_type
}	subscription_queue_size
struct {
const char *   Aws::Kinesis::log4cplus_config
const char *   Aws::Kinesis::message_queue_size
const char *   Aws::Kinesis::prefix
const char *   Aws::Kinesis::rekognition_data_stream
const char *   Aws::Kinesis::rekognition_topic_name
const char *   Aws::Kinesis::stream_count
const char *   Aws::Kinesis::stream_name
const char *   Aws::Kinesis::stream_namespace
const char *   Aws::Kinesis::topic_name
const char *   Aws::Kinesis::topic_type
}	subscription_topic

Typedef Documentation

typedef enum Aws::Kinesis::kinesis_manager_status_e Aws::Kinesis::KinesisManagerStatus

typedef int Aws::Kinesis::KinesisStreamInputType

Definition at line 57 of file common.h.

typedef std::function<bool(const StreamSubscriptionDescriptor & descriptor)> Aws::Kinesis::SubscriberSetupFn

Definition at line 35 of file stream_subscription_installer.h.

Enumeration Type Documentation

enum Aws::Kinesis::kinesis_manager_status_e

Enumerator
KINESIS_MANAGER_STATUS_SUCCESS
KINESIS_MANAGER_STATUS_ERROR_BASE
KINESIS_MANAGER_STATUS_BASE64DECODE_FAILED
KINESIS_MANAGER_STATUS_MALLOC_FAILED
KINESIS_MANAGER_STATUS_INVALID_INPUT
KINESIS_MANAGER_STATUS_CREATESTREAMSYNC_FAILED
KINESIS_MANAGER_STATUS_PUTFRAME_STREAM_NOT_FOUND
KINESIS_MANAGER_STATUS_PUTFRAME_FAILED
KINESIS_MANAGER_STATUS_PUTMETADATA_STREAM_NOT_FOUND
KINESIS_MANAGER_STATUS_PUTMETADATA_FAILED
KINESIS_MANAGER_STATUS_VIDEO_PRODUCER_NOT_INITIALIZED
KINESIS_MANAGER_STATUS_VIDEO_PRODUCER_ALREADY_INITIALIZED
KINESIS_MANAGER_STATUS_DEFAULT_CREDENTIAL_PROVIDER_CREATION_FAILED
KINESIS_MANAGER_STATUS_EMPTY_STREAM_NAME
KINESIS_MANAGER_STATUS_STREAM_ALREADY_EXISTS
KINESIS_MANAGER_STATUS_SUBSCRIPTION_INSTALLATION_FAILED
KINESIS_MANAGER_STATUS_SUBSCRIPTION_INSTALLER_NOT_FOUND
KINESIS_MANAGER_STATUS_PROCESS_CODEC_DATA_STREAM_CONFIG_NOT_FOUND
KINESIS_MANAGER_STATUS_GET_STREAM_DEFINITION_FAILED
KINESIS_MANAGER_STATUS_NO_STREAMS_SPECIFIED
KINESIS_MANAGER_STATUS_LIST_SHARDS_FAILED
KINESIS_MANAGER_STATUS_LIST_SHARDS_EMPTY
KINESIS_MANAGER_STATUS_GET_SHARD_ITERATOR_FAILED
KINESIS_MANAGER_STATUS_GET_RECORDS_FAILED
KINESIS_MANAGER_STATUS_GET_RECORDS_THROTTLED

Definition at line 29 of file common.h.

Function Documentation

unique_ptr< CredentialProvider > Aws::Kinesis::CreateDefaultCredentialProvider

(

)

Creates a static CredentialProvider holding a single credential pair with expiration set to AWS_DEFAULT_CREDENTIAL_ROTATION_PERIOD_IN_SECONDS.. The credentials will be loaded from environment variables matching the AWS SDK.

Returns

CredentialProvider

Definition at line 46 of file default_callbacks.cpp.

Aws::Client::ParameterPath Aws::Kinesis::GetKinesisVideoParameter ( const char *  parameter_name )

inline

Use for parameters which live under the global kinesis_video/ namespace rather than under a particular stream (e.g. stream_count).

Definition at line 66 of file kinesis_stream_manager.h.

Aws::Client::ParameterPath Aws::Kinesis::GetStreamParameterPath ( int  stream_idx, const char *  parameter_name  )

inline

Constructs parameter paths for AWS Kinesis applications.

Parameters

stream_idx
parameter_name

Returns

ParameterPath object representing the parameter path, i.e. kinesis_video/stream<stream_idx>/<parameter_name>

Note

calling GetStreamParameterPath with negative stream index would result in construction of a global parameter path, rather than one that's related to a specific stream. This is appropriate for parameters such as "stream_count".

Definition at line 42 of file kinesis_stream_manager.h.

Aws::Client::ParameterPath Aws::Kinesis::GetStreamParameterPrefix ( int  stream_idx )

inline

Use to retrieve the prefix path for a given stream, i.e. "kinesis_video/stream5/" for stream_idx=5

Definition at line 58 of file kinesis_stream_manager.h.

Variable Documentation

constexpr uint32_t Aws::Kinesis::kDefaultMessageQueueSize = 1000

Definition at line 58 of file common.h.

constexpr uint16_t Aws::Kinesis::kDefaultRecordsLimitForRekognitionResults = 50

Definition at line 59 of file common.h.

const { ... } Aws::Kinesis::kinesis_video

The following structure represents the format in which parameters for the streamer node are expected. kinesis_video/ stream_count: int stream<idx>/ subscription_topic: string subscription_queue_size: optional int, defaults to 100. topic_type: int in range of KinesisStreamInputType < StreamDefinition parameters as defined in https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/how-data.html#how-data-header-streamdefinition

... more streams ...

const { ... } Aws::Kinesis::log4cplus_config

Definition at line 79 of file common.h.

const char* Aws::Kinesis::message_queue_size

Definition at line 77 of file common.h.

const char* Aws::Kinesis::prefix

Definition at line 73 of file common.h.

const { ... } Aws::Kinesis::rekognition_data_stream

Definition at line 82 of file common.h.

const { ... } Aws::Kinesis::rekognition_topic_name

Definition at line 81 of file common.h.

const { ... } Aws::Kinesis::stream

const { ... } Aws::Kinesis::stream_count

Definition at line 74 of file common.h.

const { ... } Aws::Kinesis::stream_name

Definition at line 80 of file common.h.

const char* Aws::Kinesis::stream_namespace

Definition at line 75 of file common.h.

const { ... } Aws::Kinesis::subscription_queue_size

const { ... } Aws::Kinesis::subscription_topic

const char* Aws::Kinesis::topic_name

Definition at line 76 of file common.h.

const { ... } Aws::Kinesis::topic_type

Definition at line 78 of file common.h.