←Select platform

CaptureCtrl Class Members

Summary

The following tables list the members exposed by CaptureCtrl.

Public Constructors

Name Description
Public Constructor CaptureCtrl Constructs a new CaptureCtrl control object.

Public Methods

Name Description
Public Method AllocTarget Pre-allocates the capture target to the specified size.
Public Method CanSaveObjectSettings Determines whether the specified settings can be saved.
Public Method CaptureFrame Captures a single frame during a CaptureMode.ManualFrames mode capture.
Public Method CaptureHDIB Captures a device independent bitmap.
Public Method CaptureImage Captures a video image to a System.Drawing.Image object.
Public Method CopyTarget Copies the valid media data from the target to the specified file.
Public Method EditGraph Registers the current graph and runs the DirectShow GraphEdit utility.
Public Method EnterEdit Enters editing mode by preventing the capture object from rebuilding the graph while devices are being selected.
Public Method EstimateOutputBitRate Gets the estimated capture output bit rate, in bits per second.
Public Method EstimateOutputSize Gets the estimated capturing output size for the specified duration, in bytes.
Public Method GetPreferredFilter Retrieves the preferred filter's Display Name set using the SetPreferredFilter method.
Public Method GetStillHDIB Gets a device independent bitmap (DIB) during a CaptureMode.Still capture.
Public Method GetStillImage Gets a System.Drawing.Image object during a CaptureMode.Still capture.
Public Method GetSubObject Gets the specified graph sub-object.
Public Method HasDialog Checks whether the specified property dialog is available.
Public Method IsModeAvailable Specifies whether the specified capture mode is available.
Public Method IsPreviewTapSupported Determines whether a specific preview tap for the preview source is available.
Public Method LeaveEdit Leaves editing mode.
Public Method LoadSettingsFromFile Loads settings from a file.
Public Method LoadSettingsFromStream Loads settings from a stream.
Public Method PauseCapture Pauses the capture control.
Public Method ReadyCapture Prepares the capture graph for running.
Public Method ResetTarget Resets the media target.
Public Method RunCapture Runs the capture graph.
Public Method SaveSettingsToFile Saves some or all of the capture object settings to a file. SaveSettingsToFile provides a convenient mechanism to save settings that can be retrieved at a later time.
Public Method SaveSettingsToStream Saves some or all of the capture object settings to a stream.
Public Method SaveStillBitmap Saves a snapshot from the running stream to a file as a bitmap.
Public Method SaveStillDIB Saves a snapshot from the running stream to a file as a device-independent bitmap(DIB).
Public Method SetPreferredFilter Sets a preferred filter (decoder or demultiplexer).
Public Method SetVideoWindowPos Sets the position and size of the video window.
Public Method ShowDialog Shows a specified property dialog.
Public Method StartCapture Starts capturing data.
Public Method StopCapture Stops capturing data.
Public Method ToggleClosedCaptioning Switches the state of the close captioning mode on or off.
Public Method ToggleFullScreenMode Switches the state of the full screen mode on or off.
Public Method TogglePreview Switches the state of the preview mode on or off.

Protected Methods

Name Description
Protected Method AttachInterfaces Internal method to attach interfaces to the underlying control object.
Protected Method CreateSink Internal method to create the event sink for the underlying control object.
Protected Method DetachSink Internal method to detach the event sink for the underlying control object.
Protected Method Dispose Releases internal control object and related object references.

Public Properties

Name Description
Public Property AnalogVideoDecoder Gets the AnalogVideoDecoder object that contains information about the analog-to-digital conversion process in a video capture filter.
Public Property Appearance Gets or sets a value determining the appearance of the control.
Public Property AudioBufferSize Gets or sets the audio capture buffer size, in seconds.
Public Property AudioCaptureFormats Gets the AudioFormats object that contains all the audio formats available for the current capture device.
Public Property AudioCompressors Gets the registered audio compressor collection object.
Public Property AudioDevices Gets the audio device collection object.
Public Property AudioInputs Gets an AudioInputs object reference to the audio inputs collection.
Public Property AudioProcessors Gets the registered audio processor collection object.
Public Property AudioRenderers Gets the registered audio renderer collection object.
Public Property AutoSize Gets or sets a value indicating whether the control is automatically resized.
Public Property AverageFrameSize Gets the average size of the frames that have been captured.
Public Property BackColor Gets or sets the background color for the control.
Public Property Balance Gets or sets the balance value of the audio stream for the preview output.
Public Property BorderStyle Gets or sets the border style of the control.
Public Property CameraControl Gets the camera control object exposed by the video input device.
Public Property CaptureStillDelay Gets or sets the time delay, in milliseconds, before capturing a DIB or a Picture.
Public Property CaptureTime Gets the amount of time the capture has been running, in seconds.
Public Property CaptureVCRControl Gets the video capture VCR control object.
Public Property ClosedCaptionAvailable Gets the closed captioning availability state.
Public Property ClosedCaptioning Gets a value that indicates whether closed captioning is enabled.
Public Property DeliveredFrames Gets the total number of frames that have been delivered during capture.
Public Property DroppedFrames Gets the total number of frames that have been dropped during capture.
Public Property DVDecoderResolution Gets or sets a DVResolution constant that represents the currently set DV Decoder resolution.
Public Property Enabled Gets or sets a value indicating whether the control can respond to user interaction.
Public Property FrameDelay Gets or sets the auto frames capture mode frame delay in seconds.
Public Property FrameRate Gets or sets the user defined frame rate in frames per second.
Public Property FullScreenMode Gets the video renderer full-screen mode state.
Public Property IndexMode Gets or sets the enabled state for WMV stream capture time indexing.
Public Property InterleaveMode Gets or sets the current interleave mode when writing the target file.
Public Property MasterStream Gets or sets the master stream that other streams must synchronize to after the file is written.
Public Property Mode Gets the current capture mode.
Public Property Mute Gets or sets the audio stream mute state for the preview output.
Public Property PreferredVideoRenderer Gets or sets the preferred VideoRendererType object.
Public Property Preview Gets or sets the preview enabled state.
Public Property PreviewAudioProcessors Gets the selected preview audio processor collection object.
Public Property PreviewingClosedCaption Gets or sets a value that indicates whether closed captioning is previewed.
Public Property PreviewSource Gets or sets the preview source setting.
Public Property PreviewTap Gets or sets the tap location from which the preview output originates.
Public Property PreviewVideoProcessors Gets the selected preview video processor collection object.
Public Property ScaleHeight Gets or sets the height of the client area of the control.
Public Property ScaleLeft Specifies the X coordinate of the origin in a custom coordinate system for the client area.
Public Property ScaleMode Specifies the unit of measure for the control.
Public Property ScaleTop Specifies the Y coordinate of the origin in a custom coordinate system for the client area.
Public Property ScaleWidth Specifies the width of the client area of the control.
Public Property SelectedAudioProcessors Gets the selected audio processor collection object.
Public Property SelectedVideoProcessors Gets the selected video processor collection object.
Public Property ShowDialogPreview Gets or sets the option to continue to display the preview during a call to the ShowDialog method.
Public Property State Gets the current state of the capture control.
Public Property StillTap Gets or sets the a value that indicates where in the stream still images are tapped from.
Public Property TargetDevices Gets or sets the target device collection object.
Public Property TargetFile Gets or sets the filename for the media target file.
Public Property TargetFormat Gets or sets the target format for the media file.
Public Property TargetFormats Gets the target format collection object.
Public Property TargetObject Gets or sets the media target object.
Public Property TargetStream Gets or sets a reference to the media target stream.
Public Property TargetType Gets and sets the media target type.
Public Property TargetVCRControl Gets the target VCR control object.
Public Property TimeLimit Gets or sets the capture time limit in seconds.
Public Property TVTuner Gets a TVTuner object.
Public Property UseFrameRate Gets or sets the option to use the frame rate specified in the FrameRate property.
Public Property UseTimeLimit Gets or sets the option to use the time limit specified by the TimeLimit property.
Public Property UseVideoDeviceAudio Gets or sets the option to use the audio source in the current video device.
Public Property UsingDVDecoder Gets a value that indicates whether the state of the DV Decoder is in use.
Public Property VideoCaptureFormats Gets the VideoCaptureFormats object that contains all the video formats available for the current capture device.
Public Property VideoCaptureSizes Gets the video capture sizes collection object.
Public Property VideoCaptureStreamType Gets the capture stream type.
Public Property VideoCaptureSubTypes Gets the video device's capture subtypes collection object.
Public Property VideoCompressors Gets the registered video compressor collection object.
Public Property VideoDevices Gets the video device collection object.
Public Property VideoHeight Gets the current video height.
Public Property VideoInputs Gets the video input collection object.
Public Property VideoProcAmp Gets a VideoProcAmp object which enables the user to adjust the qualities of an incoming video signal.
Public Property VideoProcessors Gets the registered video processor collection object.
Public Property VideoWidth Gets the current video width.
Public Property VideoWindow Gets the handle to the current video window.
Public Property VideoWindowHeight Gets the height of the video window.
Public Property VideoWindowLeft Gets the left position of the video window.
Public Property VideoWindowSizeMode Gets or sets the size mode for the current video window.
Public Property VideoWindowTop Gets the top position of the video window.
Public Property VideoWindowWidth Gets the width of the video window.
Public Property Volume Gets or sets the volume level of the audio stream for the preview output.
Public Property Window Gets the handle to the control's window.
Public Property WMCertificate Gets or sets the user assigned windows media certificate.
Public Property WMProfile Gets or sets the WMProfile object associated with this capture object.
Public Property WMScripter Provides a way to get the WMScript object.

Public Events

Name Description
Public Event Click Occurs when the control is clicked.
Public Event Complete Occurs when the operation in progress has completed.
Public Event DoubleClick Occurs when the control is double-clicked.
Public Event ErrorAbort Occurs when an error has caused an operation abort.
Public Event KeyDown Occurs when the control has detected a KeyDown event.
Public Event KeyPress Occurs when the control has detected a KeyPress event.
Public Event KeyUp Occurs when the control has detected a KeyUp event.
Public Event MediaEvent Occurs when the control has detected a media event.
Public Event MouseDown Occurs when the mouse pointer is over the control and a mouse button is pressed.
Public Event MouseEnter Occurs when the mouse pointer enters the control.
Public Event MouseHover Occurs when the mouse pointer rests on the control.
Public Event MouseLeave Occurs when the mouse pointer leaves the control.
Public Event MouseMove Occurs when the mouse pointer is moved over the control.
Public Event MouseUp Occurs when the mouse pointer is over the control and a mouse button is released.
Public Event Progress Occurs periodically during a capture operation to notify of capture progress.
Public Event Resize Occurs when the control is resized.
Public Event RestartApplication Occurs when settings changes on the capture device requires an application restart.
Public Event Started Occurs when a capture operation has started.

See Also

CaptureCtrl Class

Leadtools.Multimedia Namespace

Help Version 22.0.2022.12.7
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Multimedia Assembly
Introduction
Getting Started
Namespaces
Leadtools.Multimedia Namespace
Leadtools.Multimedia.Common Namespace
Assemblies
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.