Skip to main content

OutputPlaceholder

Class

Provides output data from the neural network used by an MLComponent.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Provides output data from the neural network used by an MLComponent. For more information, see the MLComponent Scripting guide.

Index

Example

//@input Component.MLComponent mlComponent
//@input string outputName = "output"

var outputData;

script.mlComponent.onLoadingFinished = onLoadingFinished;

function onLoadingFinished() {
var output = script.mlComponent.getOutput(script.outputName);
outputData = output.data;
}

function onUpdate() {
// do something with data
}

Extends

Properties

data

readonly data: Float32Array

Exposes user data

Output as a Float32Array. Usable when mode is set to MachineLearning.OutputMode.Data.


dataLayout

dataLayout: DataLayout

The data layout of the current BasePlaceholder, which defines the order in which multidimensional data is accessed in memory.

Since

Lens Scripting Version 310

Default Value

MachineLearning.DataLayout.NHWC

Inherited from

BasePlaceholder.dataLayout


internalDataLayout

readonly internalDataLayout: DataLayout

The internal data layout of the current BasePlaceholder. This layout is used by ML backend. If dataLayout is not the same as internalDataLayout, a layout conversion will happen when process model’s input/output.

Since

Lens Scripting Version 310

Inherited from

BasePlaceholder.internalDataLayout


mode

mode: OutputMode

Which type of data the output is provided as. For example, Texture or Data.

Default Value

MachineLearning.OutputMode.Data

name

readonly name: string

The name of the Placeholder.

Inherited from

BasePlaceholder.name


shape

readonly shape: vec3

The shape of the Placeholder's data.

Inherited from

BasePlaceholder.shape


texture

readonly texture: Texture

Output as a Texture. Usable when mode is set to MachineLearning.OutputMode.Texture.


transformer

readonly transformer: Transformer

Transformer object for applying transformations on the PlaceHolder's data.

Inherited from

BasePlaceholder.transformer

Methods

getTypeName()

static getTypeName(): TypeName<OutputPlaceholder>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<OutputPlaceholder>

Overrides

BasePlaceholder.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

BasePlaceholder.getTypeName


isOfType()

isOfType(type): boolean

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

Parameters

ParameterType
typestring

Returns

boolean

Inherited from

BasePlaceholder.isOfType


isSame()

isSame(other): boolean

Returns true if this object is the same as other. Useful for checking if two references point to the same thing.

Parameters

ParameterType
otherScriptObject

Returns

boolean

Inherited from

BasePlaceholder.isSame