|
Amazon Kinesis Producer C SDK
|
|
|
Amazon Kinesis Producer C SDK
|
|
Public functions. More...
Functions | |
| PUBLIC_API STATUS | createAwsCredentials (PCHAR, UINT32, PCHAR, UINT32, PCHAR, UINT32, UINT64, PAwsCredentials *) |
| Creates an AWS credentials object. More... | |
| PUBLIC_API STATUS | freeAwsCredentials (PAwsCredentials *) |
| Frees an Aws credentials object. More... | |
| PUBLIC_API STATUS | deserializeAwsCredentials (PBYTE) |
| PUBLIC_API STATUS | createStaticCredentialProvider (PCHAR, UINT32, PCHAR, UINT32, PCHAR, UINT32, UINT64, PAwsCredentialProvider *) |
| Creates a Static AWS credential provider object. More... | |
| PUBLIC_API STATUS | freeStaticCredentialProvider (PAwsCredentialProvider *) |
| Frees a Static Aws credential provider object. More... | |
| PUBLIC_API STATUS | createCurlIotCredentialProvider (PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PAwsCredentialProvider *) |
| Creates an IoT based AWS credential provider object using libCurl. More... | |
| PUBLIC_API STATUS | createLwsIotCredentialProvider (PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PAwsCredentialProvider *) |
| Creates an IoT based AWS credential provider object using libWebSockets. More... | |
| PUBLIC_API STATUS | createCurlIotCredentialProviderWithTimeAndTimeout (PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, UINT64, UINT64, GetCurrentTimeFunc, UINT64, PAwsCredentialProvider *) |
| Creates an IoT based AWS credential provider object with time function which is based on libCurl. More... | |
| PUBLIC_API STATUS | createCurlIotCredentialProviderWithTime (PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, GetCurrentTimeFunc, UINT64, PAwsCredentialProvider *) |
| Creates an IoT based AWS credential provider object with time function which is based on libCurl. More... | |
| PUBLIC_API STATUS | createLwsIotCredentialProviderWithTime (PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, GetCurrentTimeFunc, UINT64, PAwsCredentialProvider *) |
| Creates an IoT based AWS credential provider object with time function which is based on libWebSockets. More... | |
| PUBLIC_API STATUS | freeIotCredentialProvider (PAwsCredentialProvider *) |
| Frees an IoT based Aws credential provider object. More... | |
| PUBLIC_API STATUS | createFileCredentialProvider (PCHAR, PAwsCredentialProvider *) |
| Creates a File based AWS credential provider object. More... | |
| PUBLIC_API STATUS | createFileCredentialProviderWithTime (PCHAR, GetCurrentTimeFunc, UINT64, PAwsCredentialProvider *) |
| Creates a File based AWS credential provider object. More... | |
| PUBLIC_API STATUS | freeFileCredentialProvider (PAwsCredentialProvider *) |
| Frees a File based Aws credential provider object. More... | |
| PUBLIC_API STATUS | createRequestInfo (PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, PCHAR, SSL_CERTIFICATE_TYPE, PCHAR, UINT64, UINT64, UINT64, UINT64, PAwsCredentials, PRequestInfo *) |
| Creates a Request Info object. More... | |
| PUBLIC_API STATUS | freeRequestInfo (PRequestInfo *) |
| Frees a Request Info object. More... | |
| PUBLIC_API STATUS | signAwsRequestInfo (PRequestInfo) |
| Signs a request by appending SigV4 headers. More... | |
| PUBLIC_API STATUS | signAwsRequestInfoQueryParam (PRequestInfo) |
| Signs a request by appending SigV4 query param. More... | |
| PUBLIC_API STATUS | getRequestHost (PCHAR, PCHAR *, PCHAR *) |
| Gets a request host string. More... | |
| PUBLIC_API BOOL | compareJsonString (PCHAR, jsmntok_t *, jsmntype_t, PCHAR) |
| Compares JSON strings taking into account the type. More... | |
| PUBLIC_API STATUS | convertTimestampToEpoch (PCHAR, UINT64, PUINT64) |
| Converts the timestamp string to time. More... | |
| PUBLIC_API STATUS | getUserAgentString (PCHAR, PCHAR, UINT32, PCHAR) |
| Creates a user agent string. More... | |
| PUBLIC_API STATUS | requestRequiresSecureConnection (PCHAR, PBOOL) |
| Checks whether the request URL requires a secure connection. More... | |
| PUBLIC_API STATUS | setRequestHeader (PRequestInfo, PCHAR, UINT32, PCHAR, UINT32) |
| Sets a header in the request info. More... | |
| PUBLIC_API STATUS | removeRequestHeader (PRequestInfo, PCHAR) |
| Removes a header from the headers list if exists. More... | |
| PUBLIC_API STATUS | removeRequestHeaders (PRequestInfo) |
| Removes and deletes all headers. More... | |
| PUBLIC_API STATUS | createRequestHeader (PCHAR, UINT32, PCHAR, UINT32, PRequestHeader *) |
| Creates a request header. More... | |
| PUBLIC_API SERVICE_CALL_RESULT | getServiceCallResultFromHttpStatus (UINT32) |
| Convenience method to convert HTTP statuses to SERVICE_CALL_RESULT status. More... | |
| PUBLIC_API STATUS | releaseCallInfo (PCallInfo) |
| Releases the CallInfo allocations. More... | |
| PUBLIC_API STATUS | createFileLogger (UINT64, UINT64, PCHAR, BOOL, BOOL, logPrintFunc *) |
| Creates a file based logger object and installs the global logger callback function. More... | |
| PUBLIC_API STATUS | freeFileLogger () |
| Frees the static file logger object and resets the global logging function if it was previously set by the create function. More... | |
| 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) |
Public functions.
| PUBLIC_API STATUS addApiCallbacks | ( | PClientCallbacks | pClientCallbacks, |
| PApiCallbacks | pApiCallbacks | ||
| ) |
Appends Api callbacks
NOTE: The callbacks are appended at the end of the chain.
| [in] | PClientCallbacks | Pointer to client callbacks |
| [in] | PApiCallbacks | Pointer to api callbacks to use |
| PUBLIC_API STATUS addAuthCallbacks | ( | PClientCallbacks | pClientCallbacks, |
| PAuthCallbacks | pAuthCallbacks | ||
| ) |
Appends Auth callbacks
NOTE: The callbacks are appended at the end of the chain.
| [in] | PClientCallbacks | Pointer to client callbacks |
| [in] | PAuthCallbacks | Pointer to auth callbacks to use |
| PUBLIC_API STATUS addFileLoggerPlatformCallbacksProvider | ( | PClientCallbacks | pClientCallbacks, |
| UINT64 | stringBufferSize, | ||
| UINT64 | maxLogFileCount, | ||
| PCHAR | logFileDir, | ||
| BOOL | printLog | ||
| ) |
Use file logger instead of default logger which log to stdout. The underlying objects are automatically freed when PClientCallbacks is freed.
| [in] | PClientCallbacks | The callback provider whose logPrintFn will be replaced with file logger log printing function |
| [in] | UINT64 | Size of string buffer in file logger. When the string buffer is full the logger will flush everything into a new file |
| [in] | UINT64 | Max number of log file. When exceeded, the oldest file will be deleted when new one is generated |
| [in] | PCHAR | Directory in which the log file will be generated |
| [in] | BOOL | print log to std out too |
| STATUS addFileLoggerWithFilteringPlatformCallbacksProvider | ( | PClientCallbacks | pClientCallbacks, |
| UINT64 | stringBufferSize, | ||
| UINT64 | maxLogFileCount, | ||
| PCHAR | logFileDir, | ||
| BOOL | printLog, | ||
| BOOL | enableAllLevels, | ||
| UINT32 | level | ||
| ) |
Use file logger with level filtering instead of default logger which log to stdout. The underlying objects are automatically freed when PClientCallbacks is freed.
| [in] | PClientCallbacks | The callback provider whose logPrintFn will be replaced with file logger log printing function |
| [in] | UINT64 | Size of string buffer in file logger. When the string buffer is full the logger will flush everything into a new file |
| [in] | UINT64 | Max number of log file. When exceeded, the oldest file will be deleted when new one is generated |
| [in] | PCHAR | Directory in which the log file will be generated |
| [in] | BOOL | Enable logging other log levels into a file |
| [in] | UINT32 | Log level that needs to be filtered into another file |
| [in] | BOOL | print log to std out too |
| PUBLIC_API STATUS addProducerCallbacks | ( | PClientCallbacks | pClientCallbacks, |
| PProducerCallbacks | pProducerCallbacks | ||
| ) |
Appends Producer callbacks
NOTE: The callbacks are appended at the end of the chain.
| [in] | PClientCallbacks | Pointer to client callbacks |
| [in] | PProducerCallbacks | Pointer to producer callbacks to add |
| PUBLIC_API STATUS addStreamCallbacks | ( | PClientCallbacks | pClientCallbacks, |
| PStreamCallbacks | pStreamCallbacks | ||
| ) |
Appends Stream callbacks
NOTE: The callbacks are appended at the end of the chain.
| [in] | PClientCallbacks | Pointer to client callbacks |
| [in] | PStreamCallbacks | Pointer to stream callbacks to use |
| PUBLIC_API BOOL compareJsonString | ( | PCHAR | pJsonStr, |
| jsmntok_t * | pToken, | ||
| jsmntype_t | jsmnType, | ||
| PCHAR | pStr | ||
| ) |
Compares JSON strings taking into account the type.
| [in] | PCHAR | JSON string being parsed |
| [in] | jsmntok_t* | Jsmn token to match |
| [in] | jsmntype_t | Jsmn token type to match |
| [in] | PCHAR | Token name to match |
| PUBLIC_API STATUS convertTimestampToEpoch | ( | PCHAR | expirationTimestampStr, |
| UINT64 | nowTime, | ||
| PUINT64 | pExpiration | ||
| ) |
Converts the timestamp string to time.
| [in] | PCHAR | String to covert (MUST be null terminated) |
| [in] | UINT64 | Current time |
| [in,out] | PUINT64 | Converted time |
| PUBLIC_API STATUS createAbstractDefaultCallbacksProvider | ( | UINT32 | callbackChainCount, |
| API_CALL_CACHE_TYPE | cacheType, | ||
| UINT64 | endpointCachingPeriod, | ||
| PCHAR | region, | ||
| PCHAR | controlPlaneUrl, | ||
| PCHAR | certPath, | ||
| PCHAR | userAgentName, | ||
| PCHAR | customUserAgent, | ||
| PClientCallbacks * | ppClientCallbacks | ||
| ) |
Create abstract callback provider that can hook with other callbacks
| [in] | UINT32 | Length of callback provider calling chain |
| [in] | API_CALL_CACHE_TYPE | Backend API call caching mode |
| [in] | UINT64 | Cached endpoint update period |
| [in,opt] | PCHAR AWS region | |
| [in] | PCHAR | Specific Control Plane Uri as endpoint to be called |
| [in,opt] | PCHAR CA Cert path | |
| [in,opt] | PCHAR User agent name (Use NULL) | |
| [in,opt] | PCHAR Custom user agent to be used in the API calls | |
| [out] | PClientCallbacks* | Returned pointer to callbacks provider |
| PUBLIC_API STATUS createAwsCredentials | ( | PCHAR | accessKeyId, |
| UINT32 | accessKeyIdLen, | ||
| PCHAR | secretKey, | ||
| UINT32 | secretKeyLen, | ||
| PCHAR | sessionToken, | ||
| UINT32 | sessionTokenLen, | ||
| UINT64 | expiration, | ||
| PAwsCredentials * | ppAwsCredentials | ||
| ) |
Creates an AWS credentials object.
| [in] | PCHAR | Access Key Id |
| [in] | UINT32 | Access Key Id Length excluding NULL terminator or 0 to calculate |
| [in] | PCHAR | Secret Key |
| [in] | UINT32 | Secret Key Length excluding NULL terminator or 0 to calculate |
| [in,opt] | PCHAR Session Token | |
| [in,opt] | UINT32 Session Token Length excluding NULL terminator or 0 to calculate | |
| [in] | UINT64 | Expiration in 100ns absolute time |
| [out] | PAwsCredentials* | Constructed object |
Create credentials object
| PUBLIC_API STATUS createContinuousRetryStreamCallbacks | ( | PClientCallbacks | pCallbacksProvider, |
| PStreamCallbacks * | ppStreamCallbacks | ||
| ) |
Creates a stream callbacks object allowing continuous retry on failures, reset logic on staleness and latency.
https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/producer-reference-callbacks.html
| [in] | PCallbacksProvider | Pointer to callback provider |
| [out] | PStreamCallbacks* | Constructed object |
| PUBLIC_API STATUS createCredentialProviderAuthCallbacks | ( | PClientCallbacks | pCallbacksProvider, |
| PAwsCredentialProvider | pCredentialProvider, | ||
| PAuthCallbacks * | ppCredentialProviderAuthCallbacks | ||
| ) |
Creates a Credentials auth callbacks from an existing Credential Provider object
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
NOTE: The original Credential Provider object will not be released on free
| [in] | PCallbacksProvider | Pointer to callback provider |
| [in] | PAwsCredentialProvider | Credential provider object |
| [in,out] | PAuthCallbacks* | Pointer to pointer to AuthCallback struct |
Creates Credential Provider Auth callbacks
| PUBLIC_API STATUS createCurlIotCredentialProvider | ( | PCHAR | iotGetCredentialEndpoint, |
| PCHAR | certPath, | ||
| PCHAR | privateKeyPath, | ||
| PCHAR | caCertPath, | ||
| PCHAR | roleAlias, | ||
| PCHAR | thingName, | ||
| PAwsCredentialProvider * | ppCredentialProvider | ||
| ) |
Creates an IoT based AWS credential provider object using libCurl.
| [in] | PCHAR | iot endpoint |
| [in] | PCHAR | cert file path |
| [in] | PCHAR | private key file path |
| [in,opt] | PCHAR ca cert file path | |
| [in] | PCHAR | role alias |
| [in] | PCHAR | iot thing name |
| [out] | PAwsCredentialProvider* | constructed AWS credentials provider object |
| PUBLIC_API STATUS createCurlIotCredentialProviderWithTime | ( | PCHAR | iotGetCredentialEndpoint, |
| PCHAR | certPath, | ||
| PCHAR | privateKeyPath, | ||
| PCHAR | caCertPath, | ||
| PCHAR | roleAlias, | ||
| PCHAR | thingName, | ||
| GetCurrentTimeFunc | getCurrentTimeFn, | ||
| UINT64 | customData, | ||
| PAwsCredentialProvider * | ppCredentialProvider | ||
| ) |
Creates an IoT based AWS credential provider object with time function which is based on libCurl.
| [in] | PCHAR | IoT endpoint |
| [in] | PCHAR | Cert file path |
| [in] | PCHAR | Private key file path |
| [in] | PCHAR | CA cert file path |
| [in] | PCHAR | Role alias |
| [in] | PCHAR | IoT thing name |
| [in] | GetCurrentTimeFunc | Custom current time function |
| [in] | UINT64 | Time function custom data |
| [out] | PAwsCredentialProvider* | Constructed AWS credentials provider object |
| PUBLIC_API STATUS createCurlIotCredentialProviderWithTimeAndTimeout | ( | PCHAR | iotGetCredentialEndpoint, |
| PCHAR | certPath, | ||
| PCHAR | privateKeyPath, | ||
| PCHAR | caCertPath, | ||
| PCHAR | roleAlias, | ||
| PCHAR | thingName, | ||
| UINT64 | connectionTimeout, | ||
| UINT64 | completionTimeout, | ||
| GetCurrentTimeFunc | getCurrentTimeFn, | ||
| UINT64 | customData, | ||
| PAwsCredentialProvider * | ppCredentialProvider | ||
| ) |
Creates an IoT based AWS credential provider object with time function which is based on libCurl.
| [in] | PCHAR | IoT endpoint |
| [in] | PCHAR | Cert file path |
| [in] | PCHAR | Private key file path |
| [in] | PCHAR | CA cert file path |
| [in] | PCHAR | Role alias |
| [in] | PCHAR | IoT thing name |
| [in] | UINT64 | connection timeout |
| [in] | UINT64 | completion timeout |
| [in] | GetCurrentTimeFunc | Custom current time function |
| [in] | UINT64 | Time function custom data |
| [out] | PAwsCredentialProvider* | Constructed AWS credentials provider object |
| PUBLIC_API STATUS createDefaultCallbacksProviderWithAuthCallbacks | ( | PAuthCallbacks | pAuthCallbacks, |
| PCHAR | region, | ||
| PCHAR | caCertPath, | ||
| PCHAR | userAgentPostfix, | ||
| PCHAR | customUserAgent, | ||
| PClientCallbacks * | ppClientCallbacks | ||
| ) |
Creates a default callbacks provider that uses auth callbacks as auth method.
NOTE: The caller is responsible for releasing the structure by calling the corresponding freeCallbackProvider API.
| [in] | PAuthCallbacks | Auth Callback for the auth |
| [in,opt] | PCHAR AWS region | |
| [in,opt] | PCHAR CA Cert path | |
| [in,opt] | PCHAR User agent name (Use NULL) | |
| [in,opt] | PCHAR Custom user agent to be used in the API calls | |
| [out] | PClientCallbacks* | Returned pointer to callbacks provider |
| PUBLIC_API STATUS createDefaultCallbacksProviderWithAwsCredentials | ( | PCHAR | accessKeyId, |
| PCHAR | secretKey, | ||
| PCHAR | sessionToken, | ||
| UINT64 | expiration, | ||
| PCHAR | region, | ||
| PCHAR | caCertPath, | ||
| PCHAR | userAgentPostfix, | ||
| PCHAR | customUserAgent, | ||
| PClientCallbacks * | ppClientCallbacks | ||
| ) |
Creates a default callbacks provider based on static AWS credentials
NOTE: The caller is responsible for releasing the structure by calling the corresponding freeCallbackProvider API.
| [in] | PCHAR | Access Key Id |
| [in] | PCHAR | Secret Key |
| [in,opt] | PCHAR Session Token | |
| [in] | UINT64 | Expiration of the token. MAX_UINT64 if non-expiring |
| [in,opt] | PCHAR AWS region | |
| [in,opt] | PCHAR CA Cert Path | |
| [in,opt] | PCHAR User agent name (Use NULL) | |
| [in,out] | PCHAR | Custom user agent to be used in the API calls |
| [out] | PClientCallbacks* | Returned pointer to callbacks provider |
Create the default callbacks provider with AWS credentials and defaults
| PUBLIC_API STATUS createDefaultCallbacksProviderWithFileAuth | ( | PCHAR | credentialsFilePath, |
| PCHAR | region, | ||
| PCHAR | caCertPath, | ||
| PCHAR | userAgentPostfix, | ||
| PCHAR | customUserAgent, | ||
| PClientCallbacks * | ppClientCallbacks | ||
| ) |
Creates a default callbacks provider that uses file-based certificate as auth method.
NOTE: The caller is responsible for releasing the structure by calling the corresponding freeCallbackProvider API.
| [in] | PCHAR | Credential file path |
| [in,opt] | PCHAR AWS region | |
| [in,opt] | PCHAR CA Cert path | |
| [in,opt] | PCHAR User agent name (Use NULL) | |
| [in,opt] | PCHAR Custom user agent to be used in the API calls | |
| [out] | PClientCallbacks* | Returned pointer to callbacks provider |
| PUBLIC_API STATUS createDefaultCallbacksProviderWithIotCertificate | ( | PCHAR | endpoint, |
| PCHAR | iotCertPath, | ||
| PCHAR | privateKeyPath, | ||
| PCHAR | caCertPath, | ||
| PCHAR | roleAlias, | ||
| PCHAR | streamName, | ||
| PCHAR | region, | ||
| PCHAR | userAgentPostfix, | ||
| PCHAR | customUserAgent, | ||
| PClientCallbacks * | ppClientCallbacks | ||
| ) |
Creates a default callbacks provider that uses iot certificate as auth method.
NOTE: The caller is responsible for releasing the structure by calling the corresponding freeCallbackProvider API.
| [in] | PCHAR | IoT endpoint to use for the auth |
| [in] | PCHAR | Credential cert path |
| [in] | PCHAR | Private key path |
| [in,opt] | PCHAR CA Cert path | |
| [in] | PCHAR | Role alias name |
| [in] | PCHAR | IoT Thing name |
| [in,opt] | PCHAR AWS region | |
| [in,opt] | PCHAR User agent name (Use NULL) | |
| [in,opt] | PCHAR Custom user agent to be used in the API calls | |
| [out] | PClientCallbacks* | Returned pointer to callbacks provider |
| PUBLIC_API STATUS createDefaultCallbacksProviderWithIotCertificateAndTimeouts | ( | PCHAR | endpoint, |
| PCHAR | iotCertPath, | ||
| PCHAR | privateKeyPath, | ||
| PCHAR | caCertPath, | ||
| PCHAR | roleAlias, | ||
| PCHAR | streamName, | ||
| PCHAR | region, | ||
| PCHAR | userAgentPostfix, | ||
| PCHAR | customUserAgent, | ||
| UINT64 | connectionTimeout, | ||
| UINT64 | completionTimeout, | ||
| PClientCallbacks * | ppClientCallbacks | ||
| ) |
Creates a default callbacks provider that uses iot certificate as auth method.
NOTE: The caller is responsible for releasing the structure by calling the corresponding freeCallbackProvider API.
| [in] | PCHAR | IoT endpoint to use for the auth |
| [in] | PCHAR | Credential cert path |
| [in] | PCHAR | Private key path |
| [in,opt] | PCHAR CA Cert path | |
| [in] | PCHAR | Role alias name |
| [in] | PCHAR | IoT Thing name |
| [in,opt] | PCHAR AWS region | |
| [in,opt] | PCHAR User agent name (Use NULL) | |
| [in,opt] | PCHAR Custom user agent to be used in the API calls | |
| [in] | UINT64 | connection timeout |
| [in] | UINT64 | completion timeout |
| [out] | PClientCallbacks* | Returned pointer to callbacks provider |
| PUBLIC_API STATUS createDefaultDeviceInfo | ( | PDeviceInfo * | ppDeviceInfo | ) |
Create deviceInfo with DEFAULT_STORAGE_SIZE amount of storage.
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [out] | PDeviceInfo* | pointer to PDeviceInfo that will point to the created deviceInfo |
| PUBLIC_API STATUS createFileAuthCallbacks | ( | PClientCallbacks | pCallbacksProvider, |
| PCHAR | pCredentialsFilepath, | ||
| PAuthCallbacks * | ppFileAuthCallbacks | ||
| ) |
Creates the File Credentials auth callbacks
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in] | PCallbacksProvider | Pointer to callback provider |
| [in] | PCHAR | file path for the credentials file |
| [in,out] | PAuthCallbacks* | Pointer to pointer to AuthCallback struct |
Creates File Auth callbacks
| PUBLIC_API STATUS createFileCredentialProvider | ( | PCHAR | pCredentialsFilepath, |
| PAwsCredentialProvider * | ppCredentialProvider | ||
| ) |
Creates a File based AWS credential provider object.
| [in] | PCHAR | Credentials file path |
| [out] | PAwsCredentialProvider* | Constructed AWS credentials provider object |
| PUBLIC_API STATUS createFileCredentialProviderWithTime | ( | PCHAR | pCredentialsFilepath, |
| GetCurrentTimeFunc | getCurrentTimeFn, | ||
| UINT64 | customData, | ||
| PAwsCredentialProvider * | ppCredentialProvider | ||
| ) |
Creates a File based AWS credential provider object.
| [in] | PCHAR | Credentials file path |
| [in] | GetCurrentTimeFunc | Current time function |
| [in] | UINT64 | Time function custom data |
| [out] | PAwsCredentialProvider* | Constructed AWS credentials provider object |
| PUBLIC_API STATUS createFileLogger | ( | UINT64 | , |
| UINT64 | , | ||
| PCHAR | , | ||
| BOOL | , | ||
| BOOL | , | ||
| logPrintFunc * | |||
| ) |
Creates a file based logger object and installs the global logger callback function.
| [in] | UINT64 | Size of string buffer in file logger. When the string buffer is full the logger will flush everything into a new file |
| [in] | UINT64 | Max number of log file. When exceeded, the oldest file will be deleted when new one is generated |
| [in] | PCHAR | Directory in which the log file will be generated |
| [in] | BOOL | Whether to print log to std out too |
| [in] | BOOL | Whether to set global logger function pointer |
| [out/opt] | logPrintFunc* Optional function pointer to be returned to the caller that contains the main function for actual output |
| PUBLIC_API STATUS createIotAuthCallbacks | ( | PClientCallbacks | pCallbacksProvider, |
| PCHAR | iotGetCredentialEndpoint, | ||
| PCHAR | certPath, | ||
| PCHAR | privateKeyPath, | ||
| PCHAR | caCertPath, | ||
| PCHAR | roleAlias, | ||
| PCHAR | streamName, | ||
| PAuthCallbacks * | ppIotAuthCallbacks | ||
| ) |
Creates the Iot Credentials auth callbacks
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in] | PCallbacksProvider | Pointer to callback provider |
| [in] | PCHAR | iot credentials endpoint |
| [in] | PCHAR | kvs iot certificate file path |
| [in] | PCHAR | private key file path |
| [in] | PCHAR | CA cert path |
| [in] | PCHAR | iot role alias |
| [in] | PCHAR | IoT thing name |
| [in,out] | PAuthCallbacks* | Pointer to pointer to AuthCallback struct |
| PUBLIC_API STATUS createIotAuthCallbacksWithTimeouts | ( | PClientCallbacks | pCallbacksProvider, |
| PCHAR | iotGetCredentialEndpoint, | ||
| PCHAR | certPath, | ||
| PCHAR | privateKeyPath, | ||
| PCHAR | caCertPath, | ||
| PCHAR | roleAlias, | ||
| PCHAR | streamName, | ||
| UINT64 | connectionTimeout, | ||
| UINT64 | completionTimeout, | ||
| PAuthCallbacks * | ppIotAuthCallbacks | ||
| ) |
Creates the Iot Credentials auth callbacks
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in] | PCallbacksProvider | Pointer to callback provider |
| [in] | PCHAR | iot credentials endpoint |
| [in] | PCHAR | kvs iot certificate file path |
| [in] | PCHAR | private key file path |
| [in] | PCHAR | CA cert path |
| [in] | PCHAR | iot role alias |
| [in] | PCHAR | IoT thing name |
| [in] | UINT64 | connection timeout |
| [in] | UINT64 | completion timeout |
| [in,out] | PAuthCallbacks* | Pointer to pointer to AuthCallback struct |
| PUBLIC_API STATUS createLwsIotCredentialProvider | ( | PCHAR | iotGetCredentialEndpoint, |
| PCHAR | certPath, | ||
| PCHAR | privateKeyPath, | ||
| PCHAR | caCertPath, | ||
| PCHAR | roleAlias, | ||
| PCHAR | thingName, | ||
| PAwsCredentialProvider * | ppCredentialProvider | ||
| ) |
Creates an IoT based AWS credential provider object using libWebSockets.
| [in] | PCHAR | IoT endpoint |
| [in] | PCHAR | Cert file path |
| [in] | PCHAR | Private key file path |
| [in,opt] | PCHAR CA cert file path | |
| [in] | PCHAR | Role alias |
| [in] | PCHAR | IoT thing name |
| [out] | PAwsCredentialProvider* | Constructed AWS credentials provider object |
| PUBLIC_API STATUS createLwsIotCredentialProviderWithTime | ( | PCHAR | iotGetCredentialEndpoint, |
| PCHAR | certPath, | ||
| PCHAR | privateKeyPath, | ||
| PCHAR | caCertPath, | ||
| PCHAR | roleAlias, | ||
| PCHAR | thingName, | ||
| GetCurrentTimeFunc | getCurrentTimeFn, | ||
| UINT64 | customData, | ||
| PAwsCredentialProvider * | ppCredentialProvider | ||
| ) |
Creates an IoT based AWS credential provider object with time function which is based on libWebSockets.
| [in] | PCHAR | IoT endpoint |
| [in] | PCHAR | Cert file path |
| [in] | PCHAR | Private key file path |
| [in] | PCHAR | CA cert file path |
| [in] | PCHAR | Role alias |
| [in] | PCHAR | IoT thing name |
| [in] | GetCurrentTimeFunc | Custom current time function |
| [in] | UINT64 | function custom data |
| [out] | PAwsCredentialProvider* | Constructed AWS credentials provider object |
| PUBLIC_API STATUS createOfflineAudioStreamInfoProviderWithCodecs | ( | PCHAR | streamName, |
| UINT64 | retention, | ||
| UINT64 | bufferDuration, | ||
| AUDIO_CODEC_ID | audioCodecId, | ||
| PStreamInfo * | ppStreamInfo | ||
| ) |
Creates Stream Info for Offline Audio only Streaming Scenario
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in,opt] | PCHAR stream name | |
| [in] | UINT64 | retention in 100ns time unit |
| [in] | UINT64 | buffer duration in 100ns time unit |
| [in] | AUDIO_CODEC_ID | Codec ID of the audio(AAC/PCM_ALAW/PCM_MULAW) |
| [out] | PStreamInfo* | Constructed object |
| PUBLIC_API STATUS createOfflineAudioVideoStreamInfoProvider | ( | PCHAR | streamName, |
| UINT64 | retention, | ||
| UINT64 | bufferDuration, | ||
| PStreamInfo * | ppStreamInfo | ||
| ) |
Creates Stream Info for Offline Audio Video Streaming Scenario
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in,opt] | PCHAR stream name | |
| [in] | UINT64 | retention in 100ns time unit |
| [in] | UINT64 | buffer duration in 100ns time unit |
| [out] | PStreamInfo* | Constructed object |
| PUBLIC_API STATUS createOfflineAudioVideoStreamInfoProviderWithCodecs | ( | PCHAR | streamName, |
| UINT64 | retention, | ||
| UINT64 | bufferDuration, | ||
| VIDEO_CODEC_ID | videoCodecId, | ||
| AUDIO_CODEC_ID | audioCodecId, | ||
| PStreamInfo * | ppStreamInfo | ||
| ) |
Creates Stream Info for Offline Audio Video Streaming Scenario
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in,opt] | PCHAR stream name | |
| [in] | UINT64 | retention in 100ns time unit |
| [in] | UINT64 | buffer duration in 100ns time unit |
| [in] | VIDEO_CODEC_ID | Codec ID of the video(H.264/H.265) |
| [in] | AUDIO_CODEC_ID | Codec ID of the audio(AAC/PCM_ALAW/PCM_MULAW) |
| [out] | PStreamInfo* | Constructed object |
| PUBLIC_API STATUS createOfflineVideoStreamInfoProvider | ( | PCHAR | streamName, |
| UINT64 | retention, | ||
| UINT64 | bufferDuration, | ||
| PStreamInfo * | ppStreamInfo | ||
| ) |
Creates Stream Info for Offline Video Streaming Scenario.
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in,opt] | PCHAR stream name | |
| [in] | UINT64 | etention in 100ns time unit. Should be greater than 0. |
| [in] | UINT64 | buffer duration in 100ns time unit |
| [out] | PStreamInfo* | Constructed object |
| PUBLIC_API STATUS createOfflineVideoStreamInfoProviderWithCodecs | ( | PCHAR | streamName, |
| UINT64 | retention, | ||
| UINT64 | bufferDuration, | ||
| VIDEO_CODEC_ID | videoCodecId, | ||
| PStreamInfo * | ppStreamInfo | ||
| ) |
Creates Stream Info for Offline Video Streaming Scenario.
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in,opt] | PCHAR stream name | |
| [in] | UINT64 | etention in 100ns time unit. Should be greater than 0. |
| [in] | UINT64 | buffer duration in 100ns time unit |
| [in] | VIDEO_CODEC_ID | Codec ID of the video(H.264/H.265) |
| [out] | PStreamInfo* | Constructed object |
| PUBLIC_API STATUS createRealtimeAudioStreamInfoProviderWithCodecs | ( | PCHAR | streamName, |
| UINT64 | retention, | ||
| UINT64 | bufferDuration, | ||
| AUDIO_CODEC_ID | audioCodecId, | ||
| PStreamInfo * | ppStreamInfo | ||
| ) |
Creates Stream Info for RealTime Audio only Streaming Scenario
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in,opt] | PCHAR stream name | |
| [in] | UINT64 | retention in 100ns time unit |
| [in] | UINT64 | buffer duration in 100ns time unit |
| [in] | AUDIO_CODEC_ID | Codec ID of the audio(AAC/PCM_ALAW/PCM_MULAW) |
| [out] | PStreamInfo* | Constructed object |
| PUBLIC_API STATUS createRealtimeAudioVideoStreamInfoProvider | ( | PCHAR | streamName, |
| UINT64 | retention, | ||
| UINT64 | bufferDuration, | ||
| PStreamInfo * | ppStreamInfo | ||
| ) |
Creates Stream Info for RealTime Audio Video Streaming Scenario
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in,opt] | PCHAR stream name | |
| [in] | UINT64 | retention in 100ns time unit |
| [in] | UINT64 | buffer duration in 100ns time unit |
| [out] | PStreamInfo* | Constructed object |
| PUBLIC_API STATUS createRealtimeAudioVideoStreamInfoProviderWithCodecs | ( | PCHAR | streamName, |
| UINT64 | retention, | ||
| UINT64 | bufferDuration, | ||
| VIDEO_CODEC_ID | videoCodecId, | ||
| AUDIO_CODEC_ID | audioCodecId, | ||
| PStreamInfo * | ppStreamInfo | ||
| ) |
Creates Stream Info for RealTime Audio Video Streaming Scenario
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in,opt] | PCHAR stream name | |
| [in] | UINT64 | retention in 100ns time unit |
| [in] | UINT64 | buffer duration in 100ns time unit |
| [in] | VIDEO_CODEC_ID | Codec ID of the video(H.264/H.265) |
| [in] | AUDIO_CODEC_ID | Codec ID of the audio(AAC/PCM_ALAW/PCM_MULAW) |
| [out] | PStreamInfo* | Constructed object |
| PUBLIC_API STATUS createRealtimeVideoStreamInfoProvider | ( | PCHAR | streamName, |
| UINT64 | retention, | ||
| UINT64 | bufferDuration, | ||
| PStreamInfo * | ppStreamInfo | ||
| ) |
Creates Stream Info for RealTime Streaming Scenario using default values.
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in,opt] | PCHAR stream name | |
| [in] | UINT64 | retention in 100ns time unit |
| [in] | UINT64 | buffer duration in 100ns time unit |
| [out] | PStreamInfo* | Constructed object |
| PUBLIC_API STATUS createRealtimeVideoStreamInfoProviderWithCodecs | ( | PCHAR | streamName, |
| UINT64 | retention, | ||
| UINT64 | bufferDuration, | ||
| VIDEO_CODEC_ID | videoCodecId, | ||
| PStreamInfo * | ppStreamInfo | ||
| ) |
Creates Stream Info for RealTime Streaming Scenario using default values.
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in,opt] | PCHAR stream name | |
| [in] | UINT64 | retention in 100ns time unit |
| [in] | UINT64 | buffer duration in 100ns time unit |
| [in] | VIDEO_CODEC_ID | Codec ID of the video(H.264/H.265) |
| [out] | PStreamInfo* | Constructed object |
| PUBLIC_API STATUS createRequestHeader | ( | PCHAR | headerName, |
| UINT32 | headerNameLen, | ||
| PCHAR | headerValue, | ||
| UINT32 | headerValueLen, | ||
| PRequestHeader * | ppHeader | ||
| ) |
Creates a request header.
| [in] | PCHAR | Header name |
| [in] | UINT32 | Header name length |
| [in] | PCHAR | Header value |
| [in] | UINT32 | Header value length |
| [out] | PRequestHeader* | Resulting object |
| PUBLIC_API STATUS createRequestInfo | ( | PCHAR | url, |
| PCHAR | body, | ||
| PCHAR | region, | ||
| PCHAR | certPath, | ||
| PCHAR | sslCertPath, | ||
| PCHAR | sslPrivateKeyPath, | ||
| SSL_CERTIFICATE_TYPE | certType, | ||
| PCHAR | userAgent, | ||
| UINT64 | connectionTimeout, | ||
| UINT64 | completionTimeout, | ||
| UINT64 | lowSpeedLimit, | ||
| UINT64 | lowSpeedTimeLimit, | ||
| PAwsCredentials | pAwsCredentials, | ||
| PRequestInfo * | ppRequestInfo | ||
| ) |
Creates a Request Info object.
| [in] | PCHAR | URL of the request |
| [in,opt] | PCHAR Body of the request | |
| [in] | PCHAR | Region |
| [in,opt] | PCHAR CA Certificate path/file | |
| [in,opt] | PCHAR SSL Certificate path/file | |
| [in,opt] | PCHAR SSL Certificate private key file path | |
| [in,opt] | SSL_CERTIFICATE_TYPE SSL certificate file type | |
| [in,opt] | PCHAR User agent string | |
| [in] | UINT64 | Connection timeout |
| [in] | UINT64 | Completion timeout |
| [in,opt] | UINT64 Low speed limit | |
| [in,opt] | UINT64 Low speed time limit | |
| [in,opt] | PAwsCredentials Credentials to use for the call | |
| [in,out] | PRequestInfo* | The newly created object |
| PUBLIC_API STATUS createStaticAuthCallbacks | ( | PClientCallbacks | pCallbacksProvider, |
| PCHAR | accessKeyId, | ||
| PCHAR | secretKey, | ||
| PCHAR | sessionToken, | ||
| UINT64 | expiration, | ||
| PAuthCallbacks * | ppStaticAuthCallbacks | ||
| ) |
Creates a Static Credentials auth callbacks
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in] | PCallbacksProvider | Pointer to callback provider |
| [in] | PCHAR | Access key id |
| [in] | PCHAR | Secret key |
| [in,opt] | PCHAR Session token | |
| [in] | UINT64 | Expiration absolute time in 100ns |
| [in,out] | PAuthCallbacks* | Pointer to pointer to AuthCallback struct |
Creates Static Auth callbacks
| PUBLIC_API STATUS createStaticCredentialProvider | ( | PCHAR | accessKeyId, |
| UINT32 | accessKeyIdLen, | ||
| PCHAR | secretKey, | ||
| UINT32 | secretKeyLen, | ||
| PCHAR | sessionToken, | ||
| UINT32 | sessionTokenLen, | ||
| UINT64 | expiration, | ||
| PAwsCredentialProvider * | ppCredentialProvider | ||
| ) |
Creates a Static AWS credential provider object.
| [in] | PCHAR | AWS Access Key Id |
| [in] | UINT32 | Access Key Id Length excluding NULL terminator or 0 to calculate |
| [in] | PCHAR | AWS Secret Key |
| [in] | UINT32 | Secret Key Length excluding NULL terminator or 0 to calculate |
| [in,opt] | PCHAR Session Token | |
| [in,opt] | UINT32 Session Token Length excluding NULL terminator or 0 to calculate | |
| [in] | UINT64 | Expiration in 100ns absolute time |
| [out] | PAwsCredentialProvider* | Constructed AWS credentials provider object |
| PUBLIC_API STATUS createStreamCallbacks | ( | PStreamCallbacks * | ppStreamCallbacks | ) |
Creates StreamCallbacks struct
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [out] | PStreamCallbacks* | Constructed object |
| PUBLIC_API STATUS deserializeAwsCredentials | ( | PBYTE | token | ) |
@ brief Deserialize an AWS credentials object, adapt the accessKey/secretKey/sessionToken pointer to offset following the AwsCredential structure
| [in] | PBYTE | Token to be deserialized. |
| PUBLIC_API STATUS freeAwsCredentials | ( | PAwsCredentials * | ppAwsCredentials | ) |
Frees an Aws credentials object.
| [in,out] | PAwsCredentials* | Credentials object to be destroyed. |
| PUBLIC_API STATUS freeCallbacksProvider | ( | PClientCallbacks * | ppClientCallbacks | ) |
Releases and frees the callbacks provider structure.
NOTE: The caller is responsible for releasing the structure by calling the corresponding free API.
| [in,out] | PClientCallbacks* | Pointer to callbacks provider to free |
Frees the callbacks provider
NOTE: The caller should have passed a pointer which was previously created by the corresponding function NOTE: The call is idempotent
| PUBLIC_API STATUS freeContinuousRetryStreamCallbacks | ( | PStreamCallbacks * | ppStreamCallbacks | ) |
Frees a previously constructed continuous stream callbacks object
| [in,out,opt] | PStreamCallbacks* Object to be destroyed. |
| PUBLIC_API STATUS freeCredentialProviderAuthCallbacks | ( | PAuthCallbacks * | ppCredentialProviderAuthCallbacks | ) |
Frees the Credential Provider based auth callback
NOTE: The underlying credential provider object will not be freed
| [in,out] | PAuthCallbacks* | pointer to AuthCallback provider object |
Frees the Credential Provider based Auth callbacks object
NOTE: The caller should have passed a pointer which was previously created by the corresponding function NOTE: The underlying credential provider object will not be freed
| PUBLIC_API STATUS freeDeviceInfo | ( | PDeviceInfo * | ppDeviceInfo | ) |
Frees the DeviceInfo provider object.
| [in,out] | PDeviceInfo* | pointer to PDeviceInfo provider that will be freed |
| PUBLIC_API STATUS freeFileAuthCallbacks | ( | PAuthCallbacks * | ppAuthCallbacks | ) |
Frees the File Credential auth callbacks
| [in,out] | PAuthCallbacks* | pointer to AuthCallback provider object |
Frees the File Auth callbacks object
NOTE: The caller should have passed a pointer which was previously created by the corresponding function
| PUBLIC_API STATUS freeFileCredentialProvider | ( | PAwsCredentialProvider * | ppCredentialProvider | ) |
Frees a File based Aws credential provider object.
| [in,out] | PAwsCredentialProvider* | Object to be destroyed. |
| PUBLIC_API STATUS freeFileLogger | ( | ) |
Frees the static file logger object and resets the global logging function if it was previously set by the create function.
| PUBLIC_API STATUS freeIotAuthCallbacks | ( | PAuthCallbacks * | ppIotAuthCallbacks | ) |
Frees the Iot Credential auth callbacks
| [in,out] | PAuthCallbacks* | pointer to AuthCallback provider object |
Frees the IotCredential Auth callback object
NOTE: The caller should have passed a pointer which was previously created by the corresponding function
| PUBLIC_API STATUS freeIotCredentialProvider | ( | PAwsCredentialProvider * | ppCredentialProvider | ) |
Frees an IoT based Aws credential provider object.
| [in,out] | PAwsCredentialProvider* | Object to be destroyed. |
| PUBLIC_API STATUS freeRequestInfo | ( | PRequestInfo * | ppRequestInfo | ) |
Frees a Request Info object.
| [in,out] | PRequestInfo* | The object to release |
| PUBLIC_API STATUS freeStaticAuthCallbacks | ( | PAuthCallbacks * | ppStaticAuthCallbacks | ) |
Frees the Static Credential auth callback
| [in,out] | PAuthCallbacks* | pointer to AuthCallback provider object |
Frees the Static Auth callbacks object
NOTE: The caller should have passed a pointer which was previously created by the corresponding function
| PUBLIC_API STATUS freeStaticCredentialProvider | ( | PAwsCredentialProvider * | ppCredentialProvider | ) |
Frees a Static Aws credential provider object.
| [in,out] | PAwsCredentialProvider* | Object to be destroyed. |
| PUBLIC_API STATUS freeStreamCallbacks | ( | PStreamCallbacks * | ppStreamCallbacks | ) |
Frees StreamCallbacks struct
| [in,out] | PStreamCallbacks* | the object to be freed |
| PUBLIC_API STATUS freeStreamInfoProvider | ( | PStreamInfo * | ppStreamInfo | ) |
Frees the StreamInfo provider object.
| [in,out] | PStreamInfo* | StreamInfo provider object to be freed |
| PUBLIC_API STATUS getRequestHost | ( | PCHAR | pUrl, |
| PCHAR * | ppStart, | ||
| PCHAR * | ppEnd | ||
| ) |
Gets a request host string.
| [in] | PCHAR | Request URL |
| [out] | PCHAR* | The request host start character. NULL on error. |
| [out] | PCHAR* | The request host end character. NULL on error. |
| PUBLIC_API SERVICE_CALL_RESULT getServiceCallResultFromHttpStatus | ( | UINT32 | httpStatus | ) |
Convenience method to convert HTTP statuses to SERVICE_CALL_RESULT status.
| [in] | UINT32 | http_status the HTTP status code of the call |
| PUBLIC_API STATUS getUserAgentString | ( | PCHAR | userAgentName, |
| PCHAR | customUserAgent, | ||
| UINT32 | len, | ||
| PCHAR | pUserAgent | ||
| ) |
Creates a user agent string.
| [in] | PCHAR | User agent name |
| [in] | PCHAR | Custom user agent string |
| [in] | UINT32 | Length of the string |
| [out] | PCHAR | Combined user agent string |
| PUBLIC_API STATUS releaseCallInfo | ( | PCallInfo | pCallInfo | ) |
Releases the CallInfo allocations.
| [in] | PCallInfo | Call info object to release |
| PUBLIC_API STATUS removeRequestHeader | ( | PRequestInfo | pRequestInfo, |
| PCHAR | headerName | ||
| ) |
Removes a header from the headers list if exists.
| [in] | PRequestInfo | Request Info object |
| [in] | PCHAR | Header name to check and remove |
| PUBLIC_API STATUS removeRequestHeaders | ( | PRequestInfo | pRequestInfo | ) |
Removes and deletes all headers.
| [in] | PRequestInfo | Request Info object |
| PUBLIC_API STATUS requestRequiresSecureConnection | ( | PCHAR | pUrl, |
| PBOOL | pSecure | ||
| ) |
Checks whether the request URL requires a secure connection.
| [in] | PCHAR | Request URL |
| [out] | PBOOL | returned value |
| PUBLIC_API STATUS setDeviceInfoStorageSize | ( | PDeviceInfo | pDeviceInfo, |
| UINT64 | storageSize | ||
| ) |
Can be called after createDefaultDeviceInfo, set the storage size to storageSize.
| [in] | PDeviceInfo | pointer to the target object |
| [in] | UINT64 | Buffer storage size in bytes |
| PUBLIC_API STATUS setDeviceInfoStorageSizeBasedOnBitrateAndBufferDuration | ( | PDeviceInfo | pDeviceInfo, |
| UINT64 | averageBitsPerSecond, | ||
| UINT64 | bufferDuration | ||
| ) |
Can be called after createDefaultDeviceInfo, calculate the storage size based on averageBitRate and bufferDuration, the call initDeviceInfoStorageInMemoryFixedSize to set storage size.
| [in] | PDeviceInfo | pointer to the target object |
| [in] | UINT64 | bitrate in bits per second |
| [in] | UINT64 | buffer duration in 100ns |
| PUBLIC_API STATUS setPlatformCallbacks | ( | PClientCallbacks | pClientCallbacks, |
| PPlatformCallbacks | pPlatformCallbacks | ||
| ) |
Sets the Platform callbacks.
NOTE: The existing Platform callbacks are overwritten.
| [in] | PClientCallbacks | Pointer to client callbacks |
| [in] |
| PUBLIC_API STATUS setRequestHeader | ( | PRequestInfo | pRequestInfo, |
| PCHAR | headerName, | ||
| UINT32 | headerNameLen, | ||
| PCHAR | headerValue, | ||
| UINT32 | headerValueLen | ||
| ) |
Sets a header in the request info.
| [in] | PRequestInfo | Request Info object |
| [in] | PCHAR | Header name |
| [in,opt] | UINT32 Header name length. Calculated if 0 | |
| [in] | PCHAR | Header value |
| [in,opt] | UINT32 Header value length. Calculated if 0 |
| PUBLIC_API STATUS setStreamInfoBasedOnStorageSize | ( | UINT32 | storageSize, |
| UINT64 | avgBitrate, | ||
| UINT32 | totalStreamCount, | ||
| PStreamInfo | pStreamInfo | ||
| ) |
Configure streaminfo based on given storage size and average bitrate Will change buffer duration, stream latency duration.
| [in] | UINT32 | Storage size in bytes |
| [in] | UINT64 | Total average bitrate for all tracks. Unit: bits per second |
| [in] | UINT32 | Total number of streams per kinesisVideoStreamClient |
| [out] | PStreamInfo |
| PUBLIC_API STATUS signAwsRequestInfo | ( | PRequestInfo | pRequestInfo | ) |
Signs a request by appending SigV4 headers.
| [in,out] | PRequestInfo* | request info for signing |
| PUBLIC_API STATUS signAwsRequestInfoQueryParam | ( | PRequestInfo | pRequestInfo | ) |
Signs a request by appending SigV4 query param.
| [in,out] | PRequestInfo* | Request info for signing |
1.9.1