Typedefs | |
typedef enum wcStateId | wcStateId |
typedef enum wcTaskStateId | wcTaskStateId |
Enumerations | |
enum | wcStateId { wcstConnection = 0 , wcstVerifyTLS = 1 , wcstError = 2 , wcstLog = 3 , wcstStreaming = 4 , wcstStreams = 5 , wcstDevices = 6 , wcstRecords = 7 , wcstRecordsStamp = 8 , wcstMsgs = 9 , wcstSendWithSync = 22 , wcstMsgsStamp = 10 , wcstMetaData = 11 , wcstDeviceName = 12 , wcstSID = 13 , wcstHostName = 14 , wcstProxy = 15 , wcstProxyAuth = 16 , wcstProxyProtocol = 17 , wcstProxyHost = 18 , wcstProxyPort = 19 , wcstProxyUser = 20 , wcstProxyPwrd = 21 } |
enum | wcTaskStateId { wctstError = 0 , wctstPath , wctstSubProto , wctstDeviceName } |
Functions | |
wcRCode DLLEXPORT | wcClientInvalidateState (wcHandle client, wcStateId aStateId) |
Reset the selected client state. More... | |
wcRCode DLLEXPORT | wcClientGetIntState (wcHandle client, wcStateId aStateId, int *aStateVal) |
Get a integer value for the selected client state. More... | |
wcRCode DLLEXPORT | wcClientGetBoolState (wcHandle client, wcStateId aStateId) |
Get a boolean value for the selected client state. More... | |
wcRCode DLLEXPORT | wcClientSetBoolState (wcHandle client, wcStateId aStateId, wcStateVal aStateVal) |
Set the boolean value to the selected client state. More... | |
wcRCode DLLEXPORT | wcClientGetStrValue (wcHandle client, wcStateId aStateId, char **aStateVal) |
Get a C-style string value for the selected client state. More... | |
wcRCode DLLEXPORT | wcClientGetStrNValue (wcHandle client, wcStateId aStateId, uint32_t sz, char *aStateVal) |
Get a C-style string value for the selected client state. More... | |
wcRCode DLLEXPORT | wcClientSetStrValue (wcHandle client, wcStateId aStateId, const char *aStateVal) |
Set a C-style string value to the selected client state. More... | |
typedef enum wcTaskStateId wcTaskStateId |
enum wcStateId |
Enumerator | |
---|---|
wcstConnection |
|
wcstVerifyTLS |
|
wcstError | |
wcstLog | |
wcstStreaming | |
wcstStreams | |
wcstDevices | |
wcstRecords | |
wcstRecordsStamp | |
wcstMsgs | |
wcstSendWithSync |
|
wcstMsgsStamp | |
wcstMetaData | |
wcstDeviceName | |
wcstSID |
|
wcstHostName | |
wcstProxy | |
wcstProxyAuth |
|
wcstProxyProtocol |
|
wcstProxyHost |
|
wcstProxyPort |
|
wcstProxyUser |
|
wcstProxyPwrd |
|
enum wcTaskStateId |
Enumerator | |
---|---|
wctstError |
|
wctstPath |
|
wctstSubProto |
|
wctstDeviceName |
|
Reset the selected client state.
Acceptable values of the state param are:
wcstLog - clear the log,
wcstError - delete information about the last error,
wcstDevices - update the list of devices (see also getDevicesOnline.json),
wcstRecords - update the list of media records (see also getRecordCount.json - according to the results of the request, the wcstRecordsStamp state will be updated automatically),
wcstRecordsStamp - clear the timestamp for records (the stamp parameter in getRecordCount.json request),
wcstMsgs - update the list of messages (see also getMsgs.json - according to the results of the request, the wcstMsgsStamp state will be updated automatically),
wcstSendWithSync - uncheck the synchronization flag - the next update of the message list will occur without the sending of a 'sync' message ( getMsgsAndSync.json),
wcstMsgsStamp - clear the timestamp for messages (the stamp parameter in getMsgs.json request),
wcstStreams - update the list of streams (see also getStreams.json),
wcstMetaData - clear the metadata,
wcstDeviceName - clear the device name,
wcstHostName - clear the server address,
wcstProxy - clear proxy settings.
Resetting wcstDevices, wcstRecords, wcstMsgs, wcstStreams states will update the selected state when wcClientProceed is called. During the execution of wcClientProceed, requests getDevicesOnline.json, getRecordCount.json, getMsgs.json and getStreams.json will be generated and launched, respectively.
client | The client handle. |
aStateId | The selected client state. |
Get a integer value for the selected client state.
Acceptable values of the state param are:
wcstError - get a code of the last error,
wcstLog - get a length of the log,
wcstStreaming - get streaming mask (input or output stream launched).
client | The client handle. |
aStateId | The selected client state. |
aStateVal | Pointer to a variable to which the selected client state will be written. |
Example
Get a boolean value for the selected client state.
Acceptable values of the state param are:
wcstConnection - is client connected,
wcstVerifyTLS - should client verify TLS certificate,
wcstError - an error has occurred,
wcstStreaming - has the client started the media stream - the result is disjunction of the launched task classes (see also: wcTaskClass),
wcstLog - does the log contain entries,
wcstDevices - should client update the list of devices,
wcstRecords - should client update the list of media records,
wcstMsgs - should client update the list of messages,
wcstSendWithSync - get the synchronization flag (see also: getMsgsAndSync.json, getMsgs.json),
wcstStreams - should client update the list of streams.
client | The client handle. |
aStateId | The selected client state. |
wcRCode DLLEXPORT wcClientSetBoolState | ( | wcHandle | client, |
wcStateId | aStateId, | ||
wcStateVal | aStateVal | ||
) |
Set the boolean value to the selected client state.
Acceptable values of the state param are:
wcstConnection - disconnect ( WC_FALSE, see also wcClientDisconnect) the client ( WC_TRUE not allowed, use wcClientAuth instead),
wcstVerifyTLS - should client verify TLS certificate (both WC_TRUE/ WC_FALSE allowed),
wcstStreaming - stop output streaming ( WC_FALSE) for the client ( WC_TRUE not allowed, use wcLaunchOutStream instead),
wcstDevices - the client should update the list of devices (only WC_TRUE value allowed),
wcstRecords - the client should update the list of media records (only WC_TRUE value allowed),
wcstMsgs - the client should update the list of messages (only WC_TRUE value allowed),
wcstSendWithSync - set the synchronization flag (both WC_TRUE/ WC_FALSE allowed) - the next update of the message list will occur with or without the sending of a 'sync' message ( getMsgsAndSync.json, getMsgs.json),
wcstStreams - the client should update the list of streams (only WC_TRUE value allowed).
client | The client handle. |
aStateId | The selected client state. |
aStateVal | The boolean value. |
Get a C-style string value for the selected client state.
As a result of successful execution of the function, the aStateVal parameter will contain a pointer to NULL-terminated string. (Don't forget to free up memory after using the aStateVal). Acceptable values of the state param are:
wcstLog - get the first log entry and delete it from the clients log (see also wcSetCStringCallback, wcSetStringCallback),
wcstSID - the client session id,
wcstRecordsStamp - current timestamp value for records (the stamp parameter retrieved from the last getRecordCount.json response),
wcstMsgsStamp - current timestamp value for messages (the stamp parameter retrieved from the last getMsgs.json response),
wcstMetaData - the client metadata,
wcstDeviceName - the client device name,
wcstHostName - the client host name,
wcstProxy - the client proxy server address in format
,
wcstProxyAuth - the client proxy server authorization data in format
.
client | The client handle. |
aStateId | The selected client state. |
aStateVal | The pointer to the variable of char * type initialized with NULL value |
Example
wcRCode DLLEXPORT wcClientGetStrNValue | ( | wcHandle | client, |
wcStateId | aStateId, | ||
uint32_t | sz, | ||
char * | aStateVal | ||
) |
Get a C-style string value for the selected client state.
As a result of successful execution of the function, the requested value will be copied to the passed array aStateVal. If the size of the passed array is less than the requested state value, the function returns an WC_NOT_ENOUGH_MEM error. Acceptable values of the state param are listed in wcClientGetStrValue
client | The client handle. |
aStateId | The selected client state. |
aStateVal | The pointer to allocated char array with at least sz+1 chars. |
sz | The size of the given char array. |
Example
wcRCode DLLEXPORT wcClientSetStrValue | ( | wcHandle | client, |
wcStateId | aStateId, | ||
const char * | aStateVal | ||
) |
Set a C-style string value to the selected client state.
Acceptable values of the state param are:
wcstMetaData - set the metadata for client (the meta parameter in authorize.json request),
wcstDeviceName - set the client device name,
wcstHostName - set the client host name,
wcstMsgsStamp - set the timestamp value for messages (the stamp parameter in getMsgs.json request),
wcstRecordsStamp - set the timestamp value for records (the stamp parameter in getRecordCount.json request),
wcstProxy - set the client proxy server authorization@address in format
,
wcstProxyProtocol - set the client proxy server protocol ("http://", "https://", etc),
wcstProxyHost - set the client proxy server host,
wcstProxyPort - set the client proxy server port,
wcstProxyUser - set the client proxy server user name,
wcstProxyPwrd - set the client proxy server user password.
client | The client handle. |
aStateId | The selected client state. |
aStateVal | The C-style string value to be setted. |
Example