PageRenderTime 20ms CodeModel.GetById 14ms app.highlight 3ms RepoModel.GetById 2ms app.codeStats 0ms

/Dlls/Delta.Multimedia.Vlc.xml

#
XML | 226 lines | 226 code | 0 blank | 0 comment | 0 complexity | 49159ceea51fdf9cb2f9ec430e3c462c MD5 | raw file
  1<?xml version="1.0"?>
  2<doc>
  3    <assembly>
  4        <name>Delta.Multimedia.Vlc</name>
  5    </assembly>
  6    <members>
  7        <member name="T:Delta.Multimedia.Vlc.VlcVideo">
  8            <summary>
  9            Video class using vlc library to natively play the video. Note: Needs
 10            native libvlc.dll, libvlccore.dll file, plus plugins for the video
 11            format (see \External\Vlc\plugins).
 12            </summary>
 13        </member>
 14        <member name="F:Delta.Multimedia.Vlc.VlcVideo.vlcManager">
 15            <summary>
 16            Vlc manager instance.
 17            </summary>
 18        </member>
 19        <member name="F:Delta.Multimedia.Vlc.VlcVideo.player">
 20            <summary>
 21            Controller of the current video displayer, it provides basic function
 22            for handling the video player such as playing or stopping.
 23            </summary>
 24        </member>
 25        <member name="F:Delta.Multimedia.Vlc.VlcVideo.nativeVideoData">
 26            <summary>
 27            Video data
 28            </summary>
 29        </member>
 30        <member name="M:Delta.Multimedia.Vlc.VlcVideo.#cctor">
 31            <summary>
 32            Initialize vlcManager for all VlcVideo instances!
 33            </summary>
 34        </member>
 35        <member name="M:Delta.Multimedia.Vlc.VlcVideo.#ctor(System.String)">
 36            <summary>
 37            Create a VLC video.
 38            </summary>
 39            <param name="contentName">The name of the content file to load.</param>
 40        </member>
 41        <member name="M:Delta.Multimedia.Vlc.VlcVideo.LoadNativeData(System.String)">
 42            <summary>
 43            Load the native content data.
 44            </summary>
 45            <param name="filename">Filename</param>
 46            <returns>True if loading succeeded, otherwise False.</returns>
 47        </member>
 48        <member name="M:Delta.Multimedia.Vlc.VlcVideo.PlayNative">
 49            <summary>
 50            Native implementation of playing the native video data.
 51            Note: This method will only be called, if the video is loaded.
 52            </summary>
 53        </member>
 54        <member name="M:Delta.Multimedia.Vlc.VlcVideo.UpdateNative">
 55            <summary>
 56            Native implementation of update, which simply checks the actual
 57            video state and updates the base classes state.
 58            </summary>
 59        </member>
 60        <member name="M:Delta.Multimedia.Vlc.VlcVideo.DrawNative(Delta.Utilities.Datatypes.Rectangle)">
 61            <summary>
 62            Native implementation of drawing the native video data.
 63            Note: This method will only be called, if the video is loaded.
 64            </summary>
 65            <param name="drawArea">Draw area</param>
 66        </member>
 67        <member name="M:Delta.Multimedia.Vlc.VlcVideo.StopNative">
 68            <summary>
 69            Stops the native playing video data.
 70            Note: This method will only be called, if the video is currently played.
 71            </summary>
 72        </member>
 73        <member name="M:Delta.Multimedia.Vlc.VlcVideo.DisposeNativeData">
 74            <summary>
 75            Dispose the native data object.
 76            </summary>
 77        </member>
 78        <member name="M:Delta.Multimedia.Vlc.VlcVideo.SetVolume(System.Single)">
 79            <summary>
 80            Set the volume.
 81            </summary>
 82            <param name="setVolume">Volume value.</param>
 83        </member>
 84        <member name="P:Delta.Multimedia.Vlc.VlcVideo.TimePlayed">
 85            <summary>
 86            Return the time in seconds how long this video already played.
 87            </summary>
 88        </member>
 89        <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMedia.#ctor(Delta.Multimedia.Vlc.LibVlc.VlcInstance,System.String)">
 90            <summary>
 91            Create a new vlc media instance.
 92            </summary>
 93            <param name="instance">The manager instance.</param>
 94            <param name="filepath">The path to the file.</param>
 95        </member>
 96        <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMedia.#ctor(System.IntPtr)">
 97            <summary>
 98            Helper constructor to create a wrapper instance from a handle.
 99            </summary>
100            <param name="setHandle">The handle of the media.</param>
101        </member>
102        <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMedia.Dispose">
103            <summary>
104            Unload the media handle.
105            </summary>
106        </member>
107        <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMedia.Handle">
108            <summary>
109            The handle of the media data.
110            </summary>
111        </member>
112        <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMedia.State">
113            <summary>
114            The current state of the media.
115            </summary>
116        </member>
117        <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcInstance.#ctor(System.String[])">
118            <summary>
119            Create a new instance of the vlc manager.
120            </summary>
121            <param name="args">The arguments sent to the manager.</param>
122        </member>
123        <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcInstance.Dispose">
124            <summary>
125            Unload the manager handle.
126            </summary>
127        </member>
128        <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcInstance.Handle">
129            <summary>
130            The handle of the vlc manager.
131            </summary>
132        </member>
133        <member name="T:Delta.Multimedia.Vlc.LibVlc.VlcCore">
134            <summary>
135            Credits go to Helyar.net which provided a really nice starting point
136            to an own vlc wrapper implementation.
137            <para />
138            http://www.helyar.net/2009/libvlc-media-player-in-c-part-2/
139            <para />
140            For VLC method information see:
141            http://www.videolan.org/developers/vlc/doc/doxygen/html/group__libvlc.html
142            <para />
143            Vlc commands:
144            http://wiki.videolan.org/VLC_command-line_help
145            </summary>
146        </member>
147        <member name="T:Delta.Multimedia.Vlc.LibVlc.VlcMediaState">
148            <summary>
149            The native libvlc media state enum.
150            </summary>
151        </member>
152        <member name="F:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.handle">
153            <summary>
154            The media player handle.
155            </summary>
156        </member>
157        <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.#ctor(Delta.Multimedia.Vlc.LibVlc.VlcMedia)">
158            <summary>
159            Create a new vlc media player instance.
160            </summary>
161            <param name="media">The media item to create the player with.</param>
162        </member>
163        <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Dispose">
164            <summary>
165            Free the native media player handle.
166            </summary>
167        </member>
168        <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Play">
169            <summary>
170            Play the current media item.
171            </summary>
172        </member>
173        <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Pause">
174            <summary>
175            Pause the current media item.
176            </summary>
177        </member>
178        <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Stop">
179            <summary>
180            Stop the current media item.
181            </summary>
182        </member>
183        <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Drawable">
184            <summary>
185            Get or set the drawing target for the media player.
186            </summary>
187        </member>
188        <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Media">
189            <summary>
190            Get or set the current media item being played by this media player.
191            </summary>
192        </member>
193        <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.VideoPosition">
194            <summary>
195            Get the current position in the media playback in milliseconds.
196            </summary>
197        </member>
198        <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.VideoLength">
199            <summary>
200            Get the length of the current media item in milliseconds.
201            </summary>
202        </member>
203        <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcMediaPlayer.Volume">
204            <summary>
205            Get or set the volume of the media playback.
206            <para />
207            The value is the volume in percents (0 = mute, 100 = 0dB).
208            </summary>
209        </member>
210        <member name="F:Delta.Multimedia.Vlc.LibVlc.VlcException.errorMessage">
211            <summary>
212            The error message of the exception.
213            </summary>
214        </member>
215        <member name="M:Delta.Multimedia.Vlc.LibVlc.VlcException.#ctor">
216            <summary>
217            Create a new vlc exception.
218            </summary>
219        </member>
220        <member name="P:Delta.Multimedia.Vlc.LibVlc.VlcException.Message">
221            <summary>
222            The error message of the exception.
223            </summary>
224        </member>
225    </members>
226</doc>