Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Polish Doc for get_inclusions #16

Open
matheusvilano opened this issue Aug 16, 2024 · 0 comments
Open

Polish Doc for get_inclusions #16

matheusvilano opened this issue Aug 16, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@matheusvilano
Copy link
Owner

matheusvilano commented Aug 16, 2024

The function ak.wwise.core.soundbank.get_inclusions works, but the return type is wrong:

def get_inclusions(self, sound_bank: GUID | Name | ProjectPath) -> tuple[str, str]:
  """
  https://www.audiokinetic.com/library/edge/?source=SDK&id=ak_wwise_core_soundbank_getinclusions.html \n
  Retrieves a SoundBank's inclusion list.
  :param sound_bank: The GUID, name, or project path of the SoundBank to get inclusions from.
  :return: An array of SoundBank inclusions.
  """

The return type is hinted as tuple[str, str], but in fact it returns tuple[str, list[str, list[str]]]. From the Audiokinetic documentation, the return data is:

Name Type Description
inclusions array An array of inclusions.
inclusions [...] object A SoundBank inclusion.
inclusions[...].object * string The ID (GUID) of the object to add to / remove from the SoundBank's inclusion list.
An object GUID of the form: {aabbcc00-1122-3344-5566-77889900aabb}.
inclusions[...].filter * array Specifies what relations are being included.
inclusions[...].filter [...] string Specifies one of the inclusion types. Possible values:
  • events
  • structures
  • media
It would make sense to have a dataclass called `InclusionEntry` (or similar), then have the return type as `tuple[GUID, InclusionEntry]`.
@matheusvilano matheusvilano added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 16, 2024
@matheusvilano matheusvilano changed the title Fix return data in ak.wwise.core.soundbank.get_inclusions Polish Doc for get_inclusions Feb 5, 2025
@matheusvilano matheusvilano moved this to Todo in PyWwise Feb 5, 2025
@matheusvilano matheusvilano removed the enhancement New feature or request label Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: Todo
Development

No branches or pull requests

1 participant