Skip to main content

Remote Assets & Media

Loading media and assets at runtime: RemoteMediaModule, remote references, dynamic resources, and image upload.

Commonly used

Guides

All APIs in this topic

Reference assets and other modules with a script input and require modules with require('LensStudio:<name>').

Components, assets, and modules

APIDescription
RemoteMediaModuleAllows the Lens to download and integrate remote media content such as 3D GLTF assets, images, audio tracks, and video textures into Lenses.
RemoteReferenceAssetProvides a reference to a remote asset (i.e. assets outside of the Lens size limit) that can be downloaded at runtime using script.

Objects and data

APIDescription
DynamicResourceA resource that is resolved at runtime.
ImageUploadOptionsProvides configuration options for uploading images via RemoteMediaModule.uploadImage.
RestrictedResourceA DynamicResource whose raw data cannot be retrieved as bytes or string.

Enums

APIDescription
ImageUploadCompressionMethodSpecifies the compression format to use when uploading an image.