API Documentation

Namespaces

Anki.Vector

This namespace contains the main Anki.Vector.Robot class and all the various API components listed below.

Component	Description
AnimationComponent	Animation related methods
AudioComponent	Support for Vector's speakers
BehaviorComponent	Complex tasks which require Vector's internal logic to complete
CameraComponent	Support for Vector's camera feed
ControlComponent	Manage control of Vector's behaviors
EventComponent	Subscribe to events generated directly by Vector
FaceComponent	Manage faces stored on the robot
MotorComponent	Control the low-level motor functions
NavMapComponent	Vector's navigation memory map
PhotoComponent	Manage the photos stored in Vector
ScreenComponent	Display images on Vector's screen
VisionComponent	Enable/disable object/face detection modes
WorldComponent	Vector's known view of the world

In addition this namespace contains the Authentication class for logging into Vector and creating RobotConfiguration instances for connecting to a Vector robot.

Anki.Vector.Events

This namespace that contains all the EventArgs types for all the events generated by the SDK. This includes events generated directly by the robot (RobotEventArgs) and events generated by the main Robot class and various other components.

Anki.Vector.Exceptions

This namespace contains the exceptions generated by the SDK. They all inherit from VectorException.

Anki.Vector.Objects

This namespace contains the types for the various supported objects that Vector can recognize including his charger, light cube, faces, and custom objects.

Object Type	Description
Charger	Vector's charger object
CustomBoxArchetype	Custom object cuboid definition
CustomCubeArchetype	Custom object cube definition
CustomObject	Custom object instance
CustomWallArchetype	Custom object wall definition
Face	A single face that Vector has detected.
LightCube	Vector’s Light Cube.

Anki.Vector.Types

This namespace contains various classes and structs representing the data to received from Vector or sent to Vector.