Interface SceneProvider

Provides information & assest for the scenes available in the dressing room.

interface SceneProvider {
    getById(id: ReferenceData): Awaitable<undefined | AssetInfo>;
    getIds(): Awaitable<ReferenceData[]>;
    getName(id: ReferenceData): Awaitable<undefined | string>;
    getThumbnail(id: ReferenceData): Awaitable<undefined | string>;
}

Hierarchy

AssetProvider
- SceneProvider

Index

Methods

getById getIds getName getThumbnail

Methods

getById

getById(id): Awaitable<undefined | AssetInfo>
Returns the asset bundle for a specific resource
Parameters
- id: ReferenceData
  Unique ID if the garment as used in your systems
Returns Awaitable<undefined | AssetInfo>
Inherited from AssetProvider.getById
- Defined in packages/public-types/src/mdrc.ts:41

getIds

getIds(): Awaitable<ReferenceData[]>
Returns a list of ids for the available resources for this provider.

Returns Awaitable<ReferenceData[]>
Inherited from AssetProvider.getIds
- Defined in packages/public-types/src/mdrc.ts:36

getName

getName(id): Awaitable<undefined | string>
Returns the display name of the scene as string. This will be shown in the scene selection drawer.
Parameters
- id: ReferenceData
  Unique ID of the scene
Returns Awaitable<undefined | string>
- Defined in packages/public-types/src/mdrc.ts:108

getThumbnail

getThumbnail(id): Awaitable<undefined | string>
Returns an url to the thumbail image for the scene. This will be shown in the scene selection drawer. Thumbnails should ideally be square.
Parameters
- id: ReferenceData
Returns Awaitable<undefined | string>
- Defined in packages/public-types/src/mdrc.ts:114