Class RealityCaptureClient

Client providing access to Autodesk Forge capture APIs.

Tutorial

realitycapture

Hierarchy (view full)

Constructors

Properties

axios: AxiosInstance
host: string
region: Region
root: string
token?: string

Methods

  • 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.

  • 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.

  • Parameters

    • endpoint: string
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • Parameters

    • config: AxiosRequestConfig<any>

    Returns Promise<AxiosResponse<any, any>>

  • Parameters

    • endpoint: string
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • Parameters

    • endpoint: string
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • 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.

  • Parameters

    • endpoint: string
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • Parameters

    • endpoint: string
    • data: any
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • Parameters

    • endpoint: string
    • data: any
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • Parameters

    • endpoint: string
    • data: any
    • headers: {
          [name: string]: string;
      } = {}
      • [name: string]: string
    • scopes: string[]

    Returns Promise<any>

  • 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

Generated using TypeDoc