Package MSP

sfinfo~

Report audio file information

Description

sfinfo~ gives you the number of channels, sample size, sampling rate, sampletype, filename, and duration of a soundfile.

Arguments

filename[symbol]
optional

Names a file that sfinfo~ will report about when it receives a subsequent bang message. The file must exist in the Max search path.

Attributes

Common Box Attributes

Below is a list of attributes shared by all objects. If you want to change one of these attributes for an object based on the object box, you need to place the word sendbox in front of the attribute name, or use the object's Inspector.

annotation[symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background[int]: 0

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color[4 floats]

Sets the color for the object box outline.

fontface[int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname[symbol]

Sets the object's font.

fontsize[float]

Sets the object's font size (in points). Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden[int]: 0

Toggles whether an object is hidden when the patcher is locked.

hint[symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick[int]: 0

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile[symbol]

You can override the default appearance of a user interface object by assigning a JavaScript file with code for painting the object. The file must be in the search path.

patching_rect[4 floats]: 0. 0. 100. 0.

Sets the position and size of the object in the patcher window.

position[2 floats]
write-only

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation[int]: 0

Sets whether an object belongs to the patcher's presentation.

presentation_rect[4 floats]: 0. 0. 0. 0.

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect[4 floats]
write-only

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size[2 floats]
write-only

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor[4 floats]

Sets the color for the object's text in RGBA format.

textjustification[int]

Sets the justification for the object's text. Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname[symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Messages

bang

If a file has already been opened, either with the open message or specified by an argument to sfinfo~, bang reports the number of channels, sample size, sample rate, and length in milliseconds out the sfinfo~ object's outlets.

(drag)

Drag supported audio files directly onto sfinfo~ to report info.

getnamed

In left inlet: The word getnamed , followed by a symbol which specifies the name of an sfplay~ object, interrogates the named sfplay~ object and reports the number of channels, sample size, sample rate, file length in milliseconds, sample type, and filename out its outlets.

Arguments:
  • object-name [symbol]

open

The word open , followed by a name of an audio file, opens the file if it exists in Max's search path. Without a filename, open brings up a standard open file dialog allowing you to choose a file. After the file is opened, sfinfo~ interrogates the file and reports the number of channels, sample size, sample rate, file length in milliseconds, sample type, and filename out its outlets.

Arguments:
  • filename [symbol]

Output

alaw

8-bit a-law encoding

Out 6th outlet: The filename of the audio file

float

Out 3rd outlet: The audio file's sampling rate.

Out 4th outlet: The duration of the audio file in milliseconds.

float32

32-bit floating-point

float64

64-bit floating-point

int

Out left outlet: The number of channels in the audio file.

Out 2nd outlet: The audio file's sample size in bits (typically 16).

int16

16-bit integer

int24

24-bit integer

int32

32-bit integer

int8

8-bit integer

mulaw

8-bit "mu"-law encoding

symbol

Out 5th outlet: the sample type of the audio file.

The following types of sample data are supported:

uint8

unsigned 8-bit integer

See Also

Name Description
info~ Report information about a sample
sflist~ Store audio file cues
sfplay~ Play audio file from disk