1d20b7f2c6
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@35526 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
289 lines
10 KiB
TeX
289 lines
10 KiB
TeX
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
%% Name: mediactrl.tex
|
|
%% Purpose: wxMediaCtrl docs
|
|
%% Author: Ryan Norton <wxprojects@comcast.net>
|
|
%% Modified by:
|
|
%% Created: 11/7/2004
|
|
%% RCS-ID: $Id$
|
|
%% Copyright: (c) Ryan Norton
|
|
%% License: wxWindows license
|
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
|
|
|
|
\section{\class{wxMediaCtrl}}\label{wxmediactrl}
|
|
|
|
wxMediaCtrl is a class that allows a way to convieniently display 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.
|
|
|
|
\wxheading{Derived from}
|
|
|
|
\helpref{wxControl}{wxcontrol}
|
|
|
|
\wxheading{Include files}
|
|
|
|
<wx/mediactrl.h>
|
|
|
|
\latexignore{\rtfignore{\wxheading{Members}}}
|
|
|
|
\membersection{Rendering media}\label{renderingmediawxmediactrl}
|
|
|
|
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
|
|
\helpref{wxMediaCtrl::Load}{wxmediactrlload} to load the file
|
|
you want to render, catch the EVT\_MEDIA\_LOADED event,
|
|
and then call \helpref{wxMediaCtrl::Play}{wxmediactrlplay}
|
|
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.
|
|
|
|
\membersection{Operation}\label{operationwxmediactrl}
|
|
|
|
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:
|
|
\begin{verbatim}
|
|
//connect to the media event
|
|
this->Connect(wxMY_ID, wxEVT_MEDIA_STOP, (wxObjectEventFunction)
|
|
(wxEventFunction)(wxMediaEventFunction) &MyFrame::OnMediaStop);
|
|
|
|
//...
|
|
void MyFrame::OnMediaStop(const wxMediaEvent& evt)
|
|
{
|
|
if(bUserWantsToSeek)
|
|
{
|
|
m_mediactrl->SetPosition(
|
|
m_mediactrl->GetDuration() << 1
|
|
);
|
|
evt.Veto();
|
|
}
|
|
}
|
|
\end{verbatim}
|
|
|
|
When wxMediaCtrl stops, either by the EVT\_MEDIA\_STOP not being
|
|
vetoed, or by manually calling
|
|
\helpref{wxMediaCtrl::Stop}{wxmediactrlstop}, 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.
|
|
|
|
\membersection{Choosing a backend}\label{choosingbackendwxmediactrl}
|
|
|
|
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
|
|
\helpref{wxMediaCtrl::Create}{wxmediactrlcreate}.
|
|
|
|
The following are valid backend identifiers -
|
|
\twocolwidtha{7cm}
|
|
\begin{twocollist}\itemsep=0pt
|
|
\twocolitem{{\bf wxMEDIABACKEND\_DIRECTSHOW}}{
|
|
Use ActiveMovie/DirectShow. Requires wxUSE\_DIRECTSHOW to be
|
|
enabled, requires linkage with the static library strmiids.lib,
|
|
and is available on Windows Only.}
|
|
\twocolitem{{\bf wxMEDIABACKEND\_QUICKTIME}}{
|
|
Use QuickTime. Windows and Mac Only. NOTE: On Mac Systems lower than OSX 10.2 this defaults to emulating window positioning and suffers from several bugs, including not working correctly embedded in a wxNotebook. }
|
|
\twocolitem{{\bf wxMEDIABACKEND\_MCI}}{
|
|
Use Media Command Interface. Windows Only. }
|
|
\twocolitem{{\bf wxMEDIABACKEND\_GSTREAMER}}{
|
|
Use GStreamer. Unix Only. }
|
|
\end{twocollist}
|
|
|
|
\membersection{wxMediaCtrl::wxMediaCtrl}\label{wxmediactrlwxmediactrl}
|
|
|
|
\func{}{wxMediaCtrl}{\void}
|
|
|
|
Default constructor - you \tt{must} call Create before calling any other methods
|
|
of wxMediaCtrl.
|
|
|
|
\func{}{wxMediaCtrl}{
|
|
\param{wxWindow* }{parent},
|
|
\param{const wxString\& }{fileName = wxT("")},
|
|
\param{wxWindowID }{id},
|
|
\param{const wxPoint\& }{pos = wxDefaultPosition},
|
|
\param{const wxSize\& }{size = wxDefaultSize},
|
|
\param{long }{style = 0},
|
|
\param{const wxString\& }{szBackend = wxT("")},
|
|
\param{const wxValidator& }{validator = wxDefaultValidator},
|
|
\param{const wxString\& }{name = wxPanelNameStr}
|
|
}
|
|
|
|
Constructor that calls \helpref{Create}{wxmediactrlcreate}. You may prefer to call \helpref{Create}{wxmediactrlcreate} directly to check to see if wxMediaCtrl is available on the system.
|
|
|
|
\docparam{parent}{parent of this control. Must not be NULL.}
|
|
\docparam{id}{id to use for events}
|
|
\docparam{fileName}{If not empty, the path of a file to open.}
|
|
\docparam{pos}{Position to put control at.}
|
|
\docparam{size}{Size to put the control at and to stretch movie to.}
|
|
\docparam{style}{Optional styles.}
|
|
\docparam{szBackend}{Name of backend you want to use, leave blank to make
|
|
wxMediaCtrl figure it out.}
|
|
\docparam{validator}{validator to use.}
|
|
\docparam{name}{Window name.}
|
|
|
|
|
|
\membersection{wxMediaCtrl::Create}\label{wxmediactrlcreate}
|
|
|
|
\func{bool}{Create}{
|
|
\param{wxWindow* }{parent},
|
|
\param{const wxString\& }{fileName = wxT("")},
|
|
\param{wxWindowID }{id},
|
|
\param{const wxPoint\& }{pos = wxDefaultPosition},
|
|
\param{const wxSize\& }{size = wxDefaultSize},
|
|
\param{long }{style = 0},
|
|
\param{const wxString\& }{szBackend = wxT("")},
|
|
\param{const wxValidator& }{validator = wxDefaultValidator},
|
|
\param{const wxString\& }{name = wxPanelNameStr}
|
|
}
|
|
|
|
Creates this control. Returns \tt{false} if it can't load the movie located at \tt{fileName} or it cannot load one of its native backends.
|
|
|
|
If you specify a file to open via \tt{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 \tt{fileName} can be found.
|
|
|
|
\docparam{parent}{parent of this control. Must not be NULL.}
|
|
\docparam{id}{id to use for events}
|
|
\docparam{fileName}{If not empty, the path of a file to open.}
|
|
\docparam{pos}{Position to put control at.}
|
|
\docparam{size}{Size to put the control at and to stretch movie to.}
|
|
\docparam{style}{Optional styles.}
|
|
\docparam{szBackend}{Name of backend you want to use, leave blank to make
|
|
wxMediaCtrl figure it out.}
|
|
\docparam{validator}{validator to use.}
|
|
\docparam{name}{Window name.}
|
|
|
|
|
|
\membersection{wxMediaCtrl::Length}\label{wxmediactrlgetduration}
|
|
|
|
\func{wxFileOffset}{GetDuration}{\void}
|
|
|
|
Obtains the length - the total amount of time the movie has in milliseconds.
|
|
|
|
|
|
\membersection{wxMediaCtrl::Tell}\label{wxmediactrlgetposition}
|
|
|
|
\func{wxFileOffset}{GetPosition}{\void}
|
|
|
|
Obtains the current position in time within the movie in milliseconds.
|
|
|
|
|
|
\membersection{wxMediaCtrl::GetState}\label{wxmediactrlgetstate}
|
|
|
|
\func{wxMediaCtrlState}{GetState}{\void}
|
|
|
|
Obtains the state the playback of the movie is in -
|
|
|
|
\twocolwidtha{7cm}
|
|
\begin{twocollist}\itemsep=0pt
|
|
\twocolitem{{\bf wxMEDIASTATE\_STOPPED}}{The movie has stopped.}
|
|
\twocolitem{{\bf wxMEDIASTATE\_PAUSED}}{The movie is paused.}
|
|
\twocolitem{{\bf wxMEDIASTATE\_PLAYING}}{The movie is currently playing.}
|
|
\end{twocollist}
|
|
|
|
|
|
\membersection{wxMediaCtrl::Load}\label{wxmediactrlload}
|
|
|
|
\func{bool}{Load}{\param{const wxString\& }{fileName}}
|
|
|
|
Loads the file that \tt{fileName} refers to. Returns false if loading fails.
|
|
|
|
|
|
\membersection{wxMediaCtrl::Load}\label{wxmediactrlloaduri}
|
|
|
|
\func{bool}{Load}{\param{const wxURI\& }{location}}
|
|
|
|
Loads the url that \tt{location} refers to. Returns false if loading fails.
|
|
|
|
\membersection{wxMediaCtrl::Pause}\label{wxmediactrlpause}
|
|
|
|
\func{bool}{Pause}{\void}
|
|
|
|
Pauses playback of the movie.
|
|
|
|
|
|
\membersection{wxMediaCtrl::Play}\label{wxmediactrlplay}
|
|
|
|
\func{bool}{Play}{\void}
|
|
|
|
Resumes playback of the movie.
|
|
|
|
|
|
\membersection{wxMediaCtrl::Seek}\label{wxmediactrlsetposition}
|
|
|
|
\func{wxFileOffset}{Seek}{\param{wxFileOffset }{where}, \param{wxSeekMode }{mode}}
|
|
|
|
Seeks to a position within the movie.
|
|
|
|
|
|
\membersection{wxMediaCtrl::Stop}\label{wxmediactrlstop}
|
|
|
|
\func{bool}{Stop}{\void}
|
|
|
|
Stops the media.
|
|
|
|
See \helpref{Operation}{operationwxmediactrl} for an overview of how stopping works.
|
|
|
|
|
|
\membersection{wxMediaCtrl::SetVolume}\label{wxmediactrlsetvolume}
|
|
|
|
\func{bool}{SetVolume}{\param{double }{dVolume}}
|
|
|
|
Sets the volume of the media from a 0.0 to 1.0 range.
|
|
|
|
|
|
\membersection{wxMediaCtrl::GetVolume}\label{wxmediactrlgetvolume}
|
|
|
|
\func{double}{GetVolume}{\void}
|
|
|
|
Gets the volume of the media from a 0.0 to 1.0 range.
|
|
|
|
|
|
\membersection{wxMediaCtrl::GetPlaybackRate}\label{wxmediactrlgetplaybackrate}
|
|
|
|
\func{double}{GetPlaybackrate}{\void}
|
|
|
|
Gets the playback rate of the media; for example 2.0 is double speed.
|
|
Not implemented on MCI or GStreamer.
|
|
|
|
|
|
\membersection{wxMediaCtrl::SetPlaybackRate}\label{wxmediactrlsetplaybackrate}
|
|
|
|
\func{bool}{SetPlaybackrate}{\param{double }{dVolume}}
|
|
|
|
Sets the rate that the media plays; for example 0.5 is half speed.
|
|
|
|
|
|
\membersection{wxMediaCtrl::ShowPlayerControls}\label{wxmediactrlshowplayercontrols}
|
|
|
|
\func{bool}{ShowPlayerControls}{\param{wxMediaCtrlPlayerControls }{flags}}
|
|
|
|
Normally, when you use wxMediaCtrl it is just a window for the video to
|
|
play in. However, platforms generally have their own media player interface,
|
|
like quicktime has a bar below the video with a slider etc.. If you want that native
|
|
interface instead of making your own use this function. There are several options
|
|
for the flags parameter, however you can look at the mediactrl header for these.
|
|
The two general flags are wxMEDIACTRLPLAYERCONTROLS\_NONE which turns off the
|
|
native interface, and wxMEDIACTRLPLAYERCONTROLS\_DEFAULT which lets wxMediaCtrl
|
|
decide what native controls on the interface.
|
|
|