Falcon Speaker Diarization
Web API

API Reference for the Falcon Web SDK (falcon-web).

Falcon

class Falcon {}

Class for the Falcon Speaker Diarization engine.

Falcon.create()

static async function create(
  accessKey: string,
  model: FalconModel
): Promise<Falcon>

Creates an instance of Falcon Speaker Diarization engine using '.pv' file in public directory. The model size is large, hence it will try to use the existing one if it exists, otherwise saves the model in storage.

Parameters

• accessKey string : AccessKey obtained from Picovoice Console.
• model FalconModel : Object containing Falcon model data.

Returns

• Falcon : An instance of the Falcon engine.

Falcon.process()

async function process(pcm: Int16Array): Promise<FalconSegments>

Processes audio. The required sample rate can be retrieved from '.sampleRate'. The audio needs to be 16-bit linearly-encoded. Furthermore, the engine operates on single-channel audio.

Parameters

• pcm Int16Array : Audio data.

Returns

• FalconSegments : The inferred segments.

Falcon.release()

async function release(): Promise<void>

Releases resources acquired by the Falcon Web SDK.

Falcon.sampleRate

get sampleRate(): number

Audio sample rate accepted by Falcon.

Falcon.version

get version(): string

Falcon version string.

Falcon.listAvailableDevices()

public static async listAvailableDevices(): Promise<string[]>

Lists all available devices that Falcon can use for inference. Each entry in the list can be the used as the device argument for the .create() method.

Returns

• string[] : List of all available devices that Falcon can use for inference.

FalconModel

type FalconModel = {
  base64?: string;
  publicPath?: string;
  customWritePath?: string;
  forceWrite?: boolean;
  version?: number;
}

Falcon model type.

FalconSegments

type FalconSegments = {
  segments: FalconSegment[];
}

Falcon segments type.

• segments FalconSegment[] : Diarization output as an array of segments.

FalconSegment

type FalconSegment = {
  startSec: number;
  endSec: number;
  speakerTag: number;
}

Falcon segment type.

• startSec number : Position in seconds where the segment starts.
• endSec number : Position in seconds where the segment ends.
• speakerTag number : A non-negative integer that identifies unique speakers.

FalconWorker

class FalconWorker {}

A class for creating new instances of FalconWorker.

FalconWorker.create()

static async create(
  accessKey: string,
  model: FalconModel,
  device?: string,
): Promise<FalconWorker>

Creates an instance of FalconWorker using '.pv' file in public directory. The model size is large, hence it will try to use the existing one if it exists, otherwise saves the model in storage.

Parameters

• accessKey string : AccessKey obtained from Picovoice Console.
• model FalconModel : Object containing Falcon model data.
• device string? : device String representation of the device (e.g., CPU or GPU) to use. If set to best, the most suitable device is selected automatically. If set to gpu, the engine uses the first available GPU device. To select a specific GPU device, set this argument to gpu:${GPU_INDEX}, where ${GPU_INDEX} is the index of the target GPU. If set to cpu, the engine will run on the CPU with the default number of threads. To specify the number of threads, set this argument to cpu:${NUM_THREADS}, where ${NUM_THREADS} is the desired number of threads.

Returns

• FalconWorker : An instance of FalconWorker.

FalconWorker.process()

async function process(
  pcm: Int16Array,
  options?: { transfer?: boolean, transferCallback?: (data: Int16Array) => void }
): Promise<FalconSegments>

Processes audio. The required sample rate can be retrieved from '.sampleRate'. The audio needs to be 16-bit linearly-encoded. Furthermore, the engine operates on single-channel audio.

Parameters

• pcm Int16Array : Audio data.
• options Object : Optional process arguments.
• options.transfer boolean : Optional flag to indicate if the buffer should be transferred or not. If set to true, input buffer array will be transferred to the worker.
• options.transferCallback (pcm: Int16Array) => void : Optional callback containing a new Int16Array with contents from pcm. Use this callback to get the input pcm when using transfer.

Returns

• FalconSegments : The inferred segments with metadata.

FalconWorker.release()

async function release(): Promise<void>

Releases resources acquired by the Falcon Web SDK.

FalconWorker.terminate()

async function terminate(): Promise<void>

Force terminates the instance of FalconWorker.

FalconWorker.sampleRate

get sampleRate(): number

Audio sample rate accepted by Falcon.

FalconWorker.version

get version(): string

Falcon version string.