Unigine.Sound Class

<?xml version="1.0" encoding="utf-8"?>
<settings version="2.5.0.1">
	<sound>
		<scale>1</scale>
		<volume>0.8458</volume>
		<doppler>1</doppler>
		<velocity>340.3</velocity>
		<adaptation>0.01</adaptation>
		<attenuation>3</attenuation>
		<hrtf>0</hrtf>
		<source source="0" limit="2"/>
		<source source="1" limit="4"/>
		<source source="2" limit="4"/>
		<source source="4" volume="0.4"/>
	</sound>
</settings>

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using Unigine;

namespace UnigineApp
{
	class AppWorldLogic : WorldLogic
	{
        AmbientSource source;

		public override int init()
		{
           // load sound settings from a file
            Sound.get().loadSettings("sound_settings.sound");

            // create a sound source that plays a sample
            source = new AmbientSource("ambient_source.oga",1);
            source.setLoop(1);
            source.play();

			return 1;
		}

		public override int update()
		{
            // enable/disable sounds in the scene
            if (App.get().clearKeyState('z') == 1) {

	            Sound.get().setEnabled(Convert.ToInt32(!Convert.ToBoolean(Sound.get().isEnabled())));
	            Log.message("The enabled flag is {0}\n", Sound.get().isEnabled());
            }

            // print the current speed of sound
            if (App.get().clearKeyState('c') == 1) {
                Log.message("Sound velocity: {0}\n", Sound.get().getVelocity());
            }

            // make the sound louder
            if (App.get().clearKeyState('n') == 1) {
	            if (Sound.get().getVolume() != 1.0f) Sound.get().setVolume(Sound.get().getVolume() + 0.1f);
                Log.message("The sound is louder {0}\n", Sound.get().getVolume());
            }

            // make the sound quieter
            if (App.get().getKeyState('m') == 1) {
	            if (Sound.get().getVolume() > 0.0f) Sound.get().setVolume(Sound.get().getVolume() - 0.1f);
                Log.message("The sound is quieter {0}\n", Sound.get().getVolume());
            }

			return 1;
		}
		
		public override int shutdown()
		{
            // save the sound settings into the file
	        Sound.get().saveSettings("sound_settings.sound",1);
			source.clear();
			
			return 1;
		}
	}
}

Sound Class

Properties

bool IsSourceOcclusion#

int SourceReverbMode#

bool IsHRTF#

int Attenuation#

float Scale#

float Doppler#

float Adaptation#

float Velocity#

float Volume#

float TotalTime#

string Data#

bool IsEnabled#

Members

---

Sound * get ( ) #

Returns the existing Sound instance.

Return value

The Sound instance.

void SetSourceLimit ( int source, int limit ) #

Limits the number of simultaneously played sound sources per one mixer channel.

Arguments

• int source - Number of the mixer channel (from 0 to 31).
• int limit - The maximum number of sound sources that can be played simultaneously.

int GetSourceLimit ( int source ) #

Returns the current number of simultaneously played sound sources per one mixer channel.

Arguments

• int source - Number of the mixer channel (from 0 to 31).

Return value

The maximum number of sound sources that can be played simultaneously.

void SetSourceVolume ( int source, float volume ) #

Sets the volume of the specified mixer channel.

Arguments

• int source - Number of the mixer channel (from 0 to 31).
• float volume - Channel volume. The provided value is clamped within [0;1] range, where 0 means muted sound and 1 is the maximum volume.

float GetSourceVolume ( int source ) #

Returns the current volume of the specified mixer channel.

Arguments

• int source - Number of the mixer channel (from 0 to 31).

Return value

Volume of the specified mixer channel. The returning value is in range [0;1], where 0 means muted sound and 1 is the maximum volume.

bool LoadSettings ( string name ) #

Loads the sound settings from the given file.

Arguments

• string name - Path to a sound settings file (*.sound).

Return value

1 if the sound settings are loaded successfully; otherwise, 0.

bool LoadWorld ( Xml xml ) #

Loads a sound state from the Xml. The sound state includes such settings as the volume, velocity, adaptation, Doppler factor, time scale and number of sound sources and their volumes.

Arguments

• Xml xml - Xml node.

Return value

1 if the sound state is loaded successfully; otherwise, 0.

void RenderWorld ( int force ) #

Forces update of the sound system: all sound settings will be applied at once (such as play, stop events and change of parameters). For example, if you have a sound sample playing and you want to update the time, from which the sample should be played, you can perform as follows: The sound thread is updated at 30 FPS, so the playback won't stop immediately, and, therefore, a new time value won't be set. You need force updating of the sound thread after stopping it.

Arguments

• int force - 1 to force update of the sound system; otherwise, 0.

bool RestoreState ( Stream stream ) #

Restores a sound state from the stream. The sound state includes such settings as the volume, velocity, adaptation, Doppler factor, time scale and number of sound sources and their volumes.

Arguments

• Stream stream - Stream to restore the state from.

Return value

1 if the sound state is restored successfully; otherwise, 0.

bool SaveSettings ( string name, int force = 0 ) #

Saves the current sound settings to the given file.

Arguments

• string name - Path to a sound settings file (*.sound).
• int force - Force flag indcating if forced saving of sound settings is enabled.

Return value

1 if the sound settings are saved successfully; otherwise, 0.

bool SaveState ( Stream stream ) #

Saves a sound state into the stream. The sound state includes such settings as the volume, velocity, adaptation, Doppler factor, time scale and number of sound sources and their volumes.

Arguments

• Stream stream - Stream to save the state into.

Return value

1 if the sound state is saved successfully; otherwise, 0.

bool SaveWorld ( Xml xml, int force = 0 ) #

Saves a sound state into the given Xml node. The sound state includes such settings as the volume, velocity, adaptation, Doppler factor, time scale and number of sound sources and their volumes.

Arguments

• Xml xml - Xml node.
• int force - Force flag indicating if forced saving of the sound state is enabled.

Return value

1 if the sound state is saved successfully; otherwise, 0.