Interface: AssetSource

A source of assets

Methods#

findAssets(queryData): Promise<
  | undefined
| AssetsQueryResult<AssetResult>>;

Find all asset for the given type and the provided query data.

Parameter	Type
`queryData`	`AssetQueryData`

optional addAsset(asset): void;

Adds the given asset to this source. Throws an error if the asset source does not support adding assets.

Parameter	Type
`asset`	`AssetDefinition`

void

optional removeAsset(assetId): void;

Removes the given asset from this source.

Parameter	Type
`assetId`	`string`

void

optional getSupportedMimeTypes(): undefined | string[];

Generates a list of supported mime types for this source.

undefined | string[]

a list of the mime types should be supported by this source

Property	Type	Description
`id`	`string`	The unique id of the API
`fetchAsset?`	(`id`) => `Promise`<	`null`
`getGroups?`	() => `Promise`<`string`[]>	Return every available group
`credits?`	`object`	Credits for the source/api
`credits.name`	`string`	-
`credits.url?`	`string`	-
`license?`	`object`	General license for all asset from this source
`license.name`	`string`	-
`license.url?`	`string`	-
~~`canManageAssets?`~~	`boolean`	Can the source add and remove assets dynamically? If `false` methods like `addAsset` and `removeAsset` will throw an error. Deprecated Will be removed in v1.11. Use `canAdd` and `canRemove` in the asset library configuration
`applyAsset?`	(`asset`) => `Promise`<`undefined`	`number`>
`applyAssetToBlock?`	(`asset`, `block`) => `Promise`<`void`>	Apply the given asset result to the given block. You can override this with custom behavior.
`applyAssetProperty?`	(`asset`, `property`) => `Promise`<`void`>	Apply a property of the given asset result to the active scene. You can override this with custom behavior.