The Viro Developer Hub

Welcome to the Viro developer hub. You'll find comprehensive guides and sample code to help you start working with Viro as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Sound

Adding audio to your scenes

ViroReact supports three forms of audio: stereo sound, spatial sound, and ambisonic sound fields. Sprinkling environments with sound helps to add true immersion to your scenes; they draw the listener's attention and provide cues on where to look next. ViroReact supports three forms of sound.

Stereo Sound

Many scenes benefit from having a background sound track, either in the form of music or ambient noise like wind or ocean waves. You can add background audio to your scene by utilizing the <ViroSound> component. The audio to be played is specified via the source property, as in the following example.

<ViroSound paused={false}
           muted={false}
           source={require('./res/sound.mp3'}
           loop={false}
           volume={1.0}
           onFinish={this.onFinishSound}
           onError={this.onErrorSound}/>

<ViroSound> can also be used for short sound effects. To replay such a sound, either set loop to true, or toggle paused off and on. Finally, these sounds also provide callbacks:

  • onFinish is invoked whenever the sound completes (if looping, this is invoked at the end of each loop
  • onError is invoked if a sound fails to load.

Spatial Sound

Spatial sound is positioned audio that can travel throughout a scene. For example, you can create a spatial sound that animates along with a bird, chirping as it flies through the scene. To create spatial sounds, use the <ViroSpatialSound> component. This component supports all the fields of <ViroSound>, and adds new properties that define how the sound travels.

Spatial Sound File must be a single-channel sound (mono)

<ViroSpatialSound rolloffModel="linear"
                  paused={false}
                  muted={false}
                  minDistance={2}
                  maxDistance={5}
                  position={[0, 0, 5]}
                  source={require('./res/spatial_sound.wav'}
                  loop={false}
                  volume={1.0}
                  onFinish={this.onFinishSpatial}
                  onError={this.onErrorSpatial}/>

The new properties are:

  • position indicates the position of the sound within the coordinate space of its parent node
  • minDistance specifies the distance from the sound at which it starts attenuating
  • maxDistance the maximum distance at which the sound can be heard; that is, when the sound attenuates to zero
  • rolloffModel defines the curve of the attenuation between minDistance and maxDistance, and can be set to none, linear, or logarithmic

Spatial sounds are especially useful in that they can be animated along with visual objects in the scene graph. In the example below, the 'chirp' sound follows the bird 3D object. We can do this by adding both the sound and the 3D object to the same node, then simply animating the node as a whole.

var SoundAnimationTest = React.createClass({
  render: function() {
    <ViroScene>
    	<ViroAnimatedComponent animation='translate' run={true} loop={true}>
        <ViroNode>
      	  <Viro3DObject source={require('./res/bird.obj')}
                        resources={[require('./res/bird.mtl'),
                                    require('./res/bird.jpg')]}
                        position={[0, 0, 0]} />
          <ViroSpatialSound rolloffModel="linear"
                  paused={false} muted={false}
                  minDistance={5} maxDistance={8}
                  position={[0, 0, 0]}
                  source={require('./res/chirp.wav'}
                  loop={true}
                  volume={1.0} />
        </ViroNode>
   	 </ViroAnimatedComponent> 
   </ViroScene>
  }
});

ViroAnimations.registerAnimations({
  translate:{properties:{positionX:"+=1.0"}, duration:1000},
});

Ambisonic Sound Fields

Ambisonic sound fields emit environmental sound from every direction. They are the audio equivalent of a skybox or 360 image, providing atmospheric background noise. These sounds respond to the user's head rotation.

Producing ambisonic sound is beyond the scope of this document, but if you have ambisonic sound files, you can load them into ViroReact via the <ViroSoundField> component. This component shares the same properties as <ViroSound>, and can additionally be rotated about the Z axis with the rotation property. See the <ViroSoundField> reference for details.

Sound


Adding audio to your scenes

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.