Initializes new client with specific authentication method
Authentication object,
containing client_id
and client_secret
properties (for 2-legged authentication).
Optional
host: stringForge API host.
Protected
Optional
authProtected
axiosProtected
hostProtected
regionProtected
rootProtected
Optional
tokenAdds one or more files to a photoscene. Only JPEG images are supported. Maximum number of files in a single request: 20 Maximum size of a single file: 128 MB Maximum uncompressed size of image in memory: 512 MB Note: Uploaded files will be deleted after 30 days. https://forge.autodesk.com/en/docs/reality-capture/v1/reference/http/file-POST|docs.
Specifies the ID of the photoscene to add the files to.
Specifies the type of file being uploaded: image (default) or survey
Specifies the file URLs to be uploaded (i.e. http://, https://). For externally stored files, please verify that the URLs are publically accessible.
A JSON object containing details of the image files uploaded to the photoscene.
Error when the request fails, for example, due to invalid request.
Adds one or more files to a photoscene. Only JPEG images are supported. Maximum number of files in a single request: 20 Maximum size of a single file: 128 MB Maximum uncompressed size of image in memory: 512 MB Note: Uploaded files will be deleted after 30 days. https://forge.autodesk.com/en/docs/reality-capture/v1/reference/http/file-POST|docs.
Specifies the ID of the photoscene to add the files to.
Specifies the type of file being uploaded: image (default) or survey
Specifies the local files to be uploaded.
A JSON object containing details of the image files uploaded to the photoscene.
Error when the request fails, for example, due to invalid request.
Aborts the processing of a photoscene and marks it as cancelled.
Specifices the ID of the photoscene to cancel.
A JSON object containing information on cancelled job.
Error when the request fails, for example, due to invalid request.
Creates new photoscene https://forge.autodesk.com/en/docs/reality-capture/v1/reference/http/photoscene-POST|docs.
Specifies the parameters for the new photoscene.
A JSON object containing details of the photoscene that was created, with property 'photosceneid' ID of the photoscene that was created.
Error when the request fails, for example, due to invalid request.
Protected
deleteDeletes a photoscene and its associated assets (images, output files, ...).
Specifices the ID of the photoscene to delete.
A JSON object containing information on deleted job.
Error when the request fails, for example, due to invalid request.
Protected
fetchProtected
getProtected
getReturns a time-limited HTTPS link to an output file of the specified format. Note: The link will expire 30 days after the date of processing completion.
Specifies the ID of the photoscene to download the output
A JSON object containing time-bound HTTPS link to the output file.
Error when the request fails, for example, due to invalid request.
Returns the processing progress and status of a photoscene.
Specifies the ID of the photoscene to retrieve status
A JSON object containing details of current progress status.
Error when the request fails, for example, due to invalid request.
Protected
getProtected
patchProtected
postStarts photoscene processing. The main processing steps involve: camera calibration, mesh reconstruction, texturing, and any necessary output file format conversions, in that order. This method should not be called until a photoscene has been created and at least three images have been added to the photoscene. Note: Progress of the processing can be monitored with the GET photoscene/:photosceneid/progress method. https://forge.autodesk.com/en/docs/reality-capture/v1/reference/http/photoscene-:photosceneid-POST|docs.
Specifies the ID of the photoscene to start processing.
A JSON object containing a message for current processing job.
Error when the request fails, for example, due to invalid request.
Protected
putResets client to specific authentication method, Forge host, and availability region.
Optional
auth: IAuthOptionsAuthentication object,
containing either client_id
and client_secret
properties (for 2-legged authentication),
or a single token
property (for 2-legged or 3-legged authentication with pre-generated access token).
Optional
host: stringForge API host.
Optional
region: RegionForge availability region ("US" or "EMEA").
Protected
setGenerated using TypeDoc
Client providing access to Autodesk Forge capture APIs.
Tutorial
realitycapture