Skip to main content

AsrModule.TranscriptionUpdateEvent

Class

Argument passed for a transcription update event.

  • Snapchat: not supported
  • SPECS: fully supported
  • Camera Kit Web: not supported
  • Camera Kit Mobile: not supported
  • SnapchatNot supported — Available on SPECS only
  • SPECSFully supported
  • Camera Kit WebNot supported — Available on SPECS only
  • Camera Kit MobileNot supported — Available on SPECS only

Platform details

  • Snapchat — Not supported — Available on SPECS only.

  • SPECS — Fully supported.

  • Camera Kit Web — Not supported — Available on SPECS only.

  • Camera Kit Mobile — Not supported — Available on SPECS only.

Argument passed for a transcription update event.

Index

Example

const onTranscriptionUpdate = (eventArgs: AsrModule.TranscriptionUpdateEvent) => {
print(`onTranscriptionUpdateCallback text=${eventArgs.text}, isFinal=${eventArgs.isFinal}`)
}

Extends

Properties

isFinal

isFinal: boolean

SPECS

Specifies whether the transcription returned is final, or partial (interim) which can be updated later as the sentence continues.

Default Value

false
@snapOS

text

text: string

SPECS

Transcribed text.

Default Value

""
@snapOS

Methods

create()

static create(): TranscriptionUpdateEvent

SPECS

Creates a new instance.

Returns

TranscriptionUpdateEvent


getTypeName()

static getTypeName(): TypeName<TranscriptionUpdateEvent>

SPECS

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<TranscriptionUpdateEvent>

Overrides

ScriptObject.getTypeName


getTypeName()

getTypeName(): string

Returns the name of this object's type.

Returns

string

Inherited from

ScriptObject.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

ScriptObject.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

ScriptObject.isSame