Skip to content

Feat: clean up interface methods that are not implemented

This MR removes the interface methods for

  • geometry meshes,
  • acoustic materials,
  • sound portals,
  • scenes.

All of these are not implemented in the core library and raise exceptions. In order to clean up the interface, we decided to remove them.

Since gRPC is forwards compatible with regards to adding functions, this was considered a good choice. For future features like this, it could also make sense to use some of the existing methods like call_module (e.g. call the geometry module) or setting a geometry for a certain renderer via SetRenderingModuleParameters.

Things to discuss:

  • Remove:
    • CreateSignalSourceTextToSpeech etc..?
    • AddSignalSourceSequencerSample
    • AddSignalSourceSequencerPlayback
  • Streamline the interface? I.e. with SetSoundSourcePose, SetSoundSourcePosition and SetSoundSourceOrientation are redundant.
    • Also note: SetSoundReceiverRealWorldPositionOrientationVU
  • The signal source type has different option on the interface and the core.

Additional changes:

  • Remove:
    • parameter from ModuleInfo -> The modules in the VACore do not have any parameters to set.
    • directivity_id, auralization_mode, position, view, up, orientation, parameters from SoundSourceInfo -> These cannot be set easily from a CVASoundSourceDesc and are redundant.
    • a lot of fields from SoundReceiverInfo -> Same as for SoundSourceInfo
  • Fixes:
    • class and num_references from DirectivityInfo -> Always set to -1; now correct in VACore
    • signal_source_id in SoundSourceInfo -> now correct in VACore
    • bOutputRecordingEnabled in AudioRendererInfo -> was not set by Core
    • bOutputRecordingEnabled and bInputRecordingEnabled in AudioReproductionInfo -> was not set by Core
  • Added:
    • explicit_renderer_id to SoundSourceInfo
    • explicit_renderer_id to SoundReceiverInfo
    • id to ModuleInfo
Edited by Pascal Palenda

Merge request reports

Loading