Skip to main content

VideoControls

Description​

Ce composant permet aux entités de contrôler la lecture vidéo des textures appliquées aux matériaux. Il est automatiquement ajouté lorsqu'une vidéo est définie via le configurateur de studio. Si la vidéo est ajoutée par programme, ce composant doit être ajouté manuellement pour activer les contrôles de lecture.

Propriétés​

PropriétéTypeDéfautDescription
url (Obligatoire)chaîne de caractères''URL source de la vidéo
volumenombre1Volume sonore de la vidéo. Une valeur comprise entre 0 et 1
bouclebooléenfauxSi la vidéo redémarre une fois terminée
en pausebooléenfauxSi la vidéo est actuellement en pause
vitessenombre1Vitesse de lecture de la vidéo. Affecte également la hauteur de l'audio
positionnelbooléenfauxSi l'audio de la vidéo est joué de manière positionnelle
refDistancenombre1**La distance à laquelle le volume de l'audio commence à diminuer. Doit être une valeur non négative
modèle de distancechaîne de caractèresinverse**L'algorithme utilisé pour réduire le volume à mesure que la distance entre cette source vidéo et l'auditeur augmente. Options : "linéaire", "inverse", "exponentiel".
Facteur d'atténuationnombre1**La vitesse à laquelle le volume est réduit lorsque la distance augmente. La plage acceptable varie en fonction de la distanceModèle : linéaire : 0-1, inverse : 0-∞, exponentiel : 0-∞
maxDistancenombre10000Appliqué uniquement si positional est vrai et si distanceModel est "linear". Au-delà de cette distance, le volume ne diminue plus. Doit être une valeur positive

Fonctions​

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)