Class VLAVIPlayer.TVLAVIPlayer
From Mitov Wiki Doc
(Difference between revisions)
(Automated Syncronization with Documentation) |
(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''' | + | '''public ref class''' AVIPlayer : [[Class LPComponent.TLPComponent|Mitov.VideoLab.Component]] |
</code> | </code> | ||
== Summary == | == Summary == | ||
| Line 40: | Line 40: | ||
component [[Property VLAVIPlayer.TVLAVIPlayer.Enabled|Enabled]] property to True, and connect the OutputPut | component [[Property VLAVIPlayer.TVLAVIPlayer.Enabled|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:VLAVIPlayer_Preview.png]] | ||
== Properties == | == Properties == | ||
| Line 70: | Line 76: | ||
=== Public === | === Public === | ||
| − | *[[Method procedure VLAVIPlayer.TVLAVIPlayer.Pump()|procedure Pump()]] - Plays one buffer if enabled and [[Property VLAVIPlayer.TVLAVIPlayer.ClockSource|ClockSource]] is [[Enum item | + | *[[Method procedure VLAVIPlayer.TVLAVIPlayer.Pump()|procedure Pump()]] - Plays one buffer if enabled and [[Property VLAVIPlayer.TVLAVIPlayer.ClockSource|ClockSource]] is [[Enum item SLTypes.TSLClockSource.csExternal|csExternal]]. |
*[[Method procedure VLAVIPlayer.TVLAVIPlayer.Pause()|procedure Pause()]] - Pauses the playback. | *[[Method procedure VLAVIPlayer.TVLAVIPlayer.Pause()|procedure Pause()]] - Pauses the playback. | ||
*[[Method procedure VLAVIPlayer.TVLAVIPlayer.Resume()|procedure Resume()]] - Resumes paused playback. | *[[Method procedure VLAVIPlayer.TVLAVIPlayer.Resume()|procedure Resume()]] - Resumes paused playback. | ||
| Line 81: | Line 87: | ||
*[[Pin VLAVIPlayer.TVLAVIPlayer.OutputPin|OutputPin]] - The Video Output Pin of the player. | *[[Pin VLAVIPlayer.TVLAVIPlayer.OutputPin|OutputPin]] - The Video Output Pin of the player. | ||
*[[Pin VLAVIPlayer.TVLAVIPlayer.AudioOutputPin|AudioOutputPin]] - The Audio Output Pin of the player. | *[[Pin VLAVIPlayer.TVLAVIPlayer.AudioOutputPin|AudioOutputPin]] - The Audio Output Pin of the player. | ||
| − | |||
*[[Pin VLAVIPlayer.TVLAVIPlayer.ProgressPin|ProgressPin]] - The Play Progress Pin. | *[[Pin VLAVIPlayer.TVLAVIPlayer.ProgressPin|ProgressPin]] - The Play Progress Pin. | ||
| − | |||
| − | |||
*[[Pin VLAVIPlayer.TVLAVIPlayer.ClockPin|ClockPin]] - The external clock pin for the player. | *[[Pin VLAVIPlayer.TVLAVIPlayer.ClockPin|ClockPin]] - The external clock pin for the player. | ||
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: VLAVIPlayer
Inherits: TLPComponent
Contents |
Syntax
Delphi:
type TVLAVIPlayer = class( TLPComponent )
C++ Builder:
class TVLAVIPlayer : public TLPComponent
Visual C++ (MFC):
class CTVLAVIPlayer : public CTLPComponent
C# (.NET):
public ref class AVIPlayer : Mitov.VideoLab.Component
Summary
Plays AVI Video files.
Description
Use this component to play AVI Video files.
To play an AVI file, place the component on a form, set the FileName with the name of an existing AVI file, set the component Enabled property to True, and connect the OutputPut pin to the InputPin of an TVLImageDisplay.
Diagram:
Properties
Published
- FileName - Name of the file to be Played.
- RestartOnNewFile - Send Stop/Start notification when switching files.
- PumpPriority - Specifies the priority of the component as a pump.
- Enabled - Enables/Disables the player.
- Paused - Pauses or resumes the playback.
- AudioEnabled - Enables audio preview.
- Loop - Replayed again after the end.
- AudioBuffersAhead - Number of audio buffers pre-filled.
- ClockSource - Specifies the clock source - internal or external.
- PumpAudio - How the Audio data will be pumped.
- PlaySegment - A segment of the video file to be played.
- InitialFrame - Specifies the initial starting frame to be played.
Public
- Height - Returns the Height of the video frame.
- Width - Returns the Width of the video frame.
- FramePeriod - Returns the period between the video frames.
- DurationTime - The total time of the opened file.
- CurrentTime - Current time being played.
- FramesCount - Total number of frames.
- CurrentFrame - Current frame being played.
- Opened - Indicates if the file is opened.
Methods
Public
- procedure Pump() - Plays one buffer if enabled and ClockSource is csExternal.
- procedure Pause() - Pauses the playback.
- procedure Resume() - Resumes paused playback.
- procedure Start() - Starts the playback.
- procedure Stop() - Stops the playback.
- function Open() : Boolean - Opens the video file and prepares it for playing.
- procedure Close() - Closed the current video file.
Pins
- OutputPin - The Video Output Pin of the player.
- AudioOutputPin - The Audio Output Pin of the player.
- ProgressPin - The Play Progress Pin.
- ClockPin - The external clock pin for the player.
Events
- OnProgress - Player progress notification event.
- OnStop - Occurs when the playback stops.
- OnCaptionText - Occurs every time a closed caption text is extracted from the video.
- OnError - Occurs on video file error.
