/Dlls/Delta.Multimedia.xml
XML | 293 lines | 293 code | 0 blank | 0 comment | 0 complexity | 28026dfa9aa882973232ea6fd1df5e08 MD5 | raw file
1<?xml version="1.0" encoding="utf-8"?> 2<doc> 3 <assembly> 4 <name>Delta.Multimedia</name> 5 </assembly> 6 <members> 7 <member name="T:Delta.Multimedia.Video"> 8 <summary> 9 Abstract base video class. 10 </summary> 11 </member> 12 <member name="M:Delta.Multimedia.Video.Create(System.String)"> 13 <summary> 14 Load a video instance. 15 </summary> 16 <param name="videoName">Name of the video content file.</param> 17 <returns>Video instance.</returns> 18 </member> 19 <member name="F:Delta.Multimedia.Video.videoData"> 20 <summary> 21 Native video data. 22 </summary> 23 </member> 24 <member name="M:Delta.Multimedia.Video.#ctor(System.String)"> 25 <summary> 26 Create base video 27 </summary> 28 <param name="contentName">Name of the content.</param> 29 </member> 30 <member name="M:Delta.Multimedia.Video.Dispose"> 31 <summary> 32 Dispose stops the video and calls DisposeNative. 33 </summary> 34 </member> 35 <member name="M:Delta.Multimedia.Video.Play"> 36 <summary> 37 Starts playing the video. 38 </summary> 39 </member> 40 <member name="M:Delta.Multimedia.Video.Stop"> 41 <summary> 42 Stops the playing video 43 </summary> 44 </member> 45 <member name="M:Delta.Multimedia.Video.Load"> 46 <summary> 47 Simple load method for handling exceptions and if the loading failed. 48 </summary> 49 </member> 50 <member name="M:Delta.Multimedia.Video.LoadNativeData(System.String)"> 51 <summary> 52 Load the native music data. 53 </summary> 54 <param name="filename">Filename</param> 55 <returns>True if loading succeeded, otherwise False.</returns> 56 </member> 57 <member name="M:Delta.Multimedia.Video.DisposeNativeData"> 58 <summary> 59 Dispose the video natively. 60 </summary> 61 </member> 62 <member name="M:Delta.Multimedia.Video.SetVolume(System.Single)"> 63 <summary> 64 Set the volume of the video. Implemented in the derived classes. 65 </summary> 66 <param name="setVolume">The desired volume value for the video.</param> 67 </member> 68 <member name="M:Delta.Multimedia.Video.PlayNative"> 69 <summary> 70 Plays this media natively. 71 </summary> 72 </member> 73 <member name="M:Delta.Multimedia.Video.StopNative"> 74 <summary> 75 Stops this media natively. 76 </summary> 77 </member> 78 <member name="M:Delta.Multimedia.Video.UpdateNative"> 79 <summary> 80 Updates this media natively. 81 </summary> 82 </member> 83 <member name="M:Delta.Multimedia.Video.DrawNative(Delta.Utilities.Datatypes.Rectangle)"> 84 <summary> 85 Native implementation of drawing the native video data. 86 Note: This method will only be called, if the video is loaded. 87 </summary> 88 <param name="drawArea">Draw area</param> 89 </member> 90 <member name="P:Delta.Multimedia.Video.State"> 91 <summary> 92 Represents the current state of the media file (play, pause, stop). 93 </summary> 94 </member> 95 <member name="P:Delta.Multimedia.Video.Volume"> 96 <summary> 97 Gets or sets the volume (between 0.0 and 1.0) of this music instance 98 by using a logarithmic approach, so you can just use linear values to 99 get the desired effect. E.g.: 0.5 is half as loud as 1.0. 100 </summary> 101 </member> 102 <member name="P:Delta.Multimedia.Video.TimePlayed"> 103 <summary> 104 Time the video played in seconds. 105 </summary> 106 </member> 107 <member name="P:Delta.Multimedia.Video.Name"> 108 <summary> 109 Name of the content file. 110 </summary> 111 </member> 112 <member name="E:Delta.Multimedia.Video.Ended"> 113 <summary> 114 Occurs every time playing the sound has ended. 115 </summary> 116 </member> 117 <member name="T:Delta.Multimedia.MusicPlaylist"> 118 <summary> 119 Music playlist 120 </summary> 121 </member> 122 <member name="M:Delta.Multimedia.MusicPlaylist.#ctor"> 123 <summary> 124 Create a new music playlist. 125 </summary> 126 </member> 127 <member name="M:Delta.Multimedia.MusicPlaylist.Add(Delta.Multimedia.Music)"> 128 <summary> 129 Add a new music item to the playlist. 130 </summary> 131 <param name="musicItem">The music to add.</param> 132 </member> 133 <member name="M:Delta.Multimedia.MusicPlaylist.Play"> 134 <summary> 135 Play this playlist. 136 </summary> 137 </member> 138 <member name="M:Delta.Multimedia.MusicPlaylist.Stop"> 139 <summary> 140 Stop this playlist. 141 </summary> 142 </member> 143 <member name="P:Delta.Multimedia.MusicPlaylist.Count"> 144 <summary> 145 The number of music items in the playlist. 146 </summary> 147 </member> 148 <member name="P:Delta.Multimedia.MusicPlaylist.CurrentIndex"> 149 <summary> 150 The index of the current playing music in the playlist. 151 </summary> 152 </member> 153 <member name="P:Delta.Multimedia.MusicPlaylist.State"> 154 <summary> 155 The current state of the playlist. 156 </summary> 157 </member> 158 <member name="T:Delta.Multimedia.MediaState"> 159 <summary> 160 Defines the possible states in which a media content file can be. 161 </summary> 162 </member> 163 <member name="T:Delta.Multimedia.Sound"> 164 <summary> 165 Abstract base sound class. Needs to be implemented in the platform 166 multimedia module. Properties are set in the derived class. 167 </summary> 168 </member> 169 <member name="M:Delta.Multimedia.Sound.#ctor(System.String)"> 170 <summary> 171 Create base sound class. 172 </summary> 173 <param name="contentName">Name of the content.</param> 174 </member> 175 <member name="M:Delta.Multimedia.Sound.Dispose"> 176 <summary> 177 Dispose stops the video and calls DisposeNative. 178 </summary> 179 </member> 180 <member name="M:Delta.Multimedia.Sound.Play"> 181 <summary> 182 Plays a sound with the help of a sound channel. 183 You can specify that you want a Channel returned, this will 184 lock its use for you, until you decide to set it to null, so that 185 it can be reused again. 186 </summary> 187 </member> 188 <member name="M:Delta.Multimedia.Sound.Stop"> 189 <summary> 190 Stops the sound (if it is playing). 191 </summary> 192 </member> 193 <member name="P:Delta.Multimedia.Sound.ActiveChannels"> 194 <summary> 195 The number of active sound channels. 196 </summary> 197 </member> 198 <member name="P:Delta.Multimedia.Sound.Volume"> 199 <summary> 200 Volume, is 1.0f by default. 201 Gets or sets the volume (between 0.0 and 1.0) of this sound instance 202 by using a logarithmic approach, so you can just use linear values to 203 get the desired effect. E.g.: 0.5 is half as loud as 1.0. 204 </summary> 205 </member> 206 <member name="P:Delta.Multimedia.Sound.Pitch"> 207 <summary> 208 Pitch, is 1.0f by default. 209 Gets or sets the pitch of this sound instance which is the speed 210 of the sound playback. 211 </summary> 212 </member> 213 <member name="P:Delta.Multimedia.Sound.Pan"> 214 <summary> 215 Pan, is 0.0f by default. 216 Gets or sets the pan value. -1.0f is full left and 1.0f is full right. 217 </summary> 218 </member> 219 <member name="P:Delta.Multimedia.Sound.State"> 220 <summary> 221 Represents the current state of the media file (play, pause, stop). 222 </summary> 223 </member> 224 <member name="P:Delta.Multimedia.Sound.Name"> 225 <summary> 226 Name of the content file. 227 </summary> 228 </member> 229 <member name="T:Delta.Multimedia.Music"> 230 <summary> 231 Main music class, allowing to create a Music instance with the 232 normal constructor, instead of a static Create Method. For the abstract 233 layer and platform implementations there is the NativeMusic class which 234 then has the static Create method. 235 </summary> 236 </member> 237 <member name="M:Delta.Multimedia.Music.#ctor(System.String)"> 238 <summary> 239 Create music, all the magic happens in native classes. 240 </summary> 241 <param name="contentName">Name of the music content.</param> 242 </member> 243 <member name="M:Delta.Multimedia.Music.Dispose"> 244 <summary> 245 Dispose stops the music and calls DisposeNative. 246 </summary> 247 </member> 248 <member name="M:Delta.Multimedia.Music.Play"> 249 <summary> 250 Starts playback of the music (always looping, use Finished event 251 to do something else when music is done playing). 252 </summary> 253 </member> 254 <member name="M:Delta.Multimedia.Music.Stop"> 255 <summary> 256 Stops the music (if he is playing). 257 </summary> 258 </member> 259 <member name="P:Delta.Multimedia.Music.State"> 260 <summary> 261 Represents the current state of the media file (play, pause, stop). 262 </summary> 263 </member> 264 <member name="P:Delta.Multimedia.Music.Volume"> 265 <summary> 266 Gets or sets the volume (between 0.0 and 1.0) of this music instance 267 by using a logarithmic approach, so you can just use linear values to 268 get the desired effect. E.g.: 0.5 is half as loud as 1.0. 269 </summary> 270 </member> 271 <member name="P:Delta.Multimedia.Music.TimePlayed"> 272 <summary> 273 Time the music played in seconds. 274 </summary> 275 </member> 276 <member name="P:Delta.Multimedia.Music.Looping"> 277 <summary> 278 Looping (auto replay after end), only used for music. 279 <c>true</c> if looping; otherwise, <c>false</c>. 280 </summary> 281 </member> 282 <member name="P:Delta.Multimedia.Music.Name"> 283 <summary> 284 Name of the content file. 285 </summary> 286 </member> 287 <member name="E:Delta.Multimedia.Music.Ended"> 288 <summary> 289 Occurs every time playing the sound has ended. 290 </summary> 291 </member> 292 </members> 293</doc>