#include "Capsule/CClient.h"
#include "Capsule/CDefinesPrivate.h"
#include "Capsule/CDevice.h"
#include "Capsule/CEEGTimedData.h"
Go to the source code of this file.
Typedefs | |
typedef enum clCSessionState | clCSessionState |
Session state. | |
typedef enum clCSessionError | clCSessionError |
Session error. | |
typedef void(* | clCSessionHandlerSessionError) (clCSession, clCSessionError) |
typedef enum clCUserActivity | clCUserActivity |
typedef void(* | clCSessionHandler) (clCSession) |
typedef void(* | clCSessionHandlerSessionEEGData) (clCSession, clCEEGTimedData) |
Enumerations | |
enum | clCSessionState { clC_SS_Unknown , clC_SS_Starting , clC_SS_Active , clC_SS_Inactive , clC_SS_Pausing , clC_SS_Paused , clC_SS_Stopping } |
Session state. More... | |
enum | clCSessionError { clC_SE_Unknown , clC_SE_FailedToStart , clC_SE_FailedToStop , clC_SE_LostConnection } |
Session error. More... | |
enum | clCUserActivity { clCUserActivity1 , clCUserActivity2 , clCUserActivity3 , clCUserActivity4 , clCUserActivity5 , clCUserActivityNone } |
Functions | |
CLC_CLASS_WN (SessionPrivate, clCSession) | |
Client session. | |
CLC_STRUCT (clCSessionDelegateSessionError) | |
Session error callback. Not supported in the current version. | |
CL_DLL void | clCSessionDelegateSessionError_Set (clCSessionDelegateSessionError delegate, clCSessionHandlerSessionError callback) NOEXCEPT |
CL_DLL clCSession | clCClient_CreateSessionWithError (clCClient client, clCDevice device, clCError *error) NOEXCEPT |
Create a Capsule session. Requires a device. | |
CL_DLL clCSession | clCClient_CreateSessionWithMonopolarChannelsWithError (clCClient client, clCDevice device, clCError *error) NOEXCEPT |
CL_DLL void | clCSession_Destroy (clCSession session) NOEXCEPT |
Destroy Capsule session. Release the handle. | |
CL_DLL int64_t | clCSession_GetSessionID (clCSession session) NOEXCEPT |
Get numeric ID of the session. | |
CL_DLL clCString | clCSession_GetSessionUUID (clCSession session) NOEXCEPT |
Get UUID of the session. | |
CL_DLL clCSessionState | clCSession_GetSessionState (clCSession session) NOEXCEPT |
Get session state. | |
CL_DLL void | clCSession_Start (clCSession session) NOEXCEPT |
Start the session. | |
CL_DLL void | clCSession_Stop (clCSession session) NOEXCEPT |
Stop the session. | |
CL_DLL bool | clCSession_IsActive (clCSession session) NOEXCEPT |
Is the session active. | |
CL_DLL void | clCSession_SetExtra (clCSession session, const char *json) NOEXCEPT |
Set extra data to send to platform. | |
CL_DLL void | clCSession_MarkActivity (clCSession session, clCUserActivity marker) NOEXCEPT |
Mark user activity start/stop. | |
CL_DLL bool | clCSession_IsFilterEEG (clCSession session) NOEXCEPT |
Check if EEG in the session is filtered. | |
CL_DLL bool | clCSession_IsBipolarMode (clCSession session) NOEXCEPT |
Check if bipolar mode is enabled for the session. | |
CLC_STRUCT (clCSessionDelegate) | |
CL_DLL void | clCSessionDelegate_Set (clCSessionDelegate delegate, clCSessionHandler callback) NOEXCEPT |
CL_DLL clCSessionDelegate | clCSession_GetOnSessionStartedEvent (clCSession session) NOEXCEPT |
Get session delegate for started event. | |
CL_DLL clCSessionDelegate | clCSession_GetOnSessionStoppedEvent (clCSession session) NOEXCEPT |
Get session delegate for stopped event. | |
CL_DLL clCSessionDelegateSessionError | clCSession_GetOnErrorEvent (clCSession session) NOEXCEPT |
Get session delegate for error event. | |
CLC_STRUCT (clCSessionDelegateSessionEEGData) | |
Session delegate for EEG data event. Session EEG data may be filtered and in bipolar mode depending on session configuration. | |
CL_DLL void | clCSessionDelegateSessionEEGData_Set (clCSessionDelegateSessionEEGData delegate, clCSessionHandlerSessionEEGData callback) NOEXCEPT |
CL_DLL clCSessionDelegateSessionEEGData | clCSession_GetOnSessionEEGDataEvent (clCSession device) NOEXCEPT |
Get delegate for session EEG data event. Session EEG data may be filtered and in bipolar mode depending on session configuration. | |
CL_DLL void | clCSession_SetConfig (clCSession session, bool bipolarMode, bool filterEEG) NOEXCEPT |
Configure whether channels in the session should work in bipolar mode. | |
typedef enum clCSessionError clCSessionError |
Session error.
typedef void(* clCSessionHandler) (clCSession) |
typedef void(* clCSessionHandlerSessionEEGData) (clCSession, clCEEGTimedData) |
typedef void(* clCSessionHandlerSessionError) (clCSession, clCSessionError) |
typedef enum clCSessionState clCSessionState |
Session state.
typedef enum clCUserActivity clCUserActivity |
enum clCSessionError |
enum clCSessionState |
enum clCUserActivity |
CLC_CLASS_WN | ( | SessionPrivate | , |
clCSession | |||
) |
Client session.
Required for classifiers and calibrators
CLC_STRUCT | ( | clCSessionDelegate | ) |
Session delegate without parameters. Not supported in the current version
CLC_STRUCT | ( | clCSessionDelegateSessionEEGData | ) |
Session delegate for EEG data event. Session EEG data may be filtered and in bipolar mode depending on session configuration.
CLC_STRUCT | ( | clCSessionDelegateSessionError | ) |
Session error callback. Not supported in the current version.
CL_DLL clCSession clCClient_CreateSessionWithError | ( | clCClient | client, |
clCDevice | device, | ||
clCError * | error | ||
) |
Create a Capsule session. Requires a device.
client | client handle |
device | device handle |
CL_DLL clCSession clCClient_CreateSessionWithMonopolarChannelsWithError | ( | clCClient | client, |
clCDevice | device, | ||
clCError * | error | ||
) |
CL_DLL void clCSession_Destroy | ( | clCSession | session | ) |
Destroy Capsule session. Release the handle.
session | session handle |
CL_DLL clCSessionDelegateSessionError clCSession_GetOnErrorEvent | ( | clCSession | session | ) |
Get session delegate for error event.
session | session handle |
CL_DLL clCSessionDelegateSessionEEGData clCSession_GetOnSessionEEGDataEvent | ( | clCSession | device | ) |
Get delegate for session EEG data event. Session EEG data may be filtered and in bipolar mode depending on session configuration.
session | session handle |
CL_DLL clCSessionDelegate clCSession_GetOnSessionStartedEvent | ( | clCSession | session | ) |
Get session delegate for started event.
session | session handle |
CL_DLL clCSessionDelegate clCSession_GetOnSessionStoppedEvent | ( | clCSession | session | ) |
Get session delegate for stopped event.
session | session handle |
CL_DLL int64_t clCSession_GetSessionID | ( | clCSession | session | ) |
Get numeric ID of the session.
session | session handle |
CL_DLL clCSessionState clCSession_GetSessionState | ( | clCSession | session | ) |
Get session state.
session | session handle |
CL_DLL clCString clCSession_GetSessionUUID | ( | clCSession | session | ) |
Get UUID of the session.
session | session handle |
CL_DLL bool clCSession_IsActive | ( | clCSession | session | ) |
Is the session active.
session | session handle |
CL_DLL bool clCSession_IsBipolarMode | ( | clCSession | session | ) |
Check if bipolar mode is enabled for the session.
session |
true
if bipolar mode is enabled CL_DLL bool clCSession_IsFilterEEG | ( | clCSession | session | ) |
Check if EEG in the session is filtered.
session |
true
if EEG is filtered CL_DLL void clCSession_MarkActivity | ( | clCSession | session, |
clCUserActivity | marker | ||
) |
Mark user activity start/stop.
session | |
marker | user activity marker or None for the end of user activity |
CL_DLL void clCSession_SetConfig | ( | clCSession | session, |
bool | bipolarMode, | ||
bool | filterEEG | ||
) |
Configure whether channels in the session should work in bipolar mode.
session | |
bipolarMode | true if bipolar mode is enabled |
filterEEG | true if raw EEG should be filtered |
CL_DLL void clCSession_SetExtra | ( | clCSession | session, |
const char * | json | ||
) |
Set extra data to send to platform.
session | session handle |
json | extra data in json format |
CL_DLL void clCSession_Start | ( | clCSession | session | ) |
Start the session.
session | session handle |
CL_DLL void clCSession_Stop | ( | clCSession | session | ) |
Stop the session.
session | session handle |
CL_DLL void clCSessionDelegate_Set | ( | clCSessionDelegate | delegate, |
clCSessionHandler | callback | ||
) |
CL_DLL void clCSessionDelegateSessionEEGData_Set | ( | clCSessionDelegateSessionEEGData | delegate, |
clCSessionHandlerSessionEEGData | callback | ||
) |
CL_DLL void clCSessionDelegateSessionError_Set | ( | clCSessionDelegateSessionError | delegate, |
clCSessionHandlerSessionError | callback | ||
) |