Package com.viam.sdk.core.component.camera

Class Camera

java.lang.Object

com.viam.sdk.core.resource.Resource

com.viam.sdk.core.component.Component

com.viam.sdk.core.component.camera.Camera

Direct Known Subclasses:

CameraRPCClient

public abstract class Camera
extends Component

MovementSensor reports information about the robot's direction, position, and speed

Nested Class Summary

Nested classes/interfaces inherited from class com.viam.sdk.core.resource.Resource

Resource.Reconfigurable, Resource.Stoppable

Field Summary

Fields

Modifier and Type	Field	Description
static final Subtype	SUBTYPE

Constructor Summary

Constructors

Constructor	Description
Camera(String name)

Method Summary

Modifier and Type	Method	Description
static Camera	fromRobot(RobotClient robot, String name)	Get the component with the provided name from the provided robot.
abstract Camera.Image	getImage(Camera.Format format, Optional<com.google.protobuf.Struct> extra)	Deprecated. please utilize getImages instead
Map.Entry<List<Camera.Image>,Common.ResponseMetadata>	getImages()
abstract Map.Entry<List<Camera.Image>,Common.ResponseMetadata>	getImages(Optional<List<String>> filterSourceNames, Optional<com.google.protobuf.Struct> extra)
static Common.ResourceName	named(String name)	Get the ResourceName of the component

Methods inherited from class com.viam.sdk.core.component.Component

getGeometries

Methods inherited from class com.viam.sdk.core.resource.Resource

close, createStatus, doCommand, getName, getSubtype, named

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SUBTYPE

public static final Subtype SUBTYPE

Constructor Details

Camera

public Camera(String name)

Method Details

named

public static Common.ResourceName named(String name)

Get the ResourceName of the component

Parameters:

name - the name of the component

Returns:

the component's ResourceName

fromRobot

public static Camera fromRobot(RobotClient robot,
 String name)

Get the component with the provided name from the provided robot.

Parameters:

robot - the RobotClient

name - the name of the component

Returns:

the component

getImage

@Deprecated
public abstract Camera.Image getImage(Camera.Format format,
 Optional<com.google.protobuf.Struct> extra)

Deprecated.

please utilize getImages instead

getImages

public abstract Map.Entry<List<Camera.Image>,Common.ResponseMetadata> getImages(Optional<List<String>> filterSourceNames,
 Optional<com.google.protobuf.Struct> extra)

getImages

public Map.Entry<List<Camera.Image>,Common.ResponseMetadata> getImages()