# :stopdoc:
# This file is automatically generated by the WXRuby3 documentation 
# generator. Do not alter this file.
# :startdoc:


module Wx

  # {Wx::MediaCtrl} is a class for displaying various types of media, such as videos, audio files, natively through native codecs.
  # {Wx::MediaCtrl} uses native backends to render media, for example on Windows there is a ActiveMovie/DirectShow backend, and on Macintosh there is a QuickTime backend.
  # 
  # == Rendering media
  # 
  # Depending upon the backend, {Wx::MediaCtrl} 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 {Wx::MediaCtrl#load} to load the file you want to render, catch the EVT_MEDIA_LOADED event, and then call {Wx::MediaCtrl#play} to show the video/audio of the media in that event.
  # 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.
  # 
  # == Operation
  # 
  # When {Wx::MediaCtrl} 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:
  # 
  # ```
  #   // bind the media event
  #   Bind(wxMY_ID, wxEVT_MEDIA_STOP, &MyFrame::OnMediaStop, this);
  #   
  #   //...
  #   void MyFrame::OnMediaStop(wxMediaEvent& evt)
  #   {
  #       if( userWantsToSeek )
  #       {
  #           m_mediactrl->Seek(m_mediactrl->Length() - 1);
  #           evt.Veto();
  #       }
  #   }
  # ```
  # 
  # When {Wx::MediaCtrl} stops, either by the EVT_MEDIA_STOP not being vetoed, or by manually calling {Wx::MediaCtrl#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 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 {Wx::MediaCtrl} tries to keep consistent for all types of media.
  # Note that when changing the state of the media through {Wx::MediaCtrl#play} and other methods, the media may not actually be in the {Wx::MediaState::MEDIASTATE_PLAYING}, for example. If you are relying on the media being in certain state, catch the event relevant to the state. See {Wx::MediaEvent} for the kinds of events that you can catch.
  # 
  # == Video size
  # 
  # By default, {Wx::MediaCtrl} will scale the size of the video to the requested amount passed to either its constructor or {Wx::MediaCtrl#create}. After calling {Wx::MediaCtrl#load} or performing an equivalent operation, you can subsequently obtain the "real" size of the video (if there is any) by calling {Wx::MediaCtrl#get_best_size}. Note that the actual result on the display will be slightly different when {Wx::MediaCtrl#show_player_controls} is 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 {Wx::MediaCtrl#get_best_size} to include the size of the extra controls - so if you want the real size of the video just disable {Wx::MediaCtrl#show_player_controls}.
  # The idea with setting {Wx::MediaCtrl#get_best_size} to the size of the video is that {Wx::MediaCtrl#get_best_size} is a {Wx::Window}-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 its original size without any extra assistance needed from the user.
  # 
  # == Player controls
  # 
  # Normally, when you use {Wx::MediaCtrl} 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 {Wx::MediaCtrl}, you can use the toolkits interface instead of making your own by using the {Wx::MediaCtrl#show_player_controls} function. There are several options for the flags parameter, with the two general flags being {Wx::MediaCtrlPlayerControls::MEDIACTRLPLAYERCONTROLS_NONE} which turns off the native interface, and {Wx::MediaCtrlPlayerControls::MEDIACTRLPLAYERCONTROLS_DEFAULT} which lets {Wx::MediaCtrl} decide what native controls on the interface. Be sure to review the caveats outlined in Video size before doing so.
  # 
  # == Choosing a backend
  # 
  # Generally, you should almost certainly leave this part up to {Wx::MediaCtrl} - 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 {Wx::MediaCtrl#create}.
  # The following are valid backend identifiers:
  # 
  # - <b>{Wx::MEDIABACKEND_DIRECTSHOW}:</b> Use ActiveMovie/DirectShow. Uses the native ActiveMovie (I.E. DirectShow) control. Default backend on Windows and supported by nearly all Windows versions. May display a windows media player logo while inactive.
  # - <b>{Wx::MEDIABACKEND_QUICKTIME}:</b> Use QuickTime. Mac Only. WARNING: May not work correctly when embedded in a {Wx::Notebook}.
  # - <b>{Wx::MEDIABACKEND_GSTREAMER}</b>, Use GStreamer. Unix Only. Requires GStreamer 0.10 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 relevant files, for example the mad module to play mp3s, etc.
  # - <b>{Wx::MEDIABACKEND_WMP10}</b>, Use Windows Media Player 10 (Windows only). Works on systems with either Windows Media Player 9 or 10 installed.
  # 
  # == Creating a backend
  # 
  # Creating a backend for {Wx::MediaCtrl} is a rather simple process. Simply derive from {Wx::MediaBackendCommonBase} and implement the methods you want. The methods in {Wx::MediaBackend} correspond to those in {Wx::MediaCtrl} except for {Wx::MediaCtrl::CreateControl} which does the actual creation of the control, in cases where a custom control is not needed you may simply call {Wx::Control#create}.
  # You need to make sure to use the {Wx::DECLARE_CLASS} and {Wx::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 {Wx::FORCE_LINK_MODULE} usage in the mediactrl sample).
  # There is a rather simple example of how to create a backend in the {Wx::ActiveXContainer} documentation.
  # === Styles
  # 
  # This class supports the following styles:
  # 
  # - {Wx::MC_NO_AUTORESIZE}: By default, the control will automatically adjust its size to exactly fit the size of a loaded video as soon as a video is loaded. If this flag is given, the control will not change its size automatically and it must be done manually (if desired) using {Wx::MediaCtrl#layout}. It is strongly recommended to use this flag and handle control resizing manually (note that this style is only available in wxWidgets 3.1.6, so it is only possible to do it when using this or later version). 
  # 
  # === 
  # 
  # Category:  {Wx::Multimedia}
  # @see Wx::MediaEvent 
  # 
  # 
  class MediaCtrl < Control
  
    # @overload initialize()
    #   Default constructor - you MUST call {Wx::MediaCtrl#create} before calling any other methods of {Wx::MediaCtrl}.
    #   @return [Wx::MediaCtrl]
    # @overload initialize(parent, id, fileName=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, szBackend=(''), validator=Wx::DEFAULT_VALIDATOR, name=("MEDIA_CTRL"))
    #   Constructor that calls {Wx::MediaCtrl#create}.
    #   You may prefer to call {Wx::MediaCtrl#create} directly to check to see if {Wx::MediaCtrl} is available on the system.
    #   @param parent [Wx::Window]  parent of this control. Must not be NULL.
    #   @param id [Integer]  id to use for events
    #   @param fileName [String]  If not empty, the path of a file to open.
    #   @param pos [Array(Integer, Integer), Wx::Point]  Position to put control at.
    #   @param size [Array(Integer, Integer), Wx::Size]  Size to put the control at and to stretch movie to.
    #   @param style [Integer]  Optional styles. It is recommended to use {Wx::MC_NO_AUTORESIZE}, although it is not used by default for compatibility reasons.
    #   @param szBackend [String]  Name of backend you want to use, leave blank to make {Wx::MediaCtrl} figure it out.
    #   @param validator [Wx::Validator]  validator to use.
    #   @param name [String]  Window name.
    #   @return [Wx::MediaCtrl]
    def initialize(*args) end
    
    # Creates this control.
    # Returns false if it can't load the media located at fileName or it can't create a backend.
    # If you specify a file to open via fileName and you don't specify a backend to use, {Wx::MediaCtrl} tries each of its backends until one that can render the path referred to by fileName can be found.
    # @param parent [Wx::Window]  parent of this control. Must not be NULL.
    # @param id [Integer]  id to use for events
    # @param fileName [String]  If not empty, the path of a file to open.
    # @param pos [Array(Integer, Integer), Wx::Point]  Position to put control at.
    # @param size [Array(Integer, Integer), Wx::Size]  Size to put the control at and to stretch movie to.
    # @param style [Integer]  Optional styles. It is recommended to use {Wx::MC_NO_AUTORESIZE}, although it is not used by default for compatibility reasons.
    # @param szBackend [String]  Name of backend you want to use, leave blank to make {Wx::MediaCtrl} figure it out.
    # @param validator [Wx::Validator]  validator to use.
    # @param name [String]  Window name.
    # @return [Boolean]
    def create(parent, id, fileName=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, szBackend=(''), validator=Wx::DEFAULT_VALIDATOR, name=("MEDIA_CTRL")) end
    
    # Obtains the best size relative to the original/natural size of the video, if there is any.
    # See Video size for more information.
    # @return [Wx::Size]
    def get_best_size; end
    alias_method :best_size, :get_best_size
    
    # Obtains the playback rate, or speed of the media.
    # 1.0 represents normal speed, while 2.0 represents twice the normal speed of the media, for example. Not supported on the GStreamer (Unix) backend.
    # zero on failure.
    # @return [Float]
    def get_playback_rate; end
    alias_method :playback_rate, :get_playback_rate
    
    # Obtains the state the playback of the media is in.
    # {Wx::MediaState::MEDIASTATE_STOPPED} 
    # The media has stopped. 
    # 
    # {Wx::MediaState::MEDIASTATE_PAUSED} 
    # The media is paused. 
    # 
    # {Wx::MediaState::MEDIASTATE_PLAYING} 
    # The media is currently playing.
    # @return [Wx::MediaState]
    def get_state; end
    alias_method :state, :get_state
    
    # Gets the volume of the media from a 0.0 to 1.0 range.
    # Due to rounding and other errors the value returned may not be the exact value sent to {Wx::MediaCtrl#set_volume}.
    # @return [Float]
    def get_volume; end
    alias_method :volume, :get_volume
    
    # Obtains the length - the total amount of time the media has in milliseconds.
    # @return [Wx::FileOffset]
    def length; end
    
    # @overload load(fileName)
    #   Loads the file that fileName refers to.
    #   Returns false if loading fails.
    #   @param fileName [String] 
    #   @return [Boolean]
    # @overload load(uri)
    #   Loads the location that uri refers to.
    #   Note that this is very implementation-dependent, although HTTP URI/URLs are generally supported, for example. Returns false if loading fails.
    #   @param uri [Wx::URI] 
    #   @return [Boolean]
    # @overload load(uri, proxy)
    #   Loads the location that uri refers to with the proxy proxy.
    #   Not implemented on most backends so it should be called with caution. Returns false if loading fails.
    #   @param uri [Wx::URI] 
    #   @param proxy [Wx::URI] 
    #   @return [Boolean]
    def load(*args) end
    
    # Same as Load(const wxURI& uri).
    # Kept for {Wx::Python} compatibility.
    # @param uri [String] 
    # @return [Boolean]
    def load_uri(uri) end
    
    # Same as Load(const wxURI& uri, const wxURI& proxy).
    # Kept for {Wx::Python} compatibility.
    # @param uri [String] 
    # @param proxy [String] 
    # @return [Boolean]
    def load_uri_with_proxy(uri, proxy) end
    
    # Pauses playback of the media.
    # @return [Boolean]
    def pause; end
    
    # Resumes playback of the media.
    # @return [Boolean]
    def play; end
    
    # Seeks to a position within the media.
    # TodoDocument the {Wx::SeekMode} parameter mode, and perhaps also the {Wx::FileOffset} and {Wx::SeekMode} themselves.
    # @param where [Wx::FileOffset] 
    # @param mode [Wx::SeekMode] 
    # @return [Wx::FileOffset]
    def seek(where, mode=Wx::SeekMode::FromStart) end
    
    # Sets the playback rate, or speed of the media, to that referred by dRate.
    # 1.0 represents normal speed, while 2.0 represents twice the normal speed of the media, for example. Not supported on the GStreamer (Unix) backend. Returns true if successful.
    # @param dRate [Float] 
    # @return [Boolean]
    def set_playback_rate(dRate) end
    alias_method :playback_rate=, :set_playback_rate
    
    # Sets the volume of the media from a 0.0 to 1.0 range to that referred by dVolume.
    # 1.0 represents full volume, while 0.5 represents half (50 percent) volume, for example.
    # The volume 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.
    # @param dVolume [Float] 
    # @return [Boolean]
    def set_volume(dVolume) end
    alias_method :volume=, :set_volume
    
    # A special feature to {Wx::MediaCtrl}.
    # Applications using native toolkits such as QuickTime usually have a scrollbar, play button, and more provided to them by the toolkit. By default {Wx::MediaCtrl} 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 {Wx::MediaCtrl#show_player_controls}. Simply calling the function with default parameters tells {Wx::MediaCtrl} to use the default controls provided by the toolkit. The function takes a {Wx::MediaCtrlPlayerControls} enumeration, please see available show modes there.
    # For more info see Player controls.
    # Currently only implemented on the QuickTime and DirectShow backends. The function returns true on success.
    # @param flags [Wx::MediaCtrlPlayerControls] 
    # @return [Boolean]
    def show_player_controls(flags=Wx::MediaCtrlPlayerControls::MEDIACTRLPLAYERCONTROLS_DEFAULT) end
    
    # Stops the media.
    # See {Wx::Operation} for an overview of how stopping works.
    # @return [Boolean]
    def stop; end
    
    # Obtains the current position in time within the media in milliseconds.
    # @return [Wx::FileOffset]
    def tell; end
    
  end # MediaCtrl
  

end