OMI_audio_emitter

extensions/2.0/OMI_audio_emitter/README.md

@@ -0,0 +1,96 @@
+# OMI_audio_emitter
+
+## Example
+
+```json
+{
+ "extensions": {
+ "OMI_audio_emitter": {
+ "audioClips": [
+ {
+ "name": "environment",
+ "sources": [
+ {
+ "mimeType": "audio/ogg",
+ "uri": "./environment.ogg"
+ },
+ {
+ "mimeType": "audio/wav",
+ "uri": "./environment.wav"
+ },
+ {
+ "mimeType": "audio/mpeg",
+ "uri": "./environment.mp3"
+ }
+ ]
+ },
+ {
+ "name": "quack",
+ "sources": [
+ {
+ "mimeType": "audio/ogg",
+ "bufferView": 3
+ },
+ {
+ "mimeType": "audio/wav",
+ "bufferView": 4
+ },
+ {
+ "mimeType": "audio/mpeg",
+ "bufferView": 5
+ }
+ ]
+ }
+ ],
+ "audioEmitters": [
+ {
+ "name": "environment emitter",
+ "type": "global",
+ "volume": 1,
+ "loop": true,
+ "autoPlay": true,
+ "muted": false,
+ "clip": 0
+ },
+ {
+ "name": "duck emitter",
+ "type": "positional",
+ "volume": 0.8,
+ "loop": false,
+ "autoPlay": false,
+ "muted": false,
+ "clip": 1,
+ "coneInnerAngle": 360,
+ "coneOuterAngle": 360,
+ "coneOuterGain": 0,
+ "distanceModel": "inverse",
+ "maxDistance": 10,
+ "refDistance": 1,
+ "rolloffFactor": 0.8
+ }
+ ]
+ }
+ },
+ "scenes": [
+ {
+ "name": "Default Scene",
+ "extensions": {
+ "OMI_audio_emitter": {
+ "audioEmitters": [0]
+ }
+ }
+ }
+ ],
+ "nodes": [
+ {
+ "name": "Duck",
+ "translation": [1, 2, 3],
+ "extensions": {
+ "OMI_audio_emitter": {
+ "audioEmitter": 1
+ }
+ }
+ }
+ ]
+}
+```

extensions/2.0/OMI_audio_emitter/schema/audio.schema.json

@@ -0,0 +1,34 @@
+{
+ "$schema": "http://json-schema.org/draft-04/schema",
+ "title": "Audio",
+ "type": "object",
+ "description": "Audio data used for audio emitters. Audio can be referenced by URI or `bufferView` index. `mimeType` is required.",
+ "allOf": [ { "$ref": "glTFProperty.schema.json" } ],
+ "properties": {
+ "uri": {
+ "type": "string",
+ "description": "The uri of the image.",
+ "format": "uriref",
+ "gltf_detailedDescription": "The uri of the audio. Relative paths are relative to the .gltf file.",
+ "gltf_uriType": "audio"
+ },
+ "mimeType": {
+ "type": "string",
+ "description": "The audio's MIME type. Used to determine if the client supports the given audio."
+ },
+ "bufferView": {
+ "allOf": [ { "$ref": "glTFid.schema.json" } ],
+ "description": "The index of the bufferView that contains the audio data. Use this instead of the image's uri property."
+ },
+ "name": { },
+ "extensions": { },
+ "extras": { }
+ },
+ "oneOf": [
+ { "required": [ "uri" ] },
+ { "required": [ "bufferView" ] }
+ ],
+ "required": [
+ "mimeType"
+ ]
+}

extensions/2.0/OMI_audio_emitter/schema/audioClip.schema.json

@@ -0,0 +1,22 @@
+{
+ "$schema": "http://json-schema.org/draft-04/schema",
+ "title": "Audio Clip",
+ "type": "object",
+ "allOf": [ { "$ref": "glTFProperty.schema.json" } ],
+ "properties": {
+ "sources": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "$ref": "audio.schema.json"
+ },
+ "minItems": 1,
+ "description": "One or more sources for the client to negotiate using the provided mimetypes. Clients should process sources in order."
+ },
+ "extensions": { },
+ "extras": { }
+ },
+ "required": [
+ "audio"
+ ]
+ }

extensions/2.0/OMI_audio_emitter/schema/audioEmitter.schema.json

@@ -0,0 +1,111 @@
+{
+ "$schema": "http://json-schema.org/draft-04/schema",
+ "title": "Audio Emitter",
+ "type": "object",
+ "description": "A positional or global audio emitter.",
+ "allOf": [ { "$ref": "glTFProperty.schema.json" } ],
+ "properties": {
+ "type": {
+ "type": "string",
+ "description": "Specifies the audio emitter type.",
+ "anyOf": [
+ {
+ "enum": [ "positional" ],
+ "description": "Positional audio emitters "
+ },
+ {
+ "enum": [ "global" ],
+ "description": "Global audio emitters are not affected by the position of audio listeners."
+ },
+ {
+ "type": "string"
+ }
+ ]
+ },
+ "volume": {
+ "type": "number",
+ "minimum": 0,
+ "default": 1
+ },
+ "loop": {
+ "type": "boolean",
+ "default": false
+ },
+ "autoPlay": {
+ "type": "boolean",
+ "default": false
+ },
+ "clip": {
+ "allOf": [
+ {
+ "$ref": "glTFid.schema.json"
+ }
+ ],
+ "description": "The id of the audio clip referenced by this audio emitter."
+ },
+ "coneInnerAngle": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 360,
+ "default": 360
+ },
+ "coneOuterAngle": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 360,
+ "default": 360
+ },
+ "coneOuterGain": {
+ "type": "number",
+ "minimum": 0,
+ "maximum": 1,
+ "default": 0
+ },
+ "distanceModel": {
+ "type": "string",
+ "description": "Specifies the distance model for the audio emitter.",
+ "anyOf": [
+ {
+ "enum": [ "linear" ],
+ "description": "A linear distance model calculating the gain induced by the distance according to: 1 - rolloffFactor * (distance - refDistance) / (maxDistance - refDistance)"
+ },
+ {
+ "enum": [ "inverse" ],
+ "description": "An inverse distance model calculating the gain induced by the distance according to: refDistance / (refDistance + rolloffFactor * (Math.max(distance, refDistance) - refDistance))"
+ },
+ {
+ "enum": [ "exponential" ],
+ "description": "An exponential distance model calculating the gain induced by the distance according to: pow((Math.max(distance, refDistance) / refDistance, -rolloffFactor)"
+ },
+ {
+ "type": "string"
+ }
+ ],
+ "default": "inverse"
+ },
+ "maxDistance": {
+ "type": "number",
+ "minimum": 0,
+ "exclusiveMinimum": true,
+ "default": 10000
+ },
+ "refDistance": {
+ "type": "number",
+ "minimum": 0,
+ "default": 1
+ },
+ "rolloffFactor": {
+ "type": "number",
+ "description": "When distanceModel is set to linear, the maximum value is 1.",
+ "minimum": 0,
+ "default": 1
+ },
+ "name": { },
+ "extensions": { },
+ "extras": { }
+ },
+ "required": [
+ "type",
+ "clip"
+ ]
+}

extensions/2.0/OMI_audio_emitter/schema/glTF.OMI_audio_emitter.schema.json

@@ -0,0 +1,29 @@
+{
+ "$schema": "http://json-schema.org/draft-04/schema",
+ "title": "OMI_audio_emitter glTF extension",
+ "type": "object",
+ "allOf": [ { "$ref": "glTFProperty.schema.json" } ],
+ "properties": {
+ "audioClips": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "$ref": "audioClip.schema.json"
+ },
+ "minItems": 1
+ },
+ "audioEmitters": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "$ref": "audioEmitter.schema.json"
+ },
+ "minItems": 1
+ },
+ "extensions": { },
+ "extras": { }
+ },
+ "required": [
+ "audio"
+ ]
+}

extensions/2.0/OMI_audio_emitter/schema/node.OMI_audio_emitter.schema.json

@@ -0,0 +1,21 @@
+{
+ "$schema": "http://json-schema.org/draft-04/schema",
+ "title": "OMI_audio_emitter node extension",
+ "type": "object",
+ "allOf": [ { "$ref": "glTFProperty.schema.json" } ],
+ "properties": {
+ "audioEmitter": {
+ "allOf": [
+ {
+ "$ref": "glTFid.schema.json"
+ }
+ ],
+ "description": "The id of the audioEmitter referenced by this node."
+ },
+ "extensions": { },
+ "extras": { }
+ },
+ "required": [
+ "audioEmitter"
+ ]
+}