Bixby Developer Center

Guides
References

Image (viv.image)

Note

The viv.image capsule has been deprecated, and will be removed from Bixby in the future. New capsules should not import it, and capsules that currently rely on it should be rewritten to avoid the dependency.

Instead of using the viv.image.Image model, your capsules should use the corresponding viv.core.BaseImage model.

The viv.image capsule provides a basic concept, Image, for storing image metadata; many other library capsules, such as viv.contact, import this for image handling purposes.

Models

Note

Types are always in the viv.* namespace, and in the viv.image.* namespace unless another namespace is specified (e.g., viv.rating.*). All properties have a cardinality of min (Optional), max (One) unless otherwise specified.

PropertyTypeKindNotes
urlUrltextRequired
sizeSizeinteger
dimensionsDimensionsstructure
rotationmeasurement.AngleValuedecimal
captionCaptiontext 

The Dimensions structure contains two integer properties:

PropertyTypeKindNotes
heightHeightinteger
widthWidthinteger 
Note

viv.image does not store images on the device Bixby is running on, but stores metadata for images along with URL-based references to them.