git.saurik.com Git - wxWidgets.git/blame_incremental

... / ...

Commit	Line	Data
	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: sound.h
	3	// Purpose: interface of wxSound
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows licence
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9
	10	#define wxSOUND_SYNC 0
	11	#define wxSOUND_ASYNC 1
	12	#define wxSOUND_LOOP 2
	13
	14
	15	/**
	16	@class wxSound
	17
	18	This class represents a short sound (loaded from Windows WAV file), that
	19	can be stored in memory and played.
	20
	21	Currently this class is implemented on Windows and Unix (and uses either
	22	Open Sound System or Simple DirectMedia Layer).
	23
	24	@library{wxadv}
	25	@category{media}
	26	*/
	27	class wxSound : public wxObject
	28	{
	29	public:
	30	/**
	31	Default ctor.
	32	*/
	33	wxSound();
	34
	35	/**
	36	Constructs a wave object from a file or, under Windows, from a Windows
	37	resource. Call IsOk() to determine whether this succeeded.
	38
	39	@param fileName
	40	The filename or Windows resource.
	41	@param isResource
	42	@true if fileName is a resource, @false if it is a filename.
	43	*/
	44	wxSound(const wxString& fileName, bool isResource = false);
	45
	46	/**
	47	Constructs a wave object from in-memory data.
	48
	49	@param size
	50	Size of the buffer pointer to by @a data.
	51	@param data
	52	The buffer containing the sound data in WAV format.
	53	*/
	54	wxSound(size_t size, const void* data);
	55
	56	/**
	57	Destroys the wxSound object.
	58	*/
	59	virtual ~wxSound();
	60
	61	/**
	62	Constructs a wave object from a file or resource.
	63
	64	@param fileName
	65	The filename or Windows resource.
	66	@param isResource
	67	@true if fileName is a resource, @false if it is a filename.
	68
	69	@return @true if the call was successful, @false otherwise.
	70	*/
	71	bool Create(const wxString& fileName, bool isResource = false);
	72
	73	/**
	74	Constructs a wave object from in-memory data.
	75
	76	@param size
	77	Size of the buffer pointer to by @a data.
	78	@param data
	79	The buffer containing the sound data in WAV format.
	80	*/
	81	bool Create(size_t size, const void* data);
	82
	83	/**
	84	Returns @true if the object contains a successfully loaded file or resource,
	85	@false otherwise.
	86	*/
	87	bool IsOk() const;
	88
	89	/**
	90	Returns @true if a sound is played at the moment.
	91
	92	This method is currently not available under Windows and may not be
	93	always implemented in Unix ports depending on the compilation options
	94	used (in this case it just always returns @false).
	95
	96	@onlyfor{wxgtk,wxosx}
	97	*/
	98	static bool IsPlaying();
	99
	100	//@{
	101	/**
	102	Plays the sound file. If another sound is playing, it will be interrupted.
	103
	104	Returns @true on success, @false otherwise. Note that in general it is
	105	possible to delete the object which is being asynchronously played any time
	106	after calling this function and the sound would continue playing, however this
	107	currently doesn't work under Windows for sound objects loaded from memory data.
	108
	109	The possible values for @a flags are:
	110	- wxSOUND_SYNC: @c Play will block and wait until the sound is replayed.
	111	- wxSOUND_ASYNC: Sound is played asynchronously, @c Play returns immediately.
	112	- wxSOUND_ASYNC\|wxSOUND_LOOP: Sound is played asynchronously and loops
	113	until another sound is played, Stop() is
	114	called or the program terminates.
	115
	116	The static form is shorthand for this code:
	117	@code
	118	wxSound(filename).Play(flags);
	119	@endcode
	120	*/
	121	bool Play(unsigned flags = wxSOUND_ASYNC) const;
	122	static bool Play(const wxString& filename,
	123	unsigned flags = wxSOUND_ASYNC);
	124	//@}
	125
	126	/**
	127	If a sound is played, this function stops it.
	128	*/
	129	static void Stop();
	130	};
	131