108 lines
11 KiB
HTML
108 lines
11 KiB
HTML
|
<html dir="LTR">
|
|||
|
|
<head>
|
|||
|
|
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252" />
|
|||
|
|
<meta name="vs_targetSchema" content="http://schemas.microsoft.com/intellisense/ie5" />
|
|||
|
|
<title>ISound Members</title>
|
|||
|
|
<xml>
|
|||
|
|
</xml>
|
|||
|
|
<link rel="stylesheet" type="text/css" href="MSDN.css" />
|
|||
|
|
</head>
|
|||
|
|
<body id="bodyID" class="dtBODY">
|
|||
|
|
<div id="nsbanner">
|
|||
|
|
<div id="bannerrow1">
|
|||
|
|
<table class="bannerparthead" cellspacing="0">
|
|||
|
|
<tr id="hdr">
|
|||
|
|
<td class="runninghead">IrrKlang.NET</td>
|
|||
|
|
<td class="product">
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
<div id="TitleRow">
|
|||
|
|
<h1 class="dtH1">ISound Members
|
|||
|
|
</h1>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div id="nstext">
|
|||
|
|
<p>
|
|||
|
|
<a href="IrrKlang.ISound.html">ISound overview</a>
|
|||
|
|
</p>
|
|||
|
|
<h4 class="dtH4">Public Instance Constructors</h4>
|
|||
|
|
<div class="tablediv">
|
|||
|
|
<table class="dtTABLE" cellspacing="0">
|
|||
|
|
<tr VALIGN="top">
|
|||
|
|
<td width="50%">
|
|||
|
|
<img src="pubmethod.gif" />
|
|||
|
|
<a href="IrrKlang.ISoundConstructor.html">ISound Constructor</a>
|
|||
|
|
</td>
|
|||
|
|
<td width="50%">
|
|||
|
|
</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
<h4 class="dtH4">Public Instance Properties</h4>
|
|||
|
|
<div class="tablediv">
|
|||
|
|
<table class="dtTABLE" cellspacing="0">
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.Finished.html">Finished</a></td><td width="50%"> returns if the sound has finished playing. Don't mix this up with isPaused(). isFinished() returns if the sound has been finished playing. If it has, is maybe already have been removed from the playing list of the sound engine and calls to any other of the methods of ISound will not have any result. If you call stop() to a playing sound will result that this function will return true when invoked. </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.Looped.html">Looped</a></td><td width="50%"> gets or sets if the sound has been started to play looped. If the sound is playing looped and it is changed to not-looped, then it will stop playing after the loop has finished. If it is not looped and changed to looped, the sound will start repeating to be played when it reaches its end. Invoking this method will not have an effect when the sound already has stopped. </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.MaxDistance.html">MaxDistance</a></td><td width="50%"> Sets the maximal distance if this is a 3D sound. Specify the distances at which 3D sounds stop getting louder or quieter. This works like this: As a listener approaches a 3D sound source, the sound gets louder. Past a certain point, it is not reasonable for the volume to continue to increase. Either the maximum (zero) has been reached, or the nature of the sound source imposes a logical limit. This is the minimum distance for the sound source. Similarly, the maximum distance for a sound source is the distance beyond which the sound does not get any quieter. The default minimum distance is 1, the default max distance is a huge number nearly to infinite. </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.MinDistance.html">MinDistance</a></td><td width="50%"> Sets the minimal distance if this is a 3D sound. Specify the distances at which 3D sounds stop getting louder or quieter. This works like this: As a listener approaches a 3D sound source, the sound gets louder. Past a certain point, it is not reasonable for the volume to continue to increase. Either the maximum (zero) has been reached, or the nature of the sound source imposes a logical limit. This is the minimum distance for the sound source. Similarly, the maximum distance for a sound source is the distance beyond which the sound does not get any quieter. The default minimum distance is 1, the default max distance is a huge number nearly to infinite. </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.Pan.html">Pan</a></td><td width="50%"> sets the pan of the sound. Takes a value between -1 and 1, 0 is center. </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.Paused.html">Paused</a></td><td width="50%"> returns if the sound is paused </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.PlaybackSpeed.html">PlaybackSpeed</a></td><td width="50%"> Sets or gets the playback speed (frequency) of the sound. Plays the sound at a higher or lower speed, increasing or decreasing its frequency which makes it sound lower or higher. Note that this feature is not available on all sound output drivers (it is on the DirectSound drivers at least), and it does not work together with the 'enableSoundEffects' parameter of ISoundEngine::play2D and ISoundEngine::play3D when using DirectSound. </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.PlayLength.html">PlayLength</a></td><td width="50%"> Returns the play length of the sound in milliseconds. Returns -1 if not known for this sound for example because its decoder does not support length reporting or it is a file stream of unknown size. Note: You can also use ISoundSource::getPlayLength() to get the length of a sound without actually needing to play it. </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.PlayPosition.html">PlayPosition</a></td><td width="50%"> returns or sets the current play position of the sound in milliseconds. Returns -1 if not implemented or possible for this sound for example because it already has been stopped and freed internally or similar. </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.Position.html">Position</a></td><td width="50%"> sets the position of the sound in 3d space </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.SoundEffectControl.html">SoundEffectControl</a></td><td width="50%"> Returns the sound effect control interface for this sound. Sound effects such as Chorus, Distorsions, Echo, Reverb and similar can be controlled using this. This can be null if the sound has not been started with the flag 'enableSoundEffects' or the driver doesn't support effects. </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.Velocity.html">Velocity</a></td><td width="50%"> sets or returns the velocity of the sound in 3d space, needed for Doppler effects. To use doppler effects use ISound::setVelocity to set a sounds velocity, ISoundEngine::setListenerPosition() to set the listeners velocity and ISoundEngine::setDopplerEffectParameters() to adjust two parameters influencing the doppler effects intensity. </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="IrrKlang.ISound.Volume.html">Volume</a></td><td width="50%"> returns volume of the sound, a value between 0 (mute) and 1 (full volume). (this volume gets multiplied with the master volume of the sound engine and other parameters like distance to listener when played as 3d sound) </td></tr></table>
|
|||
|
|
</div>
|
|||
|
|
<h4 class="dtH4">Public Instance Methods</h4>
|
|||
|
|
<div class="tablediv">
|
|||
|
|
<table class="dtTABLE" cellspacing="0">
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="IrrKlang.ISound.Dispose.html">Dispose</a></td><td width="50%"><EFBFBD></td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassEqualsTopic.htm">Equals</a> (inherited from <b>Object</b>)</td><td width="50%">
|
|||
|
|
Determines whether the specified <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassTopic.htm">Object</a> is equal to the current <b>Object</b>.
|
|||
|
|
</td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassGetHashCodeTopic.htm">GetHashCode</a> (inherited from <b>Object</b>)</td><td width="50%">
|
|||
|
|
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
|
|||
|
|
</td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassGetTypeTopic.htm">GetType</a> (inherited from <b>Object</b>)</td><td width="50%">
|
|||
|
|
Gets the <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemTypeClassTopic.htm">Type</a> of the current instance.
|
|||
|
|
</td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="IrrKlang.ISound.setSoundStopEventReceiver_overloads.html">setSoundStopEventReceiver</a></td><td width="50%">Overloaded. Sets the sound stop event receiver, an interface which gets called if a sound has finished playing. </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="IrrKlang.ISound.Stop.html">Stop</a></td><td width="50%"><EFBFBD></td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassToStringTopic.htm">ToString</a> (inherited from <b>Object</b>)</td><td width="50%">
|
|||
|
|
Returns a <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemStringClassTopic.htm">String</a> that represents the current <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassTopic.htm">Object</a>.
|
|||
|
|
</td></tr></table>
|
|||
|
|
</div>
|
|||
|
|
<h4 class="dtH4">Protected Instance Methods</h4>
|
|||
|
|
<div class="tablediv">
|
|||
|
|
<table class="dtTABLE" cellspacing="0">
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="IrrKlang.ISound.Finalize.html">Finalize</a></td><td width="50%"> Destructor </td></tr>
|
|||
|
|
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassMemberwiseCloneTopic.htm">MemberwiseClone</a> (inherited from <b>Object</b>)</td><td width="50%">
|
|||
|
|
Creates a shallow copy of the current <a href="ms-help://MS.NETFrameworkSDKv1.1/cpref/html/frlrfSystemObjectClassTopic.htm">Object</a>.
|
|||
|
|
</td></tr></table>
|
|||
|
|
</div>
|
|||
|
|
<h4 class="dtH4">See Also</h4>
|
|||
|
|
<p>
|
|||
|
|
<a href="IrrKlang.ISound.html">ISound Class</a> | <a href="IrrKlang.html">IrrKlang Namespace</a></p>
|
|||
|
|
<object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e" viewastext="true" style="display: none;">
|
|||
|
|
<param name="Keyword" value="ISound class">
|
|||
|
|
</param>
|
|||
|
|
<param name="Keyword" value="IrrKlang.ISound class">
|
|||
|
|
</param>
|
|||
|
|
<param name="Keyword" value="ISound class, all members">
|
|||
|
|
</param>
|
|||
|
|
</object>
|
|||
|
|
<hr />
|
|||
|
|
<div id="footer">
|
|||
|
|
<p>
|
|||
|
|
<a>The irrKlang Sound Engine Documentation <20> 2003-2010 by Nikolaus Gebhardt.</a>
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|