Class RemoteMediaModule

Allows the Lens to download and integrate remote media content such as 3D GLTF assets, images, audio tracks, and video textures into Lenses.

Example

// @input Asset.BitmojiModule bitmojiModule
// @input Asset.RemoteMediaModule remoteMediaModule
// @input Asset.Material pbrMaterialHolder

script.bitmojiModule.requestBitmoji3DResource(
    function (bitmoji3DResource) {
      script.remoteMediaModule.loadResourceAsGltfAsset(
        bitmoji3DResource,
        onDownloaded,
        onFail
      )
    }
  )

function onDownloaded (gltfAsset){
  var root = scene.createSceneObject("BitmojiAvatar");
  var avatar = gltfAsset.tryInstantiate(root, script.pbrMaterialHolder);
}

function onFail (e){
    print(e);
}

Hierarchy (View Summary)

Asset
- RemoteMediaModule

Index

Properties

name uniqueIdentifier

Methods

getTypeName isOfType isSame loadResourceAsAudioTrackAsset loadResourceAsBytes loadResourceAsGaussianSplattingAsset loadResourceAsGltfAsset loadResourceAsImageTexture loadResourceAsRuntimeBundle loadResourceAsString loadResourceAsVideoTexture uploadImage

Properties

name

name: string

The name of the Asset in Lens Studio.

`Readonly`uniqueIdentifier

uniqueIdentifier: string

Methods

getTypeName

getTypeName(): string
Returns the name of this object's type.

Returns string
Inherited from Asset.getTypeName

isOfType

isOfType(type: string): boolean
Returns true if the object matches or derives from the passed in type.
Parameters
- type: string
Returns boolean
Inherited from Asset.isOfType

isSame

isSame(other: ScriptObject): boolean
Returns true if this object is the same as other. Useful for checking if two references point to the same thing.
Parameters
- other: ScriptObject
Returns boolean
Inherited from Asset.isSame

loadResourceAsAudioTrackAsset

loadResourceAsAudioTrackAsset(
    resource: DynamicResource,
    onSuccess: (audioTrackAsset: AudioTrackAsset) => void,
    onFailure: (errorMessage: string) => void,
): void
Downloads the remote image resource from the DynamicResource object and loads the resource as AudioTrackAsset.
Parameters
- resource: DynamicResource
- onSuccess: (audioTrackAsset: AudioTrackAsset) => void
- onFailure: (errorMessage: string) => void
Returns void

loadResourceAsBytes

loadResourceAsBytes(
    resource: DynamicResource,
    onSuccess: (bytes: Uint8Array) => void,
    onFailure: (errorMessage: string) => void,
): void
Parameters
- resource: DynamicResource
- onSuccess: (bytes: Uint8Array) => void
- onFailure: (errorMessage: string) => void
Returns void

loadResourceAsGaussianSplattingAsset

loadResourceAsGaussianSplattingAsset(
    resource: DynamicResource,
    onSuccess: (gaussianSplattingAsset: GaussianSplattingAsset) => void,
    onFailure: (errorMessage: string) => void,
): void
Download the file from the DynamicResource object and loads the resource as a GaussianSplattingAsset. Supported file formats: .ply, .gs, .gsaf, .gfrosting
Parameters
- resource: DynamicResource
- onSuccess: (gaussianSplattingAsset: GaussianSplattingAsset) => void
- onFailure: (errorMessage: string) => void
Returns void
Example
```
// @input Asset.RemoteMediaModule mediaModule
// @input string url

let gsVisual = script.getSceneObject().getComponent("Component.GaussianSplattingVisual")
function success(gsa) { gsVisual.asset = gsa }
function fail(msg) { print('Error: ' + msg) }
const resource = DynamicResource.createWithResourceId(script.url)
script.mediaModule.loadResourceAsGaussianSplattingAsset(resource, success, fail)
```

loadResourceAsGltfAsset

loadResourceAsGltfAsset(
    resource: DynamicResource,
    onSuccess: (glTFAsset: GltfAsset) => void,
    onFailure: (errorMessage: string) => void,
): void
Downloads a remote 3D GLTF file given a DynamicResource.
Parameters
- resource: DynamicResource
- onSuccess: (glTFAsset: GltfAsset) => void
- onFailure: (errorMessage: string) => void
Returns void

loadResourceAsImageTexture

loadResourceAsImageTexture(
    resource: DynamicResource,
    onSuccess: (texture: Texture) => void,
    onFailure: (errorMessage: string) => void,
): void
Downloads the remote image resource from the DynamicResource object and loads the resource as an Image Texture.
Parameters
- resource: DynamicResource
- onSuccess: (texture: Texture) => void
- onFailure: (errorMessage: string) => void
Returns void

loadResourceAsRuntimeBundle

loadResourceAsRuntimeBundle(
    resource: DynamicResource,
    onSuccess: (asset: Asset) => void,
    onFailure: (errorMessage: string) => void,
): void
Downloads the remote asset resource from the DynamicResource object and loads the resource as an Asset.
Parameters
- resource: DynamicResource
- onSuccess: (asset: Asset) => void
- onFailure: (errorMessage: string) => void
Returns void

loadResourceAsString

loadResourceAsString(
    resource: DynamicResource,
    onSuccess: (string: string) => void,
    onFailure: (errorMessage: string) => void,
): void
Parameters
- resource: DynamicResource
- onSuccess: (string: string) => void
- onFailure: (errorMessage: string) => void
Returns void

loadResourceAsVideoTexture

loadResourceAsVideoTexture(
    resource: DynamicResource,
    onSuccess: (texture: Texture) => void,
    onFailure: (errorMessage: string) => void,
): void
Downloads the remote image resource from the DynamicResource object and loads the resource as a VideoTextureProvider.
Parameters
- resource: DynamicResource
- onSuccess: (texture: Texture) => void
- onFailure: (errorMessage: string) => void
Returns void

uploadImage

uploadImage(
    resource: Texture,
    onSuccess: (resource: DynamicResource) => void,
    onFailure: (errorMessage: string) => void,
    uploadOptions?: ImageUploadOptions,
): void
Uploads a Texture as an image and returns a DynamicResource on success. Use ImageUploadOptions to configure the compression method, quality, and alpha channel inclusion.
Parameters
- resource: Texture
- onSuccess: (resource: DynamicResource) => void
- onFailure: (errorMessage: string) => void
- OptionaluploadOptions: ImageUploadOptions
Returns void

Class RemoteMediaModule

Example

Hierarchy (View Summary)

Index

Properties

Methods

Properties

name

ReadonlyuniqueIdentifier

Methods

getTypeName

Returns string

isOfType

Parameters

Returns boolean

isSame

Parameters

Returns boolean

loadResourceAsAudioTrackAsset

Parameters

Returns void

loadResourceAsBytes

Parameters

Returns void

loadResourceAsGaussianSplattingAsset

Parameters

Returns void

Example

loadResourceAsGltfAsset

Parameters

Returns void

loadResourceAsImageTexture

Parameters

Returns void

loadResourceAsRuntimeBundle

Parameters

Returns void

loadResourceAsString

Parameters

Returns void

loadResourceAsVideoTexture

Parameters

Returns void

uploadImage

Parameters

Returns void

Settings

On This Page

`Readonly`uniqueIdentifier