SoundFileMBS.Close

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Closes file now.

Same as destructor, but you can call it early.

SoundFileMBS.Constructor   Private

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Private constructor.

SoundFileMBS.GetString(type as Integer) as string

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Queries one of the strings.

See kString* constants.
Returns "" in case of error.

SoundFileMBS.ReadDouble(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Reads data as double values, converts if necessary.

Pointer should point to memmoryblock with 8 * Items in size.
Returns number of items read.

SoundFileMBS.ReadDoubleFrames(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Reads frames as double values, converts if necessary.

Pointer should point to memmoryblock with 8 * Items * Channels in size.
Returns number of items read.

SoundFileMBS.ReadInt(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Reads data as Int32 values, converts if necessary.

Pointer should point to memmoryblock with 4 * Items in size.
Returns number of items read.

SoundFileMBS.ReadIntFrames(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Reads frames as Int32 values, converts if necessary.

Pointer should point to memmoryblock with 4 * Items * Channels in size.
Returns number of items read.

SoundFileMBS.ReadRaw(p as ptr, bytes as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Read raw data.

Pointer should point to memmoryblock with Bytes in size.
Returns number of bytes read.

SoundFileMBS.ReadShort(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Reads data as Int16 values, converts if necessary.

Pointer should point to memmoryblock with 2 * Items in size.
Returns number of items read.

SoundFileMBS.ReadShortFrames(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Reads frames as Int16 values, converts if necessary.

Pointer should point to memmoryblock with 2 * Items * Channels in size.
Returns number of items read.

SoundFileMBS.ReadSingle(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Reads data as single values, converts if necessary.

Pointer should point to memmoryblock with 4 * Items in size.
Returns number of items read.

SoundFileMBS.ReadSingleFrames(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Reads frames as single values, converts if necessary.

Pointer should point to memmoryblock with 4 * Items * Channels in size.
Returns number of items read.

Some examples using this method:

• /Tools/SoundFile/SoundFile convert

SoundFileMBS.Seek(frames as Int64, whence as Integer) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Seeks within the audio file.

See kSeek* constants for whence parameter.

SoundFileMBS.SetString(type as Integer, data as Memoryblock) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets one of the strings.

See kString* constants.
Returns zero on success.

See also:

• SetString(type as Integer, text as string) as Integer

SoundFileMBS.SetString(type as Integer, text as string) as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Sets one of the strings.

See kString* constants.
Returns zero on success.

See also:

• SetString(type as Integer, data as Memoryblock) as Integer

SoundFileMBS.WriteDouble(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Writes data to file in double format.

Pointer should point to memmoryblock with 8 * Items in size.
Returns number of items written.

SoundFileMBS.WriteDoubleFrames(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Writes frames to file in double format.

Pointer should point to memmoryblock with 8 * Items * Channels in size.
Returns number of items written.

SoundFileMBS.WriteInt(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Writes data to file in Int32 format.

Pointer should point to memmoryblock with 4 * Items in size.
Returns number of items written.

Some examples using this method:

• /Audio/PortAudio
• /Audio/PortAudio Record and Play

SoundFileMBS.WriteIntFrames(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Writes frames to file in Int32 format.

Pointer should point to memmoryblock with 4 * Items * Channels in size.
Returns number of items written.

SoundFileMBS.WriteRaw(p as ptr, bytes as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Writes raw data to file.

Pointer should point to memmoryblock with Bytes in size.
Returns number of bytes written.

SoundFileMBS.WriteShort(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Writes data to file in Int16 format.

Pointer should point to memmoryblock with 2 * Items in size.
Returns number of items written.

SoundFileMBS.WriteShortFrames(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Writes frames to file in Int16 format.

Pointer should point to memmoryblock with 2 * Items * Channels in size.
Returns number of items written.

SoundFileMBS.WriteSingle(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Writes data to file in single format.

Pointer should point to memmoryblock with 4 * Items in size.
Returns number of items written.

SoundFileMBS.WriteSingleFrames(p as ptr, items as Int64) as Int64

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Writes frames to file in single format.

Pointer should point to memmoryblock with 4 * Items * Channels in size.
Returns number of items written.

SoundFileMBS.WriteSync

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
method	Audio	MBS Tools Plugin	17.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Writes recent changes in file to disk.