UnityEngine.VideoModule.xml 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700
  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.sRGB">
  169. <summary>
  170. <para>Whether the imported clip contains sRGB color data (Read Only).</para>
  171. </summary>
  172. </member>
  173. <member name="P:UnityEngine.Video.VideoClip.width">
  174. <summary>
  175. <para>The width of the images in the video clip in pixels. (Read Only).</para>
  176. </summary>
  177. </member>
  178. <member name="M:UnityEngine.Video.VideoClip.GetAudioChannelCount(System.UInt16)">
  179. <summary>
  180. <para>The number of channels in the audio track. E.g. 2 for a stereo track.</para>
  181. </summary>
  182. <param name="audioTrackIdx">Index of the audio queried audio track.</param>
  183. <returns>
  184. <para>The number of channels.</para>
  185. </returns>
  186. </member>
  187. <member name="M:UnityEngine.Video.VideoClip.GetAudioLanguage(System.UInt16)">
  188. <summary>
  189. <para>Get the audio track language. Can be unknown.</para>
  190. </summary>
  191. <param name="audioTrackIdx">Index of the audio queried audio track.</param>
  192. <returns>
  193. <para>The abbreviated name of the language.</para>
  194. </returns>
  195. </member>
  196. <member name="M:UnityEngine.Video.VideoClip.GetAudioSampleRate(System.UInt16)">
  197. <summary>
  198. <para>Get the audio track sampling rate in Hertz.</para>
  199. </summary>
  200. <param name="audioTrackIdx">Index of the audio queried audio track.</param>
  201. <returns>
  202. <para>The sampling rate in Hertz.</para>
  203. </returns>
  204. </member>
  205. <member name="T:UnityEngine.Video.VideoPlayer">
  206. <summary>
  207. <para>Plays video content onto a target.</para>
  208. </summary>
  209. </member>
  210. <member name="P:UnityEngine.Video.VideoPlayer.aspectRatio">
  211. <summary>
  212. <para>Defines how the video content will be stretched to fill the target area.</para>
  213. </summary>
  214. </member>
  215. <member name="P:UnityEngine.Video.VideoPlayer.audioOutputMode">
  216. <summary>
  217. <para>Destination for the audio embedded in the video.</para>
  218. </summary>
  219. </member>
  220. <member name="P:UnityEngine.Video.VideoPlayer.audioTrackCount">
  221. <summary>
  222. <para>Number of audio tracks found in the data source currently configured. (Read Only)</para>
  223. </summary>
  224. </member>
  225. <member name="P:UnityEngine.Video.VideoPlayer.canSetDirectAudioVolume">
  226. <summary>
  227. <para>Whether direct-output volume controls are supported for the current platform and video format. (Read Only)</para>
  228. </summary>
  229. </member>
  230. <member name="P:UnityEngine.Video.VideoPlayer.canSetPlaybackSpeed">
  231. <summary>
  232. <para>Whether the playback speed can be changed. (Read Only)</para>
  233. </summary>
  234. </member>
  235. <member name="P:UnityEngine.Video.VideoPlayer.canSetSkipOnDrop">
  236. <summary>
  237. <para>Whether frame-skipping to maintain synchronization can be controlled. (Read Only)</para>
  238. </summary>
  239. </member>
  240. <member name="P:UnityEngine.Video.VideoPlayer.canSetTime">
  241. <summary>
  242. <para>Whether current time can be changed using the time or timeFrames property. (Read Only)</para>
  243. </summary>
  244. </member>
  245. <member name="P:UnityEngine.Video.VideoPlayer.canSetTimeSource">
  246. <summary>
  247. <para>Whether the time source followed by the VideoPlayer can be changed. (Read Only)</para>
  248. </summary>
  249. </member>
  250. <member name="P:UnityEngine.Video.VideoPlayer.canStep">
  251. <summary>
  252. <para>Returns true if the VideoPlayer can step forward through the video content. (Read Only)</para>
  253. </summary>
  254. </member>
  255. <member name="P:UnityEngine.Video.VideoPlayer.clip">
  256. <summary>
  257. <para>The clip being played by the VideoPlayer.</para>
  258. </summary>
  259. </member>
  260. <member name="?:UnityEngine.Video.VideoPlayer.clockResyncOccurred(UnityEngine.Video.VideoPlayer/TimeEventHandler)">
  261. <summary>
  262. <para>Invoked when the VideoPlayer clock is synced back to its Video.VideoTimeReference.</para>
  263. </summary>
  264. <param name="value"></param>
  265. </member>
  266. <member name="P:UnityEngine.Video.VideoPlayer.clockTime">
  267. <summary>
  268. <para>The clock time that the VideoPlayer follows to schedule its samples. The clock time is expressed in seconds. (Read Only)</para>
  269. </summary>
  270. </member>
  271. <member name="P:UnityEngine.Video.VideoPlayer.controlledAudioTrackCount">
  272. <summary>
  273. <para>Number of audio tracks that this VideoPlayer will take control of.</para>
  274. </summary>
  275. </member>
  276. <member name="P:UnityEngine.Video.VideoPlayer.controlledAudioTrackMaxCount">
  277. <summary>
  278. <para>Maximum number of audio tracks that can be controlled. (Read Only)</para>
  279. </summary>
  280. </member>
  281. <member name="?:UnityEngine.Video.VideoPlayer.errorReceived(UnityEngine.Video.VideoPlayer/ErrorEventHandler)">
  282. <summary>
  283. <para>Errors such as HTTP connection problems are reported through this callback.</para>
  284. </summary>
  285. <param name="value"></param>
  286. </member>
  287. <member name="P:UnityEngine.Video.VideoPlayer.externalReferenceTime">
  288. <summary>
  289. <para>Reference time of the external clock the Video.VideoPlayer uses to correct its drift.</para>
  290. </summary>
  291. </member>
  292. <member name="P:UnityEngine.Video.VideoPlayer.frame">
  293. <summary>
  294. <para>The frame index of the currently available frame in VideoPlayer.texture.</para>
  295. </summary>
  296. </member>
  297. <member name="P:UnityEngine.Video.VideoPlayer.frameCount">
  298. <summary>
  299. <para>Number of frames in the current video content. (Read Only)</para>
  300. </summary>
  301. </member>
  302. <member name="?:UnityEngine.Video.VideoPlayer.frameDropped(UnityEngine.Video.VideoPlayer/EventHandler)">
  303. <summary>
  304. <para>[NOT YET IMPLEMENTED] Invoked when the video decoder does not produce a frame as per the time source during playback.</para>
  305. </summary>
  306. <param name="value"></param>
  307. </member>
  308. <member name="P:UnityEngine.Video.VideoPlayer.frameRate">
  309. <summary>
  310. <para>The frame rate of the clip or URL in frames/second. (Read Only)</para>
  311. </summary>
  312. </member>
  313. <member name="?:UnityEngine.Video.VideoPlayer.frameReady(UnityEngine.Video.VideoPlayer/FrameReadyEventHandler)">
  314. <summary>
  315. <para>Invoked when a new frame is ready.</para>
  316. </summary>
  317. <param name="value"></param>
  318. </member>
  319. <member name="P:UnityEngine.Video.VideoPlayer.height">
  320. <summary>
  321. <para>The height of the images in the VideoClip, or URL, in pixels. (Read Only)</para>
  322. </summary>
  323. </member>
  324. <member name="P:UnityEngine.Video.VideoPlayer.isLooping">
  325. <summary>
  326. <para>Determines whether the VideoPlayer restarts from the beginning when it reaches the end of the clip.</para>
  327. </summary>
  328. </member>
  329. <member name="P:UnityEngine.Video.VideoPlayer.isPaused">
  330. <summary>
  331. <para>Whether playback is paused. (Read Only)</para>
  332. </summary>
  333. </member>
  334. <member name="P:UnityEngine.Video.VideoPlayer.isPlaying">
  335. <summary>
  336. <para>Whether content is being played. (Read Only)</para>
  337. </summary>
  338. </member>
  339. <member name="P:UnityEngine.Video.VideoPlayer.isPrepared">
  340. <summary>
  341. <para>Whether the VideoPlayer has successfully prepared the content to be played. (Read Only)</para>
  342. </summary>
  343. </member>
  344. <member name="P:UnityEngine.Video.VideoPlayer.length">
  345. <summary>
  346. <para>The length of the VideoClip, or the URL, in seconds. (Read Only)</para>
  347. </summary>
  348. </member>
  349. <member name="?:UnityEngine.Video.VideoPlayer.loopPointReached(UnityEngine.Video.VideoPlayer/EventHandler)">
  350. <summary>
  351. <para>Invoked when the VideoPlayer reaches the end of the content to play.</para>
  352. </summary>
  353. <param name="value"></param>
  354. </member>
  355. <member name="P:UnityEngine.Video.VideoPlayer.pixelAspectRatioDenominator">
  356. <summary>
  357. <para>Denominator of the pixel aspect ratio (num:den) for the VideoClip or the URL. (Read Only)</para>
  358. </summary>
  359. </member>
  360. <member name="P:UnityEngine.Video.VideoPlayer.pixelAspectRatioNumerator">
  361. <summary>
  362. <para>Numerator of the pixel aspect ratio (num:den) for the VideoClip or the URL. (Read Only)</para>
  363. </summary>
  364. </member>
  365. <member name="P:UnityEngine.Video.VideoPlayer.playbackSpeed">
  366. <summary>
  367. <para>Factor by which the basic playback rate will be multiplied.</para>
  368. </summary>
  369. </member>
  370. <member name="P:UnityEngine.Video.VideoPlayer.playOnAwake">
  371. <summary>
  372. <para>Whether the content will start playing back as soon as the component awakes.</para>
  373. </summary>
  374. </member>
  375. <member name="?:UnityEngine.Video.VideoPlayer.prepareCompleted(UnityEngine.Video.VideoPlayer/EventHandler)">
  376. <summary>
  377. <para>Invoked when the VideoPlayer preparation is complete.</para>
  378. </summary>
  379. <param name="value"></param>
  380. </member>
  381. <member name="P:UnityEngine.Video.VideoPlayer.renderMode">
  382. <summary>
  383. <para>Where the video content will be drawn.</para>
  384. </summary>
  385. </member>
  386. <member name="?:UnityEngine.Video.VideoPlayer.seekCompleted(UnityEngine.Video.VideoPlayer/EventHandler)">
  387. <summary>
  388. <para>Invoke after a seek operation completes.</para>
  389. </summary>
  390. <param name="value"></param>
  391. </member>
  392. <member name="P:UnityEngine.Video.VideoPlayer.sendFrameReadyEvents">
  393. <summary>
  394. <para>Enables the frameReady events.</para>
  395. </summary>
  396. </member>
  397. <member name="P:UnityEngine.Video.VideoPlayer.skipOnDrop">
  398. <summary>
  399. <para>Whether the VideoPlayer is allowed to skip frames to catch up with current time.</para>
  400. </summary>
  401. </member>
  402. <member name="P:UnityEngine.Video.VideoPlayer.source">
  403. <summary>
  404. <para>The source that the VideoPlayer uses for playback.</para>
  405. </summary>
  406. </member>
  407. <member name="?:UnityEngine.Video.VideoPlayer.started(UnityEngine.Video.VideoPlayer/EventHandler)">
  408. <summary>
  409. <para>Invoked immediately after Play is called.</para>
  410. </summary>
  411. <param name="value"></param>
  412. </member>
  413. <member name="P:UnityEngine.Video.VideoPlayer.targetCamera">
  414. <summary>
  415. <para>Camera component to draw to when Video.VideoPlayer.renderMode is set to either Video.VideoRenderMode.CameraFarPlane or Video.VideoRenderMode.CameraNearPlane.</para>
  416. </summary>
  417. </member>
  418. <member name="P:UnityEngine.Video.VideoPlayer.targetCamera3DLayout">
  419. <summary>
  420. <para>Type of 3D content contained in the source video media.</para>
  421. </summary>
  422. </member>
  423. <member name="P:UnityEngine.Video.VideoPlayer.targetCameraAlpha">
  424. <summary>
  425. <para>Overall transparency level of the target camera plane video.</para>
  426. </summary>
  427. </member>
  428. <member name="P:UnityEngine.Video.VideoPlayer.targetMaterialProperty">
  429. <summary>
  430. <para>Material texture property which is targeted when Video.VideoPlayer.renderMode is set to Video.VideoTarget.MaterialOverride.</para>
  431. </summary>
  432. </member>
  433. <member name="P:UnityEngine.Video.VideoPlayer.targetMaterialRenderer">
  434. <summary>
  435. <para>Renderer which is targeted when Video.VideoPlayer.renderMode is set to Video.VideoTarget.MaterialOverride</para>
  436. </summary>
  437. </member>
  438. <member name="P:UnityEngine.Video.VideoPlayer.targetTexture">
  439. <summary>
  440. <para>RenderTexture to draw to when Video.VideoPlayer.renderMode is set to Video.VideoTarget.RenderTexture.</para>
  441. </summary>
  442. </member>
  443. <member name="P:UnityEngine.Video.VideoPlayer.texture">
  444. <summary>
  445. <para>Internal texture in which video content is placed. (Read Only)</para>
  446. </summary>
  447. </member>
  448. <member name="P:UnityEngine.Video.VideoPlayer.time">
  449. <summary>
  450. <para>The presentation time of the currently available frame in VideoPlayer.texture.</para>
  451. </summary>
  452. </member>
  453. <member name="P:UnityEngine.Video.VideoPlayer.timeReference">
  454. <summary>
  455. <para>The clock that the Video.VideoPlayer observes to detect and correct drift.</para>
  456. </summary>
  457. </member>
  458. <member name="P:UnityEngine.Video.VideoPlayer.timeSource">
  459. <summary>
  460. <para>[NOT YET IMPLEMENTED] The source used used by the VideoPlayer to derive its current time.</para>
  461. </summary>
  462. </member>
  463. <member name="P:UnityEngine.Video.VideoPlayer.url">
  464. <summary>
  465. <para>The file or HTTP URL that the VideoPlayer reads content from.</para>
  466. </summary>
  467. </member>
  468. <member name="P:UnityEngine.Video.VideoPlayer.waitForFirstFrame">
  469. <summary>
  470. <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>
  471. </summary>
  472. </member>
  473. <member name="P:UnityEngine.Video.VideoPlayer.width">
  474. <summary>
  475. <para>The width of the images in the VideoClip, or URL, in pixels. (Read Only)</para>
  476. </summary>
  477. </member>
  478. <member name="M:UnityEngine.Video.VideoPlayer.EnableAudioTrack(System.UInt16,System.Boolean)">
  479. <summary>
  480. <para>Enable/disable audio track decoding. Only effective when the VideoPlayer is not currently playing.</para>
  481. </summary>
  482. <param name="trackIndex">Index of the audio track to enable/disable.</param>
  483. <param name="enabled">True for enabling the track. False for disabling the track.</param>
  484. </member>
  485. <member name="T:UnityEngine.Video.VideoPlayer.ErrorEventHandler">
  486. <summary>
  487. <para>Delegate type for VideoPlayer events that contain an error message.</para>
  488. </summary>
  489. <param name="source">The VideoPlayer that is emitting the event.</param>
  490. <param name="message">Message describing the error just encountered.</param>
  491. </member>
  492. <member name="T:UnityEngine.Video.VideoPlayer.EventHandler">
  493. <summary>
  494. <para>Delegate type for all parameterless events emitted by VideoPlayers.</para>
  495. </summary>
  496. <param name="source">The VideoPlayer that is emitting the event.</param>
  497. </member>
  498. <member name="T:UnityEngine.Video.VideoPlayer.FrameReadyEventHandler">
  499. <summary>
  500. <para>Delegate type for VideoPlayer events that carry a frame number.</para>
  501. </summary>
  502. <param name="source">The VideoPlayer that is emitting the event.</param>
  503. <param name="frameNum">The current frame of the VideoPlayer.</param>
  504. <param name="frameIdx"></param>
  505. </member>
  506. <member name="M:UnityEngine.Video.VideoPlayer.GetAudioChannelCount(System.UInt16)">
  507. <summary>
  508. <para>The number of audio channels in the specified audio track.</para>
  509. </summary>
  510. <param name="trackIndex">Index for the audio track being queried.</param>
  511. <returns>
  512. <para>Number of audio channels.</para>
  513. </returns>
  514. </member>
  515. <member name="M:UnityEngine.Video.VideoPlayer.GetAudioLanguageCode(System.UInt16)">
  516. <summary>
  517. <para>Returns the language code, if any, for the specified track.</para>
  518. </summary>
  519. <param name="trackIndex">Index of the audio track to query.</param>
  520. <returns>
  521. <para>Language code.</para>
  522. </returns>
  523. </member>
  524. <member name="M:UnityEngine.Video.VideoPlayer.GetAudioSampleRate(System.UInt16)">
  525. <summary>
  526. <para>Gets the audio track sampling rate in Hertz.</para>
  527. </summary>
  528. <param name="trackIndex">Index of the audio track to query.</param>
  529. <returns>
  530. <para>The sampling rate in Hertz.</para>
  531. </returns>
  532. </member>
  533. <member name="M:UnityEngine.Video.VideoPlayer.GetDirectAudioMute(System.UInt16)">
  534. <summary>
  535. <para>Gets the direct-output audio mute status for the specified track.</para>
  536. </summary>
  537. <param name="trackIndex"></param>
  538. </member>
  539. <member name="M:UnityEngine.Video.VideoPlayer.GetDirectAudioVolume(System.UInt16)">
  540. <summary>
  541. <para>Return the direct-output volume for specified track.</para>
  542. </summary>
  543. <param name="trackIndex">Track index for which the volume is queried.</param>
  544. <returns>
  545. <para>Volume, between 0 and 1.</para>
  546. </returns>
  547. </member>
  548. <member name="M:UnityEngine.Video.VideoPlayer.GetTargetAudioSource(System.UInt16)">
  549. <summary>
  550. <para>Gets the AudioSource that will receive audio samples for the specified track if Video.VideoPlayer.audioOutputMode is set to Video.VideoAudioOutputMode.AudioSource.</para>
  551. </summary>
  552. <param name="trackIndex">Index of the audio track for which the AudioSource is wanted.</param>
  553. <returns>
  554. <para>The source associated with the audio track.</para>
  555. </returns>
  556. </member>
  557. <member name="M:UnityEngine.Video.VideoPlayer.IsAudioTrackEnabled(System.UInt16)">
  558. <summary>
  559. <para>Whether decoding for the specified audio track is enabled. See Video.VideoPlayer.EnableAudioTrack for distinction with mute.</para>
  560. </summary>
  561. <param name="trackIndex">Index of the audio track being queried.</param>
  562. <returns>
  563. <para>Returns true if decoding for the specified audio track is enabled.</para>
  564. </returns>
  565. </member>
  566. <member name="M:UnityEngine.Video.VideoPlayer.Pause">
  567. <summary>
  568. <para>Pauses the playback and leaves the current time intact.</para>
  569. </summary>
  570. </member>
  571. <member name="M:UnityEngine.Video.VideoPlayer.Play">
  572. <summary>
  573. <para>Starts playback.</para>
  574. </summary>
  575. </member>
  576. <member name="M:UnityEngine.Video.VideoPlayer.Prepare">
  577. <summary>
  578. <para>Initiates playback engine preparation.</para>
  579. </summary>
  580. </member>
  581. <member name="M:UnityEngine.Video.VideoPlayer.SetDirectAudioMute(System.UInt16,System.Boolean)">
  582. <summary>
  583. <para>Set the direct-output audio mute status for the specified track.</para>
  584. </summary>
  585. <param name="trackIndex">Track index for which the mute is set.</param>
  586. <param name="mute">Mute on/off.</param>
  587. </member>
  588. <member name="M:UnityEngine.Video.VideoPlayer.SetDirectAudioVolume(System.UInt16,System.Single)">
  589. <summary>
  590. <para>Set the direct-output audio volume for the specified track.</para>
  591. </summary>
  592. <param name="trackIndex">Track index for which the volume is set.</param>
  593. <param name="volume">New volume, between 0 and 1.</param>
  594. </member>
  595. <member name="M:UnityEngine.Video.VideoPlayer.SetTargetAudioSource(System.UInt16,UnityEngine.AudioSource)">
  596. <summary>
  597. <para>Sets the AudioSource that will receive audio samples for the specified track if this audio target is selected with Video.VideoPlayer.audioOutputMode.</para>
  598. </summary>
  599. <param name="trackIndex">Index of the audio track to associate with the specified AudioSource.</param>
  600. <param name="source">AudioSource to associate with the audio track.</param>
  601. </member>
  602. <member name="M:UnityEngine.Video.VideoPlayer.StepForward">
  603. <summary>
  604. <para>Advances the current time by one frame immediately.</para>
  605. </summary>
  606. </member>
  607. <member name="M:UnityEngine.Video.VideoPlayer.Stop">
  608. <summary>
  609. <para>Stops the playback and sets the current time to 0.</para>
  610. </summary>
  611. </member>
  612. <member name="T:UnityEngine.Video.VideoPlayer.TimeEventHandler">
  613. <summary>
  614. <para>Delegate type for VideoPlayer events that carry a time position.</para>
  615. </summary>
  616. <param name="source">The VideoPlayer that is emitting the event.</param>
  617. <param name="seconds">Time position.</param>
  618. </member>
  619. <member name="T:UnityEngine.Video.VideoRenderMode">
  620. <summary>
  621. <para>Type of destination for the images read by a VideoPlayer.</para>
  622. </summary>
  623. </member>
  624. <member name="F:UnityEngine.Video.VideoRenderMode.APIOnly">
  625. <summary>
  626. <para>Don't draw the video content anywhere, but still make it available via the VideoPlayer's texture property in the API.</para>
  627. </summary>
  628. </member>
  629. <member name="F:UnityEngine.Video.VideoRenderMode.CameraFarPlane">
  630. <summary>
  631. <para>Draw video content behind a camera's Scene.</para>
  632. </summary>
  633. </member>
  634. <member name="F:UnityEngine.Video.VideoRenderMode.CameraNearPlane">
  635. <summary>
  636. <para>Draw video content in front of a camera's Scene.</para>
  637. </summary>
  638. </member>
  639. <member name="F:UnityEngine.Video.VideoRenderMode.MaterialOverride">
  640. <summary>
  641. <para>Draw the video content into a user-specified property of the current GameObject's material.</para>
  642. </summary>
  643. </member>
  644. <member name="F:UnityEngine.Video.VideoRenderMode.RenderTexture">
  645. <summary>
  646. <para>Draw video content into a RenderTexture.</para>
  647. </summary>
  648. </member>
  649. <member name="T:UnityEngine.Video.VideoSource">
  650. <summary>
  651. <para>Source of the video content for a VideoPlayer.</para>
  652. </summary>
  653. </member>
  654. <member name="F:UnityEngine.Video.VideoSource.Url">
  655. <summary>
  656. <para>Use the current URL as the video content source.</para>
  657. </summary>
  658. </member>
  659. <member name="F:UnityEngine.Video.VideoSource.VideoClip">
  660. <summary>
  661. <para>Use the current clip as the video content source.</para>
  662. </summary>
  663. </member>
  664. <member name="T:UnityEngine.Video.VideoTimeReference">
  665. <summary>
  666. <para>The clock that the Video.VideoPlayer observes to detect and correct drift.</para>
  667. </summary>
  668. </member>
  669. <member name="F:UnityEngine.Video.VideoTimeReference.ExternalTime">
  670. <summary>
  671. <para>External reference clock the Video.VideoPlayer observes to detect and correct drift.</para>
  672. </summary>
  673. </member>
  674. <member name="F:UnityEngine.Video.VideoTimeReference.Freerun">
  675. <summary>
  676. <para>Disables the drift detection.</para>
  677. </summary>
  678. </member>
  679. <member name="F:UnityEngine.Video.VideoTimeReference.InternalTime">
  680. <summary>
  681. <para>Internal reference clock the Video.VideoPlayer observes to detect and correct drift.</para>
  682. </summary>
  683. </member>
  684. <member name="T:UnityEngine.Video.VideoTimeSource">
  685. <summary>
  686. <para>Time source followed by the Video.VideoPlayer when reading content.</para>
  687. </summary>
  688. </member>
  689. <member name="F:UnityEngine.Video.VideoTimeSource.AudioDSPTimeSource">
  690. <summary>
  691. <para>The audio hardware clock.</para>
  692. </summary>
  693. </member>
  694. <member name="F:UnityEngine.Video.VideoTimeSource.GameTimeSource">
  695. <summary>
  696. <para>The unscaled game time as defined by Time.realtimeSinceStartup.</para>
  697. </summary>
  698. </member>
  699. </members>
  700. </doc>