Uses of Class
org.jjazz.song.api.Song

Packages that use Song

Package	Description
org.jjazz.activesong.spi
org.jjazz.chordinspector.spi
org.jjazz.cl_editor.api	The chord leadsheet editor.
org.jjazz.cl_editor.spi	Service providers for the chord leadsheet editor.
org.jjazz.importers.api	Various file readers
org.jjazz.midimix.api	The model for the mix of a song (instruments used per channel and their settings, volume, effect, etc.).
org.jjazz.midimix.spi	A service provider to find the most relevant instrument for a given rhythm voice.
org.jjazz.mixconsole.api	The mix console editor to edit a song's MidiMix.
org.jjazz.musiccontrol.api	Music controller: control the overall playback of a song.
org.jjazz.musiccontrol.spi
org.jjazz.musiccontrolactions.api.ui
org.jjazz.pianoroll.api
org.jjazz.rhythmmusicgeneration.api	Objects and helper methods to generate musical phrases from the song and form the final backing track (see SongSequenceBuilder).
org.jjazz.rhythmselectiondialog.spi
org.jjazz.song.api	The model of a song, which mainly contains a ChordLeadSheet and a SongStructure.
org.jjazz.song.spi	Service providers to create songs using eg importers.
org.jjazz.songcontext.api	Describe the context for which a backing track should be generated: which (part of the) song, which MidiMix.
org.jjazz.songeditormanager.spi	Manage the creation/destruction of editors for a new/closed song, plus related actions (eg duplicate song).
org.jjazz.spteditor.spi	Service provider for indvidual RhythmParameter editor components.
org.jjazz.ss_editor.api	The SongStructure graphical editor.
org.jjazz.ss_editor.rpviewer.api	The graphical RpViewer component to represent a RhythmParameter value within a SptViewer.
org.jjazz.ss_editor.rpviewer.spi	Service provider to provider RpViewer instances for each type of RhythmParameter.
org.jjazz.ss_editor.spi
org.jjazz.ss_editor.sptviewer.spi	Service provider to provide SptViewer instances.

Uses of Song in org.jjazz.activesong.spi

Methods in org.jjazz.activesong.spi that return Song

Modifier and Type	Method	Description
Song	ActiveSongManager.getActiveSong()

Methods in org.jjazz.activesong.spi with parameters of type Song

Modifier and Type	Method	Description
String	ActiveSongManager.isActivable(Song sg)
boolean	ActiveSongManager.setActive(Song sg, MidiMix mm)	Set the specified song and MidiMix as active: - send MidiMessages for all MidiMix parameters at activation - listen to MidiMix changes and send the related Midi messages according to the SendPolicy - reset MusicController session - Fire a PROP_ACTIVE_SONG change event (oldValue=mm, newValue=sg)

Uses of Song in org.jjazz.chordinspector.spi

Methods in org.jjazz.chordinspector.spi with parameters of type Song

Modifier and Type	Method	Description
void	ChordViewer.setContext(Song song, MidiMix midiMix, RhythmVoice rv)	Provide optional context info to the viewer.

Uses of Song in org.jjazz.cl_editor.api

Methods in org.jjazz.cl_editor.api that return Song

Modifier and Type	Method	Description
abstract Song	CL_Editor.getSongModel()
Song	CL_EditorTopComponent.getSongModel()

Methods in org.jjazz.cl_editor.api with parameters of type Song

Modifier and Type	Method	Description
static int	CL_EditorClientProperties.getBarAnnotationNbLines(Song song)
static int	CL_EditorClientProperties.getZoomXFactor(Song song)
static int	CL_EditorClientProperties.getZoomYFactor(Song song)
static boolean	CL_EditorClientProperties.isBarAnnotationVisible(Song song)
static void	CL_EditorClientProperties.setBarAnnotationNbLines(Song song, int n)
static void	CL_EditorClientProperties.setBarAnnotationVisible(Song song, boolean b)
static void	CL_EditorClientProperties.setZoomXFactor(Song song, int factor)	Note: it might be easier to use CL_Editor.setNbColumns(int).
static void	CL_EditorClientProperties.setZoomYFactor(Song song, int factor)

Constructors in org.jjazz.cl_editor.api with parameters of type Song

Modifier	Constructor	Description
	CL_EditorTopComponent(Song song)

Uses of Song in org.jjazz.cl_editor.spi

Methods in org.jjazz.cl_editor.spi with parameters of type Song

Modifier and Type	Method	Description
default CL_Editor	CL_EditorFactory.createEditor(Song song)	Create an editor with the default settings.
CL_Editor	CL_EditorFactory.createEditor(Song song, CL_EditorSettings settings, BarBoxFactory bbf, BarRendererFactory brf)	Create an editor with the specified settings.

Uses of Song in org.jjazz.importers.api

Methods in org.jjazz.importers.api that return Song

Modifier and Type	Method	Description
Song	BiabFileReader.readFile()	Read the file and construct a song.
Song	ImprovisorFileReader.readSong()	Get the song from the current file.
Song	MusicXMLFileReader.readSong()	Get the song from the current file.
Song	TextReader.readSong()	Get the song from the current text or file.

Uses of Song in org.jjazz.midimix.api

Methods in org.jjazz.midimix.api that return Song

Modifier and Type	Method	Description
Song	MidiMix.getSong()

Methods in org.jjazz.midimix.api with parameters of type Song

Modifier and Type	Method	Description
void	MidiMix.checkConsistency(Song sg, boolean fullCheck)	Check if this MidiMix is consistent with the specified song.
MidiMix	DefaultMidiMixManager.createMix(Song sg)
MidiMix	DefaultMidiMixManager.findExistingMix(Song s)
MidiMix	DefaultMidiMixManager.findMix(Song s)
final void	MidiMix.setSong(Song sg)	Associate a song to this MidiMix : listen to song changes to keep this MidiMix consistent.

Constructors in org.jjazz.midimix.api with parameters of type Song

Modifier	Constructor	Description
	MidiMix(Song s)	create an empty MidiMix and associate it to specified song.

Uses of Song in org.jjazz.midimix.spi

Methods in org.jjazz.midimix.spi with parameters of type Song

Modifier and Type	Method	Description
MidiMix	MidiMixManager.createMix(Song sg)	Create a new MidiMix for the specified song.
MidiMix	MidiMixManager.findExistingMix(Song s)	Find a mix which must be existing.
MidiMix	MidiMixManager.findMix(Song s)	Get a MidiMix for the specified song in the following order.

Uses of Song in org.jjazz.mixconsole.api

Methods in org.jjazz.mixconsole.api that return Song

Modifier and Type	Method	Description
Song	MixConsole.getSong()	The current song edited by the MixConsole.

Uses of Song in org.jjazz.musiccontrol.api

Methods in org.jjazz.musiccontrol.api that return Song

Modifier and Type	Method	Description
Song	SongMusicGenerationListener.getSong()

Methods in org.jjazz.musiccontrol.api with parameters of type Song

Modifier and Type	Method	Description
static boolean	SongMidiExporter.songToMidiFile(Song song, MidiMix midiMix, File midiFile, RhythmVoice rv)	Export a song to the specified midi File.

Constructors in org.jjazz.musiccontrol.api with parameters of type Song

Modifier	Constructor	Description
	SongMusicGenerationListener(Song song, MidiMix midiMix, int preFireChangeEventDelayMs)	Construct a SongMusicGenerationListener.

Uses of Song in org.jjazz.musiccontrol.spi

Methods in org.jjazz.musiccontrol.spi that return Song

Modifier and Type	Method	Description
Song	ActiveSongBackgroundMusicBuilder.getSong()	Get the active song for this ActiveSongMusicBuilder.

Uses of Song in org.jjazz.musiccontrolactions.api.ui

Methods in org.jjazz.musiccontrolactions.api.ui that return Song

Modifier and Type	Method	Description
Song	PositionViewer.getSongModel()

Methods in org.jjazz.musiccontrolactions.api.ui with parameters of type Song

Modifier and Type	Method	Description
void	PositionViewer.setModel(Song song, Position pos)

Uses of Song in org.jjazz.pianoroll.api

Methods in org.jjazz.pianoroll.api that return Song

Modifier and Type	Method	Description
Song	PianoRollEditor.getSong()	Get the song the edited phrase belongs to.
Song	PianoRollEditorTopComponent.getSong()	The song associated to this TopComponent.

Methods in org.jjazz.pianoroll.api with parameters of type Song

Modifier and Type	Method	Description
static PianoRollEditorTopComponent	PianoRollEditorTopComponent.get(Song song)	Search for the PianoRollEditorTopComponent associated to song.
static String	PianoRollEditorTopComponent.getDefaultTabName(Song song)	The default tab name for a song.
void	PianoRollEditor.setSong(Song song)	Associate an optional song to the editor -this method can be called only once.

Constructors in org.jjazz.pianoroll.api with parameters of type Song

Modifier	Constructor	Description
	PianoRollEditorTopComponent(Song sg, PianoRollEditorSettings settings)	Create a TopComponent editor for the specified song.

Uses of Song in org.jjazz.rhythmmusicgeneration.api

Methods in org.jjazz.rhythmmusicgeneration.api that return Song

Modifier and Type	Method	Description
Song	SongChordSequence.getSong()

Methods in org.jjazz.rhythmmusicgeneration.api with parameters of type Song

Modifier and Type	Method	Description
static void	SongChordSequence.fillChordSequence(ChordSequence cSeq, Song song, IntRange barRange)	Fill a ChordSequence with the chord symbols of the specified song (or part of the song).

Constructors in org.jjazz.rhythmmusicgeneration.api with parameters of type Song

Modifier	Constructor	Description
	SongChordSequence(Song song, IntRange barRange)	Build a ChordSequence for the specified song, or part of the song.

Uses of Song in org.jjazz.rhythmselectiondialog.spi

Methods in org.jjazz.rhythmselectiondialog.spi with parameters of type Song

Modifier and Type	Method	Description
void	RhythmPreviewer.setContext(Song sg, SongPart spt)	Set the context for which the object will preview rhythms.

Uses of Song in org.jjazz.song.api

Methods in org.jjazz.song.api that return Song

Modifier and Type	Method	Description
Song	SongFactory.createEmptySong(String songName)	Create a 8-bar empty song with only the 4/4 initial Section named "A" and its corresponding SongPart.
Song	SongFactory.createEmptySong(String songName, int nbBars, String initSectionName, TimeSignature ts, String initialChord)	Create an empty song with the specified parameters.
Song	SongFactory.createSong(String name, ChordLeadSheet cls)	Create a Song from the specified chordleadsheet.
Song	SongFactory.createSong(String name, SongStructure sgs)	Create a Song from a SongStructure and its parent ChordLeadSheet.
Song	SongFactory.createSong(String name, SongStructure sgs, boolean noClsSgsLink)	Create a Song from a SongStructure and its parent ChordLeadSheet, possibly unlinked.
Song	SongFactory.findSong(ChordLeadSheet cls)	Find in the created song the first one which uses the specified ChordLeadSheet.
Song	SongFactory.findSong(SongStructure sgs)	Find in the created song the first one which uses the specified SongStructure.
Song	SongFactory.getCopy(Song song, boolean noClsSgsLink, boolean register)	Return a deep copy of the specified song.
static Song	SongUtilities.getLinearizedSong(Song song, boolean register)	Get a new song with the lead sheet linearized ("unfolded") according to the song structure.
static Song	SongUtilities.getSimplifiedLeadSheet(Song song, boolean register)	Get a new song with a simplified lead sheet.
Song	BeatIterator.getSong()
Song	SongMetaEvents.getSong()
static Song	Song.loadFromFile(File f)	Load a Song from a file.

Methods in org.jjazz.song.api that return types with arguments of type Song

Modifier and Type	Method	Description
Set<Song>	SongFactory.getRegisteredSongs()

Methods in org.jjazz.song.api with parameters of type Song

Modifier and Type	Method	Description
static void	SongUtilities.doubleChordLeadsheet(Song song)	Double the chord leadsheet of the specified song.
Song	SongFactory.getCopy(Song song, boolean noClsSgsLink, boolean register)	Return a deep copy of the specified song.
static SongMetaEvents	SongMetaEvents.getInstance(Song song)
static Song	SongUtilities.getLinearizedSong(Song song, boolean register)	Get a new song with the lead sheet linearized ("unfolded") according to the song structure.
static Song	SongUtilities.getSimplifiedLeadSheet(Song song, boolean register)	Get a new song with a simplified lead sheet.
static void	SongUtilities.halfChordLeadsheet(Song song)	Half the chord leadsheet of the specified song.
void	SongFactory.registerSong(Song sg)	Register a song if it was not created by this SongFactory.
void	SongFactory.unregisterSong(Song song)	Remove a song from the list returned by getRegisteredSong().

Constructors in org.jjazz.song.api with parameters of type Song

Modifier	Constructor	Description
	BeatIterator(Song song)	Create a beat iterator for the specified song.
	BeatIterator(Song song, Position pos)	Construct an iterator for the specified song, starting at specified position.
	BeatIterator(Song song, IntRange barRange)	Construct an iterator for the specified bar range within a song.
	BeatIterator(Song song, IntRange barRange, Position pos)	Construct an iterator for the specified bar range within a song, starting at pos.

Uses of Song in org.jjazz.song.spi

Methods in org.jjazz.song.spi that return Song

Modifier and Type	Method	Description
Song	SongImporter.importFromFile(File f)	Try to build a Song object from the specified file.

Uses of Song in org.jjazz.songcontext.api

Methods in org.jjazz.songcontext.api that return Song

Modifier and Type	Method	Description
Song	SongContext.getSong()	Music should be produced for this song.

Constructors in org.jjazz.songcontext.api with parameters of type Song

Modifier	Constructor	Description
	SongContext(Song s, MidiMix mm)	Create a SongContext object for the whole song.
	SongContext(Song s, MidiMix mm, IntRange bars)	Create a SongContext object for whole or part of a song.
	SongPartContext(Song s, MidiMix mix, SongPart spt)	Create a SongPartContext.
	SongPartContext(Song s, MidiMix mix, IntRange bars)	Create a SongPartContext.

Uses of Song in org.jjazz.songeditormanager.spi

Methods in org.jjazz.songeditormanager.spi that return Song

Modifier and Type	Method	Description
Song	SongEditorManager.showSong(File f, boolean makeActive, boolean updateLastSongDirectory)	Load a song from a file and show it.

Methods in org.jjazz.songeditormanager.spi that return types with arguments of type Song

Modifier and Type	Method	Description
List<Song>	SongEditorManager.getOpenedSongs()	Get all the currently opened songs.

Methods in org.jjazz.songeditormanager.spi with parameters of type Song

Modifier and Type	Method	Description
boolean	SongEditorManager.closeSong(Song song, boolean enforce)	Programmatically close all the editors associated to a song.
SongEditorManager.SongEditorSet	SongEditorManager.getSongEditorSet(Song s)	Get the editors currently opened for the specified song.
PianoRollEditorTopComponent	SongEditorManager.showPianoRollEditorForSptCustomPhrase(Song song, MidiMix midiMix, SongPart spt, RhythmVoice rv, Phrase p)	Open (or show) the song's PianoRollEditor and set it up to edit a custom phrase of a SongPart.
PianoRollEditorTopComponent	SongEditorManager.showPianoRollEditorForUserTrack(Song song, MidiMix midiMix, UserRhythmVoice userRhythmVoice)	Open (or show) the song's PianoRollEditor and set it up to edit a user track associated to userRhythmVoice.
void	SongEditorManager.showSong(Song song, boolean makeActive, boolean savable)	Show a song in the application.

Uses of Song in org.jjazz.spteditor.spi

Methods in org.jjazz.spteditor.spi with parameters of type Song

Modifier and Type	Method	Description
RpEditorComponent	DefaultRpEditorComponentFactory.createComponent(Song song, DefaultRpEditorComponentFactory.Type type, SongPart spt, RhythmParameter<?> rp)	Create a RpEditorComponent of the specified type.
RpEditorComponent	RpEditorComponentFactory.createComponent(Song song, SongPart spt, RhythmParameter<?> rp)	Create a RpEditorComponent adapted to rp class (whatever the containing rhythm).

Uses of Song in org.jjazz.ss_editor.api

Methods in org.jjazz.ss_editor.api that return Song

Modifier and Type	Method	Description
abstract Song	SS_Editor.getSongModel()
Song	SS_EditorTopComponent.getSongModel()

Methods in org.jjazz.ss_editor.api with parameters of type Song

Modifier and Type	Method	Description
static List<RhythmParameter<?>>	SS_EditorClientProperties.getCompactViewModeVisibleRPs(Song song, Rhythm r)	Get the list of visible RPs in compact view mode for the specified rhythm.
static SS_EditorClientProperties.ViewMode	SS_EditorClientProperties.getViewMode(Song song)
static int	SS_EditorClientProperties.getZoomXFactor(Song song)
static int	SS_EditorClientProperties.getZoomYFactor(Song song)
static void	SS_EditorClientProperties.setCompactViewModeVisibleRPs(Song song, Rhythm r, List<RhythmParameter<?>> rps)	Set the list of visible RPs in compact view mode for the specified rhythm.
static void	SS_EditorClientProperties.setViewMode(Song song, SS_EditorClientProperties.ViewMode mode)
static void	SS_EditorClientProperties.setZoomXFactor(Song song, int factor)
static void	SS_EditorClientProperties.setZoomYFactor(Song song, int factor)

Constructors in org.jjazz.ss_editor.api with parameters of type Song

Modifier	Constructor	Description
	SS_EditorTopComponent(Song song)	Create an editor.

Uses of Song in org.jjazz.ss_editor.rpviewer.api

Methods in org.jjazz.ss_editor.rpviewer.api that return Song

Modifier and Type	Method	Description
Song	MeterRpRenderer.getSong()
Song	RpViewerRenderer.getSong()	The Song context.
Song	StringRpRenderer.getSong()

Constructors in org.jjazz.ss_editor.rpviewer.api with parameters of type Song

Modifier	Constructor	Description
	MeterRpRenderer(Song song, SongPart spt)
	StringRpRenderer(Song song, SongPart spt, Supplier<String> stringSupplier, StringRpRendererSettings settings)

Uses of Song in org.jjazz.ss_editor.rpviewer.spi

Methods in org.jjazz.ss_editor.rpviewer.spi with parameters of type Song

Modifier and Type	Method	Description
RpViewerRenderer	DefaultRpViewerRendererFactory.getRpViewerRenderer(Song song, SongPart spt, RhythmParameter<?> rp, DefaultRpViewerRendererFactory.Type type, RpViewerSettings settings)	Get the RpViewerRenderer of the specified type.
RpViewerRenderer	RpViewerRendererFactory.getRpViewerRenderer(Song song, SongPart spt, RhythmParameter<?> rp, RpViewerSettings settings)	Get a RpViewerRenderer instance adapted to the specified RhyhtmParameter.

Uses of Song in org.jjazz.ss_editor.spi

Methods in org.jjazz.ss_editor.spi with parameters of type Song

Modifier and Type	Method	Description
SS_Editor	SS_EditorFactory.createEditor(Song song, SS_EditorSettings settings, SptViewerFactory factory)

Uses of Song in org.jjazz.ss_editor.sptviewer.spi

Methods in org.jjazz.ss_editor.sptviewer.spi with parameters of type Song

Modifier and Type	Method	Description
SptViewer	SptViewerFactory.createSptViewer(Song song, SongPart spt, SptViewerSettings settings, DefaultRpViewerRendererFactory factory)