Namespace Buttplug.Core.Messages
Classes
ButtplugDeviceMessage
Subclass of Buttplug Messages, that command a device to take an action.
ButtplugMessage
Base class for Buttplug protocol messages.
ButtplugMessageMetadata
DeviceAdded
Sent from server when a new device is discovered.
DeviceList
List of devices connected to the server.
DeviceMessageAttributes
DeviceMessageInfo
Container class for describing a device.
DeviceRemoved
Sent from server when a device is disconnected.
Error
Indicator that there has been an error in the system, either due to the last message/query sent, or due to an internal error.
GenericDeviceMessageAttributes
GenericMessageSubcommand
LinearCmd
Sent to server, generic message that can control any linear-actuated device. This message can take multiple commands for devices with multiple actuators.
LinearCmd.VectorCommand
Container object for representing a single linear motion command on a device that may have multiple independent linear actuated features.
LinearCmd.VectorSubcommand
Container object for representing a single linear motion command on a device that may have multiple independent linear actuated features.
MessageAttributes
Container class for device attributes.
MessageReceivedEventArgs
Event fired when a new ButtplugMessage is received.
NullDeviceMessageAttributes
Ok
Signifies the success of the last message/query.
Ping
Sent to server, at an interval specified by the server. If ping is not received in a timely manner, devices are stopped and client/server connection is severed.
RawDeviceMessageAttributes
RequestDeviceList
Sent to server to request a list of all connected devices.
RequestServerInfo
Sent to server to set up client information, including client name and schema version. Denotes the beginning of a connection handshake.
RotateCmd
Sent to server, generic message that can control any rotating device. This message can take multiple commands for devices with multiple rotators.
RotateCmd.RotateCommand
Container object for representing a single rotation command on a device that may have multiple independent rotating features. Missing index, as it is to be used in enumerative structures that imply index.
RotateCmd.RotateSubcommand
Container object for representing a single rotation command on a device that may have multiple independent rotating features.
ScalarCmd
Sent to server, generic message that can control any device that takes a single value and staticly sets an actuator to that value (speed, oscillation frequency, instanteous position, etc).
ScalarCmd.ScalarCommand
Container object for representing a single rotation command on a device that may have multiple independent rotating features. Missing index, as it is to be used in enumerative structures that imply index.
ScalarCmd.ScalarSubcommand
Container object for representing a single scalar value on a device that may have multiple independent scalar actuators.
ScanningFinished
Sent from server when scanning has finished.
SensorDeviceMessageAttributes
SensorReadCmd
Sent to server, generic message that can control any device that takes a single value and staticly sets an actuator to that value (speed, oscillation frequency, instanteous position, etc).
SensorReading
Sent to server, generic message that can control any device that takes a single value and staticly sets an actuator to that value (speed, oscillation frequency, instanteous position, etc).
ServerInfo
Sent from server, in response to RequestServerInfo. Contains server name, message version, ping information, etc...
StartScanning
Sent to server, to start scanning for devices across supported busses.
StopAllDevices
Sent to server, stops actions of all currently connected devices.
StopDeviceCmd
Sent to server, stops actions of a specific device.
StopScanning
Sent to server, to stop scanning for devices across supported busses.
Test
Sends text to a server, expected to be echoed back.
Interfaces
IButtplugDeviceInfoMessage
Interface for messages containing Device Info, such as DeviceAdded/Removed.
IButtplugMessageOutgoingOnly
Interface for messages only sent from server to client.
Enums
ActuatorType
Error.ErrorClass
Types of errors described by the message.