OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
ui.music_visualizer.music_visualizer_control_if.MusicVisualizerControlIf Class Reference

Nonblocking controls consumed by visualizer frontends. More...

Inheritance diagram for ui.music_visualizer.music_visualizer_control_if.MusicVisualizerControlIf:
audio.music_analysis.music_visualizer_controller.MusicVisualizerController

Public Member Functions

None start (self, MusicVisualizerSource source)
 Select and asynchronously start an input.
 
None stop (self)
 Invalidate pending work and asynchronously release capture.
 
None calibrate (self, str action)
 Request ambient-noise calibration.
 
tuple[VisualizerFrame|None, str|None] presentation (self)
 Consume the latest frame and status without waiting.
 

Detailed Description

Nonblocking controls consumed by visualizer frontends.

Member Function Documentation

◆ calibrate()

None ui.music_visualizer.music_visualizer_control_if.MusicVisualizerControlIf.calibrate (   self,
str  action 
)

Request ambient-noise calibration.

Parameters
actionCalibration operation name.

Reimplemented in audio.music_analysis.music_visualizer_controller.MusicVisualizerController.

◆ presentation()

tuple[VisualizerFrame | None, str | None] ui.music_visualizer.music_visualizer_control_if.MusicVisualizerControlIf.presentation (   self)

Consume the latest frame and status without waiting.

Returns
Latest available frame and status, or None for unchanged fields.

Reimplemented in audio.music_analysis.music_visualizer_controller.MusicVisualizerController.

◆ start()

None ui.music_visualizer.music_visualizer_control_if.MusicVisualizerControlIf.start (   self,
MusicVisualizerSource  source 
)

Select and asynchronously start an input.

Parameters
sourceSemantic input choice.

Reimplemented in audio.music_analysis.music_visualizer_controller.MusicVisualizerController.


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