Documentation ¶
Overview ¶
Package v1 is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterCameraServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterCameraServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client CameraServiceClient) error
- func RegisterCameraServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterCameraServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server CameraServiceServer) error
- func RegisterCameraServiceServer(s grpc.ServiceRegistrar, srv CameraServiceServer)
- type CameraServiceClient
- type CameraServiceServer
- type DistortionParameters
- func (*DistortionParameters) Descriptor() ([]byte, []int)deprecated
- func (x *DistortionParameters) GetModel() string
- func (x *DistortionParameters) GetParameters() []float64
- func (*DistortionParameters) ProtoMessage()
- func (x *DistortionParameters) ProtoReflect() protoreflect.Message
- func (x *DistortionParameters) Reset()
- func (x *DistortionParameters) String() string
- type Format
- type GetImageRequest
- func (*GetImageRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetImageRequest) GetExtra() *structpb.Struct
- func (x *GetImageRequest) GetMimeType() string
- func (x *GetImageRequest) GetName() string
- func (*GetImageRequest) ProtoMessage()
- func (x *GetImageRequest) ProtoReflect() protoreflect.Message
- func (x *GetImageRequest) Reset()
- func (x *GetImageRequest) String() string
- type GetImageResponse
- func (*GetImageResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetImageResponse) GetImage() []byte
- func (x *GetImageResponse) GetMimeType() string
- func (*GetImageResponse) ProtoMessage()
- func (x *GetImageResponse) ProtoReflect() protoreflect.Message
- func (x *GetImageResponse) Reset()
- func (x *GetImageResponse) String() string
- type GetImagesRequest
- type GetImagesResponse
- func (*GetImagesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetImagesResponse) GetImages() []*Image
- func (x *GetImagesResponse) GetResponseMetadata() *v1.ResponseMetadata
- func (*GetImagesResponse) ProtoMessage()
- func (x *GetImagesResponse) ProtoReflect() protoreflect.Message
- func (x *GetImagesResponse) Reset()
- func (x *GetImagesResponse) String() string
- type GetPointCloudRequest
- func (*GetPointCloudRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetPointCloudRequest) GetExtra() *structpb.Struct
- func (x *GetPointCloudRequest) GetMimeType() string
- func (x *GetPointCloudRequest) GetName() string
- func (*GetPointCloudRequest) ProtoMessage()
- func (x *GetPointCloudRequest) ProtoReflect() protoreflect.Message
- func (x *GetPointCloudRequest) Reset()
- func (x *GetPointCloudRequest) String() string
- type GetPointCloudResponse
- func (*GetPointCloudResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetPointCloudResponse) GetMimeType() string
- func (x *GetPointCloudResponse) GetPointCloud() []byte
- func (*GetPointCloudResponse) ProtoMessage()
- func (x *GetPointCloudResponse) ProtoReflect() protoreflect.Message
- func (x *GetPointCloudResponse) Reset()
- func (x *GetPointCloudResponse) String() string
- type GetPropertiesRequest
- func (*GetPropertiesRequest) Descriptor() ([]byte, []int)deprecated
- func (x *GetPropertiesRequest) GetName() string
- func (*GetPropertiesRequest) ProtoMessage()
- func (x *GetPropertiesRequest) ProtoReflect() protoreflect.Message
- func (x *GetPropertiesRequest) Reset()
- func (x *GetPropertiesRequest) String() string
- type GetPropertiesResponse
- func (*GetPropertiesResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetPropertiesResponse) GetDistortionParameters() *DistortionParameters
- func (x *GetPropertiesResponse) GetFrameRate() float32
- func (x *GetPropertiesResponse) GetIntrinsicParameters() *IntrinsicParameters
- func (x *GetPropertiesResponse) GetMimeTypes() []string
- func (x *GetPropertiesResponse) GetSupportsPcd() bool
- func (*GetPropertiesResponse) ProtoMessage()
- func (x *GetPropertiesResponse) ProtoReflect() protoreflect.Message
- func (x *GetPropertiesResponse) Reset()
- func (x *GetPropertiesResponse) String() string
- type Image
- type IntrinsicParameters
- func (*IntrinsicParameters) Descriptor() ([]byte, []int)deprecated
- func (x *IntrinsicParameters) GetCenterXPx() float64
- func (x *IntrinsicParameters) GetCenterYPx() float64
- func (x *IntrinsicParameters) GetFocalXPx() float64
- func (x *IntrinsicParameters) GetFocalYPx() float64
- func (x *IntrinsicParameters) GetHeightPx() uint32
- func (x *IntrinsicParameters) GetWidthPx() uint32
- func (*IntrinsicParameters) ProtoMessage()
- func (x *IntrinsicParameters) ProtoReflect() protoreflect.Message
- func (x *IntrinsicParameters) Reset()
- func (x *IntrinsicParameters) String() string
- type Property
- func (*Property) Descriptor() ([]byte, []int)deprecated
- func (x *Property) GetFrameFormat() string
- func (x *Property) GetFrameRate() float32
- func (x *Property) GetHeightPx() int32
- func (x *Property) GetWidthPx() int32
- func (*Property) ProtoMessage()
- func (x *Property) ProtoReflect() protoreflect.Message
- func (x *Property) Reset()
- func (x *Property) String() string
- type RenderFrameRequest
- func (*RenderFrameRequest) Descriptor() ([]byte, []int)deprecated
- func (x *RenderFrameRequest) GetExtra() *structpb.Struct
- func (x *RenderFrameRequest) GetMimeType() string
- func (x *RenderFrameRequest) GetName() string
- func (*RenderFrameRequest) ProtoMessage()
- func (x *RenderFrameRequest) ProtoReflect() protoreflect.Message
- func (x *RenderFrameRequest) Reset()
- func (x *RenderFrameRequest) String() string
- type UnimplementedCameraServiceServer
- func (UnimplementedCameraServiceServer) DoCommand(context.Context, *v1.DoCommandRequest) (*v1.DoCommandResponse, error)
- func (UnimplementedCameraServiceServer) GetGeometries(context.Context, *v1.GetGeometriesRequest) (*v1.GetGeometriesResponse, error)
- func (UnimplementedCameraServiceServer) GetImage(context.Context, *GetImageRequest) (*GetImageResponse, error)
- func (UnimplementedCameraServiceServer) GetImages(context.Context, *GetImagesRequest) (*GetImagesResponse, error)
- func (UnimplementedCameraServiceServer) GetPointCloud(context.Context, *GetPointCloudRequest) (*GetPointCloudResponse, error)
- func (UnimplementedCameraServiceServer) GetProperties(context.Context, *GetPropertiesRequest) (*GetPropertiesResponse, error)
- func (UnimplementedCameraServiceServer) RenderFrame(context.Context, *RenderFrameRequest) (*httpbody.HttpBody, error)
- type UnsafeCameraServiceServer
- type Webcam
- func (*Webcam) Descriptor() ([]byte, []int)deprecated
- func (x *Webcam) GetId() string
- func (x *Webcam) GetLabel() string
- func (x *Webcam) GetName() string
- func (x *Webcam) GetProperties() []*Property
- func (x *Webcam) GetStatus() string
- func (*Webcam) ProtoMessage()
- func (x *Webcam) ProtoReflect() protoreflect.Message
- func (x *Webcam) Reset()
- func (x *Webcam) String() string
- type Webcams
Constants ¶
This section is empty.
Variables ¶
var ( Format_name = map[int32]string{ 0: "FORMAT_UNSPECIFIED", 1: "FORMAT_RAW_RGBA", 2: "FORMAT_RAW_DEPTH", 3: "FORMAT_JPEG", 4: "FORMAT_PNG", } Format_value = map[string]int32{ "FORMAT_UNSPECIFIED": 0, "FORMAT_RAW_RGBA": 1, "FORMAT_RAW_DEPTH": 2, "FORMAT_JPEG": 3, "FORMAT_PNG": 4, } )
Enum value maps for Format.
var CameraService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "viam.component.camera.v1.CameraService", HandlerType: (*CameraServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetImage", Handler: _CameraService_GetImage_Handler, }, { MethodName: "GetImages", Handler: _CameraService_GetImages_Handler, }, { MethodName: "RenderFrame", Handler: _CameraService_RenderFrame_Handler, }, { MethodName: "GetPointCloud", Handler: _CameraService_GetPointCloud_Handler, }, { MethodName: "GetProperties", Handler: _CameraService_GetProperties_Handler, }, { MethodName: "DoCommand", Handler: _CameraService_DoCommand_Handler, }, { MethodName: "GetGeometries", Handler: _CameraService_GetGeometries_Handler, }, }, Streams: []grpc.StreamDesc{}, Metadata: "component/camera/v1/camera.proto", }
CameraService_ServiceDesc is the grpc.ServiceDesc for CameraService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
var File_component_camera_v1_camera_proto protoreflect.FileDescriptor
Functions ¶
func RegisterCameraServiceHandler ¶
func RegisterCameraServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
RegisterCameraServiceHandler registers the http handlers for service CameraService to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterCameraServiceHandlerClient ¶
func RegisterCameraServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client CameraServiceClient) error
RegisterCameraServiceHandlerClient registers the http handlers for service CameraService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "CameraServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "CameraServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "CameraServiceClient" to call the correct interceptors.
func RegisterCameraServiceHandlerFromEndpoint ¶
func RegisterCameraServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterCameraServiceHandlerFromEndpoint is same as RegisterCameraServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterCameraServiceHandlerServer ¶
func RegisterCameraServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server CameraServiceServer) error
RegisterCameraServiceHandlerServer registers the http handlers for service CameraService to "mux". UnaryRPC :call CameraServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterCameraServiceHandlerFromEndpoint instead.
func RegisterCameraServiceServer ¶
func RegisterCameraServiceServer(s grpc.ServiceRegistrar, srv CameraServiceServer)
Types ¶
type CameraServiceClient ¶
type CameraServiceClient interface { // GetImage returns a frame from a camera of the underlying robot. A specific MIME type // can be requested but may not necessarily be the same one returned. GetImage(ctx context.Context, in *GetImageRequest, opts ...grpc.CallOption) (*GetImageResponse, error) GetImages(ctx context.Context, in *GetImagesRequest, opts ...grpc.CallOption) (*GetImagesResponse, error) // RenderFrame renders a frame from a camera of the underlying robot to an HTTP response. A specific MIME type // can be requested but may not necessarily be the same one returned. RenderFrame(ctx context.Context, in *RenderFrameRequest, opts ...grpc.CallOption) (*httpbody.HttpBody, error) // GetPointCloud returns a point cloud from a camera of the underlying robot. A specific MIME type // can be requested but may not necessarily be the same one returned. GetPointCloud(ctx context.Context, in *GetPointCloudRequest, opts ...grpc.CallOption) (*GetPointCloudResponse, error) // GetProperties returns the camera intrinsic parameters and camera distortion parameters from a camera of the underlying robot, if available. GetProperties(ctx context.Context, in *GetPropertiesRequest, opts ...grpc.CallOption) (*GetPropertiesResponse, error) // DoCommand sends/receives arbitrary commands DoCommand(ctx context.Context, in *v1.DoCommandRequest, opts ...grpc.CallOption) (*v1.DoCommandResponse, error) // GetGeometries returns the geometries of the component in their current configuration GetGeometries(ctx context.Context, in *v1.GetGeometriesRequest, opts ...grpc.CallOption) (*v1.GetGeometriesResponse, error) }
CameraServiceClient is the client API for CameraService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
func NewCameraServiceClient ¶
func NewCameraServiceClient(cc grpc.ClientConnInterface) CameraServiceClient
type CameraServiceServer ¶
type CameraServiceServer interface { // GetImage returns a frame from a camera of the underlying robot. A specific MIME type // can be requested but may not necessarily be the same one returned. GetImage(context.Context, *GetImageRequest) (*GetImageResponse, error) GetImages(context.Context, *GetImagesRequest) (*GetImagesResponse, error) // RenderFrame renders a frame from a camera of the underlying robot to an HTTP response. A specific MIME type // can be requested but may not necessarily be the same one returned. RenderFrame(context.Context, *RenderFrameRequest) (*httpbody.HttpBody, error) // GetPointCloud returns a point cloud from a camera of the underlying robot. A specific MIME type // can be requested but may not necessarily be the same one returned. GetPointCloud(context.Context, *GetPointCloudRequest) (*GetPointCloudResponse, error) // GetProperties returns the camera intrinsic parameters and camera distortion parameters from a camera of the underlying robot, if available. GetProperties(context.Context, *GetPropertiesRequest) (*GetPropertiesResponse, error) // DoCommand sends/receives arbitrary commands DoCommand(context.Context, *v1.DoCommandRequest) (*v1.DoCommandResponse, error) // GetGeometries returns the geometries of the component in their current configuration GetGeometries(context.Context, *v1.GetGeometriesRequest) (*v1.GetGeometriesResponse, error) // contains filtered or unexported methods }
CameraServiceServer is the server API for CameraService service. All implementations must embed UnimplementedCameraServiceServer for forward compatibility
type DistortionParameters ¶
type DistortionParameters struct { Model string `protobuf:"bytes,1,opt,name=model,proto3" json:"model,omitempty"` Parameters []float64 `protobuf:"fixed64,2,rep,packed,name=parameters,proto3" json:"parameters,omitempty"` // contains filtered or unexported fields }
func (*DistortionParameters) Descriptor
deprecated
func (*DistortionParameters) Descriptor() ([]byte, []int)
Deprecated: Use DistortionParameters.ProtoReflect.Descriptor instead.
func (*DistortionParameters) GetModel ¶
func (x *DistortionParameters) GetModel() string
func (*DistortionParameters) GetParameters ¶
func (x *DistortionParameters) GetParameters() []float64
func (*DistortionParameters) ProtoMessage ¶
func (*DistortionParameters) ProtoMessage()
func (*DistortionParameters) ProtoReflect ¶
func (x *DistortionParameters) ProtoReflect() protoreflect.Message
func (*DistortionParameters) Reset ¶
func (x *DistortionParameters) Reset()
func (*DistortionParameters) String ¶
func (x *DistortionParameters) String() string
type Format ¶ added in v0.1.156
type Format int32
func (Format) Descriptor ¶ added in v0.1.156
func (Format) Descriptor() protoreflect.EnumDescriptor
func (Format) EnumDescriptor
deprecated
added in
v0.1.156
func (Format) Number ¶ added in v0.1.156
func (x Format) Number() protoreflect.EnumNumber
func (Format) Type ¶ added in v0.1.156
func (Format) Type() protoreflect.EnumType
type GetImageRequest ¶
type GetImageRequest struct { // Name of a camera Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Requested MIME type of response MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"` // Additional arguments to the method Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"` // contains filtered or unexported fields }
func (*GetImageRequest) Descriptor
deprecated
func (*GetImageRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetImageRequest.ProtoReflect.Descriptor instead.
func (*GetImageRequest) GetExtra ¶ added in v0.1.175
func (x *GetImageRequest) GetExtra() *structpb.Struct
func (*GetImageRequest) GetMimeType ¶
func (x *GetImageRequest) GetMimeType() string
func (*GetImageRequest) GetName ¶
func (x *GetImageRequest) GetName() string
func (*GetImageRequest) ProtoMessage ¶
func (*GetImageRequest) ProtoMessage()
func (*GetImageRequest) ProtoReflect ¶
func (x *GetImageRequest) ProtoReflect() protoreflect.Message
func (*GetImageRequest) Reset ¶
func (x *GetImageRequest) Reset()
func (*GetImageRequest) String ¶
func (x *GetImageRequest) String() string
type GetImageResponse ¶
type GetImageResponse struct { // Actual MIME type of response MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"` // Frame in bytes Image []byte `protobuf:"bytes,2,opt,name=image,proto3" json:"image,omitempty"` // contains filtered or unexported fields }
func (*GetImageResponse) Descriptor
deprecated
func (*GetImageResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetImageResponse.ProtoReflect.Descriptor instead.
func (*GetImageResponse) GetImage ¶
func (x *GetImageResponse) GetImage() []byte
func (*GetImageResponse) GetMimeType ¶
func (x *GetImageResponse) GetMimeType() string
func (*GetImageResponse) ProtoMessage ¶
func (*GetImageResponse) ProtoMessage()
func (*GetImageResponse) ProtoReflect ¶
func (x *GetImageResponse) ProtoReflect() protoreflect.Message
func (*GetImageResponse) Reset ¶
func (x *GetImageResponse) Reset()
func (*GetImageResponse) String ¶
func (x *GetImageResponse) String() string
type GetImagesRequest ¶ added in v0.1.156
type GetImagesRequest struct { // Name of a camera Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*GetImagesRequest) Descriptor
deprecated
added in
v0.1.156
func (*GetImagesRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetImagesRequest.ProtoReflect.Descriptor instead.
func (*GetImagesRequest) GetName ¶ added in v0.1.156
func (x *GetImagesRequest) GetName() string
func (*GetImagesRequest) ProtoMessage ¶ added in v0.1.156
func (*GetImagesRequest) ProtoMessage()
func (*GetImagesRequest) ProtoReflect ¶ added in v0.1.156
func (x *GetImagesRequest) ProtoReflect() protoreflect.Message
func (*GetImagesRequest) Reset ¶ added in v0.1.156
func (x *GetImagesRequest) Reset()
func (*GetImagesRequest) String ¶ added in v0.1.156
func (x *GetImagesRequest) String() string
type GetImagesResponse ¶ added in v0.1.156
type GetImagesResponse struct { // list of images returned from the camera system Images []*Image `protobuf:"bytes,1,rep,name=images,proto3" json:"images,omitempty"` // contains timestamp data ResponseMetadata *v1.ResponseMetadata `protobuf:"bytes,84260,opt,name=response_metadata,json=responseMetadata,proto3" json:"response_metadata,omitempty"` // contains filtered or unexported fields }
func (*GetImagesResponse) Descriptor
deprecated
added in
v0.1.156
func (*GetImagesResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetImagesResponse.ProtoReflect.Descriptor instead.
func (*GetImagesResponse) GetImages ¶ added in v0.1.156
func (x *GetImagesResponse) GetImages() []*Image
func (*GetImagesResponse) GetResponseMetadata ¶ added in v0.1.156
func (x *GetImagesResponse) GetResponseMetadata() *v1.ResponseMetadata
func (*GetImagesResponse) ProtoMessage ¶ added in v0.1.156
func (*GetImagesResponse) ProtoMessage()
func (*GetImagesResponse) ProtoReflect ¶ added in v0.1.156
func (x *GetImagesResponse) ProtoReflect() protoreflect.Message
func (*GetImagesResponse) Reset ¶ added in v0.1.156
func (x *GetImagesResponse) Reset()
func (*GetImagesResponse) String ¶ added in v0.1.156
func (x *GetImagesResponse) String() string
type GetPointCloudRequest ¶
type GetPointCloudRequest struct { // Name of a camera Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Requested MIME type of response MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"` // Additional arguments to the method Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"` // contains filtered or unexported fields }
func (*GetPointCloudRequest) Descriptor
deprecated
func (*GetPointCloudRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetPointCloudRequest.ProtoReflect.Descriptor instead.
func (*GetPointCloudRequest) GetExtra ¶ added in v0.1.175
func (x *GetPointCloudRequest) GetExtra() *structpb.Struct
func (*GetPointCloudRequest) GetMimeType ¶
func (x *GetPointCloudRequest) GetMimeType() string
func (*GetPointCloudRequest) GetName ¶
func (x *GetPointCloudRequest) GetName() string
func (*GetPointCloudRequest) ProtoMessage ¶
func (*GetPointCloudRequest) ProtoMessage()
func (*GetPointCloudRequest) ProtoReflect ¶
func (x *GetPointCloudRequest) ProtoReflect() protoreflect.Message
func (*GetPointCloudRequest) Reset ¶
func (x *GetPointCloudRequest) Reset()
func (*GetPointCloudRequest) String ¶
func (x *GetPointCloudRequest) String() string
type GetPointCloudResponse ¶
type GetPointCloudResponse struct { // Actual MIME type of response MimeType string `protobuf:"bytes,1,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"` // Frame in bytes PointCloud []byte `protobuf:"bytes,2,opt,name=point_cloud,json=pointCloud,proto3" json:"point_cloud,omitempty"` // contains filtered or unexported fields }
func (*GetPointCloudResponse) Descriptor
deprecated
func (*GetPointCloudResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetPointCloudResponse.ProtoReflect.Descriptor instead.
func (*GetPointCloudResponse) GetMimeType ¶
func (x *GetPointCloudResponse) GetMimeType() string
func (*GetPointCloudResponse) GetPointCloud ¶
func (x *GetPointCloudResponse) GetPointCloud() []byte
func (*GetPointCloudResponse) ProtoMessage ¶
func (*GetPointCloudResponse) ProtoMessage()
func (*GetPointCloudResponse) ProtoReflect ¶
func (x *GetPointCloudResponse) ProtoReflect() protoreflect.Message
func (*GetPointCloudResponse) Reset ¶
func (x *GetPointCloudResponse) Reset()
func (*GetPointCloudResponse) String ¶
func (x *GetPointCloudResponse) String() string
type GetPropertiesRequest ¶
type GetPropertiesRequest struct { // Name of a camera Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // contains filtered or unexported fields }
func (*GetPropertiesRequest) Descriptor
deprecated
func (*GetPropertiesRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetPropertiesRequest.ProtoReflect.Descriptor instead.
func (*GetPropertiesRequest) GetName ¶
func (x *GetPropertiesRequest) GetName() string
func (*GetPropertiesRequest) ProtoMessage ¶
func (*GetPropertiesRequest) ProtoMessage()
func (*GetPropertiesRequest) ProtoReflect ¶
func (x *GetPropertiesRequest) ProtoReflect() protoreflect.Message
func (*GetPropertiesRequest) Reset ¶
func (x *GetPropertiesRequest) Reset()
func (*GetPropertiesRequest) String ¶
func (x *GetPropertiesRequest) String() string
type GetPropertiesResponse ¶
type GetPropertiesResponse struct { // A boolean property determining whether the camera supports the return of pointcloud data SupportsPcd bool `protobuf:"varint,1,opt,name=supports_pcd,json=supportsPcd,proto3" json:"supports_pcd,omitempty"` // Parameters for doing a perspective of a 3D scene to a 2D plane // If camera does not provide intrinsic parameters, leave the field empty // Initializing the parameters with 0-values is considered an error IntrinsicParameters *IntrinsicParameters `protobuf:"bytes,2,opt,name=intrinsic_parameters,json=intrinsicParameters,proto3" json:"intrinsic_parameters,omitempty"` // Parameters for modeling lens distortion in cameras // If camera does not provide distortion parameters, leave the field empty // Initializing the parameters with 0-values is considered an error DistortionParameters *DistortionParameters `protobuf:"bytes,3,opt,name=distortion_parameters,json=distortionParameters,proto3" json:"distortion_parameters,omitempty"` // Supported MIME types by the camera MimeTypes []string `protobuf:"bytes,4,rep,name=mime_types,json=mimeTypes,proto3" json:"mime_types,omitempty"` // Optional camera frame rate for image capture timing FrameRate *float32 `protobuf:"fixed32,5,opt,name=frame_rate,json=frameRate,proto3,oneof" json:"frame_rate,omitempty"` // contains filtered or unexported fields }
func (*GetPropertiesResponse) Descriptor
deprecated
func (*GetPropertiesResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetPropertiesResponse.ProtoReflect.Descriptor instead.
func (*GetPropertiesResponse) GetDistortionParameters ¶
func (x *GetPropertiesResponse) GetDistortionParameters() *DistortionParameters
func (*GetPropertiesResponse) GetFrameRate ¶ added in v0.1.340
func (x *GetPropertiesResponse) GetFrameRate() float32
func (*GetPropertiesResponse) GetIntrinsicParameters ¶
func (x *GetPropertiesResponse) GetIntrinsicParameters() *IntrinsicParameters
func (*GetPropertiesResponse) GetMimeTypes ¶ added in v0.1.237
func (x *GetPropertiesResponse) GetMimeTypes() []string
func (*GetPropertiesResponse) GetSupportsPcd ¶
func (x *GetPropertiesResponse) GetSupportsPcd() bool
func (*GetPropertiesResponse) ProtoMessage ¶
func (*GetPropertiesResponse) ProtoMessage()
func (*GetPropertiesResponse) ProtoReflect ¶
func (x *GetPropertiesResponse) ProtoReflect() protoreflect.Message
func (*GetPropertiesResponse) Reset ¶
func (x *GetPropertiesResponse) Reset()
func (*GetPropertiesResponse) String ¶
func (x *GetPropertiesResponse) String() string
type Image ¶ added in v0.1.156
type Image struct { // the name of the sensor where the image came from SourceName string `protobuf:"bytes,1,opt,name=source_name,json=sourceName,proto3" json:"source_name,omitempty"` // format of the response image bytes Format Format `protobuf:"varint,2,opt,name=format,proto3,enum=viam.component.camera.v1.Format" json:"format,omitempty"` // image in bytes Image []byte `protobuf:"bytes,3,opt,name=image,proto3" json:"image,omitempty"` // contains filtered or unexported fields }
func (*Image) Descriptor
deprecated
added in
v0.1.156
func (*Image) GetSourceName ¶ added in v0.1.156
func (*Image) ProtoMessage ¶ added in v0.1.156
func (*Image) ProtoMessage()
func (*Image) ProtoReflect ¶ added in v0.1.156
func (x *Image) ProtoReflect() protoreflect.Message
type IntrinsicParameters ¶
type IntrinsicParameters struct { WidthPx uint32 `protobuf:"varint,1,opt,name=width_px,json=widthPx,proto3" json:"width_px,omitempty"` HeightPx uint32 `protobuf:"varint,2,opt,name=height_px,json=heightPx,proto3" json:"height_px,omitempty"` FocalXPx float64 `protobuf:"fixed64,3,opt,name=focal_x_px,json=focalXPx,proto3" json:"focal_x_px,omitempty"` FocalYPx float64 `protobuf:"fixed64,4,opt,name=focal_y_px,json=focalYPx,proto3" json:"focal_y_px,omitempty"` CenterXPx float64 `protobuf:"fixed64,5,opt,name=center_x_px,json=centerXPx,proto3" json:"center_x_px,omitempty"` CenterYPx float64 `protobuf:"fixed64,6,opt,name=center_y_px,json=centerYPx,proto3" json:"center_y_px,omitempty"` // contains filtered or unexported fields }
func (*IntrinsicParameters) Descriptor
deprecated
func (*IntrinsicParameters) Descriptor() ([]byte, []int)
Deprecated: Use IntrinsicParameters.ProtoReflect.Descriptor instead.
func (*IntrinsicParameters) GetCenterXPx ¶
func (x *IntrinsicParameters) GetCenterXPx() float64
func (*IntrinsicParameters) GetCenterYPx ¶
func (x *IntrinsicParameters) GetCenterYPx() float64
func (*IntrinsicParameters) GetFocalXPx ¶
func (x *IntrinsicParameters) GetFocalXPx() float64
func (*IntrinsicParameters) GetFocalYPx ¶
func (x *IntrinsicParameters) GetFocalYPx() float64
func (*IntrinsicParameters) GetHeightPx ¶
func (x *IntrinsicParameters) GetHeightPx() uint32
func (*IntrinsicParameters) GetWidthPx ¶
func (x *IntrinsicParameters) GetWidthPx() uint32
func (*IntrinsicParameters) ProtoMessage ¶
func (*IntrinsicParameters) ProtoMessage()
func (*IntrinsicParameters) ProtoReflect ¶
func (x *IntrinsicParameters) ProtoReflect() protoreflect.Message
func (*IntrinsicParameters) Reset ¶
func (x *IntrinsicParameters) Reset()
func (*IntrinsicParameters) String ¶
func (x *IntrinsicParameters) String() string
type Property ¶
type Property struct { // Video resolution width in px WidthPx int32 `protobuf:"varint,1,opt,name=width_px,json=widthPx,proto3" json:"width_px,omitempty"` // Video resolution height in px HeightPx int32 `protobuf:"varint,2,opt,name=height_px,json=heightPx,proto3" json:"height_px,omitempty"` // Video frame format FrameFormat string `protobuf:"bytes,3,opt,name=frame_format,json=frameFormat,proto3" json:"frame_format,omitempty"` // Video frame rate in fps FrameRate float32 `protobuf:"fixed32,4,opt,name=frame_rate,json=frameRate,proto3" json:"frame_rate,omitempty"` // contains filtered or unexported fields }
func (*Property) Descriptor
deprecated
func (*Property) GetFrameFormat ¶
func (*Property) GetFrameRate ¶ added in v0.1.125
func (*Property) GetHeightPx ¶ added in v0.1.1
func (*Property) GetWidthPx ¶ added in v0.1.1
func (*Property) ProtoMessage ¶
func (*Property) ProtoMessage()
func (*Property) ProtoReflect ¶
func (x *Property) ProtoReflect() protoreflect.Message
type RenderFrameRequest ¶
type RenderFrameRequest struct { // Name of a camera Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` // Requested MIME type of response MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"` // Additional arguments to the method Extra *structpb.Struct `protobuf:"bytes,99,opt,name=extra,proto3" json:"extra,omitempty"` // contains filtered or unexported fields }
func (*RenderFrameRequest) Descriptor
deprecated
func (*RenderFrameRequest) Descriptor() ([]byte, []int)
Deprecated: Use RenderFrameRequest.ProtoReflect.Descriptor instead.
func (*RenderFrameRequest) GetExtra ¶ added in v0.1.175
func (x *RenderFrameRequest) GetExtra() *structpb.Struct
func (*RenderFrameRequest) GetMimeType ¶
func (x *RenderFrameRequest) GetMimeType() string
func (*RenderFrameRequest) GetName ¶
func (x *RenderFrameRequest) GetName() string
func (*RenderFrameRequest) ProtoMessage ¶
func (*RenderFrameRequest) ProtoMessage()
func (*RenderFrameRequest) ProtoReflect ¶
func (x *RenderFrameRequest) ProtoReflect() protoreflect.Message
func (*RenderFrameRequest) Reset ¶
func (x *RenderFrameRequest) Reset()
func (*RenderFrameRequest) String ¶
func (x *RenderFrameRequest) String() string
type UnimplementedCameraServiceServer ¶
type UnimplementedCameraServiceServer struct { }
UnimplementedCameraServiceServer must be embedded to have forward compatible implementations.
func (UnimplementedCameraServiceServer) DoCommand ¶ added in v0.1.79
func (UnimplementedCameraServiceServer) DoCommand(context.Context, *v1.DoCommandRequest) (*v1.DoCommandResponse, error)
func (UnimplementedCameraServiceServer) GetGeometries ¶ added in v0.1.129
func (UnimplementedCameraServiceServer) GetGeometries(context.Context, *v1.GetGeometriesRequest) (*v1.GetGeometriesResponse, error)
func (UnimplementedCameraServiceServer) GetImage ¶
func (UnimplementedCameraServiceServer) GetImage(context.Context, *GetImageRequest) (*GetImageResponse, error)
func (UnimplementedCameraServiceServer) GetImages ¶ added in v0.1.156
func (UnimplementedCameraServiceServer) GetImages(context.Context, *GetImagesRequest) (*GetImagesResponse, error)
func (UnimplementedCameraServiceServer) GetPointCloud ¶
func (UnimplementedCameraServiceServer) GetPointCloud(context.Context, *GetPointCloudRequest) (*GetPointCloudResponse, error)
func (UnimplementedCameraServiceServer) GetProperties ¶
func (UnimplementedCameraServiceServer) GetProperties(context.Context, *GetPropertiesRequest) (*GetPropertiesResponse, error)
func (UnimplementedCameraServiceServer) RenderFrame ¶
func (UnimplementedCameraServiceServer) RenderFrame(context.Context, *RenderFrameRequest) (*httpbody.HttpBody, error)
type UnsafeCameraServiceServer ¶
type UnsafeCameraServiceServer interface {
// contains filtered or unexported methods
}
UnsafeCameraServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to CameraServiceServer will result in compilation errors.
type Webcam ¶
type Webcam struct { // Camera driver label (for internal use only) Label string `protobuf:"bytes,1,opt,name=label,proto3" json:"label,omitempty"` // Camera driver status Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"` // Camera properties Properties []*Property `protobuf:"bytes,3,rep,name=properties,proto3" json:"properties,omitempty"` // Camera human-readable driver name Name string `protobuf:"bytes,4,opt,name=name,proto3" json:"name,omitempty"` // Camera unique identifier Id string `protobuf:"bytes,5,opt,name=id,proto3" json:"id,omitempty"` // contains filtered or unexported fields }
func (*Webcam) Descriptor
deprecated
func (*Webcam) GetProperties ¶
func (*Webcam) ProtoMessage ¶
func (*Webcam) ProtoMessage()
func (*Webcam) ProtoReflect ¶
func (x *Webcam) ProtoReflect() protoreflect.Message
type Webcams ¶
type Webcams struct { Webcams []*Webcam `protobuf:"bytes,1,rep,name=webcams,proto3" json:"webcams,omitempty"` // contains filtered or unexported fields }
func (*Webcams) Descriptor
deprecated
func (*Webcams) GetWebcams ¶
func (*Webcams) ProtoMessage ¶
func (*Webcams) ProtoMessage()
func (*Webcams) ProtoReflect ¶
func (x *Webcams) ProtoReflect() protoreflect.Message