audio.music_analysis.music_analysis_fanout.MusicAnalysisFanout Class Reference

Publish each analysis snapshot to an ordered set of consumers. More...

Public Member Functions
None	add (self, MusicAnalysisConsumer consumer)
	Append a consumer to the publication order.
None	remove (self, MusicAnalysisConsumer consumer)
	Remove the first matching consumer.
None	__call__ (self, MusicAnalysisState state)
	Publish one snapshot to all registered consumers.

Detailed Description

Publish each analysis snapshot to an ordered set of consumers.

Member Function Documentation

__call__()

None audio.music_analysis.music_analysis_fanout.MusicAnalysisFanout.__call__	(		self,
		MusicAnalysisState	state
	)

Publish one snapshot to all registered consumers.

Consumers are invoked in registration order. Return values are intentionally ignored so consumers such as lighting adapters may return command futures without coupling the analysis pipeline to them.

Parameters

state

Shared music-analysis snapshot.

add()

None audio.music_analysis.music_analysis_fanout.MusicAnalysisFanout.add	(		self,
		MusicAnalysisConsumer	consumer
	)

Append a consumer to the publication order.

Parameters

consumer

Callback invoked for each analysis snapshot.

remove()

None audio.music_analysis.music_analysis_fanout.MusicAnalysisFanout.remove	(		self,
		MusicAnalysisConsumer	consumer
	)

Remove the first matching consumer.

Parameters

consumer

Previously registered callback.

Exceptions

ValueError

If the callback is not registered.

---

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

• controllers/audio/music_analysis/music_analysis_fanout.py