wiki.sine.space | sinespace
Open Nav

Difference between revisions of "Scripting/SAudioSource"

From wiki.sine.space
Jump to: navigation, search
(Created the page; added Enabled, Loop, DopplerLevel)
 
(Added Volume, Pitch, Time, IsPlaying)
Line 23: Line 23:
 
''-- Now it is looping.''}}
 
''-- Now it is looping.''}}
  
−
{{ScriptFunction|float|DopplerLevel|{get;set;}|The Doppler level for the Audio Source. (See: Doppler Effect)|5=
+
{{ScriptFunction|float|DopplerLevel|{get;set;}|The Doppler level of the Audio Source. (See: Doppler Effect)|5=
 
hostObject = Space.Host.ExecutingObject;<br><br>
 
hostObject = Space.Host.ExecutingObject;<br><br>
 
Space.Log(hostObject.Audio.DopplerLevel);<br>
 
Space.Log(hostObject.Audio.DopplerLevel);<br>
Line 29: Line 29:
 
hostObject.Audio.DopplerLevel = 5;<br>
 
hostObject.Audio.DopplerLevel = 5;<br>
 
''-- The highest possible value''}}
 
''-- The highest possible value''}}
 +
 +
{{ScriptFunction|float|Volume|{get;set;}|The Volume level of the Audio Source. |5=
 +
hostObject = Space.Host.ExecutingObject;<br>
 +
Space.Log(hostObject.Audio.Volume);<br>
 +
''-- 1 by default''<br><br>
 +
function audioVolumeDecr ()<br>
 +
:if hostObject.Audio.Volume > 0 then<br>
 +
::hostObject.Audio.Volume = hostObject.Audio.Volume - 0.2;<br>
 +
:end<br>
 +
:Space.Log(hostObject.Audio.Volume);<br>
 +
end<br><br>
 +
hostObject.SubscribeToEvents();<br>
 +
hostObject.OnMouseDown(audioVolumeDecr);<br>
 +
''-- Now, every time we click this object, the Volume level is decreased by 0.2, until it reaches 0.''}}
 +
 +
{{ScriptFunction|float|Pitch|{get;set;}|The Pitch level for the Audio Source. |5=
 +
hostObject = Space.Host.ExecutingObject;<br>
 +
Space.Log(hostObject.Audio.Pitch);<br>
 +
''-- 1 by default''<br><br>
 +
function audioPitchChange ()<br>
 +
:if hostObject.Audio.Pitch < 3 then<br>
 +
::hostObject.Audio.Pitch = hostObject.Audio.Pitch + 0.5;<br>
 +
:end<br>
 +
:Space.Log(hostObject.Audio.Pitch);<br>
 +
end<br><br>
 +
hostObject.SubscribeToEvents();<br>
 +
hostObject.OnMouseDown(audioPitchChange);<br>
 +
''-- Now, every time we click this object, the Pitch level is increased by 0.5, until it reaches 3.''}}
 +
 +
{{ScriptFunction|float|Time|{get;set;}|Playback position in seconds. |5=
 +
hostObject = Space.Host.ExecutingObject;<br><br>
 +
Space.Log(hostObject.Audio.Time);<br>
 +
''-- 0 by default (the beginning of the sound clip)''<br>
 +
hostObject.Audio.Time = 15;<br>
 +
''-- jumps to the 0:15 position of the sound clip''<br>
 +
hostObject.Audio.Time = 75;<br>
 +
''-- jumps to the 1:15 position of the sound clip''}}
 +
 +
{{ScriptFunction|bool|IsPlaying|{get;}|Is the sound clip playing right now? |5=
 +
hostObject = Space.Host.ExecutingObject;<br><br>
 +
Space.Log(hostObject.Audio.IsPlaying);<br>
 +
''-- prints True (by default), if the sound clip is playing, or False, if it doesn't, to the console''}}

Revision as of 05:17, 20 July 2017

The SAudioSource class deals with the Audio Source component, which allows the object to play sounds in the scene.

Properties

Enabled

bool Enabled {get;set;}

Is the Audio Source component enabled?

hostObject = Space.Host.ExecutingObject;

function audioOnOff ()

hostObject.Audio.Enabled = not hostObject.Audio.Enabled;
Space.Log(hostObject.Audio.Enabled);

end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(audioOnOff);
-- When the host object is clicked, the Audio Source component gets enabled, if it was disabled,

-- or disabled, if it was enabled, and its new state is printed to the console.


Loop

bool Loop {get;set;}

Is looping of the sound clip enabled?

hostObject = Space.Host.ExecutingObject;

Space.Log(hostObject.Audio.Loop);
-- False by default.

if not hostObject.Audio.Loop then

hostObject.Audio.Loop = true;

end

-- Now it is looping.


DopplerLevel

float DopplerLevel {get;set;}

The Doppler level of the Audio Source. (See: Doppler Effect)

hostObject = Space.Host.ExecutingObject;

Space.Log(hostObject.Audio.DopplerLevel);
-- 1 by default
hostObject.Audio.DopplerLevel = 5;

-- The highest possible value


Volume

float Volume {get;set;}

The Volume level of the Audio Source.

hostObject = Space.Host.ExecutingObject;

Space.Log(hostObject.Audio.Volume);
-- 1 by default

function audioVolumeDecr ()

if hostObject.Audio.Volume > 0 then
hostObject.Audio.Volume = hostObject.Audio.Volume - 0.2;
end
Space.Log(hostObject.Audio.Volume);

end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(audioVolumeDecr);

-- Now, every time we click this object, the Volume level is decreased by 0.2, until it reaches 0.


Pitch

float Pitch {get;set;}

The Pitch level for the Audio Source.

hostObject = Space.Host.ExecutingObject;

Space.Log(hostObject.Audio.Pitch);
-- 1 by default

function audioPitchChange ()

if hostObject.Audio.Pitch < 3 then
hostObject.Audio.Pitch = hostObject.Audio.Pitch + 0.5;
end
Space.Log(hostObject.Audio.Pitch);

end

hostObject.SubscribeToEvents();
hostObject.OnMouseDown(audioPitchChange);

-- Now, every time we click this object, the Pitch level is increased by 0.5, until it reaches 3.


Time

float Time {get;set;}

Playback position in seconds.

hostObject = Space.Host.ExecutingObject;

Space.Log(hostObject.Audio.Time);
-- 0 by default (the beginning of the sound clip)
hostObject.Audio.Time = 15;
-- jumps to the 0:15 position of the sound clip
hostObject.Audio.Time = 75;

-- jumps to the 1:15 position of the sound clip


IsPlaying

bool IsPlaying {get;}

Is the sound clip playing right now?

hostObject = Space.Host.ExecutingObject;

Space.Log(hostObject.Audio.IsPlaying);

-- prints True (by default), if the sound clip is playing, or False, if it doesn't, to the console


Retrieved from "https://wiki.sine.space/index.php?title=Scripting/SAudioSource&oldid=58014"