←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 CaptureDIB Captures a device independent bitmap.
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 EnterEdit Enters editing mode by preventing the capture object from rebuilding the media session 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, in bytes, for the specified duration.
Public Method GetStillDIB Gets a device-independent bitmap (HDIB).
Public Method GetStillHDIB Gets a device independent bitmap during a CaptureMode.Still capture.
Public Method GetStillImage Gets a System.Drawing.Image object during a CaptureMode.Still capture.
Public Method HasDialog Checks if the specified property dialog is available.
Public Method IsModeAvailable Specifies whether the specified capture mode is available.
Public Method LeaveEdit Leaves editing mode.
Public Method PauseCapture Pauses the capture control.
Public Method ReadyCapture Prepares the capture media session for running.
Public Method ResetTarget Resets the media target.
Public Method RunCapture Runs the capture session.
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 ShowDialog Shows a specified property dialog.
Public Method StartCapture Starts capturing data.
Public Method StopCapture Stops capturing data.
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 Appearance Gets or sets a value determining the appearance of the control.
Public Property AudioCaptureFormats Gets the AudioFormats object containing all the audio formats available for the current capture device.
Public Property AudioDevices Gets the audio device collection object.
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.
Public Property BorderStyle Gets or sets the border style of the control.
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 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 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 Mode Gets the current capture mode.
Public Property Mute Gets or sets the audio stream mute state.
Public Property Preview Gets or sets the preview enabled state.
Public Property PreviewSource Gets or sets the preview source setting.
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 capture control's current state.
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 TargetType Gets and sets the media target type.
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 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 VideoCaptureSubTypes Gets the video device's capture subtypes 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 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.
Public Property Window Gets the handle to the control's window.

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 to 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 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 Started Occurs when a capture operation has started.

See Also

CaptureCtrl Class

Leadtools.MediaFoundation Namespace

Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2025 Apryse Sofware Corp. All Rights Reserved.

Leadtools.MediaFoundation Assembly
Introduction
Getting Started
Namespaces
Leadtools.MediaFoundation Namespace
Leadtools.MediaFoundation.Common Namespace
Assemblies
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2025 Apryse Sofware Corp. All Rights Reserved.