Cue¶
-
class
Cue
: System.Object, System.IDisposable Manages the playback of a sound or set of sounds.
-
readonly bool
IsPaused
Indicates whether or not the cue is currently paused.
-
readonly bool
IsPlaying
Indicates whether or not the cue is currently playing.
-
readonly bool
IsStopped
Indicates whether or not the cue is currently stopped.
-
readonly bool
IsStopping
-
readonly bool
IsPreparing
-
readonly bool
IsPrepared
-
readonly bool
IsCreated
-
readonly string
Name
Gets the friendly name of the cue.
-
readonly bool
IsDisposed
Is true if the Cue has been disposed.
-
void
set_IsPrepared
(bool value) Parameters: - value (bool) –
-
void
set_IsCreated
(bool value) Parameters: - value (bool) –
-
void
Prepare
()
-
public void
Pause
() Pauses playback.
-
public void
Play
() Requests playback of a prepared or preparing Cue.
-
public void
Resume
() Resumes playback of a paused Cue.
-
public void
Stop
(AudioStopOptions options) Stops playback of a Cue.
Parameters: - options (Microsoft.Xna.Framework.Audio.AudioStopOptions) – Specifies if the sound should play any pending release phases or transitions before stopping.
-
public void
SetVariable
(string name, float value) Sets the value of a cue-instance variable based on its friendly name.
Parameters: - name (string) – Friendly name of the variable to set.
- value (float) – Value to assign to the variable.
-
public float
GetVariable
(string name) Gets a cue-instance variable value based on its friendly name.
Parameters: - name (string) – Friendly name of the variable.
Returns: Value of the variable.
-
public void
Apply3D
(AudioListener listener, AudioEmitter emitter) Updates the simulated 3D Audio settings calculated between an AudioEmitter and AudioListener.
Parameters: - listener (Microsoft.Xna.Framework.Audio.AudioListener) – The listener to calculate.
- emitter (Microsoft.Xna.Framework.Audio.AudioEmitter) – The emitter to calculate.
-
void
Update
(float dt) Parameters: - dt (float) –
-
public void
add_Disposing
(System.EventHandler<EventArgs> value) Parameters: - value (System.EventHandler<EventArgs>) –
-
public void
remove_Disposing
(System.EventHandler<EventArgs> value) Parameters: - value (System.EventHandler<EventArgs>) –
-
void
set_IsDisposed
(bool value) Parameters: - value (bool) –
-
public void
Dispose
() Disposes the Cue.
-
readonly bool