Class: Stream

.stream. Stream

new Stream()

A generic Stream class -- a holder for other music21 objects
Will be subclassed into music21.stream.Score,
music21.stream.Part,
music21.stream.Measure,
music21.stream.Voice, but most functions will be found here.

Properties:
Name Type Argument Default Description
elements Array.<music21.base.Music21Object>

the elements in the stream. DO NOT MODIFY individual components (consider it like a Python tuple)

length number

(readonly) the number of elements in the stream.

duration music21.duration.Duration

the total duration of the stream's elements

highestTime number
  • the highest time point in the stream's elements
clef music21.clef.Clef

the clef for the Stream (if there is one; if there are multiple, then the first clef)

timeSignature music21.meter.TimeSignature

the first TimeSignature of the Stream

keySignature music21.key.KeySignature

the first KeySignature for the Stream

renderOptions music21.renderOptions.RenderOptions

an object specifying how to render the stream

flat music21.stream.Stream

(readonly) a flattened representation of the Stream

notes music21.stream.Stream

(readonly) the stream with only music21.note.Note and music21.chord.Chord objects included

notesAndRests music21.stream.Stream

(readonly) like notes but also with music21.note.Rest objects included

parts music21.stream.Stream

(readonly) a filter on the Stream to just get the parts (NON-recursive)

measures music21.stream.Stream

(readonly) a filter on the Stream to just get the measures (NON-recursive)

tempo number

tempo in beats per minute (will become more sophisticated later, but for now the whole stream has one tempo

instrument music21.instrument.Instrument | undefined

an instrument object associated with the stream (can be set with a string also, but will return an Instrument object)

autoBeam Boolean

whether the notes should be beamed automatically or not (will be moved to renderOptions soon)

activeVFStave Vex.Flow.Stave | undefined

the current Stave object for the Stream

activeVFRenderer music21.vfShow.Renderer | undefined

the current vfShow.Renderer object for the Stream

staffLines int <optional>
5

number of staff lines

changedCallbackFunction function | undefined

function to call when the Stream changes through a standard interface

maxSystemWidth number

confusing... should be in renderOptions

Source:

Extends

Music21j, Copyright © 2013-2021 Michael Scott Asato Cuthbert.
Documentation generated by JSDoc 3.6.3 on Wed Jul 31st 2019 using the DocStrap template.