/Dlls/Delta.Multimedia.Vlc.xml
XML | 226 lines | 226 code | 0 blank | 0 comment | 0 complexity | 49159ceea51fdf9cb2f9ec430e3c462c MD5 | raw file
Possible License(s): Apache-2.0
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>Delta.Multimedia.Vlc</name>
- </assembly>
- <members>
- <member name="T:Delta.Multimedia.Vlc.VlcVideo">
- <summary>
- Video class using vlc library to natively play the video. Note: Needs
- native libvlc.dll, libvlccore.dll file, plus plugins for the video
- format (see \External\Vlc\plugins).
- </summary>
- </member>
- <member name="F:Delta.Multimedia.Vlc.VlcVideo.vlcManager">
- <summary>
- Vlc manager instance.
- </summary>
- </member>
- <member name="F:Delta.Multimedia.Vlc.VlcVideo.player">
- <summary>
- Controller of the current video displayer, it provides basic function
- for handling the video player such as playing or stopping.
- </summary>
- </member>
- <member name="F:Delta.Multimedia.Vlc.VlcVideo.nativeVideoData">
- <summary>
- Video data
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.VlcVideo.#cctor">
- <summary>
- Initialize vlcManager for all VlcVideo instances!
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.VlcVideo.#ctor(System.String)">
- <summary>
- Create a VLC video.
- </summary>
- <param name="contentName">The name of the content file to load.</param>
- </member>
- <member name="M:Delta.Multimedia.Vlc.VlcVideo.LoadNativeData(System.String)">
- <summary>
- Load the native content data.
- </summary>
- <param name="filename">Filename</param>
- <returns>True if loading succeeded, otherwise False.</returns>
- </member>
- <member name="M:Delta.Multimedia.Vlc.VlcVideo.PlayNative">
- <summary>
- Native implementation of playing the native video data.
- Note: This method will only be called, if the video is loaded.
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.VlcVideo.UpdateNative">
- <summary>
- Native implementation of update, which simply checks the actual
- video state and updates the base classes state.
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.VlcVideo.DrawNative(Delta.Utilities.Datatypes.Rectangle)">
- <summary>
- Native implementation of drawing the native video data.
- Note: This method will only be called, if the video is loaded.
- </summary>
- <param name="drawArea">Draw area</param>
- </member>
- <member name="M:Delta.Multimedia.Vlc.VlcVideo.StopNative">
- <summary>
- Stops the native playing video data.
- Note: This method will only be called, if the video is currently played.
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.VlcVideo.DisposeNativeData">
- <summary>
- Dispose the native data object.
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.VlcVideo.SetVolume(System.Single)">
- <summary>
- Set the volume.
- </summary>
- <param name="setVolume">Volume value.</param>
- </member>
- <member name="P:Delta.Multimedia.Vlc.VlcVideo.TimePlayed">
- <summary>
- Return the time in seconds how long this video already played.
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMedia.#ctor(Delta.Multimedia.Vlc.LibVlc.VlcInstance,System.String)">
- <summary>
- Create a new vlc media instance.
- </summary>
- <param name="instance">The manager instance.</param>
- <param name="filepath">The path to the file.</param>
- </member>
- <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMedia.#ctor(System.IntPtr)">
- <summary>
- Helper constructor to create a wrapper instance from a handle.
- </summary>
- <param name="setHandle">The handle of the media.</param>
- </member>
- <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMedia.Dispose">
- <summary>
- Unload the media handle.
- </summary>
- </member>
- <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMedia.Handle">
- <summary>
- The handle of the media data.
- </summary>
- </member>
- <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMedia.State">
- <summary>
- The current state of the media.
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcInstance.#ctor(System.String[])">
- <summary>
- Create a new instance of the vlc manager.
- </summary>
- <param name="args">The arguments sent to the manager.</param>
- </member>
- <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcInstance.Dispose">
- <summary>
- Unload the manager handle.
- </summary>
- </member>
- <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcInstance.Handle">
- <summary>
- The handle of the vlc manager.
- </summary>
- </member>
- <member name="T:Delta.Multimedia.Vlc.LibVlc.VlcCore">
- <summary>
- Credits go to Helyar.net which provided a really nice starting point
- to an own vlc wrapper implementation.
- <para />
- http://www.helyar.net/2009/libvlc-media-player-in-c-part-2/
- <para />
- For VLC method information see:
- http://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html
- <para />
- Vlc commands:
- http://wiki.videolan.org/VLC_command-line_help
- </summary>
- </member>
- <member name="T:Delta.Multimedia.Vlc.LibVlc.VlcMediaState">
- <summary>
- The native libvlc media state enum.
- </summary>
- </member>
- <member name="F:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.handle">
- <summary>
- The media player handle.
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.#ctor(Delta.Multimedia.Vlc.LibVlc.VlcMedia)">
- <summary>
- Create a new vlc media player instance.
- </summary>
- <param name="media">The media item to create the player with.</param>
- </member>
- <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Dispose">
- <summary>
- Free the native media player handle.
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Play">
- <summary>
- Play the current media item.
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Pause">
- <summary>
- Pause the current media item.
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Stop">
- <summary>
- Stop the current media item.
- </summary>
- </member>
- <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Drawable">
- <summary>
- Get or set the drawing target for the media player.
- </summary>
- </member>
- <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Media">
- <summary>
- Get or set the current media item being played by this media player.
- </summary>
- </member>
- <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.VideoPosition">
- <summary>
- Get the current position in the media playback in milliseconds.
- </summary>
- </member>
- <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.VideoLength">
- <summary>
- Get the length of the current media item in milliseconds.
- </summary>
- </member>
- <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Volume">
- <summary>
- Get or set the volume of the media playback.
- <para />
- The value is the volume in percents (0 = mute, 100 = 0dB).
- </summary>
- </member>
- <member name="F:Delta.Multimedia.Vlc.LibVlc.VlcException.errorMessage">
- <summary>
- The error message of the exception.
- </summary>
- </member>
- <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcException.#ctor">
- <summary>
- Create a new vlc exception.
- </summary>
- </member>
- <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcException.Message">
- <summary>
- The error message of the exception.
- </summary>
- </member>
- </members>
- </doc>