Include.h

Go to the documentation of this file.

 
#ifndef __KINESIS_VIDEO_PRODUCER_INCLUDE__
#define __KINESIS_VIDEO_PRODUCER_INCLUDE__
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
// Public headers
#include <com/amazonaws/kinesis/video/client/Include.h>
#include <com/amazonaws/kinesis/video/common/Include.h>
 
 
#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
 
typedef STATUS (*FreePlatformCallbacksFunc)(PUINT64);
 
typedef STATUS (*FreeProducerCallbacksFunc)(PUINT64);
 
typedef STATUS (*FreeStreamCallbacksFunc)(PUINT64);
 
typedef STATUS (*FreeAuthCallbacksFunc)(PUINT64);
 
typedef STATUS (*FreeApiCallbacksFunc)(PUINT64);
 
typedef struct __PlatformCallbacks PlatformCallbacks;
struct __PlatformCallbacks {
    UINT32 version;                                              
    UINT64 customData;                                           
    GetCurrentTimeFunc getCurrentTimeFn;                         
    GetRandomNumberFunc getRandomNumberFn;                       
    CreateMutexFunc createMutexFn;                               
    LockMutexFunc lockMutexFn;                                   
    UnlockMutexFunc unlockMutexFn;                               
    TryLockMutexFunc tryLockMutexFn;                             
    FreeMutexFunc freeMutexFn;                                   
    CreateConditionVariableFunc createConditionVariableFn;       
    SignalConditionVariableFunc signalConditionVariableFn;       
    BroadcastConditionVariableFunc broadcastConditionVariableFn; 
    WaitConditionVariableFunc waitConditionVariableFn;           
    FreeConditionVariableFunc freeConditionVariableFn;           
    LogPrintFunc logPrintFn;                                     
    FreePlatformCallbacksFunc freePlatformCallbacksFn;           
};
typedef struct __PlatformCallbacks* PPlatformCallbacks;
 
typedef struct __ProducerCallbacks ProducerCallbacks;
struct __ProducerCallbacks {
    UINT32 version;                                        
    UINT64 customData;                                     
    StorageOverflowPressureFunc storageOverflowPressureFn; 
    ClientReadyFunc clientReadyFn;                         
    ClientShutdownFunc clientShutdownFn;                   
    FreeProducerCallbacksFunc freeProducerCallbacksFn;     
};
typedef struct __ProducerCallbacks* PProducerCallbacks;
 
typedef struct __StreamCallbacks StreamCallbacks;
struct __StreamCallbacks {
    UINT32 version;                                                      
    UINT64 customData;                                                   
    StreamUnderflowReportFunc streamUnderflowReportFn;                   
    BufferDurationOverflowPressureFunc bufferDurationOverflowPressureFn; 
    StreamLatencyPressureFunc streamLatencyPressureFn;                   
    StreamConnectionStaleFunc streamConnectionStaleFn;                   
    DroppedFrameReportFunc droppedFrameReportFn;                         
    DroppedFragmentReportFunc droppedFragmentReportFn;                   
    StreamErrorReportFunc streamErrorReportFn;                           
    FragmentAckReceivedFunc fragmentAckReceivedFn;                       
    StreamDataAvailableFunc streamDataAvailableFn;                       
    StreamReadyFunc streamReadyFn;                                       
    StreamClosedFunc streamClosedFn;                                     
    StreamShutdownFunc streamShutdownFn;                                 
 
    // Specialized cleanup callback
    FreeStreamCallbacksFunc freeStreamCallbacksFn;
};
typedef struct __StreamCallbacks* PStreamCallbacks;
 
typedef struct __AuthCallbacks AuthCallbacks;
struct __AuthCallbacks {
    UINT32 version;                                  
    UINT64 customData;                               
    GetSecurityTokenFunc getSecurityTokenFn;         
    GetDeviceCertificateFunc getDeviceCertificateFn; 
    DeviceCertToTokenFunc deviceCertToTokenFn;       
    GetDeviceFingerprintFunc getDeviceFingerprintFn; 
    GetStreamingTokenFunc getStreamingTokenFn;       
 
    FreeAuthCallbacksFunc freeAuthCallbacksFn;
};
typedef struct __AuthCallbacks* PAuthCallbacks;
 
typedef struct __ApiCallbacks ApiCallbacks;
struct __ApiCallbacks {
    UINT32 version;                                  
    UINT64 customData;                               
    CreateStreamFunc createStreamFn;                 
    DescribeStreamFunc describeStreamFn;             
    GetStreamingEndpointFunc getStreamingEndpointFn; 
    PutStreamFunc putStreamFn;                       
    TagResourceFunc tagResourceFn;                   
    CreateDeviceFunc createDeviceFn;                 
    FreeApiCallbacksFunc freeApiCallbacksFn;         
};
typedef struct __ApiCallbacks* PApiCallbacks;
 
typedef enum {
    API_CALL_CACHE_TYPE_NONE,
 
    API_CALL_CACHE_TYPE_ENDPOINT_ONLY,
 
    API_CALL_CACHE_TYPE_ALL,
} API_CALL_CACHE_TYPE;
 
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);
#ifdef __cplusplus
}
#endif
#endif /* __KINESIS_VIDEO_PRODUCER_INCLUDE__ */