Class VLAVIPlayer.TVLAVIPlayer

Revision as of 00:15, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) ← Older edit

Revision as of 02:44, 11 June 2013 (view source) David Alm (Talk | contribs) (Automated Syncronization with Documentation) Newer edit →

---

Revision as of 02:44, 11 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 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

Syntax

Delphi:

type TVLAVIPlayer = class( TLPComponent )

C++ Builder:

class TVLAVIPlayer : public TLPComponent

Visual C++ (MFC):

class CTVLAVIPlayer : public CTLPComponent

C# (.NET):

public ref class TVLAVIPlayer : 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.