imageio

Classes:

• Media –

  A dataclass representing some media.

• MediaSerializer –

  Serializer for ImageIO Arrays.

Attributes:

• media_serializer –

  MediaSerializer with default settings.

media_serializer module-attribute

media_serializer = MediaSerializer()

MediaSerializer with default settings.

Media

A dataclass representing some media.

Attributes:

• data (NDArray | Sequence[NDArray]) –

  The media data.

• extension (str | None) –

  The file extension of the media data.

• plugin (str | None) –

  The plugin used to read/write the media data.

data instance-attribute

data: NDArray | Sequence[NDArray]

The media data.

extension class-attribute instance-attribute

extension: str | None = None

The file extension of the media data.

plugin class-attribute instance-attribute

plugin: str | None = None

The plugin used to read/write the media data.

MediaSerializer

MediaSerializer(mimetypes: MimeTypes = _DEFAULT_MIMETYPES)

Bases: Serializer[Media, '_MediaSerializerConfig']

Serializer for ImageIO Arrays.

Parameters:

• mimetypes

  (MimeTypes, default: _DEFAULT_MIMETYPES ) –

  The MIME types to use for guessing the content type and encoding.

Methods:

• deserialize_config –

  Deserialize the configuration from a JSON string.

• deserialize_data –

  Deserialize the given array.

• serialize_config –

  Serialize the configuration to a JSON string.

• serialize_data –

  Serialize the given array.

Attributes:

• content_types (tuple[str, ...]) –

  The content types that the serializer uses.

content_types class-attribute instance-attribute

content_types: tuple[str, ...] = ()

The content types that the serializer uses.

Used to get serializers by content type in the registry.

deserialize_config

deserialize_config(config: str) -> C

Deserialize the configuration from a JSON string.

deserialize_data

deserialize_data(
    content: SerializedData[_MediaSerializerConfig],
) -> Media

Deserialize the given array.

serialize_config

serialize_config(config: C) -> str

Serialize the configuration to a JSON string.

serialize_data

serialize_data(
    media: Media,
) -> SerializedData[_MediaSerializerConfig]

Serialize the given array.