731 lines
31 KiB
XML
731 lines
31 KiB
XML
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
|
||
<doc>
|
||
<members>
|
||
<assembly>
|
||
<name>UnityEngine.VideoModule</name>
|
||
</assembly>
|
||
<member name="T:UnityEngine.Experimental.Video.VideoClipPlayable">
|
||
<summary>
|
||
<para>An implementation of IPlayable that controls playback of a VideoClip.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:UnityEngine.Experimental.Video.VideoClipPlayable.Create(UnityEngine.Playables.PlayableGraph,UnityEngine.Video.VideoClip,System.Boolean)">
|
||
<summary>
|
||
<para>Creates a VideoClipPlayable in the PlayableGraph.</para>
|
||
</summary>
|
||
<param name="graph">The PlayableGraph object that will own the VideoClipPlayable.</param>
|
||
<param name="looping">Indicates if VideoClip loops when it reaches the end.</param>
|
||
<param name="clip">VideoClip used to produce textures in the PlayableGraph.</param>
|
||
<returns>
|
||
<para>A VideoClipPlayable linked to the PlayableGraph.</para>
|
||
</returns>
|
||
</member>
|
||
<member name="T:UnityEngine.Experimental.Video.VideoPlayerExtensions">
|
||
<summary>
|
||
<para>Extension methods for the Video.VideoPlayer class.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:UnityEngine.Experimental.Video.VideoPlayerExtensions.GetAudioSampleProvider(UnityEngine.Video.VideoPlayer,System.UInt16)">
|
||
<summary>
|
||
<para>Return the Experimental.Audio.AudioSampleProvider for the specified track, used to receive audio samples during playback.</para>
|
||
</summary>
|
||
<param name="vp">The "this" pointer for the extension method.</param>
|
||
<param name="trackIndex">The audio track index for which the sample provider is queried.</param>
|
||
<returns>
|
||
<para>The sample provider for the specified track.</para>
|
||
</returns>
|
||
</member>
|
||
<member name="A:UnityEngine.VideoModule">
|
||
<summary>
|
||
<para>The Video module lets you play back video files in your content.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.Video3DLayout">
|
||
<summary>
|
||
<para>Types of 3D content layout within a video.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.Video3DLayout.No3D">
|
||
<summary>
|
||
<para>Use this setting if the video doesn't have any 3D content.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.Video3DLayout.OverUnder3D">
|
||
<summary>
|
||
<para>Video contains 3D content where the left eye occupies the upper half and right eye occupies the lower half of video frames.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.Video3DLayout.SideBySide3D">
|
||
<summary>
|
||
<para>Video contains 3D content where the left eye occupies the left half and right eye occupies the right half of video frames.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoAspectRatio">
|
||
<summary>
|
||
<para>Use these methods to fit a video into your target area.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoAspectRatio.FitHorizontally">
|
||
<summary>
|
||
<para>Resize the image proportionally so that the width fits the target area.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoAspectRatio.FitInside">
|
||
<summary>
|
||
<para>Resize the image proportionally so that the content fits the target area.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoAspectRatio.FitOutside">
|
||
<summary>
|
||
<para>Resize the image proportionally so that the content fits the target area. The VideoPlayer automatically crops the image if needed.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoAspectRatio.FitVertically">
|
||
<summary>
|
||
<para>Resize the image proportionally so that the height fits the target area.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoAspectRatio.NoScaling">
|
||
<summary>
|
||
<para>Preserve the pixel size without adjusting for target area.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoAspectRatio.Stretch">
|
||
<summary>
|
||
<para>Resize the image non-proportionally to fit the target area.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoAudioOutputMode">
|
||
<summary>
|
||
<para>Places where the audio embedded in a video can be sent.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoAudioOutputMode.APIOnly">
|
||
<summary>
|
||
<para>Send the embedded audio to the associated AudioSampleProvider.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoAudioOutputMode.AudioSource">
|
||
<summary>
|
||
<para>Send the embedded audio into a specified AudioSource.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoAudioOutputMode.Direct">
|
||
<summary>
|
||
<para>Send the embedded audio direct to the platform's audio hardware.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoAudioOutputMode.None">
|
||
<summary>
|
||
<para>Disable the embedded audio.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoClip">
|
||
<summary>
|
||
<para>A container for video data.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoClip.audioTrackCount">
|
||
<summary>
|
||
<para>Gets the number of audio tracks that are embedded in the video clip. (Read Only).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoClip.frameCount">
|
||
<summary>
|
||
<para>The length of the video clip in frames. (Read Only).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoClip.frameRate">
|
||
<summary>
|
||
<para>The frame rate of the clip in frames per second. (Read Only).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoClip.height">
|
||
<summary>
|
||
<para>The height of the images in the video clip in pixels. (Read Only).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoClip.length">
|
||
<summary>
|
||
<para>The length of the video clip in seconds. (Read Only).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoClip.originalPath">
|
||
<summary>
|
||
<para>Gets the original video clip file path as it was imported into Unity. (Read Only).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoClip.pixelAspectRatioDenominator">
|
||
<summary>
|
||
<para>Returns the denominator of the pixel aspect ratio (numerator:denominator). (Read Only).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoClip.pixelAspectRatioNumerator">
|
||
<summary>
|
||
<para>Returns the numerator of the pixel aspect ratio (numerator:denominator). (Read Only).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoClip.sRGB">
|
||
<summary>
|
||
<para>Whether the imported clip contains sRGB color data (Read Only).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoClip.width">
|
||
<summary>
|
||
<para>The width of the images in the video clip in pixels. (Read Only).</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoClip.GetAudioChannelCount(System.UInt16)">
|
||
<summary>
|
||
<para>Returns the number of channels in the audio track. For example, if the audio track is a stereo track, this function returns 2.</para>
|
||
</summary>
|
||
<param name="audioTrackIdx">Use this index to specify which audio track in the video to use.</param>
|
||
<returns>
|
||
<para>The number of channels.</para>
|
||
</returns>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoClip.GetAudioLanguage(System.UInt16)">
|
||
<summary>
|
||
<para>Gets the language of the video clip’s audio tracks, if the audio tracks have an assigned language.</para>
|
||
</summary>
|
||
<param name="audioTrackIdx">Index of the audio track you want to query in the video.</param>
|
||
<returns>
|
||
<para>The abbreviated name of the language.</para>
|
||
</returns>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoClip.GetAudioSampleRate(System.UInt16)">
|
||
<summary>
|
||
<para>Get the audio track sampling rate in hertz (Hz).</para>
|
||
</summary>
|
||
<param name="audioTrackIdx">Index of the audio queried audio track.</param>
|
||
<returns>
|
||
<para>The sampling rate in hertz.</para>
|
||
</returns>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoPlayer">
|
||
<summary>
|
||
<para>Plays video content onto a target.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.aspectRatio">
|
||
<summary>
|
||
<para>Defines how the video content will be stretched to fill the target area.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.audioOutputMode">
|
||
<summary>
|
||
<para>Destination for the audio embedded in the video.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.audioTrackCount">
|
||
<summary>
|
||
<para>Number of audio tracks found in the data source currently configured. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.canSetDirectAudioVolume">
|
||
<summary>
|
||
<para>Whether direct-output volume controls are supported for the current platform and video format. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.canSetPlaybackSpeed">
|
||
<summary>
|
||
<para>Whether you can change the playback speed. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.canSetSkipOnDrop">
|
||
<summary>
|
||
<para>Whether frame-skipping to maintain synchronization can be controlled. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.canSetTime">
|
||
<summary>
|
||
<para>Whether you can change the current time using the VideoPlayer.time or VideoPlayer.frame properties. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.canSetTimeSource">
|
||
<summary>
|
||
<para>[DEPRECATED] Whether you can change the time source followed by the VideoPlayer. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.canSetTimeUpdateMode">
|
||
<summary>
|
||
<para>Whether you can change the time source followed by the VideoPlayer. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.canStep">
|
||
<summary>
|
||
<para>Returns true if the VideoPlayer can step forward through the video content. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.clip">
|
||
<summary>
|
||
<para>The clip being played by the VideoPlayer.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="?:UnityEngine.Video.VideoPlayer.clockResyncOccurred(UnityEngine.Video.VideoPlayer/TimeEventHandler)">
|
||
<summary>
|
||
<para>Invoked when the VideoPlayer clock is synced back to its Video.VideoTimeReference.</para>
|
||
</summary>
|
||
<param name="value"></param>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.clockTime">
|
||
<summary>
|
||
<para>The clock time that the VideoPlayer follows to schedule its samples. The clock time is expressed in seconds. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.controlledAudioTrackCount">
|
||
<summary>
|
||
<para>Number of audio tracks that this VideoPlayer will take control of.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.controlledAudioTrackMaxCount">
|
||
<summary>
|
||
<para>Maximum number of audio tracks that can be controlled. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="?:UnityEngine.Video.VideoPlayer.errorReceived(UnityEngine.Video.VideoPlayer/ErrorEventHandler)">
|
||
<summary>
|
||
<para>The VideoPlayer uses this callback to report various types of errors.</para>
|
||
</summary>
|
||
<param name="value">The error message (string) the VideoPlayer reports.</param>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.externalReferenceTime">
|
||
<summary>
|
||
<para>Reference time of the external clock the Video.VideoPlayer uses to correct its drift.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.frame">
|
||
<summary>
|
||
<para>The frame index of the currently available frame in VideoPlayer.texture.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.frameCount">
|
||
<summary>
|
||
<para>Number of frames in the current video content. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="?:UnityEngine.Video.VideoPlayer.frameDropped(UnityEngine.Video.VideoPlayer/EventHandler)">
|
||
<summary>
|
||
<para>Invoked when the video decoder does not produce a frame as per the time source during playback.</para>
|
||
</summary>
|
||
<param name="value"></param>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.frameRate">
|
||
<summary>
|
||
<para>The frame rate of the clip or URL in frames/second. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="?:UnityEngine.Video.VideoPlayer.frameReady(UnityEngine.Video.VideoPlayer/FrameReadyEventHandler)">
|
||
<summary>
|
||
<para>The VideoPlayer invokes this event when a new frame is ready to be displayed.</para>
|
||
</summary>
|
||
<param name="value">The number of the frame that is ready (zero-based index).</param>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.height">
|
||
<summary>
|
||
<para>The height of the images in the VideoClip, or URL, in pixels. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.isLooping">
|
||
<summary>
|
||
<para>Determines whether the VideoPlayer restarts from the beginning when it reaches the end of the clip.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.isPaused">
|
||
<summary>
|
||
<para>Whether playback is paused. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.isPlaying">
|
||
<summary>
|
||
<para>Returns whether the VideoPlayer is currently playing the content.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.isPrepared">
|
||
<summary>
|
||
<para>Returns whether the VideoPlayer has successfully prepared the content to be played. </para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.length">
|
||
<summary>
|
||
<para>The length of the VideoClip, or the URL, in seconds. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="?:UnityEngine.Video.VideoPlayer.loopPointReached(UnityEngine.Video.VideoPlayer/EventHandler)">
|
||
<summary>
|
||
<para>The VideoPlayer emits this event when the video reaches the end of its playback.</para>
|
||
</summary>
|
||
<param name="value">The instance of the VideoPlayer that invokes the event.</param>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.pixelAspectRatioDenominator">
|
||
<summary>
|
||
<para>Denominator of the pixel aspect ratio (num:den) for the VideoClip or the URL. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.pixelAspectRatioNumerator">
|
||
<summary>
|
||
<para>Numerator of the pixel aspect ratio (num:den) for the VideoClip or the URL. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.playbackSpeed">
|
||
<summary>
|
||
<para>Factor by which the basic playback rate will be multiplied.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.playOnAwake">
|
||
<summary>
|
||
<para>Whether the content will start playing back as soon as the component awakes.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="?:UnityEngine.Video.VideoPlayer.prepareCompleted(UnityEngine.Video.VideoPlayer/EventHandler)">
|
||
<summary>
|
||
<para>The VideoPlayer invokes this event when the video is ready for playback.</para>
|
||
</summary>
|
||
<param name="value">The instance of the VideoPlayer that invoked the event.</param>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.renderMode">
|
||
<summary>
|
||
<para>Where the video content will be drawn.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="?:UnityEngine.Video.VideoPlayer.seekCompleted(UnityEngine.Video.VideoPlayer/EventHandler)">
|
||
<summary>
|
||
<para>Invoke after a seek operation completes.</para>
|
||
</summary>
|
||
<param name="value"></param>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.sendFrameReadyEvents">
|
||
<summary>
|
||
<para>Enables the frameReady events.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.skipOnDrop">
|
||
<summary>
|
||
<para>Whether the VideoPlayer is allowed to skip frames to catch up with current time.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.source">
|
||
<summary>
|
||
<para>The source that the VideoPlayer uses for playback.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="?:UnityEngine.Video.VideoPlayer.started(UnityEngine.Video.VideoPlayer/EventHandler)">
|
||
<summary>
|
||
<para>The VideoPlayer emits this event when the video starts to play.</para>
|
||
</summary>
|
||
<param name="value">The instance of the VideoPlayer that invokes the event.</param>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.targetCamera">
|
||
<summary>
|
||
<para>Camera component to draw to when Video.VideoPlayer.renderMode is set to either Video.VideoRenderMode.CameraFarPlane or Video.VideoRenderMode.CameraNearPlane.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.targetCamera3DLayout">
|
||
<summary>
|
||
<para>Type of 3D content contained in the source video media.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.targetCameraAlpha">
|
||
<summary>
|
||
<para>Overall transparency level of the target camera plane video.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.targetMaterialProperty">
|
||
<summary>
|
||
<para>Material texture property which is targeted when Video.VideoPlayer.renderMode is set to Video.VideoTarget.MaterialOverride.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.targetMaterialRenderer">
|
||
<summary>
|
||
<para>Renderer which is targeted when Video.VideoPlayer.renderMode is set to Video.VideoTarget.MaterialOverride</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.targetTexture">
|
||
<summary>
|
||
<para>RenderTexture to draw to when Video.VideoPlayer.renderMode is set to Video.VideoRenderMode.RenderTexture.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.texture">
|
||
<summary>
|
||
<para>Internal texture in which video content is placed. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.time">
|
||
<summary>
|
||
<para>The presentation time of the currently available frame in VideoPlayer.texture in seconds.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.timeReference">
|
||
<summary>
|
||
<para>The clock that the Video.VideoPlayer observes to detect and correct drift.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.timeSource">
|
||
<summary>
|
||
<para>[DEPRECATED] The source used by the VideoPlayer to derive its current time.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.timeUpdateMode">
|
||
<summary>
|
||
<para>The clock source used by the VideoPlayer to derive its current time.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.url">
|
||
<summary>
|
||
<para>The file URL or web URL that the VideoPlayer reads content from.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.waitForFirstFrame">
|
||
<summary>
|
||
<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>
|
||
</summary>
|
||
</member>
|
||
<member name="P:UnityEngine.Video.VideoPlayer.width">
|
||
<summary>
|
||
<para>The width of the images in the VideoClip, or URL, in pixels. (Read Only)</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.EnableAudioTrack(System.UInt16,System.Boolean)">
|
||
<summary>
|
||
<para>Enable/disable audio track decoding. Only effective when the VideoPlayer is not currently playing.</para>
|
||
</summary>
|
||
<param name="trackIndex">Index of the audio track to enable/disable.</param>
|
||
<param name="enabled">True for enabling the track. False for disabling the track.</param>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoPlayer.ErrorEventHandler">
|
||
<summary>
|
||
<para>Delegate type for VideoPlayer events that contain an error message.</para>
|
||
</summary>
|
||
<param name="source">The VideoPlayer that is emitting the event.</param>
|
||
<param name="message">Message describing the error just encountered.</param>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoPlayer.EventHandler">
|
||
<summary>
|
||
<para>Delegate type for all events without parameters emitted by VideoPlayers.</para>
|
||
</summary>
|
||
<param name="source">The VideoPlayer that emits the event.</param>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoPlayer.FrameReadyEventHandler">
|
||
<summary>
|
||
<para>Delegate type for VideoPlayer events that carry a frame number.</para>
|
||
</summary>
|
||
<param name="source">The VideoPlayer that is emitting the event.</param>
|
||
<param name="frameNum">The current frame of the VideoPlayer.</param>
|
||
<param name="frameIdx"></param>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.GetAudioChannelCount(System.UInt16)">
|
||
<summary>
|
||
<para>The number of audio channels in the specified audio track.</para>
|
||
</summary>
|
||
<param name="trackIndex">Index for the audio track being queried.</param>
|
||
<returns>
|
||
<para>Number of audio channels.</para>
|
||
</returns>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.GetAudioLanguageCode(System.UInt16)">
|
||
<summary>
|
||
<para>Returns the language code, if any, for the specified track.</para>
|
||
</summary>
|
||
<param name="trackIndex">Index of the audio track to query.</param>
|
||
<returns>
|
||
<para>Language code.</para>
|
||
</returns>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.GetAudioSampleRate(System.UInt16)">
|
||
<summary>
|
||
<para>Gets the audio track sampling rate in Hertz.</para>
|
||
</summary>
|
||
<param name="trackIndex">Index of the audio track to query.</param>
|
||
<returns>
|
||
<para>The sampling rate in Hertz.</para>
|
||
</returns>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.GetDirectAudioMute(System.UInt16)">
|
||
<summary>
|
||
<para>Gets the direct-output audio mute status for the specified track.</para>
|
||
</summary>
|
||
<param name="trackIndex"></param>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.GetDirectAudioVolume(System.UInt16)">
|
||
<summary>
|
||
<para>Return the direct-output volume for specified track.</para>
|
||
</summary>
|
||
<param name="trackIndex">Track index for which the volume is queried.</param>
|
||
<returns>
|
||
<para>Volume, between 0 and 1.</para>
|
||
</returns>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.GetTargetAudioSource(System.UInt16)">
|
||
<summary>
|
||
<para>Gets the AudioSource that will receive audio samples for the specified track if Video.VideoPlayer.audioOutputMode is set to Video.VideoAudioOutputMode.AudioSource.</para>
|
||
</summary>
|
||
<param name="trackIndex">Index of the audio track for which the AudioSource is wanted.</param>
|
||
<returns>
|
||
<para>The source associated with the audio track.</para>
|
||
</returns>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.IsAudioTrackEnabled(System.UInt16)">
|
||
<summary>
|
||
<para>Whether decoding for the specified audio track is enabled. See Video.VideoPlayer.EnableAudioTrack for distinction with mute.</para>
|
||
</summary>
|
||
<param name="trackIndex">Index of the audio track being queried.</param>
|
||
<returns>
|
||
<para>Returns true if decoding for the specified audio track is enabled.</para>
|
||
</returns>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.Pause">
|
||
<summary>
|
||
<para>Pauses the playback and leaves the current time intact.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.Play">
|
||
<summary>
|
||
<para>Starts or resumes the playback of a video.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.Prepare">
|
||
<summary>
|
||
<para>Prepares the playback engine so that it's ready for playback.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.SetDirectAudioMute(System.UInt16,System.Boolean)">
|
||
<summary>
|
||
<para>Set the direct-output audio mute status for the specified track.</para>
|
||
</summary>
|
||
<param name="trackIndex">Track index for which the mute is set.</param>
|
||
<param name="mute">Mute on/off.</param>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.SetDirectAudioVolume(System.UInt16,System.Single)">
|
||
<summary>
|
||
<para>Set the direct-output audio volume for the specified track.</para>
|
||
</summary>
|
||
<param name="trackIndex">Track index for which the volume is set.</param>
|
||
<param name="volume">New volume, between 0 and 1.</param>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.SetTargetAudioSource(System.UInt16,UnityEngine.AudioSource)">
|
||
<summary>
|
||
<para>Sets the AudioSource that will receive audio samples for the specified track if this audio target is selected with Video.VideoPlayer.audioOutputMode.</para>
|
||
</summary>
|
||
<param name="trackIndex">Index of the audio track to associate with the specified AudioSource.</param>
|
||
<param name="source">AudioSource to associate with the audio track.</param>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.StepForward">
|
||
<summary>
|
||
<para>Immediately advance the current time by one frame.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="M:UnityEngine.Video.VideoPlayer.Stop">
|
||
<summary>
|
||
<para>Stops the playback and sets the current time to 0.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoPlayer.TimeEventHandler">
|
||
<summary>
|
||
<para>Delegate type for VideoPlayer events that carry a time position.</para>
|
||
</summary>
|
||
<param name="source">The VideoPlayer that is emitting the event.</param>
|
||
<param name="seconds">Time position.</param>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoRenderMode">
|
||
<summary>
|
||
<para>Type of destination for the images read by a VideoPlayer.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoRenderMode.APIOnly">
|
||
<summary>
|
||
<para>Don't draw the video content anywhere, but still make it available via the VideoPlayer's texture property in the API.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoRenderMode.CameraFarPlane">
|
||
<summary>
|
||
<para>Draw video content behind a camera's scene.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoRenderMode.CameraNearPlane">
|
||
<summary>
|
||
<para>Draw video content in front of a camera's scene.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoRenderMode.MaterialOverride">
|
||
<summary>
|
||
<para>Draw the video content into a user-specified property of the current GameObject's material.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoRenderMode.RenderTexture">
|
||
<summary>
|
||
<para>Draw video content into a RenderTexture.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoSource">
|
||
<summary>
|
||
<para>Source of the video content for a VideoPlayer.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoSource.Url">
|
||
<summary>
|
||
<para>Use the current URL as the video content source.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoSource.VideoClip">
|
||
<summary>
|
||
<para>Use the current clip as the video content source.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoTimeReference">
|
||
<summary>
|
||
<para>The clock that the Video.VideoPlayer observes to detect and correct drift.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoTimeReference.ExternalTime">
|
||
<summary>
|
||
<para>The external reference clock the Video.VideoPlayer observes to detect and correct drift.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoTimeReference.Freerun">
|
||
<summary>
|
||
<para>The video plays without influence from external time sources.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoTimeReference.InternalTime">
|
||
<summary>
|
||
<para>The internal reference clock the Video.VideoPlayer observes to detect and correct drift.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoTimeSource">
|
||
<summary>
|
||
<para>[DEPRECATED] Time source followed by the Video.VideoPlayer when reading content.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoTimeSource.AudioDSPTimeSource">
|
||
<summary>
|
||
<para>The audio hardware clock.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoTimeSource.GameTimeSource">
|
||
<summary>
|
||
<para>The unscaled game time as defined by Time.realtimeSinceStartup.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="T:UnityEngine.Video.VideoTimeUpdateMode">
|
||
<summary>
|
||
<para>Defines the time source the VideoPlayer uses to update the timing of the video playback.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoTimeUpdateMode.DSPTime">
|
||
<summary>
|
||
<para>Update time based on the DSP (Digital Signal Processing) clock. Use this value to synchronize playback with Audio.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoTimeUpdateMode.GameTime">
|
||
<summary>
|
||
<para>Update the VideoPlayer's time based on Time.time.</para>
|
||
</summary>
|
||
</member>
|
||
<member name="F:UnityEngine.Video.VideoTimeUpdateMode.UnscaledGameTime">
|
||
<summary>
|
||
<para>Update the VideoPlayer's time based on Time.unscaledTime.</para>
|
||
</summary>
|
||
</member>
|
||
</members>
|
||
</doc>
|