Class RealityCaptureClient

Client providing access to Autodesk Forge capture APIs.

Tutorial

realitycapture

Hierarchy (view full)

ForgeClient
- RealityCaptureClient

Index

Constructors

constructor

new RealityCaptureClient(auth, host?): RealityCaptureClient
Initializes new client with specific authentication method
Parameters
- auth: IAuthOptions
  Authentication object, containing client_id and client_secret properties (for 2-legged authentication).
- Optional host: string
  Forge API host.
Returns RealityCaptureClient
Overrides ForgeClient.constructor
- Defined in reality-capture.ts:137

Properties

`Protected` `Optional` auth

auth?: AuthenticationClient

`Protected` axios

axios: AxiosInstance

`Protected` host

host: string

`Protected` region

region: Region

`Protected` root

root: string

`Protected` `Optional` token

token?: string

Methods

addImageURLs

addImageURLs(photosceneid, type, files): Promise<IPhotoSceneError | IFiles[]>
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.
Parameters
- photosceneid: string
  Specifies the ID of the photoscene to add the files to.
- type: FileType
  Specifies the type of file being uploaded: image (default) or survey
- files: string[]
  Specifies the file URLs to be uploaded (i.e. http://, https://). For externally stored files, please verify that the URLs are publically accessible.
Returns Promise<IPhotoSceneError | IFiles[]>
A JSON object containing details of the image files uploaded to the photoscene.

Async
Throws
Error when the request fails, for example, due to invalid request.
- Defined in reality-capture.ts:232

addImages

addImages(photosceneid, type, files): Promise<IPhotoSceneError | IFiles[]>
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.
Parameters
- photosceneid: string
  Specifies the ID of the photoscene to add the files to.
- type: FileType
  Specifies the type of file being uploaded: image (default) or survey
- files: Buffer[]
  Specifies the local files to be uploaded.
Returns Promise<IPhotoSceneError | IFiles[]>
A JSON object containing details of the image files uploaded to the photoscene.

Async
Throws
Error when the request fails, for example, due to invalid request.
- Defined in reality-capture.ts:205

cancelPhotoScene

cancelPhotoScene(photosceneid): Promise<IPhotoSceneCancelDelete | IPhotoSceneError>
Aborts the processing of a photoscene and marks it as cancelled.
Parameters
- photosceneid: string
  Specifices the ID of the photoscene to cancel.
Returns Promise<IPhotoSceneCancelDelete | IPhotoSceneError>
A JSON object containing information on cancelled job.

Async
Throws
Error when the request fails, for example, due to invalid request.
- Defined in reality-capture.ts:292

createPhotoScene

createPhotoScene(options): Promise<IPhotoScene>
Creates new photoscene https://forge.autodesk.com/en/docs/reality-capture/v1/reference/http/photoscene-POST|docs.
Parameters
- options: IPhotoSceneOptions
  Specifies the parameters for the new photoscene.
Returns Promise<IPhotoScene>
A JSON object containing details of the photoscene that was created, with property 'photosceneid' ID of the photoscene that was created.

Async
Throws
Error when the request fails, for example, due to invalid request.
- Defined in reality-capture.ts:149

`Protected` delete

delete(endpoint, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.delete
- Defined in common.ts:161

deletePhotoScene

deletePhotoScene(photosceneid): Promise<IPhotoSceneCancelDelete | IPhotoSceneError>
Deletes a photoscene and its associated assets (images, output files, ...).
Parameters
- photosceneid: string
  Specifices the ID of the photoscene to delete.
Returns Promise<IPhotoSceneCancelDelete | IPhotoSceneError>
A JSON object containing information on deleted job.

Async
Throws
Error when the request fails, for example, due to invalid request.
- Defined in reality-capture.ts:305

`Protected` fetch

fetch(config): Promise<AxiosResponse<any, any>>
Parameters
- config: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<any, any>>
Inherited from ForgeClient.fetch
- Defined in common.ts:101

`Protected` get

get(endpoint, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.get
- Defined in common.ts:107

`Protected` getBuffer

getBuffer(endpoint, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.getBuffer
- Defined in common.ts:116

getPhotoScene

getPhotoScene(photosceneid, format): Promise<IPhotoSceneError | IPhotoSceneOutput>
Returns 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.
Parameters
- photosceneid: string
  Specifies the ID of the photoscene to download the output
- format: OutputFormat
Returns Promise<IPhotoSceneError | IPhotoSceneOutput>
A JSON object containing time-bound HTTPS link to the output file.

Async
Throws
Error when the request fails, for example, due to invalid request.
- Defined in reality-capture.ts:281

getPhotoSceneProgress

getPhotoSceneProgress(photosceneid): Promise<IPhotoSceneError | IPhotoSceneProgress>
Returns the processing progress and status of a photoscene.
Parameters
- photosceneid: string
  Specifies the ID of the photoscene to retrieve status
Returns Promise<IPhotoSceneError | IPhotoSceneProgress>
A JSON object containing details of current progress status.

Async
Throws
Error when the request fails, for example, due to invalid request.
- Defined in reality-capture.ts:269

`Protected` getStream

getStream(endpoint, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.getStream
- Defined in common.ts:125

`Protected` patch

patch(endpoint, data, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- data: any
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.patch
- Defined in common.ts:152

`Protected` post

post(endpoint, data, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- data: any
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.post
- Defined in common.ts:134

processPhotoScene

processPhotoScene(photosceneid): Promise<IPhotoSceneError | IPhotoSceneProcess>
Starts 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.
Parameters
- photosceneid: string
  Specifies the ID of the photoscene to start processing.
Returns Promise<IPhotoSceneError | IPhotoSceneProcess>
A JSON object containing a message for current processing job.

Async
Throws
Error when the request fails, for example, due to invalid request.
- Defined in reality-capture.ts:256

`Protected` put

put(endpoint, data, headers?, scopes): Promise<any>
Parameters
- endpoint: string
- data: any
- headers: {
  [name: string]: string;
  } = {}
  - [name: string]: string
- scopes: string[]
Returns Promise<any>
Inherited from ForgeClient.put
- Defined in common.ts:143

reset

reset(auth?, host?, region?): void
Resets client to specific authentication method, Forge host, and availability region.
Parameters
- Optional auth: IAuthOptions
  Authentication 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: string
  Forge API host.
- Optional region: Region
  Forge availability region ("US" or "EMEA").
Returns void
Inherited from ForgeClient.reset
- Defined in common.ts:71

`Protected` setAuthorization

setAuthorization(options, scopes): Promise<void>
Parameters
- options: any
- scopes: string[]
Returns Promise<void>
Inherited from ForgeClient.setAuthorization
- Defined in common.ts:90

Class RealityCaptureClient

Tutorial

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

auth: IAuthOptions

Optional host: string

Returns RealityCaptureClient

Properties

Protected Optional auth

Protected axios

Protected host

Protected region

Protected root

Protected Optional token

Methods

addImageURLs

Parameters

photosceneid: string

type: FileType

files: string[]

Returns Promise<IPhotoSceneError | IFiles[]>

Async

Throws

addImages

Parameters

photosceneid: string

type: FileType

files: Buffer[]

Returns Promise<IPhotoSceneError | IFiles[]>

Async

Throws

cancelPhotoScene

Parameters

photosceneid: string

Returns Promise<IPhotoSceneCancelDelete | IPhotoSceneError>

Async

Throws

createPhotoScene

Parameters

options: IPhotoSceneOptions

Returns Promise<IPhotoScene>

Async

Throws

Protected delete

Parameters

endpoint: string

headers: { [name: string]: string; } = {}

[name: string]: string

scopes: string[]

Returns Promise<any>

deletePhotoScene

Parameters

photosceneid: string

Returns Promise<IPhotoSceneCancelDelete | IPhotoSceneError>

Async

Throws

Protected fetch

Parameters

config: AxiosRequestConfig<any>

Returns Promise<AxiosResponse<any, any>>

Protected get

Parameters

endpoint: string

headers: { [name: string]: string; } = {}

[name: string]: string

scopes: string[]

Returns Promise<any>

Protected getBuffer

Parameters

endpoint: string

headers: { [name: string]: string; } = {}

[name: string]: string

scopes: string[]

Returns Promise<any>

`Optional` host: string

`Protected` `Optional` auth

`Protected` axios

`Protected` host

`Protected` region

`Protected` root

`Protected` `Optional` token

`Protected` delete

headers: {
[name: string]: string;
} = {}

`Protected` fetch

`Protected` get

headers: {
[name: string]: string;
} = {}

`Protected` getBuffer

headers: {
[name: string]: string;
} = {}

`Protected` getStream

headers: {
[name: string]: string;
} = {}

`Protected` patch

headers: {
[name: string]: string;
} = {}

`Protected` post

headers: {
[name: string]: string;
} = {}

`Protected` put

headers: {
[name: string]: string;
} = {}

`Optional` auth: IAuthOptions

`Optional` host: string

`Optional` region: Region

`Protected` setAuthorization