Skip to main content
Version: Next

Interface: Media

torchlive/media.Media

Methods

imageFromBlob

imageFromBlob(blob, width, height): Image

deprecated This function will be removed in the next release. Use imageFromTensor instead.

const tensor = torch.fromBlob(blob, [imageHeight, imageWidth, channels]);
const image = media.imageFromTensor(tensor);

Converts a Blob into an Image. The blob should be in RGB format. The width and height input should match the blob size. i.e. blob.getDirectSize() equals width * height * 3.

Parameters

NameTypeDescription
blobBlobBlob to turn into an Image.
widthnumberThe width of the image.
heightnumber-

Returns

Image

An Image object created from the Blob.


imageFromFile

imageFromFile(filepath): Image

experimental This function is experimental and can change.

Loads an Image from a file. The function will throw an error if the image couldn't be loaded.

Parameters

NameTypeDescription
filepathstringA local file path to an image.

Returns

Image

An Image loaded from filepath.


imageFromFrame

imageFromFrame(frame): Image

Converts a VisionCamera Frame into an Image. This function has to be called inside a Frame Processor, as the Frame only exists inside a Frame Processor.

Requires react-native-vision-camera to be installed.

Parameters

NameTypeDescription
frameFrameVisionCameraFrame to turn into an Image.

Returns

Image

An Image object created from the VisionCameraFrame.


imageFromTensor

imageFromTensor(tensor): Image

Converts a Tensor into an Image. The tensor should be in CHW (channels, height, width) format, with uint8 type.

There are some assumptions made about the input tensor:

  • If the tensor has 4 channels, it is assumed to be RGBA.
  • If the tensor has 3 channels, it is assumed to be RGB.
  • If the tensor has 1 channel, it is assumed to be grayscale.

Parameters

NameTypeDescription
tensorTensorTensor to turn into an Image.

Returns

Image

An Image object created from the Tensor.


imageToFile

imageToFile(image, filepath): string

experimental This function is experimental and can change.

Saves an Image to a file. The second argument is the local filepath at which the image will be saved. The filepath can be created by using a third-party React Native package like react-native-fs (i.e., RNFS).

const image = await ImageUtil.fromURL('https://example.com/image.jpg');
const filepath = media.imageToFile(
image,
RNFS.DownloadDirectoryPath + '/saved_image.png',
);
image.release();

The function will throw an error if the Image couldn't be saved.

Parameters

NameTypeDescription
imageImageImage that should be saved to a file.
filepathstringThe filepath at which the image will be saved.

Returns

string

The filepath of the saved image.


toBlob

toBlob(obj): Blob

Converts a Tensor or NativeJSRef into a Blob. The blob can be used to create a Tensor object or convert into a NativeJSRef like an image or audio.

Parameters

NameTypeDescription
objNativeJSRef | TensorObject to turn into a Blob.

Returns

Blob