Cue Class (Microsoft.Xna.Framework.Audio)

Manages the playback of a sound or set of sounds.

System.Object
Microsoft.Xna.Framework.Audio.Cue

Namespace: Microsoft.Xna.Framework.Audio
Assembly: MonoGame.Framework (MonoGame.Framework.dll 3.8.0.1082)

public class Cue : IDisposable

Syntax for VB is not yet implemented.

Syntax for F# is not yet implemented.

The Cue type exposes the following members.

	Platforms	Name	Description
		IsCreated
		IsDisposed	Is true if the Cue has been disposed.
		IsPaused	Indicates whether or not the cue is currently paused.
		IsPlaying	Indicates whether or not the cue is currently playing.
		IsPrepared
		IsPreparing
		IsStopped	Indicates whether or not the cue is currently stopped.
		IsStopping
		Name	Gets the friendly name of the cue.

Top

	Platforms	Name	Description
		Apply3D	Updates the simulated 3D Audio settings calculated between an AudioEmitter and AudioListener.
		Dispose	Disposes the Cue. (Implements IDisposable.Dispose().)
		GetVariable	Gets a cue-instance variable value based on its friendly name.
		Pause	Pauses playback.
		Play	Requests playback of a prepared or preparing Cue.
		Resume	Resumes playback of a paused Cue.
		SetVariable	Sets the value of a cue-instance variable based on its friendly name.
		Stop	Stops playback of a Cue.

Top

	Platforms	Name	Description
		Disposing	This event is triggered when the Cue is disposed.

Top

Cues are comprised of one or more sounds.Cues also define specific properties such as pitch or volume.Cues are referenced through SoundBank objects.

Supported in:

Windows DirectX Desktop

Linux Desktop

Windows OpenGL Desktop

Web