Ir al contenido principal

Audio

Descripción​

Este componente permite a las entidades reproducir sonidos.

Propiedades​

PropiedadTipoPor defectoDescripción
url (Obligatorio)cadena''Fuente URL
volumennúmero1El volumen al que se reproducirá el audio. Un valor entre 0 y 1
buclebooleanofalsoSi el audio se reinicia al terminar
en pausabooleanofalsoSi el audio está en pausa
pasonúmero1El factor utilizado para cambiar el tono del audio. 1 es el tono por defecto.
posicionalbooleanofalsoSi el audio se reproduce posicionalmente
refDistancianúmero1Sólo se aplica si posicional es verdadero. El valor que indica a qué distancia el volumen de esta fuente comenzará a reducirse a medida que el oyente se aleja. Debe ser un valor no negativo.
distanciaModelocadenainverso**El algoritmo utilizado para reducir el volumen a medida que aumenta la distancia entre esta fuente de audio y el oyente. Los valores posibles son "lineal", "inverso" y "exponencial".
rolloffFactornúmero1Sólo se aplica si posicional es verdadero. Con qué rapidez se reduce el volumen a medida que aumenta la distancia entre esta fuente de audio y el oyente. El rango aceptable de valores cambia en función de la distanciaModelo, que se muestra de la siguiente manera: lineal: 0 a 1, inversa: 0 a Infinito, exponencial: 0 a Infinito
maxDistancianúmero10000Sólo se aplica si posicional es verdadero y distanceModel es igual a lineal. La distancia máxima entre esta fuente de audio y el oyente. El volumen no se reduce después de este punto. Debe ser un valor positivo.

Funciones​

Get​

Returns a read-only reference.

Example

ecs.Audio.get(world, component.eid)

Set​

Ensures the component exists on the entity, then assigns the (optional) data to the component.

Example

ecs.Audio.set(world, component.eid, {
  url: '',
  volume: 1,
  loop: false,
  paused: false,
  pitch: 1,
  positional: false,
  refDistance: 1,
  distanceModel: ''inverse'',
  rolloffFactor: 1,
  maxDistance: 10000
})

Mutate​

Perform an update to the component within a callback function. Return true to indicate no changes made.

Example

ecs.Audio.mutate(world, component.eid, (cursor) => {
  cursor.volumen = 0,5;
  cursor.loop = true;
  return false;
})

Remove​

Removes the component from the entity.

Example

ecs.Audio.remove(world, component.eid)

Has​

Returns true if the component is present on the entity.

Example

ecs.Audio.has(world, component.eid)

Reset​

Adds, or resets the component to its default state.

Example

ecs.Audio.reset(world, component.eid)

Advanced Functions​

Cursor​

Returns a mutable reference. Cursors are reused so only one cursor for each component can exist at a time.

Example
ecs.Audio.cursor(world, component.eid)

Acquire​

Same behavior as cursor, but commit must be called after the cursor is done being used.

Example
ecs.Audio.acquire(world, component.eid)

Commit​

Called after acquire. An optional third argument determines whether the cursor was mutated or not.

Example
ecs.Audio.commit(world, component.eid)
ecs.Audio.commit(world, component.eid, false)

Dirty​

Mark the entity as having been mutated. Only needed in a specific case where systems are mutating data.

Example
ecs.Audio.dirty(world, component.eid)