Class ScenesApi

ScenesApi - object-oriented interface

export

Hierarchy

BaseAPI
- ScenesApi

Index

Constructors

constructor

Methods

Constructors

constructor

new ScenesApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): ScenesApi

Inherited from BaseAPI.constructor
- Defined in base.ts:51
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ScenesApi

Methods

createScene

createScene(requestParameters: ScenesApiCreateSceneRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<Scene, any>>

- Defined in api.ts:17371
Create a scene. Once created, add scene items via the createSceneItem API. For details, see our Render static scenes guide.

throws
{RequiredError}

memberof
ScenesApi

Parameters
- requestParameters: ScenesApiCreateSceneRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<Scene, any>>

deleteScene

deleteScene(requestParameters: ScenesApiDeleteSceneRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<void, any>>

- Defined in api.ts:17387
Delete a scene.

throws
{RequiredError}

memberof
ScenesApi

Parameters
- requestParameters: ScenesApiDeleteSceneRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<void, any>>

getQueuedScene

getQueuedScene(requestParameters: ScenesApiGetQueuedSceneRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<QueuedJob, any>>

- Defined in api.ts:17403
Get a queued-scene.

throws
{RequiredError}

memberof
ScenesApi

Parameters
- requestParameters: ScenesApiGetQueuedSceneRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<QueuedJob, any>>

getScene

getScene(requestParameters: ScenesApiGetSceneRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<Scene, any>>

- Defined in api.ts:17419
Get a scene by ID.

throws
{RequiredError}

memberof
ScenesApi

Parameters
- requestParameters: ScenesApiGetSceneRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<Scene, any>>

getScenes

getScenes(requestParameters?: ScenesApiGetScenesRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<SceneList, any>>

- Defined in api.ts:17435
Get scenes.

throws
{RequiredError}

memberof
ScenesApi

Parameters
- requestParameters: ScenesApiGetScenesRequest = {}
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<SceneList, any>>

renderScene

renderScene(requestParameters: ScenesApiRenderSceneRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<any, any>>

- Defined in api.ts:17457
Get a rendered image of a scene. If only a single pixel is returned, ensure the scene is in the commit state and contains scene items.

throws
{RequiredError}

memberof
ScenesApi

Parameters
- requestParameters: ScenesApiRenderSceneRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<any, any>>

updateScene

updateScene(requestParameters: ScenesApiUpdateSceneRequest, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<Scene, any>>

- Defined in api.ts:17478
Update a scene camera and/or state. Once updated, view the scene via the renderScene API or with the Viewer SDK. For details, see our Render static scenes guide.

throws
{RequiredError}

memberof
ScenesApi

Parameters
- requestParameters: ScenesApiUpdateSceneRequest
  
  Request parameters.
- Optional options: AxiosRequestConfig<any>
Returns Promise<AxiosResponse<Scene, any>>