class PolyBuffer

Bind to a Max polybuffer~ object.

The PolyBuffer object in JavaScript is a companion to the polybuffer~ object in Max. Through it, you can to access samples and metadata for the polybuffer~ object with the given name.

Constructors

new PolyBuffer(name: string);

Constructs a new instance of the PolyBuffer class

Properties

count string read-only

Number of buffer~ objects in the polybuffer~

name string read-only

Name of the Max polybuffer~

size number read-only

Memory size used by the polybuffer~ in bytes

Methods

append

Add a sound file to the polybuffer~

append(soundfilePath?: string): void;

appendempty

Add an empty buffer~ with specified length and channel count

appendempty(duration: number, channels: number): void;

clear

Delete every buffer~

clear(): void;

dump

Get info about a polybuffer~

dump(): [number, string, string, number, number, number];

getbufferlist

Get the names of buffer~s in the polybuffer~

getbufferlist(): string[];

getshortname

Get every buffer~ name followed by the sound file name (without extensions)

getshortname(): string[];

open

Open the polybuffer~ object's window to see information about the buffers

open(): void;

print

Post the polybuffer~s contents to the Max window

The content printed are the number of items in the polybuffer~ and the shortname and filenames of each buffer in the polybuffer~.

print(): void;

readfolder

Load multiple sound files from the specified folder

readfolder(folderPath?: string): void;

send

Send messages to buffer~ objects in the polybuffer~

send(index: number, message: any): void;

Example

The following example binds to a polybuffer~ named "mypolybuffer" and clears the second buffer~ if there is one.

var pb = new PolyBuffer("mypolybuffer");
pb.send(2, "clear");

wclose

Close the window editor

wclose(): void;

writefolder

Write every buffer~ to a fild in a folder

writefolder(folderPath?: string): void;