/////////////////////////////////////////////////////////////////////////////
// Name: mediactrl.h
-// Purpose: interface of wxMediaEvent
+// Purpose: interface of wxMediaEvent, wxMediaCtrl
// Author: wxWidgets team
-// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/** No controls. return wxMediaCtrl to its default state. */
wxMEDIACTRLPLAYERCONTROLS_NONE = 0,
- /** Step controls like fastfoward, step one frame etc. */
+ /** Step controls like fastforward, step one frame etc. */
wxMEDIACTRLPLAYERCONTROLS_STEP = 1 << 0,
/** Volume controls like the speaker icon, volume slider, etc. */
want to render, catch the @c 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
+ More complex operations are generally more heavily dependent 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.
When wxMediaCtrl stops, either by the @c 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.
+ is called, playback is guaranteed 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
+ them they return to the beginning, thus wxMediaCtrl tries to keep consistent
for all types of media.
Note that when changing the state of the media through Play() and other methods,
By default, wxMediaCtrl will scale the size of the video to the requested
amount passed to either its constructor or Create().
- After calling wxMediaCtrl::Load or performing an equivilant operation,
+ After calling wxMediaCtrl::Load or performing an equivalent operation,
you can subsequently obtain the "real" size of the video (if there is any)
by calling wxMediaCtrl::GetBestSize(). Note that the actual result on the
display will be slightly different when wxMediaCtrl::ShowPlayerControls is
- activated and the actual video size will be less then specified due to the
+ activated and the actual video size will be less than specified due to the
extra controls provided by the native toolkit.
In addition, the backend may modify wxMediaCtrl::GetBestSize() to include
the size of the extra controls - so if you want the real size of the video
- @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
+ You need the correct modules to play the relevant 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
@param name
Window name.
*/
- wxMediaCtrl(wxWindow* parent, wxWindowID id, const wxString& fileName = wxT(""),
+ wxMediaCtrl(wxWindow* parent, wxWindowID id, const wxString& fileName = wxEmptyString,
const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
- long style = 0, const wxString& szBackend = wxT(""),
+ long style = 0, const wxString& szBackend = wxEmptyString,
const wxValidator& validator = wxDefaultValidator,
- const wxString& name = wxPanelNameStr);
+ const wxString& name = "mediaCtrl");
/**
Creates this control.
@param name
Window name.
*/
- bool Create(wxWindow* parent, wxWindowID id, const wxString& fileName = wxT(""),
+ bool Create(wxWindow* parent, wxWindowID id, const wxString& fileName = wxEmptyString,
const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize,
- long style = 0, const wxString& szBackend = wxT(""),
+ long style = 0, const wxString& szBackend = wxEmptyString,
const wxValidator& validator = wxDefaultValidator,
- const wxString& name = wxPanelNameStr);
+ const wxString& name = "mediaCtrl");
/**
Obtains the best size relative to the original/natural size of the
@return zero on failure.
*/
- double GetPlaybackrate();
+ double GetPlaybackRate();
/**
Obtains the state the playback of the media is in -
@row2col{wxMEDIASTATE_PLAYING, The movie is currently playing.}
@endTable
*/
- wxMediaCtrlState GetState();
+ wxMediaState GetState();
/**
Gets the volume of the media from a 0.0 to 1.0 range.
/**
Loads the location that uri refers to. Note that this is very
- implementation-dependant, although HTTP URI/URLs are generally
+ implementation-dependent, although HTTP URI/URLs are generally
supported, for example. Returns @false if loading fails.
*/
bool Load(const wxURI& uri);
/**
Same as Load(const wxURI& uri). Kept for wxPython compatibility.
*/
- bool LoadURI(const wxURI& uri);
+ bool LoadURI(const wxString& fileName);
/**
Same as Load(const wxURI& uri, const wxURI& proxy).
Kept for wxPython compatibility.
*/
- bool LoadURIWithProxy(const wxURI& uri, const wxURI& proxy);
+ bool LoadURIWithProxy(const wxString& fileName, const wxString& proxy);
/**
Pauses playback of the movie.
@todo Document the wxSeekMode parameter @a mode, and perhaps also the
wxFileOffset and wxSeekMode themselves.
*/
- wxFileOffset Seek(wxFileOffset where, wxSeekMode mode);
+ wxFileOffset Seek(wxFileOffset where, wxSeekMode mode = wxFromStart);
/**
Sets the playback rate, or speed of the media, to that referred by @a dRate.
default controls provided by the toolkit. The function takes a
wxMediaCtrlPlayerControls enumeration, please see available show modes there.
- For more see @ref mediactrl_player_controls.
+ For more info see @ref mediactrl_player_controls.
Currently only implemented on the QuickTime and DirectShow backends.
The function returns @true on success.
projects / wxWidgets.git / blobdiff