BOW Client | .NET
BowClient class
The Robot class.
Each instance represents a robot connection. You can have multiple robots connected, each with their own class to allow for multiple synchronised robot control.
Summary
| Members | Descriptions |
|---|---|
public inline static string Version() | Gets the SDK version information. |
public inline static Error SetupClient(string appName,AudioParams? audioParams,bool logLatency,bool useBOWUtility) | Opens a channel for the given modality. |
public inline static Error LoginUser(string username,string password,bool useBOWUtility) | |
public inline static GetRobotsProtoReply GetRobots(bool searchLocal,bool searchRemote,bool useBOWUtility) | |
public inline static void CloseClientInterface() | |
public inline static ? BowRobot QuickConnect(string appName,List< string > modalities,out Error connectError) |
Members
public inline static string Version()
Gets the SDK version information.
Gets the version of the bow client and bow core libraries.
Returns
string: A version string in the form:
public inline static Error SetupClient(string appName,AudioParams? audioParams,bool logLatency,bool useBOWUtility)
Opens a channel for the given modality.
Opens a channel between the robot and client, over which data for the chosen modality is transmitted.
Parameters
modality_namestr: The name of the modality channel you wish to open. Available options are specific to the robot but can be vision, audition, proprioception, motor, voice, speech or tactile.
Returns
*animus::common::Error **: Where error.Success is a boolean, True indicates a successful open. If error.Success is False you can inspect error.Description for more information.
public inline static Error LoginUser(string username,string password,bool useBOWUtility)
public inline static GetRobotsProtoReply GetRobots(bool searchLocal,bool searchRemote,bool useBOWUtility)
public inline static void CloseClientInterface()
public inline static ? BowRobot QuickConnect(string appName,List< string > modalities,out Error connectError)
BowRobot class
The Robot class. Each instance represents a robot connection. You can have multiple robots connected, each with their own class to allow for multiple synchronised robot control.
Summary
| Members | Descriptions |
|---|---|
public BOW.RobotProto.Robot RobotDetails | |
public string robotID | |
public inline BowRobot(BOW.RobotProto.Robot robotDetails) | The Robot class initialiser. |
public inline Error Connect() | Starts a connection with the robot. |
public inline Error OpenModality(string modalityName) | |
public inline Error SetModality(string modalityName,int modalityDataType,IMessage msg) | |
public inline Sample GetModality(string modalityName,bool blocking) | |
public inline Error UpdateTexture(int imageID,IntPtr iptr,int size,int colorOrder) | |
public inline Error CloseModality(string modality) | |
public inline Error Disconnect() | |
public inline static Sample DecodeData(DataMessage dmsg) |
Members
public BOW.RobotProto.Robot RobotDetails
public string robotID
public inline BowRobot(BOW.RobotProto.Robot robotDetails)
The Robot class initialiser.
The constructor accepts the robot details obtained from BowClient.GetRobots()
Parameters
chosen_robotBOW.RobotProto.Robot:The chosen robot selected from the array of robots returned when running BowClient.GetRobots().
public inline Error Connect()
Starts a connection with the robot.
This method starts a peer to peer connection with the robot using the robot details previously passed in to the constructor.
Returns
*animus::common::Error **: Where error.Success is a boolean, True indicates a successful connection. If error.Success is False you can inspect error.Description for more information.
public inline Error OpenModality(string modalityName)
public inline Error SetModality(string modalityName,int modalityDataType,IMessage msg)
public inline Sample GetModality(string modalityName,bool blocking)
public inline Error UpdateTexture(int imageID,IntPtr iptr,int size,int colorOrder)
public inline Error CloseModality(string modality)
public inline Error Disconnect()
public inline static Sample DecodeData(DataMessage dmsg)
Sample class
Summary
| Members | Descriptions |
|---|---|
public DataMessage.Types.DataType DataType | |
public IMessage Data | |
public Error Error | |
public inline Sample(DataMessage.Types.DataType dtype,IMessage msg,Error error) |
Members
public DataMessage.Types.DataType DataType
public IMessage Data
public Error Error
public inline Sample(DataMessage.Types.DataType dtype,IMessage msg,Error error)
Generated by Moxygen