wx.adv.Sound¶

This class represents a short sound (loaded from Windows WAV file), that can be stored in memory and played.

Currently this class is implemented on Windows and Unix (and uses either Open Sound System or Simple DirectMedia Layer).

Class Hierarchy¶

Inheritance diagram for class Sound:

Methods Summary¶

`__init__`	Default constructor.
`Create`	Constructs a wave object from a file or resource.
`CreateFromData`	Create a sound object from data in a memory buffer in `WAV` format.
`IsOk`	Returns `True` if the object contains a successfully loaded file or resource, `False` otherwise.
`Play`	Plays the sound file.
`PlaySound`	Plays the sound file.
`Stop`	If a sound is played, this function stops it.
`__nonzero__`

Class API¶

class wx.adv.Sound(Object)¶

Possible constructors:

Sound()

Sound(fileName)

This class represents a short sound (loaded from Windows WAV file), that can be stored in memory and played.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Default constructor.

__init__ (self, fileName)

Constructs a wave object from a file or, under Windows, from a Windows resource.

Call IsOk to determine whether this succeeded.

Parameters:	fileName (string) – The filename or Windows resource.

Create(self, fileName)¶

Constructs a wave object from a file or resource.

Parameters:	fileName (string) – The filename or Windows resource.
Return type:	bool
Returns:	`True` if the call was successful, `False` otherwise.

CreateFromData(self, data)¶

Create a sound object from data in a memory buffer in WAV format.

Return type:	bool

IsOk(self)¶

Returns True if the object contains a successfully loaded file or resource, False otherwise.

Return type:	bool

Play(self, flags=SOUND_ASYNC)¶

Plays the sound file.

If another sound is playing, it will be interrupted.

Returns True on success, False otherwise. Note that in general it is possible to delete the object which is being asynchronously played any time after calling this function and the sound would continue playing, however this currently doesn’t work under Windows for sound objects loaded from memory data.

The possible values for flags are:

wx.adv.SOUND_SYNC: Play will block and wait until the sound is replayed.
wx.adv.SOUND_ASYNC: Sound is played asynchronously, Play returns immediately.
SOUND_ASYNC|wxSOUND_LOOP: Sound is played asynchronously and loops until another sound is played, Stop is called or the program terminates.

The static form is shorthand for this code:

wx.adv.Sound(filename).Play(flags)

Parameters:	flags –
Return type:	bool

static PlaySound(filename, flags=SOUND_ASYNC)¶