VideoControls

Descripción

Este componente permite a las entidades controlar la reproducción de vídeo en las texturas aplicadas a los materiales. Se añade automáticamente cuando se configura un vídeo a través del configurador de Studio. Si el vídeo se añade mediante programación, este componente debe añadirse manualmente para habilitar los controles de reproducción.

Propiedades

Propiedad	Tipo	Por defecto	Descripción
url (Obligatorio)	cadena	''	URL de origen del vídeo
volumen	número	1	El volumen al que se reproducirá el vídeo. Un valor entre 0 y 1
bucle	booleano	falso	Si el vídeo se reinicia al terminar
en pausa	booleano	falso	Si el vídeo está en pausa
velocidad	número	1	La velocidad de reproducción del vídeo. También afecta al tono del audio
posicional	booleano	falso	Si el audio del vídeo se reproduce posicionalmente
refDistancia	número	1	Sólo se aplica si posicional es verdadero. La distancia a la que el audio empieza a disminuir de volumen. Debe ser un valor no negativo
distanciaModelo	cadena	inverso	**El algoritmo utilizado para reducir el volumen a medida que aumenta la distancia entre esta fuente de vídeo y el oyente. Opciones: 'lineal', 'inversa', 'exponencial'
rolloffFactor	número	1	Sólo se aplica si posicional es verdadero. Con qué rapidez se reduce el volumen a medida que aumenta la distancia. El rango aceptable varía en función de la distanciaModelo: lineal: 0-1, inversa: 0-∞, exponencial: 0-∞
maxDistancia	número	10000	Sólo se aplica si posicional es verdadero y distanceModel es 'linear'. Más allá de esta distancia, el volumen no se reducirá más. Debe ser un valor positivo

Funciones

Get

Returns a read-only reference.

Example

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

Set

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

Example

ecs.VideoControls.set(world, component.eid, {
  url: './assets/video.mp4',
  volume: 1,
  loop: false,
  paused: false,
  speed: 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.VideoControls.mutate(world, component.eid, (cursor) => {
  cursor.volume = 0.5;
  cursor.loop = true;
  return false;
})

Remove

Removes the component from the entity.

Example

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

Has

Returns true if the component is present on the entity.

Example

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

Reset

Adds, or resets the component to its default state.

Example

ecs.VideoControls.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.VideoControls.cursor(world, component.eid)

Acquire

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

Example

ecs.VideoControls.acquire(world, component.eid)

Commit

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

Example

ecs.VideoControls.commit(world, component.eid)
ecs.VideoControls.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.VideoControls.dirty(world, component.eid)