Class PhotoComponent

Access the photos on Vector.

Inheritance

Object

RobotObject

Component

PhotoComponent

Implements

INotifyPropertyChanged

Inherited Members

RobotObject.PropertyChanged

Namespace: Anki.Vector

Assembly: Anki.Vector.dll

Syntax

public class PhotoComponent : Component, INotifyPropertyChanged

Methods

DeletePhoto(PhotoInfo)

Deletes the photo from the robot.

public Task<StatusCode> DeletePhoto(PhotoInfo photoInfo)

Parameters

Type	Name	Description
PhotoInfo	photoInfo	The photo information.

Returns

Type	Description
Task<StatusCode>	A task that represents the asynchronous operation. The task result contains the result of the operation.

DeletePhoto(UInt32)

Deletes the photo from the robot.

public Task<StatusCode> DeletePhoto(uint photoId)

Parameters

Type	Name	Description
UInt32	photoId	The photo identifier.

Returns

Type	Description
Task<StatusCode>	A task that represents the asynchronous operation. The task result contains the result of the operation.

GetPhoto(PhotoInfo)

Download a full-resolution photo from the robot's storage.

public Task<byte[]> GetPhoto(PhotoInfo photoInfo)

Parameters

Type	Name	Description
PhotoInfo	photoInfo	The photo information.

Returns

Type	Description
Task<Byte[]>	A task that represents the asynchronous operation. The task result contains the result of the operation.

GetPhoto(UInt32)

Download a full-resolution photo from the robot's storage.

public Task<byte[]> GetPhoto(uint photoId)

Parameters

Type	Name	Description
UInt32	photoId	The photo identifier.

Returns

Type	Description
Task<Byte[]>	A task that represents the asynchronous operation. The task result contains the result of the operation.

Exceptions

Type	Condition
VectorRequestException	Unable to retrieve photo from Vector

GetPhotoInfo()

Request the photo information from the robot.

public Task<IEnumerable<PhotoInfo>> GetPhotoInfo()

Returns

Type	Description
Task<IEnumerable<PhotoInfo>>	A task that represents the asynchronous operation. The task result contains the result of the operation.

GetThumbnail(PhotoInfo)

Download a thumbnail of a given photo from the robot's storage.

You may use this function to pull all of the images off the robot in a smaller format, and then determine which one to download as full resolution.

public Task<byte[]> GetThumbnail(PhotoInfo photoInfo)

Parameters

Type	Name	Description
PhotoInfo	photoInfo	The photo information.

Returns

Type	Description
Task<Byte[]>	A task that represents the asynchronous operation. The task result contains the result of the operation.

Exceptions

Type	Condition
VectorRequestException	Unable to retrieve photo from Vector

GetThumbnail(UInt32)

Download a thumbnail of a given photo from the robot's storage.

You may use this function to pull all of the images off the robot in a smaller format, and then determine which one to download as full resolution.

public Task<byte[]> GetThumbnail(uint photoId)

Parameters

Type	Name	Description
UInt32	photoId	The photo identifier.

Returns

Type	Description
Task<Byte[]>	A task that represents the asynchronous operation. The task result contains the result of the operation.

Exceptions

Type	Condition
VectorRequestException	Unable to retrieve photo from Vector

Implements

System.ComponentModel.INotifyPropertyChanged