Amazon Kinesis Producer C SDK
Classes | Macros | Typedefs | Enumerations | Functions
Include.h File Reference
#include <com/amazonaws/kinesis/video/client/Include.h>
#include <com/amazonaws/kinesis/video/common/Include.h>
Include dependency graph for Include.h:

Go to the source code of this file.

Classes

struct  __PlatformCallbacks
 
struct  __ProducerCallbacks
 
struct  __StreamCallbacks
 
struct  __AuthCallbacks
 
struct  __ApiCallbacks
 

Macros

#define STATUS_PRODUCER_BASE   0x15000000
 
#define STATUS_STOP_CALLBACK_CHAIN   STATUS_PRODUCER_BASE + 0x00000001
 
#define STATUS_MAX_CALLBACK_CHAIN   STATUS_PRODUCER_BASE + 0x00000002
 
#define STATUS_INVALID_PLATFORM_CALLBACKS_VERSION   STATUS_PRODUCER_BASE + 0x00000003
 
#define STATUS_INVALID_PRODUCER_CALLBACKS_VERSION   STATUS_PRODUCER_BASE + 0x00000004
 
#define STATUS_INVALID_STREAM_CALLBACKS_VERSION   STATUS_PRODUCER_BASE + 0x00000005
 
#define STATUS_INVALID_AUTH_CALLBACKS_VERSION   STATUS_PRODUCER_BASE + 0x00000006
 
#define STATUS_INVALID_API_CALLBACKS_VERSION   STATUS_PRODUCER_BASE + 0x00000007
 
#define STATUS_INVALID_DESCRIBE_STREAM_RETURN_JSON   STATUS_PRODUCER_BASE + 0x0000000f
 
#define STATUS_MAX_USER_AGENT_NAME_POSTFIX_LEN_EXCEEDED   STATUS_PRODUCER_BASE + 0x00000013
 
#define STATUS_MAX_CUSTOM_USER_AGENT_LEN_EXCEEDED   STATUS_PRODUCER_BASE + 0x00000014
 
#define STATUS_INVALID_ENDPOINT_CACHING_PERIOD   STATUS_PRODUCER_BASE + 0x00000016
 
#define STATUS_DUPLICATE_PRODUCER_CALLBACK_FREE_FUNC   STATUS_PRODUCER_BASE + 0x00000019
 
#define STATUS_DUPLICATE_STREAM_CALLBACK_FREE_FUNC   STATUS_PRODUCER_BASE + 0x0000001a
 
#define STATUS_DUPLICATE_AUTH_CALLBACK_FREE_FUNC   STATUS_PRODUCER_BASE + 0x0000001b
 
#define STATUS_DUPLICATE_API_CALLBACK_FREE_FUNC   STATUS_PRODUCER_BASE + 0x0000001c
 
#define STATUS_FILE_LOGGER_INDEX_FILE_TOO_LARGE   STATUS_PRODUCER_BASE + 0x0000001d
 
#define STATUS_STREAM_BEING_SHUTDOWN   STATUS_PRODUCER_BASE + 0x00000026
 
#define STATUS_CLIENT_BEING_SHUTDOWN   STATUS_PRODUCER_BASE + 0x00000027
 
#define STATUS_CONTINUOUS_RETRY_RESET_FAILED   STATUS_PRODUCER_BASE + 0x00000028
 
#define IS_RETRIABLE_PRODUCER_ERROR(error)    ((error) == STATUS_INVALID_DESCRIBE_STREAM_RETURN_JSON || (error) == STATUS_STREAM_BEING_SHUTDOWN || (error) == STATUS_CLIENT_BEING_SHUTDOWN)
 
#define MAX_CALLBACK_CHAIN_COUNT   20
 
#define DEFAULT_CALLBACK_CHAIN_COUNT   5
 
#define PRODUCER_CALLBACKS_CURRENT_VERSION   0
 
#define PLATFORM_CALLBACKS_CURRENT_VERSION   0
 
#define STREAM_CALLBACKS_CURRENT_VERSION   0
 
#define AUTH_CALLBACKS_CURRENT_VERSION   0
 
#define API_CALLBACKS_CURRENT_VERSION   0
 

Typedefs

typedef STATUS(* FreePlatformCallbacksFunc) (PUINT64)
 Frees platform callbacks. More...
 
typedef STATUS(* FreeProducerCallbacksFunc) (PUINT64)
 Frees producer callbacks. More...
 
typedef STATUS(* FreeStreamCallbacksFunc) (PUINT64)
 Frees stream callbacks. More...
 
typedef STATUS(* FreeAuthCallbacksFunc) (PUINT64)
 Frees auth callbacks. More...
 
typedef STATUS(* FreeApiCallbacksFunc) (PUINT64)
 Frees API callbacks. More...
 
typedef struct __PlatformCallbacks PlatformCallbacks
 The Platform specific callbacks. More...
 
typedef struct __PlatformCallbacks * PPlatformCallbacks
 
typedef struct __ProducerCallbacks ProducerCallbacks
 The Producer object specific callbacks. More...
 
typedef struct __ProducerCallbacks * PProducerCallbacks
 
typedef struct __StreamCallbacks StreamCallbacks
 The Stream specific callbacks. More...
 
typedef struct __StreamCallbacks * PStreamCallbacks
 
typedef struct __AuthCallbacks AuthCallbacks
 The Authentication specific callbacks. More...
 
typedef struct __AuthCallbacks * PAuthCallbacks
 
typedef struct __ApiCallbacks ApiCallbacks
 The KVS backend specific callbacks. More...
 
typedef struct __ApiCallbacks * PApiCallbacks
 

Enumerations

enum  API_CALL_CACHE_TYPE { API_CALL_CACHE_TYPE_NONE , API_CALL_CACHE_TYPE_ENDPOINT_ONLY , API_CALL_CACHE_TYPE_ALL }
 

Functions

PUBLIC_API STATUS createDefaultCallbacksProviderWithAwsCredentials (PCHAR, PCHAR, PCHAR, UINT64, PCHAR, PCHAR, PCHAR, PCHAR, PClientCallbacks *)
 
PUBLIC_API STATUS createDefaultCallbacksProviderWithIotCertificate (PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PClientCallbacks *)
 
PUBLIC_API STATUS createDefaultCallbacksProviderWithIotCertificateAndTimeouts (PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, UINT64, UINT64, PClientCallbacks *)
 
PUBLIC_API STATUS createDefaultCallbacksProviderWithFileAuth (PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PClientCallbacks *)
 
PUBLIC_API STATUS createDefaultCallbacksProviderWithAuthCallbacks (PAuthCallbacks, PCHAR, PCHAR, PCHAR, PCHAR, PClientCallbacks *)
 
PUBLIC_API STATUS freeCallbacksProvider (PClientCallbacks *)
 
PUBLIC_API STATUS setPlatformCallbacks (PClientCallbacks, PPlatformCallbacks)
 
PUBLIC_API STATUS addProducerCallbacks (PClientCallbacks, PProducerCallbacks)
 
PUBLIC_API STATUS addStreamCallbacks (PClientCallbacks, PStreamCallbacks)
 
PUBLIC_API STATUS addAuthCallbacks (PClientCallbacks, PAuthCallbacks)
 
PUBLIC_API STATUS addApiCallbacks (PClientCallbacks, PApiCallbacks)
 
PUBLIC_API STATUS createRealtimeVideoStreamInfoProvider (PCHAR, UINT64, UINT64, PStreamInfo *)
 
PUBLIC_API STATUS createOfflineVideoStreamInfoProvider (PCHAR, UINT64, UINT64, PStreamInfo *)
 
PUBLIC_API STATUS createRealtimeAudioVideoStreamInfoProvider (PCHAR, UINT64, UINT64, PStreamInfo *)
 
PUBLIC_API STATUS createOfflineAudioVideoStreamInfoProvider (PCHAR, UINT64, UINT64, PStreamInfo *)
 
PUBLIC_API STATUS createRealtimeVideoStreamInfoProviderWithCodecs (PCHAR, UINT64, UINT64, VIDEO_CODEC_ID, PStreamInfo *)
 
PUBLIC_API STATUS createOfflineVideoStreamInfoProviderWithCodecs (PCHAR, UINT64, UINT64, VIDEO_CODEC_ID, PStreamInfo *)
 
PUBLIC_API STATUS createRealtimeAudioVideoStreamInfoProviderWithCodecs (PCHAR, UINT64, UINT64, VIDEO_CODEC_ID, AUDIO_CODEC_ID, PStreamInfo *)
 
PUBLIC_API STATUS createOfflineAudioVideoStreamInfoProviderWithCodecs (PCHAR, UINT64, UINT64, VIDEO_CODEC_ID, AUDIO_CODEC_ID, PStreamInfo *)
 
PUBLIC_API STATUS createRealtimeAudioStreamInfoProviderWithCodecs (PCHAR, UINT64, UINT64, AUDIO_CODEC_ID, PStreamInfo *)
 
PUBLIC_API STATUS createOfflineAudioStreamInfoProviderWithCodecs (PCHAR, UINT64, UINT64, AUDIO_CODEC_ID, PStreamInfo *)
 
PUBLIC_API STATUS setStreamInfoBasedOnStorageSize (UINT32, UINT64, UINT32, PStreamInfo)
 
PUBLIC_API STATUS freeStreamInfoProvider (PStreamInfo *)
 
PUBLIC_API STATUS createDefaultDeviceInfo (PDeviceInfo *)
 
PUBLIC_API STATUS freeDeviceInfo (PDeviceInfo *)
 
PUBLIC_API STATUS setDeviceInfoStorageSize (PDeviceInfo, UINT64)
 
PUBLIC_API STATUS setDeviceInfoStorageSizeBasedOnBitrateAndBufferDuration (PDeviceInfo, UINT64, UINT64)
 
PUBLIC_API STATUS createIotAuthCallbacks (PClientCallbacks, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PAuthCallbacks *)
 
PUBLIC_API STATUS createIotAuthCallbacksWithTimeouts (PClientCallbacks, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, UINT64, UINT64, PAuthCallbacks *)
 
PUBLIC_API STATUS freeIotAuthCallbacks (PAuthCallbacks *)
 
PUBLIC_API STATUS createFileAuthCallbacks (PClientCallbacks, PCHAR, PAuthCallbacks *)
 
PUBLIC_API STATUS freeFileAuthCallbacks (PAuthCallbacks *)
 
PUBLIC_API STATUS createStaticAuthCallbacks (PClientCallbacks, PCHAR, PCHAR, PCHAR, UINT64, PAuthCallbacks *)
 
PUBLIC_API STATUS freeStaticAuthCallbacks (PAuthCallbacks *)
 
PUBLIC_API STATUS createCredentialProviderAuthCallbacks (PClientCallbacks, PAwsCredentialProvider, PAuthCallbacks *)
 
PUBLIC_API STATUS freeCredentialProviderAuthCallbacks (PAuthCallbacks *)
 
PUBLIC_API STATUS createStreamCallbacks (PStreamCallbacks *)
 
PUBLIC_API STATUS freeStreamCallbacks (PStreamCallbacks *)
 
PUBLIC_API STATUS createContinuousRetryStreamCallbacks (PClientCallbacks, PStreamCallbacks *)
 
PUBLIC_API STATUS freeContinuousRetryStreamCallbacks (PStreamCallbacks *)
 
PUBLIC_API STATUS createAbstractDefaultCallbacksProvider (UINT32, API_CALL_CACHE_TYPE, UINT64, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PClientCallbacks *)
 
PUBLIC_API STATUS addFileLoggerPlatformCallbacksProvider (PClientCallbacks, UINT64, UINT64, PCHAR, BOOL)
 
STATUS addFileLoggerWithFilteringPlatformCallbacksProvider (PClientCallbacks, UINT64, UINT64, PCHAR, BOOL, BOOL, UINT32)
 

Macro Definition Documentation

◆ DEFAULT_CALLBACK_CHAIN_COUNT

#define DEFAULT_CALLBACK_CHAIN_COUNT   5

Default number of the callbacks in the chain

◆ IS_RETRIABLE_PRODUCER_ERROR

#define IS_RETRIABLE_PRODUCER_ERROR (   error)     ((error) == STATUS_INVALID_DESCRIBE_STREAM_RETURN_JSON || (error) == STATUS_STREAM_BEING_SHUTDOWN || (error) == STATUS_CLIENT_BEING_SHUTDOWN)

Macro for checking whether the status code should be retried by the continuous retry logic

◆ MAX_CALLBACK_CHAIN_COUNT

#define MAX_CALLBACK_CHAIN_COUNT   20

Maximum callbacks in the processing chain