SoundEffect.FromStream Method

Creates a SoundEffect object based on the specified data stream.

Syntax

'Declaration
Public Shared Function FromStream ( _
         stream As Stream _
) As SoundEffect 

public static SoundEffect FromStream (
         Stream stream
)

public:
static SoundEffect FromStream(
         Stream stream
)

Parameters

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

Return Value

Type: SoundEffect
SoundEffect object that this method creates.

Exceptions

Exception type	Condition
ArgumentNullException	Stream parameter is NULL.

Remarks

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

Requirements

Namespace: Microsoft.Xna.Framework.Audio

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

See Also

SoundEffect Class
SoundEffect Members
Microsoft.Xna.Framework.Audio Namespace

Platforms

Windows Phone