SoundEffect.FromStream Method

Creates a SoundEffect object based on the specified data stream.

Namespace: Microsoft.Xna.Framework.Audio
Assembly: Microsoft.Xna.Framework (in microsoft.xna.framework.dll)

public static SoundEffect FromStream (
         Stream stream
)

Parameters

stream
Type: Stream
Stream object that contains the data for this SoundEffect object.

Return Value

SoundEffect object that this method creates.

Exception typeCondition
ArgumentNullException Stream parameter is NULL.

The Stream object must point to the head of a valid PCM wave file. Also, this wave file must be in the RIFF bitstream format.

The audio format has the following restrictions:

  • Must be a PCM wave file
  • Can only be mono or stereo
  • Must be 8 or 16 bit
  • Sample rate must be between 8,000 Hz and 48,000 Hz

Xbox 360, Windows 7, Windows Vista, Windows XP, Windows Phone

Community Additions

ADD
Show: