Class VLDSVideoPlayer.TVLDSVideoPlayer

Revision as of 00:18, 22 November 2011 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation)		Latest revision as of 00:30, 26 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation)
(6 intermediate revisions by one user not shown)
Line 28:		Line 28:
	=== C# (.NET): ===		=== C# (.NET): ===
	<code>		<code>
−	'''public ref class''' TVLDSVideoPlayer : [[Class MLDSPlayer.TMLDSPlayer|Mitov.VideoLab.DSPlayer]]	+	'''public ref class''' DSVideoPlayer : [[Class MLDSPlayer.TMLDSPlayer|Mitov.VideoLab.DSPlayer]]
	</code>		</code>
	== Summary ==		== Summary ==
Line 34:		Line 34:
	== Description ==		== Description ==
−	<b><span style="color:red">Requires DirectShow 8.1 or higher.</span></b>	+	<span style="color:red"><b>Requires DirectShow 8.1 or higher.</b></span>
−	<b><span style="color:red">If you don't want to use DirectShow use the	+	<span style="color:red"><b>If you don't want to use DirectShow use the
−	[[Class VLAVIPlayer.TVLAVIPlayer|TVLAVIPlayer]] component instead.</span></b>	+	[[Class VLAVIPlayer.TVLAVIPlayer|TVLAVIPlayer]] component instead.</b></span>
	This DirectShow compionent can be used to play Video files.		This DirectShow compionent can be used to play Video files.
	To play an Video file, place the component on a form, set the		To play an Video file, place the component on a form, set the
−	FileName with the name of an existing Video file, set the	+	[[Property VLDSVideoPlayer.TVLDSVideoPlayer.FileName|FileName]] with the name of an existing Video file, set the
	component Enabled property to True, and connect the OutputPut		component Enabled property to True, and connect the OutputPut
	pin to the InputPin of an [[Class VLImageDisplay.TVLImageDisplay|TVLImageDisplay]].		pin to the InputPin of an [[Class VLImageDisplay.TVLImageDisplay|TVLImageDisplay]].
		+
		+
		+
		+	<b>Diagram:</b>
		+
		+	[[Image:VLDSVideoPlayer_Preview.png]]
	== Properties ==		== Properties ==
Line 52:		Line 58:
	*[[Property VLDSVideoPlayer.TVLDSVideoPlayer.AudioPreview|AudioPreview]] - Enables Audio Preview.		*[[Property VLDSVideoPlayer.TVLDSVideoPlayer.AudioPreview|AudioPreview]] - Enables Audio Preview.
	*[[Property VLDSVideoPlayer.TVLDSVideoPlayer.ExtractRawVideo|ExtractRawVideo]] - Specifies if the player should try to extract raw/uncompressed video.		*[[Property VLDSVideoPlayer.TVLDSVideoPlayer.ExtractRawVideo|ExtractRawVideo]] - Specifies if the player should try to extract raw/uncompressed video.
		+	*[[Property VLDSVideoPlayer.TVLDSVideoPlayer.TimeStamps|TimeStamps]] - Timestamp settings.
		+	*[[Property VLDSVideoPlayer.TVLDSVideoPlayer.FileName|FileName]]
	=== Public ===		=== Public ===
Line 81:		Line 89:
	*[[Pin VLDSVideoPlayer.TVLDSVideoPlayer.RawOutputPin|RawOutputPin]] - The Raw uncompressed Video Output Pin of the player.		*[[Pin VLDSVideoPlayer.TVLDSVideoPlayer.RawOutputPin|RawOutputPin]] - The Raw uncompressed Video Output Pin of the player.
	*[[Pin VLDSVideoPlayer.TVLDSVideoPlayer.AudioOutputPin|AudioOutputPin]] - The Audio Output Pin of the player.		*[[Pin VLDSVideoPlayer.TVLDSVideoPlayer.AudioOutputPin|AudioOutputPin]] - The Audio Output Pin of the player.
−	*[[Pin VLDSVideoPlayer.TVLDSVideoPlayer.RawAudioOutputPin|RawAudioOutputPin]] - The Raw uncompressed Audio Output Pin of the player.
	== Events ==		== Events ==
	*[[Event VLDSVideoPlayer.TVLDSVideoPlayer.OnReset|OnReset]] - Occurs when the playback reaches the end of the video in Loop pmode.		*[[Event VLDSVideoPlayer.TVLDSVideoPlayer.OnReset|OnReset]] - Occurs when the playback reaches the end of the video in Loop pmode.
−	*[[Event VLDSVideoPlayer.TVLDSVideoPlayer.OnCaptionText|OnCaptionText]] - Occurs every time a closed caption text is extracted from the video.
	== From [[Class MLDSPlayer.TMLDSPlayer|TMLDSPlayer]] ==		== From [[Class MLDSPlayer.TMLDSPlayer|TMLDSPlayer]] ==
Line 105:		Line 111:
	=== Public ===		=== Public ===
−	*[[Property MLDSPlayer.TMLDSPlayer.WaveFormat|WaveFormat]]
	*[[Property MLDSPlayer.TMLDSPlayer.Opened|Opened]]		*[[Property MLDSPlayer.TMLDSPlayer.Opened|Opened]]
		+	*[[Property MLDSPlayer.TMLDSPlayer.WaveFormat|WaveFormat]]
	== Methods ==		== Methods ==
Line 120:		Line 126:
	== Pins ==		== Pins ==
−	*[[Pin MLDSPlayer.TMLDSPlayer.EnablePin|EnablePin]]
−	*[[Pin MLDSPlayer.TMLDSPlayer.FileNamePin|FileNamePin]]
	*[[Pin MLDSPlayer.TMLDSPlayer.ProgressPin|ProgressPin]]		*[[Pin MLDSPlayer.TMLDSPlayer.ProgressPin|ProgressPin]]
−	*[[Pin MLDSPlayer.TMLDSPlayer.PausePin|PausePin]]
	*[[Pin MLDSPlayer.TMLDSPlayer.ClockPin|ClockPin]]		*[[Pin MLDSPlayer.TMLDSPlayer.ClockPin|ClockPin]]
	*[[Pin MLDSPlayer.TMLDSPlayer.TextOutputPin|TextOutputPin]]		*[[Pin MLDSPlayer.TMLDSPlayer.TextOutputPin|TextOutputPin]]
		+	*[[Pin MLDSPlayer.TMLDSPlayer.RawAudioOutputPin|RawAudioOutputPin]]
	== Events ==		== Events ==
	*[[Event MLDSPlayer.TMLDSPlayer.OnProgress|OnProgress]]		*[[Event MLDSPlayer.TMLDSPlayer.OnProgress|OnProgress]]
	*[[Event MLDSPlayer.TMLDSPlayer.OnStop|OnStop]]		*[[Event MLDSPlayer.TMLDSPlayer.OnStop|OnStop]]
		+	*[[Event MLDSPlayer.TMLDSPlayer.OnCaptionText|OnCaptionText]]
	[[Category:Components]][[Category:Classes]]		[[Category:Components]][[Category:Classes]]

---

Latest revision as of 00:30, 26 June 2013

This is a Beta Read Only version of this page. Please review and send recommendations to mitov@mitov.com. We will enable the editing as soon as we are happy with the overall Wiki site.

Package: VideoLabBasicPkg

Unit: VLDSVideoPlayer

Inherits: TMLDSPlayer

Contents 1 Syntax 1.1 Delphi: 1.2 C++ Builder: 1.3 Visual C++ (MFC): 1.4 C# (.NET): 2 Summary 3 Description 4 Properties 4.1 Published 4.2 Public 5 Methods 5.1 Public 6 Pins 7 Events 8 From TMLDSPlayer 9 Properties 9.1 Published 9.2 Public 10 Methods 10.1 Public 11 Pins 12 Events

Syntax

Delphi:

type TVLDSVideoPlayer = class( TMLDSPlayer )

C++ Builder:

class TVLDSVideoPlayer : public TMLDSPlayer

Visual C++ (MFC):

class CTVLDSVideoPlayer : public CTMLDSPlayer

C# (.NET):

public ref class DSVideoPlayer : Mitov.VideoLab.DSPlayer

Summary

Plays Video files using DirectShow.

Description

Requires DirectShow 8.1 or higher.

If you don't want to use DirectShow use the TVLAVIPlayer component instead.

This DirectShow compionent can be used to play Video files.

To play an Video file, place the component on a form, set the FileName with the name of an existing Video file, set the component Enabled property to True, and connect the OutputPut pin to the InputPin of an TVLImageDisplay.

Diagram:

Properties

Published

• VideoPreview - Controls the video preview.
• AudioPreview - Enables Audio Preview.
• ExtractRawVideo - Specifies if the player should try to extract raw/uncompressed video.
• TimeStamps - Timestamp settings.
• FileName

Public

• AspectRatio - Returns information about the video aspect ratio.
• Interlacing - Returns information about the video interlacing.
• Height - The Height of the video frame.
• Width - The Width of the video frame.
• FramePeriod - Returns the period between the video frames.
• Capabilities - Returns the set of available capabilities.
• CanStepFrames - The number of frames the video can step forward at a time
• AudioFilterName - Returns the audio codec filter name.
• AudioCodecName - Returns the audio codec name.
• AudioCodec - The FourCC code of the audio codec used to encode the file.
• VideoFilterName - Returns the video codec filter name.
• VideoCodecName - Returns the video codec name.
• VideoCodec - The FourCC code of the video codec used to encode the file.
• DurationTime - The total time of the opened file.
• CurrentTime - Current time being played.
• CurrentFrame - Current frame being played.
• FramesCount - Total number of frames.

Methods

Public

• function FrameStep(Frames : Cardinal) : Boolean - Step number of frames. Parameters Frames : Number of frames to step forward.

Pins

• OutputPin - The Video Output Pin of the player.
• RawOutputPin - The Raw uncompressed Video Output Pin of the player.
• AudioOutputPin - The Audio Output Pin of the player.

Events

• OnReset - Occurs when the playback reaches the end of the video in Loop pmode.

From TMLDSPlayer

Properties

Published

• Graph
• Enabled
• Paused
• ClockSource
• PumpPriority
• Loop
• FileName
• RestartOnNewFile
• PlaybackRate
• PlaybackPrefill
• ExtractRawAudio

Public

• Opened
• WaveFormat

Methods

Public

• function Open() : Boolean
• procedure Close()
• procedure Start()
• procedure Stop()
• procedure Pause()
• procedure Resume()
• procedure Pump()

Pins

• ProgressPin
• ClockPin
• TextOutputPin
• RawAudioOutputPin

Events

• OnProgress
• OnStop
• OnCaptionText