audio.music_analysis.music_analyzer_if.MusicAnalyzerIf Class Reference

Analyze PCM samples into a frontend-neutral music state. More...

Inheritance diagram for audio.music_analysis.music_analyzer_if.MusicAnalyzerIf:

Public Member Functions
MusicAnalysisState	analyze (self, Sequence[float] samples, int sample_rate_hz)
	Analyze one block of normalized mono PCM samples.
None	start_zeroize (self)
	Begin collecting ambient-noise calibration blocks.
None	finish_zeroize (self)
	Commit the collected ambient-noise calibration.
None	clear_zeroize (self)
	Discard the current ambient-noise calibration.
bool	is_zeroized (self)
	Return whether an ambient-noise calibration is active.

Detailed Description

Analyze PCM samples into a frontend-neutral music state.

Member Function Documentation

analyze()

MusicAnalysisState audio.music_analysis.music_analyzer_if.MusicAnalyzerIf.analyze	(		self,
		Sequence[float]	samples,
		int	sample_rate_hz
	)

Analyze one block of normalized mono PCM samples.

Parameters

samples	Normalized mono PCM samples.
sample_rate_hz	Source sample rate in hertz.

Returns

Complete analysis state for the block.

Reimplemented in audio.music_analysis.music_analyzer.MusicAnalyzer.

is_zeroized()

bool audio.music_analysis.music_analyzer_if.MusicAnalyzerIf.is_zeroized

(

self

)

Return whether an ambient-noise calibration is active.

Returns

True when zeroization has been committed.

Reimplemented in audio.music_analysis.music_analyzer.MusicAnalyzer.

---

The documentation for this class was generated from the following file:

• controllers/audio/music_analysis/music_analyzer_if.py