viam.media.video

Module Contents

Classes

RawImage

A raw bytes representation of an image.

CameraMimeType

str(object='') -> str

ViamImage

A native implementation of an image.

NamedImage

An implementation of ViamImage that contains a name attribute.

Attributes

LAZY_SUFFIX

LIBRARY_SUPPORTED_FORMATS

viam.media.video.LAZY_SUFFIX = '+lazy'
viam.media.video.LIBRARY_SUPPORTED_FORMATS
class viam.media.video.RawImage[source]

Bases: NamedTuple

A raw bytes representation of an image.

A RawImage should be returned instead of a PIL Image instance under one of the following conditions

  1. The requested mime type has the LAZY_SUFFIX string appended to it

2) The requested mime type is not supported for decoding/encoding by Viam’s Python SDK

data: bytes

The raw data of the image

mime_type: str

The mimetype of the image

close()[source]

Close the image and release resources. For RawImage, this is a noop.

bytes_to_depth_array() List[List[int]][source]

Decode the data of an image that has the custom depth MIME type image/vnd.viam.dep into a standard representation.

Raises:

NotSupportedError – Raised if given an image that is not of MIME type image/vnd.viam.dep.

Returns:

The standard representation of the image.

Return type:

List[List[int]]

class viam.media.video.CameraMimeType[source]

Bases: str, enum.Enum

str(object=’’) -> str str(bytes_or_buffer[, encoding[, errors]]) -> str

Create a new string object from the given object. If encoding or errors is specified, then the object must expose a data buffer that will be decoded using the given encoding and error handler. Otherwise, returns the result of object.__str__() (if defined) or repr(object). encoding defaults to sys.getdefaultencoding(). errors defaults to ‘strict’.

property with_lazy_suffix: str
VIAM_RGBA = 'image/vnd.viam.rgba'
VIAM_RAW_DEPTH = 'image/vnd.viam.dep'
JPEG = 'image/jpeg'
PNG = 'image/png'
PCD = 'pointcloud/pcd'
UNSUPPORTED = 'unsupported'
classmethod from_lazy(value: str) Tuple[typing_extensions.Self, bool][source]
encode_image(image: Union[PIL.Image.Image, RawImage]) bytes[source]
classmethod is_supported(mime_type: str) bool[source]

Check if the provided mime_type is supported.

Parameters:

mime_type (str) – The mime_type to check

Returns:

Whether the mime_type is supported

Return type:

bool

classmethod from_proto(format: viam.proto.component.camera.Format.ValueType) typing_extensions.Self[source]

Returns the mimetype from a proto enum.

Parameters:

format (Format.ValueType) – The mimetype in a proto enum.

Returns:

The mimetype.

Return type:

Self

to_proto() viam.proto.component.camera.Format.ValueType[source]

Returns the mimetype in a proto enum.

Returns:

The mimetype in a proto enum.

Return type:

Format.ValueType

class viam.media.video.ViamImage(data: bytes, mime_type: CameraMimeType)[source]

A native implementation of an image.

Provides the raw data and the mime type, as well as lazily loading and caching the PIL.Image representation.

property data: bytes

The raw bytes of the image

property mime_type: CameraMimeType

The mime type of the image

property image: Optional[PIL.Image.Image]

The PIL.Image representation of the image. If the mime type is not supported, this will be None.

close()[source]

Close the image and release resources.

bytes_to_depth_array() List[List[int]][source]

Decode the data of an image that has the custom depth MIME type image/vnd.viam.dep into a standard representation.

Raises:

NotSupportedError – Raised if given an image that is not of MIME type image/vnd.viam.dep.

Returns:

The standard representation of the image.

Return type:

List[List[int]]

class viam.media.video.NamedImage(name: str, data: bytes, mime_type: CameraMimeType)[source]

Bases: ViamImage

An implementation of ViamImage that contains a name attribute.

name: str

The name of the image

close()

Close the image and release resources.