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

Rename from KHR_audio to KHR_audio_emitter and add example file #3

Merged
merged 1 commit into from
Feb 29, 2024

Conversation

aaronfranke
Copy link
Member

@aaronfranke aaronfranke commented Feb 15, 2024

See omigroup/gltf-extensions#205 and omigroup/gltf-extensions#207

See KhronosGroup#2137 (review)

This PR renames the extension to KHR_audio_emitter to be more similar to the names of the extensions this originally came from (OMI_audio_emitter and MSFT_audio_emitter).

Reasoning:

  1. Matches the recommended naming structure: https://github.com/KhronosGroup/glTF/tree/main/extensions#naming

Names SHOULD be structured as <PREFIX>_<scope>_<feature>, where scope is an existing glTF concept (e.g. mesh, texture, image) and feature describes the functionality being added within that scope. This structure is recommended, but not required.

  1. Gives us the opportunity to have more extensions under the KHR_audio_ scope. For example, I could see possible KHR_audio_listener, KHR_audio_material, KHR_audio_reverb, etc extensions. And of course, we would want extensions for specific audio types, like KHR_audio_opus, KHR_audio_vorbis, etc. Then KHR_audio would refer to a whole family of extensions, instead of a single extension.

  2. Is more descriptive of what the extension does. KHR_audio doesn't say what it actually does to the audio. Does it do everything with audio? No. Does it listen to audio? No. Does it define how audio reverbs in an area or off of objects? No. Does it define footstep sounds? No. KHR_audio_emitter describes that it's an extension for emitting audio.

I don't see a strong reason to use the name KHR_audio.

@aaronfranke aaronfranke added the enhancement New feature or request label Feb 15, 2024
Copy link

@antpb antpb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As per our discussions in past meetings, the rename is agreed by OMI members

@antpb antpb merged commit 53c75fa into omigroup:KHR_audio Feb 29, 2024
@aaronfranke aaronfranke deleted the KHR_audio_emitter_rename branch November 29, 2024 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants