Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top
top

The AudioFile class describes the properties of audio files.

On this page:

Table of Contents
maxLevel2
minLevel2
indent25px
typeflat
separator,

Panel

Class Hierarchy

Children Display
alltrue
pageClass Reference

Functions

Panel

AudioFile.open

Panel

AudioFile.open(filename)

Description

The AudioFile.open function creates an AudioFile object. The AudioFile object can be used to retrieve information from the audio file. The location of the audio file can be in a folder or in a vstsound.

Available in: Controller.

Arguments

filenameThe file path and name of the audio file.string

Example

Code Block
-- open an audio file from Skylab and print the sample rate and bit depth
fname = "vstsound://F29C895D6D8E4D6C9BCBBA5198412192/.samples/Ambient Pad 01/Ambient Pad 01 - C3.tg3c"
af = AudioFile.open(fname)
print("Sample Rate: "..af.rate, "Bit Depth: "..af.bits)

 

Classes

Panel
borderColor#bbbbbb
bgColor#ffffff

AudioFile Class

Description

The properties of an AudioFile object are described by the following fields.

Available in: Controller.

Fields

 

 

Methods