Technical Reference:Operator Library - Revision history

Mellinger: /* BCI_OnQuitRequest( void* refdata, const char** pMsg ) */

2026-08-12T14:34:44Z

BCI_OnQuitRequest( void* refdata, const char** pMsg )

← Older revision		Revision as of 14:34, 12 August 2026
Line 261:		Line 261:

	===BCI_OnQuitRequest( void* refdata, const char** pMsg )===		===BCI_OnQuitRequest( void* refdata, const char** pMsg )===
	This callback is executed when a script executes the QUIT command. ~~You~~ may abort the Quit command by returning a message through the pMsg pointer. Use the <tt>BCI_AllocateString()</tt> function to allocate such an error message.		This callback is executed when a script executes the QUIT command. It is the responsibility of your client program to shutdown the BCI2000 Operator library, and terminate the application. If you choose not to terminate, you may abort the Quit command by returning a message through the pMsg pointer. Use the <tt>BCI_AllocateString()</tt> function to allocate such an error message.

	===BCI_OnNextFilePart( void* refdata, int part )===		===BCI_OnNextFilePart( void* refdata, int part )===

Mellinger: /* const char* BCI_GetPerThreadWD() */

2026-07-03T17:02:48Z

const char* BCI_GetPerThreadWD()

← Older revision		Revision as of 17:02, 3 July 2026
Line 409:		Line 409:

	===const char* BCI_GetPerThreadWD()===		===const char* BCI_GetPerThreadWD()===
	Returns the current per-thread working directory stored inside the operator library, in UTF8-~~ending~~.		Returns the current per-thread working directory stored inside the operator library, in UTF8-encoding.
	The purpose of this command is to allow scripting commands implemented inside the library's caller to obtain the working directory that applies for the current script (see the <tt>BCI_OnUnknownCommand()</tt> callback).		The purpose of this command is to allow scripting commands implemented inside the library's caller to obtain the working directory that applies for the current script (see the <tt>BCI_OnUnknownCommand()</tt> callback).
	;returns: Pointer to a null-terminated string containing the result. The result is allocated by the library, and should be released by the caller using <tt>BCI_ReleaseObject()</tt>.		;returns: Pointer to a null-terminated string containing the result. The result is allocated by the library, and should be released by the caller using <tt>BCI_ReleaseObject()</tt>.

Mellinger: /* int BCI_TelnetListen( const char* address ) */

2026-07-03T17:01:32Z

int BCI_TelnetListen( const char* address )

@@ Line 335: / Line 335: @@
 Expects a pointer to a null-terminated string defining the working directory, in UTF8-encoding.
 Returns 1 if successful (i.e., the directory exists), and 0 otherwise.
 === int BCI_TelnetListen( const char* address )===

Mellinger: /* BCI_OnVisSignal( void* refdata, const char* visID, int channels, int elements, float* data ) */

2026-07-03T16:57:19Z

BCI_OnVisSignal( void* refdata, const char* visID, int channels, int elements, float* data )

← Older revision		Revision as of 16:57, 3 July 2026
Line 230:		Line 230:
	===BCI_OnVisSignal( void* refdata, const char* visID, int channels, int elements, float* data )===		===BCI_OnVisSignal( void* refdata, const char* visID, int channels, int elements, float* data )===
	Triggered for each signal data message to a visualization window. Data are given such that the pair of indices <tt>(ch,el)</tt> corresponds to the single index <tt>ch*elements+el</tt>. Note that this is different from the layout of bitmap data.		Triggered for each signal data message to a visualization window. Data are given such that the pair of indices <tt>(ch,el)</tt> corresponds to the single index <tt>ch*elements+el</tt>. Note that this is different from the layout of bitmap data.

			===BCI_OnVisSignalHandle( void* refdata, const char* visID, void* signalHandle )===
			Triggered for each signal data message to a visualization window. Note that using this callback is more efficient than the previous ''BCI_OnVisSignal'' because it allows to access signal data received through shared memory without copying. To access signal data behind the opaque handle, use the ''BCI_HandleGetSignalData()'' function explained below.

	===BCI_OnVisBitmap( void* refdata, const char* visID, int width, int height, signed short* data )===		===BCI_OnVisBitmap( void* refdata, const char* visID, int width, int height, signed short* data )===
	Triggered for each bitmap data message to a visualization window. Data are given in ARGB 1444 format, where the 12 bits with lowest significance represent color, and the four most significant of these 12 bits represent the R component. When any of the 3 bits with higher significance is set, the pixel is assumed to be transparent.		Triggered for each bitmap data message to a visualization window. Data are given in ARGB 1444 format, where the 12 bits with lowest significance represent color, and the four most significant of these 12 bits represent the R component. When any of the 3 bits with higher significance is set, the pixel is assumed to be transparent.

Mellinger: /* int BCI_SetPerThreadWD(const char) /

2026-07-03T16:50:17Z

int BCI_SetPerThreadWD(const char*)

@@ Line 400: / Line 400: @@
 ;arguments: Pointer to a null-terminated string defining the working directory, in UTF8-encoding.
 ;returns:   1 if successful, 0 otherwise.
 ==See also==

Mellinger: /* const char* BCI_GetPerThreadWD() */

2026-07-03T16:46:27Z

const char* BCI_GetPerThreadWD()

← Older revision		Revision as of 16:46, 3 July 2026
Line 326:		Line 326:
	Dispose of all resources allocated by the library. This function must be called from the thread that called BCI_Initialize().		Dispose of all resources allocated by the library. This function must be called from the thread that called BCI_Initialize().
	;returns: 1 if no error occurred, 0 otherwise.		;returns: 1 if no error occurred, 0 otherwise.

	~~=== const char* BCI_GetPerThreadWD()===~~
	~~Returns the current per-thread working directory stored inside the operator library, in UTF8-encoding.~~
	~~The result is a pointer to a null-terminated string containing the result.~~
	~~The result is allocated by the library, and should be released by the caller using BCI_ReleaseObject().~~

	=== int BCI_SetPerThreadWD( const char* directory)===		=== int BCI_SetPerThreadWD( const char* directory)===

Mellinger: /* int BCI_TelnetListen( const char* address ) */

2026-07-03T16:44:49Z

int BCI_TelnetListen( const char* address )

@@ Line 326: / Line 326: @@
 Dispose of all resources allocated by the library. This function must be called from the thread that called BCI_Initialize().
 ;returns:   1 if no error occurred, 0 otherwise.
 === int BCI_TelnetListen( const char* address )===

Mellinger: /* BCI_OnScriptError( void* refdata, const char* msg ) */

2026-07-03T16:39:33Z

BCI_OnScriptError( void* refdata, const char* msg )

← Older revision		Revision as of 16:39, 3 July 2026
Line 255:		Line 255:
	===BCI_OnScriptError( void* refdata, const char* msg )===		===BCI_OnScriptError( void* refdata, const char* msg )===
	Triggered when script execution results in an error condition. Note that unknown commands are reported through the <tt>BCI_OnUnknownCommand</tt> event handler to allow handling additional commands.		Triggered when script execution results in an error condition. Note that unknown commands are reported through the <tt>BCI_OnUnknownCommand</tt> event handler to allow handling additional commands.

			===BCI_OnQuitRequest( void* refdata, const char** pMsg )===
			This callback is executed when a script executes the QUIT command. You may abort the Quit command by returning a message through the pMsg pointer. Use the <tt>BCI_AllocateString()</tt> function to allocate such an error message.

			===BCI_OnNextFilePart( void* refdata, int part )===
			This callback is executed when the ''FilePart'' event state is incremented. It receives the number of the the new file part as an argument.

	==Functions that manage callbacks==		==Functions that manage callbacks==

Mellinger: /* BCI_OnScriptError( void* refdata, const char* msg ) */

2026-07-03T16:33:20Z

BCI_OnScriptError( void* refdata, const char* msg )

← Older revision		Revision as of 16:33, 3 July 2026
Line 254:		Line 254:

	===BCI_OnScriptError( void* refdata, const char* msg )===		===BCI_OnScriptError( void* refdata, const char* msg )===
	Triggered when script execution results in an error condition. Note that unknown commands are reported through the <tt>BCI_OnUnknownCommand</tt> event handler.		Triggered when script execution results in an error condition. Note that unknown commands are reported through the <tt>BCI_OnUnknownCommand</tt> event handler to allow handling additional commands.

	==Functions that manage callbacks==		==Functions that manage callbacks==

Mellinger: /* BCI_OnVisVideoFra,e( void* refdata, const char* visID, int width, int height, unsigned int* data ) */

2026-07-03T16:30:44Z

BCI_OnVisVideoFra,e( void* refdata, const char* visID, int width, int height, unsigned int* data )

← Older revision		Revision as of 16:30, 3 July 2026
Line 238:		Line 238:
	When addressing pixels, the pair of indices <tt>(x,y)</tt> corresponds to the single index <tt>y*width+x</tt>. Note that this is different from the layout of signal messages.		When addressing pixels, the pair of indices <tt>(x,y)</tt> corresponds to the single index <tt>y*width+x</tt>. Note that this is different from the layout of signal messages.

	===~~BCI_OnVisVideoFra,e~~( void* refdata, const char* visID, int width, int height, unsigned int* data )===		===BCI_OnVisVideoFrame( void* refdata, const char* visID, int width, int height, unsigned int* data )===
	Triggered for each video frame message sent to the Operator module. Data are given in ARGB 8888 format.		Triggered for each video frame message sent to the Operator module. Data are given in ARGB 8888 format.

Technical Reference:Operator Library - Revision history

Mellinger: /* BCI_OnQuitRequest( void* refdata, const char** pMsg ) */

Mellinger: /* const char* BCI_GetPerThreadWD() */

Mellinger: /* int BCI_TelnetListen( const char* address ) */

Mellinger: /* BCI_OnVisSignal( void* refdata, const char* visID, int channels, int elements, float* data ) */

Mellinger: /* int BCI_SetPerThreadWD(const char*) */

Mellinger: /* const char* BCI_GetPerThreadWD() */

Mellinger: /* int BCI_TelnetListen( const char* address ) */

Mellinger: /* BCI_OnScriptError( void* refdata, const char* msg ) */

Mellinger: /* BCI_OnScriptError( void* refdata, const char* msg ) */

Mellinger: /* BCI_OnVisVideoFra,e( void* refdata, const char* visID, int width, int height, unsigned int* data ) */

Mellinger: /* int BCI_SetPerThreadWD(const char) /