define _HPUX_SOURCE under HP-UX, otherwise many things are not defined in standard...

[wxWidgets.git] / docs / latex / wx / mediactrl.tex

diff --git a/docs/latex/wx/mediactrl.tex b/docs/latex/wx/mediactrl.tex
index 77c4ffe93e617d1dba6d0445daa5395f54589ef5..155652ae6fd9e391f441ceca32f01e9984cef913 100644 (file)
--- a/docs/latex/wx/mediactrl.tex
+++ b/docs/latex/wx/mediactrl.tex
@@ -18,8 +18,6 @@ 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.
 
 there is a ActiveMovie/DirectShow backend, and on Macintosh there is a 
 QuickTime backend.
 

-wxMediaCtrl is not currently available on unix systems. 
-

 \wxheading{Derived from}
 
 \helpref{wxControl}{wxcontrol}
 \wxheading{Derived from}
 
 \helpref{wxControl}{wxcontrol}


@@ -32,17 +30,18 @@ wxMediaCtrl is not currently available on unix systems.
 
 \membersection{Rendering media}\label{renderingmediawxmediactrl}
 
 
 \membersection{Rendering media}\label{renderingmediawxmediactrl}
 

-wxMediaCtrl can generally, depending upon the backend, render
+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 -
 and display pretty much any kind of media that the native system can - 
 such as an image, mpeg video, or mp3 (without license restrictions -

-sense it relies on native system calls that may not technically
+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
 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, then call \helpref{wxMediaCtrl::Play}{wxmediactrlplay} 
-to show the video/audio of the media.
+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
 
 More complex operations are generally more heavily dependant on the
 capabilities of the backend.  For example, QuickTime cannot set


@@ -104,9 +103,11 @@ 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}}{
 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. }
+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\_MCI}}{
 Use Media Command Interface.  Windows Only. }

+\twocolitem{{\bf wxMEDIABACKEND\_GSTREAMER}}{
+Use GStreamer.  Unix Only. }

 \end{twocollist}
 
 \membersection{wxMediaCtrl::wxMediaCtrl}\label{wxmediactrlwxmediactrl}
 \end{twocollist}
 
 \membersection{wxMediaCtrl::wxMediaCtrl}\label{wxmediactrlwxmediactrl}


@@ -172,16 +173,16 @@ wxMediaCtrl figure it out.}
 \docparam{name}{Window name.}
 
 
 \docparam{name}{Window name.}
 
 

-\membersection{wxMediaCtrl::GetDuration}\label{wxmediactrlgetduration}
+\membersection{wxMediaCtrl::Length}\label{wxmediactrlgetduration}

 
 

-\func{wxLongLong}{GetDuration}{\void}
+\func{wxFileOffset}{GetDuration}{\void}

 
 Obtains the length - the total amount of time the movie has in milliseconds.
 
 
 
 Obtains the length - the total amount of time the movie has in milliseconds.
 
 

-\membersection{wxMediaCtrl::GetPosition}\label{wxmediactrlgetposition}
+\membersection{wxMediaCtrl::Tell}\label{wxmediactrlgetposition}

 
 

-\func{wxLongLong}{GetPosition}{\void}
+\func{wxFileOffset}{GetPosition}{\void}

 
 Obtains the current position in time within the movie in milliseconds.
 
 
 Obtains the current position in time within the movie in milliseconds.
 


@@ -206,6 +207,13 @@ Obtains the state the playback of the movie is in -
 
 Loads the file that \tt{fileName} refers to.  Returns false if loading fails.
 
 
 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}
 \membersection{wxMediaCtrl::Pause}\label{wxmediactrlpause}
 
 \func{bool}{Pause}{\void}


@@ -220,9 +228,9 @@ Pauses playback of the movie.
 Resumes playback of the movie.
 
 
 Resumes playback of the movie.
 
 

-\membersection{wxMediaCtrl::SetPosition}\label{wxmediactrlsetposition}
+\membersection{wxMediaCtrl::Seek}\label{wxmediactrlsetposition}

 
 

-\func{bool}{SetPosition}{\param{wxLongLong }{where}}
+\func{wxFileOffset}{Seek}{\param{wxFileOffset }{where}, \param{wxSeekMode }{mode}}

 
 Seeks to a position within the movie.
 
 
 Seeks to a position within the movie.
 


@@ -235,3 +243,46 @@ Stops the media.
 
 See \helpref{Operation}{operationwxmediactrl} for an overview of how stopping works.
 
 
 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.
+