GvrAudioSoundfield

GVR soundfield component that allows playback of first-order ambisonic recordings.

Summary

The audio sample should be in Ambix (ACN-SN3D) format.

Inheritance

Inherits from: MonoBehaviour

Public attributes

bypassRoomEffects = true
bool
Denotes whether the room effects should be bypassed.
gainDb = 0.0f
float
Input gain in decibels.
playOnAwake = true
bool
Play source on awake.

Properties

clip0102
AudioClip
The default AudioClip to play.
clip0304
AudioClip
dopplerLevel
float
Sets the Doppler scale for this soundfield.
isPlaying
bool
Is the clip playing right now (Read Only)?
loop
bool
Is the audio clip looping?
maxDistance
float
MaxDistance is the distance a sound stops attenuating at.
minDistance
float
Within the Min distance the GvrAudioSource will cease to grow louder in volume.
mute
bool
Un- / Mutes the soundfield. Mute sets the volume=0, Un-Mute restore the original volume.
pitch
float
The pitch of the audio source.
priority
int
Sets the priority of the soundfield.
rolloffMode
AudioRolloffMode
Volume rolloff model with respect to the distance.
spatialBlend
float
Sets how much this soundfield is affected by 3D spatialization calculations (attenuation, doppler).
time
float
Playback position in seconds.
timeSamples
int
Playback position in PCM samples.
volume
float
The volume of the audio source (0.0 to 1.0).

Public functions

Pause()
void
Pauses playing the clip.
Play()
void
Plays the clip.
PlayDelayed(float delay)
void
Plays the clip with a delay specified in seconds.
PlayScheduled(double time)
void
Plays the clip at a specific time on the absolute time-line that AudioSettings.dspTime reads from.
SetScheduledEndTime(double time)
void
Changes the time at which a sound that has already been scheduled to play will end.
SetScheduledStartTime(double time)
void
Changes the time at which a sound that has already been scheduled to play will start.
Stop()
void
Stops playing the clip.
UnPause()
void
Unpauses the paused playback.

Public attributes

bypassRoomEffects

bool bypassRoomEffects = true

Denotes whether the room effects should be bypassed.

gainDb

float gainDb = 0.0f

Input gain in decibels.

playOnAwake

bool playOnAwake = true

Play source on awake.

Properties

clip0102

AudioClip clip0102

The default AudioClip to play.

clip0304

AudioClip clip0304

dopplerLevel

float dopplerLevel

Sets the Doppler scale for this soundfield.

isPlaying

bool isPlaying

Is the clip playing right now (Read Only)?

loop

bool loop

Is the audio clip looping?

maxDistance

float maxDistance

MaxDistance is the distance a sound stops attenuating at.

minDistance

float minDistance

Within the Min distance the GvrAudioSource will cease to grow louder in volume.

mute

bool mute

Un- / Mutes the soundfield. Mute sets the volume=0, Un-Mute restore the original volume.

pitch

float pitch

The pitch of the audio source.

priority

int priority

Sets the priority of the soundfield.

rolloffMode

AudioRolloffMode rolloffMode

Volume rolloff model with respect to the distance.

spatialBlend

float spatialBlend

Sets how much this soundfield is affected by 3D spatialization calculations (attenuation, doppler).

time

float time

Playback position in seconds.

timeSamples

int timeSamples

Playback position in PCM samples.

volume

float volume

The volume of the audio source (0.0 to 1.0).

Public functions

Pause

void Pause()

Pauses playing the clip.

Play

void Play()

Plays the clip.

PlayDelayed

void PlayDelayed(
  float delay
)

Plays the clip with a delay specified in seconds.

PlayScheduled

void PlayScheduled(
  double time
)

Plays the clip at a specific time on the absolute time-line that AudioSettings.dspTime reads from.

SetScheduledEndTime

void SetScheduledEndTime(
  double time
)

Changes the time at which a sound that has already been scheduled to play will end.

SetScheduledStartTime

void SetScheduledStartTime(
  double time
)

Changes the time at which a sound that has already been scheduled to play will start.

Stop

void Stop()

Stops playing the clip.

UnPause

void UnPause()

Unpauses the paused playback.