LIF Encoder

post

https://api.immersity.ai/api/v1/encode

This API allows you to encode a 2D image into a LIF file.

Body Params

The input parameters for the LIF encoder

resultPresignedUrl

string

Readable output image url

inputSingleImageUrl

string

Readable input image url

inputSingleDisparityUrl

string

Readable input disparity url

inputLeftImageUrl

string

Readable input image url

inputRightImageUrl

string

Readable input image url

inputLeftDisparityUrl

string

Readable input disparity url

inputRightDisparityUrl

string

Readable input disparity url

inputDisparitySource

string

Disparity source

gain

number

0 to 10

Defaults to Gain is estimated automatically based on input image for best results

Floating point gain value

convergence

number

-1 to 1

Defaults to Convergence is estimated automatically based on input image for best results

This changes the overall depth of the image to place objects in front of the screen or behind the screen or somewhere in between. It ranges from -1 to 1.

correlationId

string

UUID to correlate this request. This must be unique for each request. If not provided, the service will generate one

Responses

400

The request has invalid parameters

401

Returned if the user is not authenticated or authentication parameters are invalid

402

Returned it there is not enough credit balance

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The request has succeeded