Package MSP

info~

Report information about a sample

Description

Use the info~ object to report the information in a file read into a buffer~ object in response to a bang . If the information is not present, it will be 0. info~ does not require that the audio be turned on in order to work. Looping and tuning information is found in AIFF files.

Arguments

buffer-name[symbol]

optional

Names the buffer~ object for which info~ will report information.

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

In left inlet: Causes a report of information about a sample contained in the associated buffer~ object.

(mouse)

Double-clicking on info~ opens an editing window where you can view the contents of its associated buffer~ object.

set

The word set followed by the name of a buffer~ object, sets which buffer~ to which info~ will refer.

Arguments:

buffer-name [symbol]

Output

Sample Information

Most of the information reported by info~ is taken from the audio file most recently read into the associated buffer~. If this information is not present, only the sampling rate is sent out the left outlet. No output occurs for any item that's missing from the sound file.

float

Out left outlet: The sampling rate of the sample.

Out 3rd outlet: Sustain loop start, in milliseconds.

Out 4th outlet: Sustain loop end, in milliseconds.

Out 5th outlet: Release loop start, in milliseconds.

Out 6th outlet: Release loop end, in milliseconds.

Out 7th outlet: Total time of the associated buffer~ object, in milliseconds.

Out 8th outlet: Name of the most recently read audio file.

Out 9th outlet: Number of channels for the most recently read audio file.

Out 10th outlet: Full pathname of most recently read audio file.

list

Out 2nd outlet: Instrument information about the sample, as follows:

1. The MIDI pitch of the sample.

2. The detuning from the original MIDI note number of the sample, in pitch bend units.

3. The lowest MIDI note number to use when playing this sample.

4. The highest MIDI note number to use when playing this sample.

5. The lowest MIDI velocity to use when playing this sample.

6. The highest MIDI velocity to use when playing this sample.

7. The gain of the sample (0-127).

Name	Description
buffer~	Store audio samples
mstosamps~	Convert milliseconds to samples
sfinfo~	Report audio file information