Stimulation
StartStimulation
StartStimulation(Channel, )Toggles ON stimulation for the corresponding channel based on the provided Channel input parameter.
Params
Channel
integer
required
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
required
Return Value
StopStimulation
StopStimulation(Channel, )Toggles OFF stimulation for the corresponding channel based on the provided Channel input parameter.
Params
Channel
integer
required
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
required
Return Value
ReadStimulationState
ReadStimulationState(Channel, )Returns the current stimulation for the corresponding channel based on the provided Channel input parameter.
Note: Channels can be toggled ON with an amplitude of 0. Use the ReadAmplitude() call to determine the amplitude delivered.
Params
Channel
integer
required
Channel value of either 0 or 1
0 = Inner channel
1 = Outer channel
required
Return Value
State
integer
Returns State value of 0 or 1.
0 = OFF
1 = ON