[wxWidgets.git] / interface / mediactrl.h

/////////////////////////////////////////////////////////////////////////////
// Name:        mediactrl.h
// Purpose:     documentation for wxMediaEvent class
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/**
    @class wxMediaEvent
    @wxheader{mediactrl.h}

    Event wxMediaCtrl uses.

    @library{wxmedia}
    @category{FIXME}
*/
class wxMediaEvent : public wxNotifyEvent
{
public:

};


/**
    @class wxMediaCtrl
    @wxheader{mediactrl.h}

    wxMediaCtrl is a class for displaying types of
    media, such as videos, audio files, natively through native codecs.

    wxMediaCtrl uses native backends to render media, for example on Windows
    there is a ActiveMovie/DirectShow backend, and on Macintosh there is a
    QuickTime backend.

    @library{wxmedia}
    @category{media}

    @seealso
    wxMediaEvent
*/
class wxMediaCtrl : public wxControl
{
public:
    //@{
    /**
        ,
                @b const wxPoint&
        
        @param pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,
                const wxString& szBackend = wxT(""),
                const wxValidatorvalidator = wxDefaultValidator,
                const wxString& name = wxPanelNameStr
                           )
        
        Constructor that calls Create.  You may prefer to call Create directly to check
        to see if wxMediaCtrl is available on the system.
        
        parent
        parent of this control.  Must not be @NULL.
        
        @param id
        id to use for events
        
        @param fileName
        If not empty, the path of a file to open.
        
        @param pos
        Position to put control at.
        
        @param size
        Size to put the control at and to stretch movie to.
        
        @param style
        Optional styles.
        
        @param szBackend
        Name of backend you want to use, leave blank to make
        wxMediaCtrl figure it out.
        
        @param validator
        validator to use.
        
        @param name
        Window name.
    */
    wxMediaCtrl();
    wxMediaCtrl(wxWindow* parent, wxWindowID id);
    //@}

    /**
        Generally, you should almost certainly leave this part up to
        wxMediaCtrl - but if you need a certain backend for a particular
        reason, such as QuickTime for playing .mov files, all you need
        to do to choose a specific backend is to pass the
        name of the backend class to
        Create().
        
        The following are valid backend identifiers -
        
        @b wxMEDIABACKEND_DIRECTSHOW
        
        
        Use ActiveMovie/DirectShow.  Uses the native ActiveMovie
        (I.E. DirectShow) control. Default backend on Windows and
        supported by nearly all Windows versions, even some
        Windows CE versions. May display a windows media player
        logo while inactive.
        
        @b wxMEDIABACKEND_QUICKTIME
        
        
        Use QuickTime.  Mac Only.
        WARNING: May not working correctly embedded in a wxNotebook.
        
        
        @b wxMEDIABACKEND_GSTREAMER
        
        
        Use GStreamer.  Unix Only. Requires GStreamer 0.8 along
        with at the very least the xvimagesink, xoverlay, and
        gst-play modules of gstreamer to function. You need the correct
        modules to play the relavant files, for example the mad module
        to play mp3s, etc.
        
        @b wxMEDIABACKEND_WMP10
        
        
        Uses Windows Media Player 10 (Windows only) - works on mobile
        machines with Windows Media Player 10 and desktop machines with
        either Windows Media Player 9 or 10
        
        Note that other backends such as wxMEDIABACKEND_MCI can now be
        found at wxCode.
    */


    /**
        ,
                @b const wxPoint&
        
        @param pos = wxDefaultPosition,
                const wxSize& size = wxDefaultSize,
                long style = 0,
                const wxString& szBackend = wxT(""),
                const wxValidatorvalidator = wxDefaultValidator,
                const wxString& name = wxPanelNameStr
                           )
        
        Creates this control.  Returns @false if it can't load the movie located at
        fileName or it cannot load one of its native backends.
        
        If you specify a file to open via fileName and you don't specify a backend to
        use, wxMediaCtrl tries each of its backends until one that can render the path referred to by fileName can be found.
        
        parent
        parent of this control.  Must not be @NULL.
        
        @param id
        id to use for events
        
        @param fileName
        If not empty, the path of a file to open.
        
        @param pos
        Position to put control at.
        
        @param size
        Size to put the control at and to stretch movie to.
        
        @param style
        Optional styles.
        
        @param szBackend
        Name of backend you want to use, leave blank to make
        wxMediaCtrl figure it out.
        
        @param validator
        validator to use.
        
        @param name
        Window name.
    */
    bool Create(wxWindow* parent, wxWindowID id);

    /**
        Creating a backend for wxMediaCtrl is a rather simple process. Simply derive
        from wxMediaBackendCommonBase and implement the methods you want. The methods
        in wxMediaBackend correspond to those in wxMediaCtrl except for CreateControl
        which does the actual creation of the control, in cases where a custom control
        is not needed you may simply call wxControl::Create.
        
        You need to make sure to use the DECLARE_CLASS and IMPLEMENT_CLASS macros.
        
        The only real tricky part is that you need to make sure the file in compiled
        in, which if there are just backends in there will not happen and you may need
        to use a force link hack (see http://www.wxwidgets.org/wiki/index.php/RTTI).
        
        This is a rather simple example of how to create a backend in the
        wxActiveXContainer documentation.
    */


    /**
        Obtains the best size relative to the original/natural size of the
        video, if there is any. See @ref overview_videosizewxmediactrl "Video size"
        for more information.
    */
    wxSize GetBestSize();

    /**
        Obtains the playback rate, or speed of the media. @c 1.0 represents normal
        speed, while @c 2.0 represents twice the normal speed of the media, for
        example. Not supported on the GStreamer (Unix) backend.
        Returns 0 on failure.
    */
    double GetPlaybackrate();

    /**
        Obtains the state the playback of the media is in -
        
        
        @b wxMEDIASTATE_STOPPED
        
        
        The movie has stopped.
        
        @b wxMEDIASTATE_PAUSED
        
        
        The movie is paused.
        
        @b wxMEDIASTATE_PLAYING
        
        
        The movie is currently playing.
    */
    wxMediaCtrlState GetState();

    /**
        Gets the volume of the media from a 0.0 to 1.0 range. Note that due to rounding
        and other errors this may not be the exact value sent to SetVolume.
    */
    double GetVolume();

    /**
        Obtains the length - the total amount of time the movie has in milliseconds.
    */
    wxFileOffset Length();

    /**
        Loads the location that @c uri refers to with the proxy @c proxy. Not
        implemented on most backends so it should be called with caution. Returns @false if loading fails.
    */
    bool Load(const wxURI& uri, const wxURI& proxy);

    /**
        Same as @ref loaduri() Load. Kept for wxPython compatability.
    */
    bool LoadURI(const wxURI& uri);

    /**
        Same as @ref loaduriwithproxy() Load. Kept for wxPython compatability.
    */
    bool LoadURIWithProxy(const wxURI& uri, const wxURI& proxy);

    /**
        When wxMediaCtrl plays a file, it plays until the stop position
        is reached (currently the end of the file/stream).  Right before
        it hits the end of the stream, it fires off a EVT_MEDIA_STOP
        event to its parent window, at which point the event handler
        can choose to veto the event, preventing the stream from actually
        stopping.
        
        Example:
        
        When wxMediaCtrl stops, either by the EVT_MEDIA_STOP not being
        vetoed, or by manually calling
        Stop(), where it actually
        stops is not at the beginning, rather, but at the beginning of
        the stream.  That is, when it stops and play is called, playback
        is gauranteed to start at the beginning of the media.  This is
        because some streams are not seekable, and when stop is called
        on them they return to the beginning, thus wxMediaCtrl tries
        to keep consistant for all types of media.
        
        Note that when changing the state of the media through Play()
        and other methods, the media may not actually be in the
        wxMEDIASTATE_PLAYING, for example. If you are relying on the
        media being in certain state catch the event relevant to the state.
        See wxMediaEvent for the kinds of events
        that you can catch.
    */


    /**
        Pauses playback of the movie.
    */
    bool Pause();

    /**
        Resumes playback of the movie.
    */
    bool Play();

    /**
        Normally, when you use wxMediaCtrl it is just a window for the video to
        play in.  However, some toolkits have their own media player interface.
        For example, QuickTime generally has a bar below the video with a slider.
        A special feature available to wxMediaCtrl, you can use the toolkit's interface
        instead of
        making your own by using the ShowPlayerControls()
        function.  There are several options for the flags parameter, with
        the two general flags being wxMEDIACTRLPLAYERCONTROLS_NONE which turns off
        the native interface, and wxMEDIACTRLPLAYERCONTROLS_DEFAULT which lets
        wxMediaCtrl decide what native controls on the interface. Be sure to review
        the caveats outlined in @ref overview_videosizewxmediactrl "Video size" before
        doing so.
    */


    /**
        Depending upon the backend, wxMediaCtrl can render
        and display pretty much any kind of media that the native system can -
        such as an image, mpeg video, or mp3 (without license restrictions -
        since it relies on native system calls that may not technically
        have mp3 decoding available, for example, it falls outside the
        realm of licensing restrictions).
        
        For general operation, all you need to do is call
        Load() to load the file
        you want to render, catch the EVT_MEDIA_LOADED event,
        and then call Play()
        to show the video/audio of the media in that event.
        
        More complex operations are generally more heavily dependant on the
        capabilities of the backend.  For example, QuickTime cannot set
        the playback rate of certain streaming media - while DirectShow is
        slightly more flexible in that regard.
    */


    /**
        Seeks to a position within the movie.
    */
    wxFileOffset Seek(wxFileOffset where, wxSeekMode mode);

    /**
        Sets the playback rate, or speed of the media, to that referred by @c dRate.
        @c 1.0 represents normal speed, while @c 2.0 represents twice the normal
        speed of the media, for example. Not supported on the GStreamer (Unix) backend.
        Returns @true if successful.
    */
    bool SetPlaybackRate(double dRate);

    /**
        Sets the volume of the media from a 0.0 to 1.0 range to that referred
        by @c dVolume.  @c 1.0 represents full volume, while @c 0.5
        represents half (50 percent) volume, for example.  Note that this may not be
        exact due to conversion and rounding errors, although setting the volume to
        full or none is always exact. Returns @true if successful.
    */
    bool SetVolume(double dVolume);

    /**
        A special feature to wxMediaCtrl. Applications using native toolkits such as
        QuickTime usually have a scrollbar, play button, and more provided to
        them by the toolkit. By default wxMediaCtrl does not do this. However, on
        the directshow and quicktime backends you can show or hide the native controls
        provided by the underlying toolkit at will using ShowPlayerControls. Simply
        calling the function with default parameters tells wxMediaCtrl to use the
        default controls provided by the toolkit. The function takes a
        @c wxMediaCtrlPlayerControls enumeration as follows:
        
        
        @b wxMEDIACTRLPLAYERCONTROLS_NONE
        
        
        No controls. return wxMediaCtrl to it's default state.
        
        @b wxMEDIACTRLPLAYERCONTROLS_STEP
        
        
        Step controls like fastfoward, step one frame etc.
        
        @b wxMEDIACTRLPLAYERCONTROLS_VOLUME
        
        
        Volume controls like the speaker icon, volume slider, etc.
        
        @b wxMEDIACTRLPLAYERCONTROLS_DEFAULT
        
        
        Default controls for the toolkit. Currently a typedef for
        wxMEDIACTRLPLAYERCONTROLS_STEP and wxMEDIACTRLPLAYERCONTROLS_VOLUME.
        
        For more see @ref overview_playercontrolswxmediactrl "Player controls".
        Currently
        only implemented on the QuickTime and DirectShow backends. The function
        returns @true on success.
    */
    bool ShowPlayerControls(wxMediaCtrlPlayerControls flags = wxMEDIACTRLPLAYERCONTROLS_DEFAULT);

    /**
        Stops the media.
        
        See Operation for an overview of how
        stopping works.
    */
    bool Stop();

    /**
        Obtains the current position in time within the movie in milliseconds.
    */
    wxFileOffset Tell();

    /**
        By default, wxMediaCtrl will scale the size of the video to the
        requested amount passed to either it's constructor or Create().
        After calling Load or performing an equivilant operation, you
        can subsequently obtain the "real" size of the video (if there
        is any) by calling GetBestSize(). Note that the actual result
        on the display will be slightly different when ShowPlayerControls
        is activated and the actual video size will be less then
        specified due to the extra controls provided by the native toolkit.
        In addition, the backend may modify GetBestSize() to include the
        size of the extra controls - so if you want the real size of the
        video just disable ShowPlayerControls().
        
        The idea with setting GetBestSize to the size of the video is
        that GetBestSize is a wxWindow-derived function that is called
        when sizers on a window recalculate. What this means is that
        if you use sizers by default the video will show in it's
        original size without any extra assistance needed from the user.
    */
};
Commit	Line	Data
23324ae1 FM	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: mediactrl.h
	3	// Purpose: documentation for wxMediaEvent class
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxMediaEvent
	11	@wxheader{mediactrl.h}
7c913512	12
23324ae1	13	Event wxMediaCtrl uses.
7c913512	14
23324ae1 FM	15	@library{wxmedia}
	16	@category{FIXME}
	17	*/
	18	class wxMediaEvent : public wxNotifyEvent
	19	{
	20	public:
7c913512	21
23324ae1 FM	22	};
	23
	24
	25	/**
	26	@class wxMediaCtrl
	27	@wxheader{mediactrl.h}
7c913512 FM	28
7c913512 FM	29	wxMediaCtrl is a class for displaying types of
23324ae1	30	media, such as videos, audio files, natively through native codecs.
7c913512	31
23324ae1	32	wxMediaCtrl uses native backends to render media, for example on Windows
7c913512	33	there is a ActiveMovie/DirectShow backend, and on Macintosh there is a
23324ae1	34	QuickTime backend.
7c913512	35
23324ae1 FM	36	@library{wxmedia}
23324ae1 FM	37	@category{media}
7c913512	38
23324ae1 FM	39	@seealso
	40	wxMediaEvent
	41	*/
	42	class wxMediaCtrl : public wxControl
	43	{
	44	public:
	45	//@{
	46	/**
	47	,
	48	@b const wxPoint&
	49
7c913512 FM	50	@param pos = wxDefaultPosition,
	51	const wxSize& size = wxDefaultSize,
	52	long style = 0,
23324ae1 FM	53	const wxString& szBackend = wxT(""),
	54	const wxValidatorvalidator = wxDefaultValidator,
	55	const wxString& name = wxPanelNameStr
	56	)
	57
	58	Constructor that calls Create. You may prefer to call Create directly to check
	59	to see if wxMediaCtrl is available on the system.
	60
7c913512	61	parent
23324ae1 FM	62	parent of this control. Must not be @NULL.
23324ae1 FM	63
7c913512	64	@param id
23324ae1 FM	65	id to use for events
23324ae1 FM	66
7c913512	67	@param fileName
23324ae1 FM	68	If not empty, the path of a file to open.
23324ae1 FM	69
7c913512	70	@param pos
23324ae1 FM	71	Position to put control at.
23324ae1 FM	72
7c913512	73	@param size
23324ae1 FM	74	Size to put the control at and to stretch movie to.
23324ae1 FM	75
7c913512	76	@param style
23324ae1 FM	77	Optional styles.
23324ae1 FM	78
7c913512	79	@param szBackend
23324ae1 FM	80	Name of backend you want to use, leave blank to make
	81	wxMediaCtrl figure it out.
	82
7c913512	83	@param validator
23324ae1 FM	84	validator to use.
23324ae1 FM	85
7c913512	86	@param name
23324ae1 FM	87	Window name.
	88	*/
	89	wxMediaCtrl();
7c913512	90	wxMediaCtrl(wxWindow* parent, wxWindowID id);
23324ae1 FM	91	//@}
	92
	93	/**
	94	Generally, you should almost certainly leave this part up to
	95	wxMediaCtrl - but if you need a certain backend for a particular
7c913512	96	reason, such as QuickTime for playing .mov files, all you need
23324ae1	97	to do to choose a specific backend is to pass the
7c913512	98	name of the backend class to
23324ae1 FM	99	Create().
	100
	101	The following are valid backend identifiers -
	102
	103	@b wxMEDIABACKEND_DIRECTSHOW
	104
	105
7c913512	106
23324ae1 FM	107	Use ActiveMovie/DirectShow. Uses the native ActiveMovie
	108	(I.E. DirectShow) control. Default backend on Windows and
	109	supported by nearly all Windows versions, even some
	110	Windows CE versions. May display a windows media player
7c913512	111	logo while inactive.
23324ae1 FM	112
	113	@b wxMEDIABACKEND_QUICKTIME
	114
	115
	116	Use QuickTime. Mac Only.
	117	WARNING: May not working correctly embedded in a wxNotebook.
	118
	119
	120	@b wxMEDIABACKEND_GSTREAMER
	121
	122
	123	Use GStreamer. Unix Only. Requires GStreamer 0.8 along
	124	with at the very least the xvimagesink, xoverlay, and
	125	gst-play modules of gstreamer to function. You need the correct
	126	modules to play the relavant files, for example the mad module
	127	to play mp3s, etc.
	128
	129	@b wxMEDIABACKEND_WMP10
	130
	131
	132	Uses Windows Media Player 10 (Windows only) - works on mobile
	133	machines with Windows Media Player 10 and desktop machines with
	134	either Windows Media Player 9 or 10
	135
	136	Note that other backends such as wxMEDIABACKEND_MCI can now be
	137	found at wxCode.
	138	*/
	139
	140
	141	/**
	142	,
	143	@b const wxPoint&
	144
7c913512 FM	145	@param pos = wxDefaultPosition,
	146	const wxSize& size = wxDefaultSize,
	147	long style = 0,
23324ae1 FM	148	const wxString& szBackend = wxT(""),
	149	const wxValidatorvalidator = wxDefaultValidator,
	150	const wxString& name = wxPanelNameStr
	151	)
	152
	153	Creates this control. Returns @false if it can't load the movie located at
	154	fileName or it cannot load one of its native backends.
	155
	156	If you specify a file to open via fileName and you don't specify a backend to
	157	use, wxMediaCtrl tries each of its backends until one that can render the path referred to by fileName can be found.
	158
7c913512	159	parent
23324ae1 FM	160	parent of this control. Must not be @NULL.
23324ae1 FM	161
7c913512	162	@param id
23324ae1 FM	163	id to use for events
23324ae1 FM	164
7c913512	165	@param fileName
23324ae1 FM	166	If not empty, the path of a file to open.
23324ae1 FM	167
7c913512	168	@param pos
23324ae1 FM	169	Position to put control at.
23324ae1 FM	170
7c913512	171	@param size
23324ae1 FM	172	Size to put the control at and to stretch movie to.
23324ae1 FM	173
7c913512	174	@param style
23324ae1 FM	175	Optional styles.
23324ae1 FM	176
7c913512	177	@param szBackend
23324ae1 FM	178	Name of backend you want to use, leave blank to make
	179	wxMediaCtrl figure it out.
	180
7c913512	181	@param validator
23324ae1 FM	182	validator to use.
23324ae1 FM	183
7c913512	184	@param name
23324ae1 FM	185	Window name.
	186	*/
	187	bool Create(wxWindow* parent, wxWindowID id);
	188
	189	/**
	190	Creating a backend for wxMediaCtrl is a rather simple process. Simply derive
	191	from wxMediaBackendCommonBase and implement the methods you want. The methods
	192	in wxMediaBackend correspond to those in wxMediaCtrl except for CreateControl
	193	which does the actual creation of the control, in cases where a custom control
	194	is not needed you may simply call wxControl::Create.
	195
	196	You need to make sure to use the DECLARE_CLASS and IMPLEMENT_CLASS macros.
	197
	198	The only real tricky part is that you need to make sure the file in compiled
	199	in, which if there are just backends in there will not happen and you may need
	200	to use a force link hack (see http://www.wxwidgets.org/wiki/index.php/RTTI).
	201
	202	This is a rather simple example of how to create a backend in the
	203	wxActiveXContainer documentation.
	204	*/
	205
	206
	207	/**
	208	Obtains the best size relative to the original/natural size of the
	209	video, if there is any. See @ref overview_videosizewxmediactrl "Video size"
	210	for more information.
	211	*/
	212	wxSize GetBestSize();
	213
	214	/**
	215	Obtains the playback rate, or speed of the media. @c 1.0 represents normal
	216	speed, while @c 2.0 represents twice the normal speed of the media, for
	217	example. Not supported on the GStreamer (Unix) backend.
	218	Returns 0 on failure.
	219	*/
	220	double GetPlaybackrate();
	221
	222	/**
	223	Obtains the state the playback of the media is in -
	224
	225
	226	@b wxMEDIASTATE_STOPPED
	227
	228
	229	The movie has stopped.
	230
	231	@b wxMEDIASTATE_PAUSED
	232
	233
	234	The movie is paused.
	235
	236	@b wxMEDIASTATE_PLAYING
	237
	238
	239	The movie is currently playing.
	240	*/
	241	wxMediaCtrlState GetState();
	242
	243	/**
	244	Gets the volume of the media from a 0.0 to 1.0 range. Note that due to rounding
	245	and other errors this may not be the exact value sent to SetVolume.
	246	*/
	247	double GetVolume();
	248
249	/**
250	Obtains the length - the total amount of time the movie has in milliseconds.
251	*/
252	wxFileOffset Length();
253
254	/**
255	Loads the location that @c uri refers to with the proxy @c proxy. Not
256	implemented on most backends so it should be called with caution. Returns @false if loading fails.
257	*/
258	bool Load(const wxURI& uri, const wxURI& proxy);
259
260	/**
261	Same as @ref loaduri() Load. Kept for wxPython compatability.
262	*/
263	bool LoadURI(const wxURI& uri);
264
265	/**
266	Same as @ref loaduriwithproxy() Load. Kept for wxPython compatability.
267	*/
268	bool LoadURIWithProxy(const wxURI& uri, const wxURI& proxy);
269
270	/**
271	When wxMediaCtrl plays a file, it plays until the stop position
272	is reached (currently the end of the file/stream). Right before
273	it hits the end of the stream, it fires off a EVT_MEDIA_STOP
274	event to its parent window, at which point the event handler
275	can choose to veto the event, preventing the stream from actually
276	stopping.
277
278	Example:
279
280	When wxMediaCtrl stops, either by the EVT_MEDIA_STOP not being
7c913512	281	vetoed, or by manually calling
23324ae1 FM	282	Stop(), where it actually
	283	stops is not at the beginning, rather, but at the beginning of
	284	the stream. That is, when it stops and play is called, playback
7c913512	285	is gauranteed to start at the beginning of the media. This is
23324ae1 FM	286	because some streams are not seekable, and when stop is called
	287	on them they return to the beginning, thus wxMediaCtrl tries
	288	to keep consistant for all types of media.
	289
	290	Note that when changing the state of the media through Play()
	291	and other methods, the media may not actually be in the
	292	wxMEDIASTATE_PLAYING, for example. If you are relying on the
	293	media being in certain state catch the event relevant to the state.
	294	See wxMediaEvent for the kinds of events
	295	that you can catch.
	296	*/
	297
	298
	299	/**
	300	Pauses playback of the movie.
	301	*/
	302	bool Pause();
	303
	304	/**
	305	Resumes playback of the movie.
	306	*/
	307	bool Play();
	308
	309	/**
	310	Normally, when you use wxMediaCtrl it is just a window for the video to
	311	play in. However, some toolkits have their own media player interface.
	312	For example, QuickTime generally has a bar below the video with a slider.
	313	A special feature available to wxMediaCtrl, you can use the toolkit's interface
	314	instead of
	315	making your own by using the ShowPlayerControls()
	316	function. There are several options for the flags parameter, with
	317	the two general flags being wxMEDIACTRLPLAYERCONTROLS_NONE which turns off
	318	the native interface, and wxMEDIACTRLPLAYERCONTROLS_DEFAULT which lets
	319	wxMediaCtrl decide what native controls on the interface. Be sure to review
	320	the caveats outlined in @ref overview_videosizewxmediactrl "Video size" before
	321	doing so.
	322	*/
	323
	324
	325	/**
	326	Depending upon the backend, wxMediaCtrl can render
7c913512	327	and display pretty much any kind of media that the native system can -
23324ae1 FM	328	such as an image, mpeg video, or mp3 (without license restrictions -
	329	since it relies on native system calls that may not technically
	330	have mp3 decoding available, for example, it falls outside the
	331	realm of licensing restrictions).
	332
7c913512	333	For general operation, all you need to do is call
23324ae1 FM	334	Load() to load the file
23324ae1 FM	335	you want to render, catch the EVT_MEDIA_LOADED event,
7c913512	336	and then call Play()
23324ae1 FM	337	to show the video/audio of the media in that event.
	338
	339	More complex operations are generally more heavily dependant on the
	340	capabilities of the backend. For example, QuickTime cannot set
7c913512	341	the playback rate of certain streaming media - while DirectShow is
23324ae1 FM	342	slightly more flexible in that regard.
	343	*/
	344
	345
	346	/**
	347	Seeks to a position within the movie.
	348	*/
	349	wxFileOffset Seek(wxFileOffset where, wxSeekMode mode);
	350
	351	/**
	352	Sets the playback rate, or speed of the media, to that referred by @c dRate.
	353	@c 1.0 represents normal speed, while @c 2.0 represents twice the normal
	354	speed of the media, for example. Not supported on the GStreamer (Unix) backend.
	355	Returns @true if successful.
	356	*/
	357	bool SetPlaybackRate(double dRate);
	358
	359	/**
	360	Sets the volume of the media from a 0.0 to 1.0 range to that referred
	361	by @c dVolume. @c 1.0 represents full volume, while @c 0.5
	362	represents half (50 percent) volume, for example. Note that this may not be
	363	exact due to conversion and rounding errors, although setting the volume to
	364	full or none is always exact. Returns @true if successful.
	365	*/
	366	bool SetVolume(double dVolume);
	367
	368	/**
	369	A special feature to wxMediaCtrl. Applications using native toolkits such as
	370	QuickTime usually have a scrollbar, play button, and more provided to
	371	them by the toolkit. By default wxMediaCtrl does not do this. However, on
	372	the directshow and quicktime backends you can show or hide the native controls
	373	provided by the underlying toolkit at will using ShowPlayerControls. Simply
	374	calling the function with default parameters tells wxMediaCtrl to use the
	375	default controls provided by the toolkit. The function takes a
	376	@c wxMediaCtrlPlayerControls enumeration as follows:
	377
	378
	379	@b wxMEDIACTRLPLAYERCONTROLS_NONE
	380
	381
	382	No controls. return wxMediaCtrl to it's default state.
	383
	384	@b wxMEDIACTRLPLAYERCONTROLS_STEP
	385
	386
	387	Step controls like fastfoward, step one frame etc.
	388
	389	@b wxMEDIACTRLPLAYERCONTROLS_VOLUME
	390
	391
	392	Volume controls like the speaker icon, volume slider, etc.
	393
	394	@b wxMEDIACTRLPLAYERCONTROLS_DEFAULT
	395
	396
	397	Default controls for the toolkit. Currently a typedef for
	398	wxMEDIACTRLPLAYERCONTROLS_STEP and wxMEDIACTRLPLAYERCONTROLS_VOLUME.
	399
	400	For more see @ref overview_playercontrolswxmediactrl "Player controls".
	401	Currently
	402	only implemented on the QuickTime and DirectShow backends. The function
	403	returns @true on success.
	404	*/
	405	bool ShowPlayerControls(wxMediaCtrlPlayerControls flags = wxMEDIACTRLPLAYERCONTROLS_DEFAULT);
406
407	/**
408	Stops the media.
409
410	See Operation for an overview of how
411	stopping works.
412	*/
413	bool Stop();
414
415	/**
416	Obtains the current position in time within the movie in milliseconds.
417	*/
418	wxFileOffset Tell();
419
420	/**
421	By default, wxMediaCtrl will scale the size of the video to the
422	requested amount passed to either it's constructor or Create().
423	After calling Load or performing an equivilant operation, you
424	can subsequently obtain the "real" size of the video (if there
425	is any) by calling GetBestSize(). Note that the actual result
426	on the display will be slightly different when ShowPlayerControls
427	is activated and the actual video size will be less then
428	specified due to the extra controls provided by the native toolkit.
429	In addition, the backend may modify GetBestSize() to include the
430	size of the extra controls - so if you want the real size of the
431	video just disable ShowPlayerControls().
432
433	The idea with setting GetBestSize to the size of the video is
434	that GetBestSize is a wxWindow-derived function that is called
435	when sizers on a window recalculate. What this means is that
436	if you use sizers by default the video will show in it's
437	original size without any extra assistance needed from the user.
438	*/
439	};