UnityEngine.VideoModule.xml 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652
  1. <?xml version="1.0" encoding="utf-8" standalone="yes"?>
  2. <doc>
  3. <members>
  4. <assembly>
  5. <name>UnityEngine.VideoModule</name>
  6. </assembly>
  7. <member name="T:UnityEngine.Experimental.Video.VideoClipPlayable">
  8. <summary>
  9. <para>An implementation of IPlayable that controls playback of a VideoClip.</para>
  10. </summary>
  11. </member>
  12. <member name="M:UnityEngine.Experimental.Video.VideoClipPlayable.Create(UnityEngine.Playables.PlayableGraph,UnityEngine.Video.VideoClip,System.Boolean)">
  13. <summary>
  14. <para>Creates a VideoClipPlayable in the PlayableGraph.</para>
  15. </summary>
  16. <param name="graph">The PlayableGraph object that will own the VideoClipPlayable.</param>
  17. <param name="looping">Indicates if VideoClip loops when it reaches the end.</param>
  18. <param name="clip">VideoClip used to produce textures in the PlayableGraph.</param>
  19. <returns>
  20. <para>A VideoClipPlayable linked to the PlayableGraph.</para>
  21. </returns>
  22. </member>
  23. <member name="T:UnityEngine.Experimental.Video.VideoPlayerExtensions">
  24. <summary>
  25. <para>Extension methods for the Video.VideoPlayer class.</para>
  26. </summary>
  27. </member>
  28. <member name="M:UnityEngine.Experimental.Video.VideoPlayerExtensions.GetAudioSampleProvider(UnityEngine.Video.VideoPlayer,System.UInt16)">
  29. <summary>
  30. <para>Return the Experimental.Audio.AudioSampleProvider for the specified track, used to receive audio samples during playback.</para>
  31. </summary>
  32. <param name="vp">The "this" pointer for the extension method.</param>
  33. <param name="trackIndex">The audio track index for which the sample provider is queried.</param>
  34. <returns>
  35. <para>The sample provider for the specified track.</para>
  36. </returns>
  37. </member>
  38. <member name="A:UnityEngine.VideoModule">
  39. <summary>
  40. <para>The Video module lets you play back video files in your content.</para>
  41. </summary>
  42. </member>
  43. <member name="T:UnityEngine.Video.Video3DLayout">
  44. <summary>
  45. <para>Types of 3D content layout within a video.</para>
  46. </summary>
  47. </member>
  48. <member name="F:UnityEngine.Video.Video3DLayout.No3D">
  49. <summary>
  50. <para>Video does not have any 3D content.</para>
  51. </summary>
  52. </member>
  53. <member name="F:UnityEngine.Video.Video3DLayout.OverUnder3D">
  54. <summary>
  55. <para>Video contains 3D content where the left eye occupies the upper half and right eye occupies the lower half of video frames.</para>
  56. </summary>
  57. </member>
  58. <member name="F:UnityEngine.Video.Video3DLayout.SideBySide3D">
  59. <summary>
  60. <para>Video contains 3D content where the left eye occupies the left half and right eye occupies the right half of video frames.</para>
  61. </summary>
  62. </member>
  63. <member name="T:UnityEngine.Video.VideoAspectRatio">
  64. <summary>
  65. <para>Methods used to fit a video in the target area.</para>
  66. </summary>
  67. </member>
  68. <member name="F:UnityEngine.Video.VideoAspectRatio.FitHorizontally">
  69. <summary>
  70. <para>Resize proportionally so that width fits the target area, cropping or adding black bars above and below if needed.</para>
  71. </summary>
  72. </member>
  73. <member name="F:UnityEngine.Video.VideoAspectRatio.FitInside">
  74. <summary>
  75. <para>Resize proportionally so that content fits the target area, adding black bars if needed.</para>
  76. </summary>
  77. </member>
  78. <member name="F:UnityEngine.Video.VideoAspectRatio.FitOutside">
  79. <summary>
  80. <para>Resize proportionally so that content fits the target area, cropping if needed.</para>
  81. </summary>
  82. </member>
  83. <member name="F:UnityEngine.Video.VideoAspectRatio.FitVertically">
  84. <summary>
  85. <para>Resize proportionally so that height fits the target area, cropping or adding black bars on each side if needed.</para>
  86. </summary>
  87. </member>
  88. <member name="F:UnityEngine.Video.VideoAspectRatio.NoScaling">
  89. <summary>
  90. <para>Preserve the pixel size without adjusting for target area.</para>
  91. </summary>
  92. </member>
  93. <member name="F:UnityEngine.Video.VideoAspectRatio.Stretch">
  94. <summary>
  95. <para>Resize non-proportionally to fit the target area.</para>
  96. </summary>
  97. </member>
  98. <member name="T:UnityEngine.Video.VideoAudioOutputMode">
  99. <summary>
  100. <para>Places where the audio embedded in a video can be sent.</para>
  101. </summary>
  102. </member>
  103. <member name="F:UnityEngine.Video.VideoAudioOutputMode.APIOnly">
  104. <summary>
  105. <para>Send the embedded audio to the associated AudioSampleProvider.</para>
  106. </summary>
  107. </member>
  108. <member name="F:UnityEngine.Video.VideoAudioOutputMode.AudioSource">
  109. <summary>
  110. <para>Send the embedded audio into a specified AudioSource.</para>
  111. </summary>
  112. </member>
  113. <member name="F:UnityEngine.Video.VideoAudioOutputMode.Direct">
  114. <summary>
  115. <para>Send the embedded audio direct to the platform's audio hardware.</para>
  116. </summary>
  117. </member>
  118. <member name="F:UnityEngine.Video.VideoAudioOutputMode.None">
  119. <summary>
  120. <para>Disable the embedded audio.</para>
  121. </summary>
  122. </member>
  123. <member name="T:UnityEngine.Video.VideoClip">
  124. <summary>
  125. <para>A container for video data.</para>
  126. </summary>
  127. </member>
  128. <member name="P:UnityEngine.Video.VideoClip.audioTrackCount">
  129. <summary>
  130. <para>Number of audio tracks in the clip.</para>
  131. </summary>
  132. </member>
  133. <member name="P:UnityEngine.Video.VideoClip.frameCount">
  134. <summary>
  135. <para>The length of the VideoClip in frames. (Read Only).</para>
  136. </summary>
  137. </member>
  138. <member name="P:UnityEngine.Video.VideoClip.frameRate">
  139. <summary>
  140. <para>The frame rate of the clip in frames/second. (Read Only).</para>
  141. </summary>
  142. </member>
  143. <member name="P:UnityEngine.Video.VideoClip.height">
  144. <summary>
  145. <para>The height of the images in the video clip in pixels. (Read Only).</para>
  146. </summary>
  147. </member>
  148. <member name="P:UnityEngine.Video.VideoClip.length">
  149. <summary>
  150. <para>The length of the video clip in seconds. (Read Only).</para>
  151. </summary>
  152. </member>
  153. <member name="P:UnityEngine.Video.VideoClip.originalPath">
  154. <summary>
  155. <para>The video clip path in the project's assets. (Read Only).</para>
  156. </summary>
  157. </member>
  158. <member name="P:UnityEngine.Video.VideoClip.pixelAspectRatioDenominator">
  159. <summary>
  160. <para>Denominator of the pixel aspect ratio (num:den). (Read Only).</para>
  161. </summary>
  162. </member>
  163. <member name="P:UnityEngine.Video.VideoClip.pixelAspectRatioNumerator">
  164. <summary>
  165. <para>Numerator of the pixel aspect ratio (num:den). (Read Only).</para>
  166. </summary>
  167. </member>
  168. <member name="P:UnityEngine.Video.VideoClip.width">
  169. <summary>
  170. <para>The width of the images in the video clip in pixels. (Read Only).</para>
  171. </summary>
  172. </member>
  173. <member name="M:UnityEngine.Video.VideoClip.GetAudioChannelCount(System.UInt16)">
  174. <summary>
  175. <para>The number of channels in the audio track. E.g. 2 for a stereo track.</para>
  176. </summary>
  177. <param name="audioTrackIdx">Index of the audio queried audio track.</param>
  178. <returns>
  179. <para>The number of channels.</para>
  180. </returns>
  181. </member>
  182. <member name="M:UnityEngine.Video.VideoClip.GetAudioLanguage(System.UInt16)">
  183. <summary>
  184. <para>Get the audio track language. Can be unknown.</para>
  185. </summary>
  186. <param name="audioTrackIdx">Index of the audio queried audio track.</param>
  187. <returns>
  188. <para>The abbreviated name of the language.</para>
  189. </returns>
  190. </member>
  191. <member name="M:UnityEngine.Video.VideoClip.GetAudioSampleRate(System.UInt16)">
  192. <summary>
  193. <para>Get the audio track sampling rate in Hertz.</para>
  194. </summary>
  195. <param name="audioTrackIdx">Index of the audio queried audio track.</param>
  196. <returns>
  197. <para>The sampling rate in Hertz.</para>
  198. </returns>
  199. </member>
  200. <member name="T:UnityEngine.Video.VideoPlayer">
  201. <summary>
  202. <para>Plays video content onto a target.</para>
  203. </summary>
  204. </member>
  205. <member name="P:UnityEngine.Video.VideoPlayer.aspectRatio">
  206. <summary>
  207. <para>Defines how the video content will be stretched to fill the target area.</para>
  208. </summary>
  209. </member>
  210. <member name="P:UnityEngine.Video.VideoPlayer.audioOutputMode">
  211. <summary>
  212. <para>Destination for the audio embedded in the video.</para>
  213. </summary>
  214. </member>
  215. <member name="P:UnityEngine.Video.VideoPlayer.audioTrackCount">
  216. <summary>
  217. <para>Number of audio tracks found in the data source currently configured.</para>
  218. </summary>
  219. </member>
  220. <member name="P:UnityEngine.Video.VideoPlayer.canSetDirectAudioVolume">
  221. <summary>
  222. <para>Whether direct-output volume controls are supported for the current platform and video format. (Read Only)</para>
  223. </summary>
  224. </member>
  225. <member name="P:UnityEngine.Video.VideoPlayer.canSetPlaybackSpeed">
  226. <summary>
  227. <para>Whether the playback speed can be changed. (Read Only)</para>
  228. </summary>
  229. </member>
  230. <member name="P:UnityEngine.Video.VideoPlayer.canSetSkipOnDrop">
  231. <summary>
  232. <para>Determines whether the VideoPlayer skips frames to catch up with current time. (Read Only)</para>
  233. </summary>
  234. </member>
  235. <member name="P:UnityEngine.Video.VideoPlayer.canSetTime">
  236. <summary>
  237. <para>Whether current time can be changed using the time or timeFrames property. (Read Only)</para>
  238. </summary>
  239. </member>
  240. <member name="P:UnityEngine.Video.VideoPlayer.canSetTimeSource">
  241. <summary>
  242. <para>Whether the time source followed by the VideoPlayer can be changed. (Read Only)</para>
  243. </summary>
  244. </member>
  245. <member name="P:UnityEngine.Video.VideoPlayer.canStep">
  246. <summary>
  247. <para>Returns true if the VideoPlayer can step forward through the video content. (Read Only)</para>
  248. </summary>
  249. </member>
  250. <member name="P:UnityEngine.Video.VideoPlayer.clip">
  251. <summary>
  252. <para>The clip being played by the VideoPlayer.</para>
  253. </summary>
  254. </member>
  255. <member name="?:UnityEngine.Video.VideoPlayer.clockResyncOccurred(UnityEngine.Video.VideoPlayer/TimeEventHandler)">
  256. <summary>
  257. <para>Invoked when the VideoPlayer's clock is synced back to its Video.VideoTimeReference.</para>
  258. </summary>
  259. <param name="value"></param>
  260. </member>
  261. <member name="P:UnityEngine.Video.VideoPlayer.controlledAudioTrackCount">
  262. <summary>
  263. <para>Number of audio tracks that this VideoPlayer will take control of. The other ones will be silenced. A maximum of 64 tracks are allowed.
  264. The actual number of audio tracks cannot be known in advance when playing URLs, which is why this value is independent of the Video.VideoPlayer.audioTrackCount property.</para>
  265. </summary>
  266. </member>
  267. <member name="P:UnityEngine.Video.VideoPlayer.controlledAudioTrackMaxCount">
  268. <summary>
  269. <para>Maximum number of audio tracks that can be controlled.</para>
  270. </summary>
  271. </member>
  272. <member name="?:UnityEngine.Video.VideoPlayer.errorReceived(UnityEngine.Video.VideoPlayer/ErrorEventHandler)">
  273. <summary>
  274. <para>Errors such as HTTP connection problems are reported through this callback.</para>
  275. </summary>
  276. <param name="value"></param>
  277. </member>
  278. <member name="P:UnityEngine.Video.VideoPlayer.externalReferenceTime">
  279. <summary>
  280. <para>Reference time of the external clock the Video.VideoPlayer uses to correct its drift.</para>
  281. </summary>
  282. </member>
  283. <member name="P:UnityEngine.Video.VideoPlayer.frame">
  284. <summary>
  285. <para>The frame index currently being displayed by the VideoPlayer.</para>
  286. </summary>
  287. </member>
  288. <member name="P:UnityEngine.Video.VideoPlayer.frameCount">
  289. <summary>
  290. <para>Number of frames in the current video content.</para>
  291. </summary>
  292. </member>
  293. <member name="?:UnityEngine.Video.VideoPlayer.frameDropped(UnityEngine.Video.VideoPlayer/EventHandler)">
  294. <summary>
  295. <para>[NOT YET IMPLEMENTED] Invoked when the video decoder does not produce a frame as per the time source during playback.</para>
  296. </summary>
  297. <param name="value"></param>
  298. </member>
  299. <member name="P:UnityEngine.Video.VideoPlayer.frameRate">
  300. <summary>
  301. <para>The frame rate of the clip or URL in frames/second. (Read Only).</para>
  302. </summary>
  303. </member>
  304. <member name="?:UnityEngine.Video.VideoPlayer.frameReady(UnityEngine.Video.VideoPlayer/FrameReadyEventHandler)">
  305. <summary>
  306. <para>Invoked when a new frame is ready.</para>
  307. </summary>
  308. <param name="value"></param>
  309. </member>
  310. <member name="P:UnityEngine.Video.VideoPlayer.isLooping">
  311. <summary>
  312. <para>Determines whether the VideoPlayer restarts from the beginning when it reaches the end of the clip.</para>
  313. </summary>
  314. </member>
  315. <member name="P:UnityEngine.Video.VideoPlayer.isPlaying">
  316. <summary>
  317. <para>Whether content is being played. (Read Only)</para>
  318. </summary>
  319. </member>
  320. <member name="P:UnityEngine.Video.VideoPlayer.isPrepared">
  321. <summary>
  322. <para>Whether the VideoPlayer has successfully prepared the content to be played. (Read Only)</para>
  323. </summary>
  324. </member>
  325. <member name="?:UnityEngine.Video.VideoPlayer.loopPointReached(UnityEngine.Video.VideoPlayer/EventHandler)">
  326. <summary>
  327. <para>Invoked when the VideoPlayer reaches the end of the content to play.</para>
  328. </summary>
  329. <param name="value"></param>
  330. </member>
  331. <member name="P:UnityEngine.Video.VideoPlayer.playbackSpeed">
  332. <summary>
  333. <para>Factor by which the basic playback rate will be multiplied.</para>
  334. </summary>
  335. </member>
  336. <member name="P:UnityEngine.Video.VideoPlayer.playOnAwake">
  337. <summary>
  338. <para>Whether the content will start playing back as soon as the component awakes.</para>
  339. </summary>
  340. </member>
  341. <member name="?:UnityEngine.Video.VideoPlayer.prepareCompleted(UnityEngine.Video.VideoPlayer/EventHandler)">
  342. <summary>
  343. <para>Invoked when the VideoPlayer preparation is complete.</para>
  344. </summary>
  345. <param name="value"></param>
  346. </member>
  347. <member name="P:UnityEngine.Video.VideoPlayer.renderMode">
  348. <summary>
  349. <para>Where the video content will be drawn.</para>
  350. </summary>
  351. </member>
  352. <member name="?:UnityEngine.Video.VideoPlayer.seekCompleted(UnityEngine.Video.VideoPlayer/EventHandler)">
  353. <summary>
  354. <para>Invoke after a seek operation completes.</para>
  355. </summary>
  356. <param name="value"></param>
  357. </member>
  358. <member name="P:UnityEngine.Video.VideoPlayer.sendFrameReadyEvents">
  359. <summary>
  360. <para>Enables the frameReady events.</para>
  361. </summary>
  362. </member>
  363. <member name="P:UnityEngine.Video.VideoPlayer.skipOnDrop">
  364. <summary>
  365. <para>Whether the VideoPlayer is allowed to skip frames to catch up with current time.</para>
  366. </summary>
  367. </member>
  368. <member name="P:UnityEngine.Video.VideoPlayer.source">
  369. <summary>
  370. <para>The source that the VideoPlayer uses for playback.</para>
  371. </summary>
  372. </member>
  373. <member name="?:UnityEngine.Video.VideoPlayer.started(UnityEngine.Video.VideoPlayer/EventHandler)">
  374. <summary>
  375. <para>Invoked immediately after Play is called.</para>
  376. </summary>
  377. <param name="value"></param>
  378. </member>
  379. <member name="P:UnityEngine.Video.VideoPlayer.targetCamera">
  380. <summary>
  381. <para>Camera component to draw to when Video.VideoPlayer.renderMode is set to either Video.VideoRenderMode.CameraFarPlane or Video.VideoRenderMode.CameraNearPlane.</para>
  382. </summary>
  383. </member>
  384. <member name="P:UnityEngine.Video.VideoPlayer.targetCamera3DLayout">
  385. <summary>
  386. <para>Type of 3D content contained in the source video media.</para>
  387. </summary>
  388. </member>
  389. <member name="P:UnityEngine.Video.VideoPlayer.targetCameraAlpha">
  390. <summary>
  391. <para>Overall transparency level of the target camera plane video.</para>
  392. </summary>
  393. </member>
  394. <member name="P:UnityEngine.Video.VideoPlayer.targetMaterialProperty">
  395. <summary>
  396. <para>Material texture property which is targeted when Video.VideoPlayer.renderMode is set to Video.VideoTarget.MaterialOverride.</para>
  397. </summary>
  398. </member>
  399. <member name="P:UnityEngine.Video.VideoPlayer.targetMaterialRenderer">
  400. <summary>
  401. <para>Renderer which is targeted when Video.VideoPlayer.renderMode is set to Video.VideoTarget.MaterialOverride</para>
  402. </summary>
  403. </member>
  404. <member name="P:UnityEngine.Video.VideoPlayer.targetTexture">
  405. <summary>
  406. <para>RenderTexture to draw to when Video.VideoPlayer.renderMode is set to Video.VideoTarget.RenderTexture.</para>
  407. </summary>
  408. </member>
  409. <member name="P:UnityEngine.Video.VideoPlayer.texture">
  410. <summary>
  411. <para>Internal texture in which video content is placed.</para>
  412. </summary>
  413. </member>
  414. <member name="P:UnityEngine.Video.VideoPlayer.time">
  415. <summary>
  416. <para>The VideoPlayer current time in seconds.</para>
  417. </summary>
  418. </member>
  419. <member name="P:UnityEngine.Video.VideoPlayer.timeReference">
  420. <summary>
  421. <para>The clock that the Video.VideoPlayer observes to detect and correct drift.</para>
  422. </summary>
  423. </member>
  424. <member name="P:UnityEngine.Video.VideoPlayer.timeSource">
  425. <summary>
  426. <para>[NOT YET IMPLEMENTED] The source used used by the VideoPlayer to derive its current time.</para>
  427. </summary>
  428. </member>
  429. <member name="P:UnityEngine.Video.VideoPlayer.url">
  430. <summary>
  431. <para>The file or HTTP URL that the VideoPlayer will read content from.</para>
  432. </summary>
  433. </member>
  434. <member name="P:UnityEngine.Video.VideoPlayer.waitForFirstFrame">
  435. <summary>
  436. <para>Determines whether the VideoPlayer will wait for the first frame to be loaded into the texture before starting playback when Video.VideoPlayer.playOnAwake is on.</para>
  437. </summary>
  438. </member>
  439. <member name="M:UnityEngine.Video.VideoPlayer.EnableAudioTrack(System.UInt16,System.Boolean)">
  440. <summary>
  441. <para>Enable/disable audio track decoding. Only effective when the VideoPlayer is not currently playing.</para>
  442. </summary>
  443. <param name="trackIndex">Index of the audio track to enable/disable.</param>
  444. <param name="enabled">True for enabling the track. False for disabling the track.</param>
  445. </member>
  446. <member name="T:UnityEngine.Video.VideoPlayer.ErrorEventHandler">
  447. <summary>
  448. <para>Delegate type for VideoPlayer events that contain an error message.</para>
  449. </summary>
  450. <param name="source">The VideoPlayer that is emitting the event.</param>
  451. <param name="message">Message describing the error just encountered.</param>
  452. </member>
  453. <member name="T:UnityEngine.Video.VideoPlayer.EventHandler">
  454. <summary>
  455. <para>Delegate type for all parameter-less events emitted by VideoPlayers.</para>
  456. </summary>
  457. <param name="source">The VideoPlayer that is emitting the event.</param>
  458. </member>
  459. <member name="T:UnityEngine.Video.VideoPlayer.FrameReadyEventHandler">
  460. <summary>
  461. <para>Delegate type for VideoPlayer events that carry a frame number.</para>
  462. </summary>
  463. <param name="source">The VideoPlayer that is emitting the event.</param>
  464. <param name="frameNum">The frame the VideoPlayer is now at.</param>
  465. <param name="frameIdx"></param>
  466. </member>
  467. <member name="M:UnityEngine.Video.VideoPlayer.GetAudioChannelCount(System.UInt16)">
  468. <summary>
  469. <para>The number of audio channels in the specified audio track.</para>
  470. </summary>
  471. <param name="trackIndex">Index for the audio track being queried.</param>
  472. <returns>
  473. <para>Number of audio channels.</para>
  474. </returns>
  475. </member>
  476. <member name="M:UnityEngine.Video.VideoPlayer.GetAudioLanguageCode(System.UInt16)">
  477. <summary>
  478. <para>Returns the language code, if any, for the specified track.</para>
  479. </summary>
  480. <param name="trackIndex">Index of the audio track to query.</param>
  481. <returns>
  482. <para>Language code.</para>
  483. </returns>
  484. </member>
  485. <member name="M:UnityEngine.Video.VideoPlayer.GetDirectAudioMute(System.UInt16)">
  486. <summary>
  487. <para>Get the direct-output audio mute status for the specified track.</para>
  488. </summary>
  489. <param name="trackIndex"></param>
  490. </member>
  491. <member name="M:UnityEngine.Video.VideoPlayer.GetDirectAudioVolume(System.UInt16)">
  492. <summary>
  493. <para>Return the direct-output volume for specified track.</para>
  494. </summary>
  495. <param name="trackIndex">Track index for which the volume is queried.</param>
  496. <returns>
  497. <para>Volume, between 0 and 1.</para>
  498. </returns>
  499. </member>
  500. <member name="M:UnityEngine.Video.VideoPlayer.GetTargetAudioSource(System.UInt16)">
  501. <summary>
  502. <para>Gets the AudioSource that will receive audio samples for the specified track if Video.VideoPlayer.audioOutputMode is set to Video.VideoAudioOutputMode.AudioSource.</para>
  503. </summary>
  504. <param name="trackIndex">Index of the audio track for which the AudioSource is wanted.</param>
  505. <returns>
  506. <para>The source associated with the audio track.</para>
  507. </returns>
  508. </member>
  509. <member name="M:UnityEngine.Video.VideoPlayer.IsAudioTrackEnabled(System.UInt16)">
  510. <summary>
  511. <para>Returns whether decoding for the specified audio track is enabled. See Video.VideoPlayer.EnableAudioTrack for distinction with mute.</para>
  512. </summary>
  513. <param name="trackIndex">Index of the audio track being queried.</param>
  514. <returns>
  515. <para>True if decoding for the specified audio track is enabled.</para>
  516. </returns>
  517. </member>
  518. <member name="M:UnityEngine.Video.VideoPlayer.Pause">
  519. <summary>
  520. <para>Pauses the playback and leaves the current time intact.</para>
  521. </summary>
  522. </member>
  523. <member name="M:UnityEngine.Video.VideoPlayer.Play">
  524. <summary>
  525. <para>Starts playback.</para>
  526. </summary>
  527. </member>
  528. <member name="M:UnityEngine.Video.VideoPlayer.Prepare">
  529. <summary>
  530. <para>Initiates playback engine prepration.</para>
  531. </summary>
  532. </member>
  533. <member name="M:UnityEngine.Video.VideoPlayer.SetDirectAudioMute(System.UInt16,System.Boolean)">
  534. <summary>
  535. <para>Set the direct-output audio mute status for the specified track.</para>
  536. </summary>
  537. <param name="trackIndex">Track index for which the mute is set.</param>
  538. <param name="mute">Mute on/off.</param>
  539. </member>
  540. <member name="M:UnityEngine.Video.VideoPlayer.SetDirectAudioVolume(System.UInt16,System.Single)">
  541. <summary>
  542. <para>Set the direct-output audio volume for the specified track.</para>
  543. </summary>
  544. <param name="trackIndex">Track index for which the volume is set.</param>
  545. <param name="volume">New volume, between 0 and 1.</param>
  546. </member>
  547. <member name="M:UnityEngine.Video.VideoPlayer.SetTargetAudioSource(System.UInt16,UnityEngine.AudioSource)">
  548. <summary>
  549. <para>Sets the AudioSource that will receive audio samples for the specified track if this audio target is selected with Video.VideoPlayer.audioOutputMode.</para>
  550. </summary>
  551. <param name="trackIndex">Index of the audio track to associate with the specified AudioSource.</param>
  552. <param name="source">AudioSource to associate with the audio track.</param>
  553. </member>
  554. <member name="M:UnityEngine.Video.VideoPlayer.StepForward">
  555. <summary>
  556. <para>Advances the current time by one frame immediately.</para>
  557. </summary>
  558. </member>
  559. <member name="M:UnityEngine.Video.VideoPlayer.Stop">
  560. <summary>
  561. <para>Pauses the playback and sets the current time to 0.</para>
  562. </summary>
  563. </member>
  564. <member name="T:UnityEngine.Video.VideoPlayer.TimeEventHandler">
  565. <summary>
  566. <para>Delegate type for VideoPlayer events that carry a time position.</para>
  567. </summary>
  568. <param name="source">The VideoPlayer that is emitting the event.</param>
  569. <param name="seconds">Time position.</param>
  570. </member>
  571. <member name="T:UnityEngine.Video.VideoRenderMode">
  572. <summary>
  573. <para>Type of destination for the images read by a VideoPlayer.</para>
  574. </summary>
  575. </member>
  576. <member name="F:UnityEngine.Video.VideoRenderMode.APIOnly">
  577. <summary>
  578. <para>Don't draw the video content anywhere, but still make it available via the VideoPlayer's texture property in the API.</para>
  579. </summary>
  580. </member>
  581. <member name="F:UnityEngine.Video.VideoRenderMode.CameraFarPlane">
  582. <summary>
  583. <para>Draw video content behind a camera's scene.</para>
  584. </summary>
  585. </member>
  586. <member name="F:UnityEngine.Video.VideoRenderMode.CameraNearPlane">
  587. <summary>
  588. <para>Draw video content in front of a camera's scene.</para>
  589. </summary>
  590. </member>
  591. <member name="F:UnityEngine.Video.VideoRenderMode.MaterialOverride">
  592. <summary>
  593. <para>Draw the video content into a user-specified property of the current GameObject's material.</para>
  594. </summary>
  595. </member>
  596. <member name="F:UnityEngine.Video.VideoRenderMode.RenderTexture">
  597. <summary>
  598. <para>Draw video content into a RenderTexture.</para>
  599. </summary>
  600. </member>
  601. <member name="T:UnityEngine.Video.VideoSource">
  602. <summary>
  603. <para>Source of the video content for a VideoPlayer.</para>
  604. </summary>
  605. </member>
  606. <member name="F:UnityEngine.Video.VideoSource.Url">
  607. <summary>
  608. <para>Use the current URL as the video content source.</para>
  609. </summary>
  610. </member>
  611. <member name="F:UnityEngine.Video.VideoSource.VideoClip">
  612. <summary>
  613. <para>Use the current clip as the video content source.</para>
  614. </summary>
  615. </member>
  616. <member name="T:UnityEngine.Video.VideoTimeReference">
  617. <summary>
  618. <para>The clock that the Video.VideoPlayer observes to detect and correct drift.</para>
  619. </summary>
  620. </member>
  621. <member name="F:UnityEngine.Video.VideoTimeReference.ExternalTime">
  622. <summary>
  623. <para>External reference clock the Video.VideoPlayer observes to detect and correct drift.</para>
  624. </summary>
  625. </member>
  626. <member name="F:UnityEngine.Video.VideoTimeReference.Freerun">
  627. <summary>
  628. <para>Disables the drift detection.</para>
  629. </summary>
  630. </member>
  631. <member name="F:UnityEngine.Video.VideoTimeReference.InternalTime">
  632. <summary>
  633. <para>Internal reference clock the Video.VideoPlayer observes to detect and correct drift.</para>
  634. </summary>
  635. </member>
  636. <member name="T:UnityEngine.Video.VideoTimeSource">
  637. <summary>
  638. <para>Time source followed by the Video.VideoPlayer when reading content.</para>
  639. </summary>
  640. </member>
  641. <member name="F:UnityEngine.Video.VideoTimeSource.AudioDSPTimeSource">
  642. <summary>
  643. <para>The audio hardware clock.</para>
  644. </summary>
  645. </member>
  646. <member name="F:UnityEngine.Video.VideoTimeSource.GameTimeSource">
  647. <summary>
  648. <para>The unscaled game time as defined by Time.realtimeSinceStartup.</para>
  649. </summary>
  650. </member>
  651. </members>
  652. </doc>