Programming Reference:BCI2000Remote Class - Revision history

Mellinger: /* Parameters and system state */

2026-10-12T13:36:00Z

Parameters and system state

← Older revision		Revision as of 13:36, 12 October 2026
Line 75:		Line 75:

	===Parameters and system state===		===Parameters and system state===
			====bool AddParameter( string paramdef )====
			Constructs a parameter from the given parameter definition, and adds it to the parameter list.
			Note that parameters may not be added outside the idle state, i.e. they may only be added before core modules have connected to the Operator.

	====bool GetParameter( string name, string& value )====		====bool GetParameter( string name, string& value )====
	Copies the specified parameter's value into the ''value'' output argument. Returns false if parameter does not exist.		Copies the specified parameter's value into the ''value'' output argument. Returns false if parameter does not exist.
Line 80:		Line 84:
	====bool SetParameter( string name, string value )====		====bool SetParameter( string name, string value )====
	Sets the specified parameter to the given value. The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD [JSON&#93 PARAMETER <parameter definition>\|ADD PARAMETER]] scripting command.		Sets the specified parameter to the given value. The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD [JSON&#93 PARAMETER <parameter definition>\|ADD PARAMETER]] scripting command.

			====bool AddParameterJson( string json )====
			Constructs a parameter from the given JSON representation, and adds it to the parameter list.
			Note that parameters may not be added outside the idle state, i.e. they may only be added before core modules have connected to the Operator.

			The parameter definition is expected in [[User Reference:JSON Parameter Format\|JSON parameter format]].

	====bool GetParameterJson( string name, string& json )====		====bool GetParameterJson( string name, string& json )====

Mellinger: /* bool PutParameterJson( string json ) */

2026-10-12T13:31:29Z

bool PutParameterJson( string json )

← Older revision		Revision as of 13:31, 12 October 2026
Line 86:		Line 86:
	The parameter definition is provided in [[User Reference:JSON Parameter Format\|JSON parameter format]].		The parameter definition is provided in [[User Reference:JSON Parameter Format\|JSON parameter format]].

	====bool ~~PutParameterJson~~( string json )====		====bool SetParameterJson( string json )====
	Constructs a parameter from the given JSON representation, and applies it to the parameter list.		Constructs a parameter from the given JSON representation, and applies it to the parameter list.
	The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD [JSON] PARAMETER <parameter definition>\|ADD JSON PARAMETER]] scripting command.		The parameter must exist in the system.

	The parameter definition is expected in [[User Reference:JSON Parameter Format\|JSON parameter format]].		The parameter definition is expected in [[User Reference:JSON Parameter Format\|JSON parameter format]].

Mellinger: /* bool ShowParameterJson( string name, string& json ) */

2026-10-12T13:30:44Z

bool ShowParameterJson( string name, string& json )

← Older revision		Revision as of 13:30, 12 October 2026
Line 81:		Line 81:
	Sets the specified parameter to the given value. The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD [JSON&#93 PARAMETER <parameter definition>\|ADD PARAMETER]] scripting command.		Sets the specified parameter to the given value. The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD [JSON&#93 PARAMETER <parameter definition>\|ADD PARAMETER]] scripting command.

	====bool ~~ShowParameterJson~~( string name, string& json )====		====bool GetParameterJson( string name, string& json )====
	Copies the specified parameter into the ''json'' output argument. Returns false if parameter does not exist.		Copies the specified parameter into the ''json'' output argument. Returns false if parameter does not exist.

Mellinger: /* bool ShowParameterJson( string name, string& json ) */

2026-10-08T17:31:51Z

bool ShowParameterJson( string name, string& json )

← Older revision		Revision as of 17:31, 8 October 2026
Line 83:		Line 83:
	====bool ShowParameterJson( string name, string& json )====		====bool ShowParameterJson( string name, string& json )====
	Copies the specified parameter into the ''json'' output argument. Returns false if parameter does not exist.		Copies the specified parameter into the ''json'' output argument. Returns false if parameter does not exist.

			The parameter definition is provided in [[User Reference:JSON Parameter Format\|JSON parameter format]].

	====bool PutParameterJson( string json )====		====bool PutParameterJson( string json )====

Mellinger: /* bool PutParameterJson( string json ) */

2026-10-08T17:31:31Z

bool PutParameterJson( string json )

← Older revision		Revision as of 17:31, 8 October 2026
Line 87:		Line 87:
	Constructs a parameter from the given JSON representation, and applies it to the parameter list.		Constructs a parameter from the given JSON representation, and applies it to the parameter list.
	The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD [JSON] PARAMETER <parameter definition>\|ADD JSON PARAMETER]] scripting command.		The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD [JSON] PARAMETER <parameter definition>\|ADD JSON PARAMETER]] scripting command.

			The parameter definition is expected in [[User Reference:JSON Parameter Format\|JSON parameter format]].

	====bool LoadParametersLocal( string file )====		====bool LoadParametersLocal( string file )====

Mellinger: /* bool PutParameterJson( string json ) */

2026-10-08T17:30:32Z

bool PutParameterJson( string json )

← Older revision		Revision as of 17:30, 8 October 2026
Line 86:		Line 86:
	====bool PutParameterJson( string json )====		====bool PutParameterJson( string json )====
	Constructs a parameter from the given JSON representation, and applies it to the parameter list.		Constructs a parameter from the given JSON representation, and applies it to the parameter list.
	The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD [JSON] PARAMETER <parameter definition>\|ADD JSON PARAMETER]] scripting command.		The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD [JSON] PARAMETER <parameter definition>\|ADD JSON PARAMETER]] scripting command.

	====bool LoadParametersLocal( string file )====		====bool LoadParametersLocal( string file )====

Mellinger: /* bool SetParameter( string name, string value ) */

2026-10-08T17:29:54Z

bool SetParameter( string name, string value )

← Older revision		Revision as of 17:29, 8 October 2026
Line 79:		Line 79:

	====bool SetParameter( string name, string value )====		====bool SetParameter( string name, string value )====
	Sets the specified parameter to the given value. The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD PARAMETER <parameter definition>\|ADD PARAMETER]] scripting command.		Sets the specified parameter to the given value. The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD [JSON&#93 PARAMETER <parameter definition>\|ADD PARAMETER]] scripting command.

	====bool ShowParameterJson( string name, string& json )====		====bool ShowParameterJson( string name, string& json )====

Mellinger: /* bool PutParameterJson( string json ) */

2026-10-08T17:26:35Z

bool PutParameterJson( string json )

← Older revision		Revision as of 17:26, 8 October 2026
Line 86:		Line 86:
	====bool PutParameterJson( string json )====		====bool PutParameterJson( string json )====
	Constructs a parameter from the given JSON representation, and applies it to the parameter list.		Constructs a parameter from the given JSON representation, and applies it to the parameter list.
	The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD PARAMETER <parameter definition>\|ADD PARAMETER]] scripting command.		The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD [JSON] PARAMETER <parameter definition>\|ADD JSON PARAMETER]] scripting command.

	====bool LoadParametersLocal( string file )====		====bool LoadParametersLocal( string file )====

Mellinger: /* Parameters and system state */

2026-10-08T17:26:06Z

Parameters and system state

← Older revision		Revision as of 17:26, 8 October 2026
Line 80:		Line 80:
	====bool SetParameter( string name, string value )====		====bool SetParameter( string name, string value )====
	Sets the specified parameter to the given value. The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD PARAMETER <parameter definition>\|ADD PARAMETER]] scripting command.		Sets the specified parameter to the given value. The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD PARAMETER <parameter definition>\|ADD PARAMETER]] scripting command.

			====bool ShowParameterJson( string name, string& json )====
			Copies the specified parameter into the ''json'' output argument. Returns false if parameter does not exist.

			====bool PutParameterJson( string json )====
			Constructs a parameter from the given JSON representation, and applies it to the parameter list.
			The parameter must exist in the system. To add a parameter, use the Execute() method in conjunction with the [[User Reference:Operator Module Scripting#ADD PARAMETER <parameter definition>\|ADD PARAMETER]] scripting command.

	====bool LoadParametersLocal( string file )====		====bool LoadParametersLocal( string file )====

Mellinger: /* string TelnetAddress="" (rw) */

2026-04-17T10:58:16Z

string TelnetAddress="" (rw)

← Older revision		Revision as of 10:58, 17 April 2026
Line 36:		Line 36:
	====string TelnetAddress="" (rw)====		====string TelnetAddress="" (rw)====
	Telnet address to use for connection to a remote machine. To connect to a remote machine, specify the machine's IP address, followed with BCI2000's listening port. You should take care to avoid specifying a port that is used by BCI2000's internal connections between Operator and core modules. By default, these are 4000, 4001, and 4002.		Telnet address to use for connection to a remote machine. To connect to a remote machine, specify the machine's IP address, followed with BCI2000's listening port. You should take care to avoid specifying a port that is used by BCI2000's internal connections between Operator and core modules. By default, these are 4000, 4001, and 4002.

			When ''OperatorPath'' is given and ''TelnetAddress'' is empty, BCI2000Remote will use a named pipe for communication with the Operator module. This is preferable for security reasons.

	=====bool WindowVisible=2 (rw)=====		=====bool WindowVisible=2 (rw)=====