Class RemoteReferenceAsset

Provides a reference to a remote asset (i.e. assets outside of the Lens size limit) that can be downloaded at runtime using script.

See

Remote Assets

Example

//@input Asset.RemoteReferenceAsset myRemoteReferenceAsset
//@input Component.AudioComponent myAudioComponent

function onFailed() {
    print("Asset wasn't downloaded from the reference " + script.myRemoteReferenceAsset.name);
}

function previewDownloadedAsset(asset) {
    if (asset.isOfType("Asset.AudioTrackAsset")) {
        script.myAudioComponent.audioTrack = asset;
        script.myAudioComponent.play(1);
    } else {
        print("Warning, asset has type " + asset.getTypeName() + ", please set Audio Component input to display");
    }
}

script.myRemoteReferenceAsset.downloadAsset(previewDownloadedAsset, onFailed);

Hierarchy (View Summary, Expand)

  • Asset
    • RemoteReferenceAsset

Constructors

constructor

Properties

name uniqueIdentifier

Methods

downloadAsset getTypeName isOfType isSame

Constructors

Protectedconstructor

Properties

name

name: string

The name of the Asset in Lens Studio.

ReadonlyuniqueIdentifier

uniqueIdentifier: string

Methods

downloadAsset

  • downloadAsset(onDownloaded: (asset: Asset) => void, onFailed: () => void): void

    Request to download the Remote Reference Asset.

    Parameters

    • onDownloaded: (asset: Asset) => void
    • onFailed: () => void

    Returns void

getTypeName

  • getTypeName(): string

    Returns the name of this object's type.

    Returns string

isOfType

  • isOfType(type: string): boolean

    Returns true if the object matches or derives from the passed in type.

    Parameters

    • type: string

    Returns boolean

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

    Returns boolean

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR