ui.music_visualizer.music_analysis_session_if.MusicAnalysisSessionIf Class Reference

Describe the existing session API without exposing a concrete controller. More...

Inherits Protocol.

Public Member Functions
tuple[str,...]	sources (self)
	List available source identities.
dict[str, object]	state (self)
	Read the current session snapshot.
dict[str, object]	select (self, str source)
	Select a source without starting capture.
dict[str, object]	start (self, str|None source=None)
	Start the selected source.
dict[str, object]	stop (self, *str|None source=None)
	Stop capture for the session or the named source.
dict[str, object]	push_pcm16 (self, bytes audio, int sample_rate_hz, *str source="browser")
	Accept a PCM16 frame from an existing transport.
dict[str, object]	start_zeroize (self)
	Begin ambient calibration.
dict[str, object]	finish_zeroize (self)
	Finish ambient calibration.
dict[str, object]	clear_zeroize (self)
	Clear the calibration profile.

Detailed Description

Describe the existing session API without exposing a concrete controller.

Member Function Documentation

clear_zeroize()

dict[str, object] ui.music_visualizer.music_analysis_session_if.MusicAnalysisSessionIf.clear_zeroize

(

self

)

Clear the calibration profile.

Returns

Updated calibration snapshot.

finish_zeroize()

dict[str, object] ui.music_visualizer.music_analysis_session_if.MusicAnalysisSessionIf.finish_zeroize

(

self

)

Finish ambient calibration.

Returns

Updated calibration snapshot.

push_pcm16()

dict[str, object] ui.music_visualizer.music_analysis_session_if.MusicAnalysisSessionIf.push_pcm16	(		self,
		bytes	audio,
		int	sample_rate_hz,
		*str	source = "browser"
	)

Accept a PCM16 frame from an existing transport.

Parameters

audio	Little-endian signed PCM16 audio bytes.
sample_rate_hz	Sample rate in Hz.
source	Source identity associated with the frame.

Returns

Updated session snapshot.

select()

dict[str, object] ui.music_visualizer.music_analysis_session_if.MusicAnalysisSessionIf.select	(		self,
		str	source
	)

Select a source without starting capture.

Parameters

source

Registered source identity.

Returns

Updated session snapshot.

sources()

tuple[str, ...] ui.music_visualizer.music_analysis_session_if.MusicAnalysisSessionIf.sources

(

self

)

List available source identities.

Returns

Source identifiers in presentation order.

start()

dict[str, object] ui.music_visualizer.music_analysis_session_if.MusicAnalysisSessionIf.start	(		self,
		str | None	source = None
	)

Start the selected source.

Parameters

source

Optional source identity to select first.

Returns

Updated session snapshot.

start_zeroize()

dict[str, object] ui.music_visualizer.music_analysis_session_if.MusicAnalysisSessionIf.start_zeroize

(

self

)

Begin ambient calibration.

Returns

Updated calibration snapshot.

state()

dict[str, object] ui.music_visualizer.music_analysis_session_if.MusicAnalysisSessionIf.state

(

self

)

Read the current session snapshot.

Returns

Source, analysis and calibration state.

stop()

dict[str, object] ui.music_visualizer.music_analysis_session_if.MusicAnalysisSessionIf.stop	(		self,
		*str | None	source = None
	)

Stop capture for the session or the named source.

Parameters

source

Optional source identity.

Returns

Updated session snapshot.

---

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

• ui/music_visualizer/music_analysis_session_if.py