Video Class

Language:

Contains the properties and methods to play video files, including those that contain audio.

Definition

Visual Basic NotInheritable Public Class Video
Inherits Object
Implements IDisposable

C# public sealed class Video : Object, IDisposable

C++ public ref class Video sealed : Object, IDisposable

JScript public final class Video extends Object implements IDisposable

Visual Basic	NotInheritable Public Class Video Inherits Object Implements IDisposable
C#	public sealed class Video : Object, IDisposable
C++	public ref class Video sealed : Object, IDisposable
JScript	public final class Video extends Object implements IDisposable

Members Table

The following table lists the members exposed by the object. Click a tab on the left to choose the type of member you want to view.

Events

Event Description

Disposing Occurs when the Dispose method is called or when the object is finalized and collected by the garbage collector of the Microsoft .NET common language runtime.

Ending Occurs when the playback is ending.

Pausing Occurs when the playback is pausing.

Starting Occurs when the playback is starting.

Stopping Occurs when the playback is stopping.

TextureReadyToRender Occurs when target texture is ready to render video playback.

Methods

Method Description

Dispose Immediately releases the unmanaged resources used by an object.

Finalize Called during garbage collection. If implemented, allows an object to free resources before it is destroyed by the garbage collector.

FromFile Creates a Video object from a file.

FromUrl Creates a Video object from a Uri object.

HideCursor Hides the cursor while playing video.

Open Loads a new file into the Video object.

Pause Pauses playback.

Play Starts playback.

raise_Disposing Raises the Video.Disposing event when called from within a derived class.

raise_Ending Raises the Video.Ending event when called from within a derived class.

raise_Pausing Raises the Video.Pausing event when called from within a derived class.

raise_Starting Raises the Video.Starting event when called from within a derived class.

raise_Stopping Raises the Video.Stopping event when called from within a derived class.

raise_TextureReadyToRender Raises the Video.TextureReadyToRender event when called from within a derived class.

RenderToTexture Enables the Video to trigger the TextureReadyToRender event to generate Texture objects for rendering video in Microsoft Direct3D.

SeekCurrentPosition Seeks to a specific playback postion.

SeekStopPosition Sets a new stop postion in playback.

ShowCursor Shows the cursor while playing video.

Stop Stops playback.

StopWhenReady Stops playback when the Video object is ready.

Video Initializes a new instance of the object.

Properties

Property Description

Audio Retrieves the Audio object the video is using for audio playback.

AverageTimePerFrame Retrieves the average time per frame during playback.

Caption Retrieves and sets the caption of the Form playing the video.

CurrentPosition Retrieves and sets the current position of playback.

DefaultSize Retrieves the default size of the video for playback.

Disposed Retrieves a value that is true if the object is disposed; otherwise the value is false.

Duration Retrieves the length, in seconds, of the video file.

Fullscreen Retrieves and sets whether the video plays back in fullscreen mode.

IsCursorHidden Retrieves whether the cursor is hidden for the video.

MaximumIdealSize Retrieves the maximum ideal size of the video for playback.

MinimumIdealSize Retrieves the minimum ideal size of the video for playback.

Owner Retrieves or sets the Control where the video will be played.

Paused Retrieves whether playback is currently paused.

Playing Retrieves whether playback is currently playing.

SeekingCaps Retrieves the seeking capabilities of playback.

Size Retrieves and sets the size of the video for playback.

State Retrieves the current state of playback.

Stopped Retrieves whether playback is currently stopped.

StopPosition Retrieves the position where playback stopped.

Event	Description
Disposing	Occurs when the Dispose method is called or when the object is finalized and collected by the garbage collector of the Microsoft .NET common language runtime.
Ending	Occurs when the playback is ending.
Pausing	Occurs when the playback is pausing.
Starting	Occurs when the playback is starting.
Stopping	Occurs when the playback is stopping.
TextureReadyToRender	Occurs when target texture is ready to render video playback.

Method	Description
Dispose	Immediately releases the unmanaged resources used by an object.
Finalize	Called during garbage collection. If implemented, allows an object to free resources before it is destroyed by the garbage collector.
FromFile	Creates a Video object from a file.
FromUrl	Creates a Video object from a Uri object.
HideCursor	Hides the cursor while playing video.
Open	Loads a new file into the Video object.
Pause	Pauses playback.
Play	Starts playback.
raise_Disposing	Raises the Video.Disposing event when called from within a derived class.
raise_Ending	Raises the Video.Ending event when called from within a derived class.
raise_Pausing	Raises the Video.Pausing event when called from within a derived class.
raise_Starting	Raises the Video.Starting event when called from within a derived class.
raise_Stopping	Raises the Video.Stopping event when called from within a derived class.
raise_TextureReadyToRender	Raises the Video.TextureReadyToRender event when called from within a derived class.
RenderToTexture	Enables the Video to trigger the TextureReadyToRender event to generate Texture objects for rendering video in Microsoft Direct3D.
SeekCurrentPosition	Seeks to a specific playback postion.
SeekStopPosition	Sets a new stop postion in playback.
ShowCursor	Shows the cursor while playing video.
Stop	Stops playback.
StopWhenReady	Stops playback when the Video object is ready.
Video	Initializes a new instance of the object.

Property	Description
Audio	Retrieves the Audio object the video is using for audio playback.
AverageTimePerFrame	Retrieves the average time per frame during playback.
Caption	Retrieves and sets the caption of the Form playing the video.
CurrentPosition	Retrieves and sets the current position of playback.
DefaultSize	Retrieves the default size of the video for playback.
Disposed	Retrieves a value that is true if the object is disposed; otherwise the value is false.
Duration	Retrieves the length, in seconds, of the video file.
Fullscreen	Retrieves and sets whether the video plays back in fullscreen mode.
IsCursorHidden	Retrieves whether the cursor is hidden for the video.
MaximumIdealSize	Retrieves the maximum ideal size of the video for playback.
MinimumIdealSize	Retrieves the minimum ideal size of the video for playback.
Owner	Retrieves or sets the Control where the video will be played.
Paused	Retrieves whether playback is currently paused.
Playing	Retrieves whether playback is currently playing.
SeekingCaps	Retrieves the seeking capabilities of playback.
Size	Retrieves and sets the size of the video for playback.
State	Retrieves the current state of playback.
Stopped	Retrieves whether playback is currently stopped.
StopPosition	Retrieves the position where playback stopped.

Inheritance Hierarchy

Object
Video

Class Information

Namespace Microsoft.DirectX.AudioVideoPlayback

Assembly Microsoft.DirectX.AudioVideoPlayback (microsoft.directx.audiovideoplayback.dll)

Strong Name Microsoft.DirectX.AudioVideoPlayback, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Namespace	Microsoft.DirectX.AudioVideoPlayback
Assembly	Microsoft.DirectX.AudioVideoPlayback (microsoft.directx.audiovideoplayback.dll)
Strong Name	Microsoft.DirectX.AudioVideoPlayback, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center