←Select platform
In This Topic ▼

ConvertCtrl Class Members

Summary

The following tables list the members exposed by ConvertCtrl.

Public Constructors

Name Description
Public Constructor ConvertCtrl The ConvertCtrl control object constructor.

Public Methods

Name Description
Public Method CanSaveObjectSettings Determines whether the specified settings can be saved.
Public Method CloseLogFile Stops the logging of a conversion operation and closes the log file.
Public Method EditGraph Registers the current graph and runs the DirectShow GraphEdit utility.
Public Method EstimateOutputBitRate Gets the estimated conversion output bit rate, in bits per second.
Public Method EstimateOutputSize Gets the estimated conversion output size for the specified duration, in bytes.
Public Method GetClosedCaptioningTargetFile Retrieves the filename and flags set using SetClosedCaptioningTargetFile.
Public Method GetPreferredFilter Retrieves the preferred filter's Display Name set using the SetPreferredFilter method.
Public Method GetSelectedSourceStream Gets the index of the selected stream of type streamType.
Public Method GetSourceStreamCount Gets the number of elementary streams
Public Method GetSubObject Gets the specified graph sub-object.
Public Method HasDialog Checks whether the specified property dialog is available.
Public Method LoadSettingsFromFile Loads some or all of the convert object settings from a file.
Public Method LoadSettingsFromStream Loads some or all of the convert object settings from a stream.
Public Method OpenLogFile Opens a log file for convert control operation details.
Public Method PauseConvert Pauses the conversion process.
Public Method ResetSource Resets the media source.
Public Method ResetTarget Resets the media target.
Public Method RunConvert Runs a paused conversion process.
Public Method SaveSettingsToFile Saves some or all of the convert object settings to a file.
Public Method SaveSettingsToStream Saves some or all of the convert object settings to a stream.
Public Method SaveStillBitmap Saves a snapshot from the running stream to a file as a bitmap.
Public Method SetClosedCaptioningTargetFile Sets the filename and options to save closed captioning data as SRT or TEXT format files.
Public Method SetPreferredFilter Sets a preferred filter (decoder or demultiplexer)
Public Method SetSelectedSourceStream Indicates which stream of type streamType should be selected (rendered).
Public Method SetVideoWindowPos Sets the position and size of the video window in pixels.
Public Method ShowDialog Shows the specified property dialog.
Public Method StartConvert Starts converting data.
Public Method StopConvert Stops converting data.
Public Method ToggleFullScreenMode Switched the state of the full screen mode.

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 AllowedStreams Gets or sets which streams can be converted.
Public Property AudioCompressors Gets the registered audio compressors collection object.
Public Property AudioProcessors Gets the registered audio processors collection object.
Public Property ConvertError Gets the last conversion error code.
Public Property CurrentSourceProgram Gets or sets the number of the current program for the media file.
Public Property Duration Gets the duration of the media, in seconds.
Public Property DvdController Gets the DVDControl object used to control DVD playback when a DVD is loaded.
Public Property DVDecoderResolution Gets or sets a DVResolution enumeration value representing the current DV Decoder resolution.
Public Property EnableStillCapture Gets the value indicating whether still images can be captured during conversion.
Public Property ForceNoRecompressionPreview Gets or sets a value that indicates whether to enable or disable forcing the preview to be active when converting with No Recompression.
Public Property FullScreenMode Gets or sets the video renderer full-screen mode state.
Public Property IndexMode Gets or sets the index mode enabled state.
Public Property InterleaveMode Gets or sets the current interleave mode used when writing the target file.
Public Property PercentComplete Gets the current conversion completion percentage.
Public Property PercentCompleteScalar Gets or sets the scalar value by which to divide the current conversion completion percentage.
Public Property PreferredMPEG2Splitter Gets or sets the preferred MPEG2 splitter display name.
Public Property PreferredVideoRenderer Gets or sets the preferred VideoRendererType object.
Public Property Preview Gets or sets the Convert control's preview state.
Public Property PreviewVisible Gets or sets the preview visible state.
Public Property RenderedStreams Gets the streams that have been rendered.
Public Property SelectedAudioProcessors Gets the selected audio processor collection object.
Public Property SelectedVideoProcessors Gets the selected video processor collection object.
Public Property SelectionEnd Gets or sets the current selection end position in seconds.
Public Property SelectionEndModifier Offers a way to adjust the end selection point to fall on a key frame.
Public Property SelectionStart Gets or sets the current selection start position in seconds.
Public Property SelectionStartModifier Offers a way to adjust the start selection point to fall on a key frame.
Public Property SourceAudioFOURCC Gets the FOURCC format id of the source audio.
Public Property SourceAudioType Gets a string that represents the GUID of the source audio type.
Public Property SourceFile Gets or sets the media source filename, URL or UDP address.
Public Property SourceObject Gets or sets the media source object.
Public Property SourceProgramCount Gets the number of programs.
Public Property SourceStream Gets or sets the media source stream.
Public Property SourceType Gets the media source type.
Public Property SourceVideoFOURCC Gets the FOURCC format id of the source video format.
Public Property SourceVideoType Gets a string that represents the GUID of the source video type.
Public Property State Gets the convert control current state.
Public Property StillCaptureLimit Gets or sets the time limit for capturing a still image, in milliseconds.
Public Property TargetDevices Gets the target device collection object.
Public Property TargetFile Gets or sets the media target filename.
Public Property TargetFormat Gets or sets the media target file format.
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 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 UnrenderedStreams Gets the streams that have not been rendered.
Public Property UseDVDSource Gets or sets a value that indicates whether the object will use the DVD Source object when attempting to convert a DVD image (optional).
Public Property UsingDVDecoder Gets the value indicating whether the DV Decoder is being used.
Public Property VideoCompressors Gets the registered video compressors collection object.
Public Property VideoHeight Gets the current video height in pixels.
Public Property VideoProcessors Gets the registered video processors collection object.
Public Property VideoWidth Gets the current video width in pixels.
Public Property VideoWindow Gets the handle to the current video window.
Public Property VideoWindowHeight Gets the height of the video window in pixels.
Public Property VideoWindowLeft Gets the left position of the video window in pixels.
Public Property VideoWindowSizeMode Gets or sets the current video window size mode.
Public Property VideoWindowTop Gets the top position of the video window in pixels.
Public Property VideoWindowWidth Gets the width of the video window in pixels.
Public Property Window Gets or sets the handle to the convert control window.
Public Property WMCertificate Gets or sets the user assigned windows media certificate.
Public Property WMProfile Gets or sets the WMProfile object associated with the convert 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 a conversion operation was successfully 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 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 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 conversion operation to notify percentage completed.
Public Event Resize Occurs when the control is resized.
Public Event Started Occurs when a conversion operation has started.
Public Event UserAbort Occurs when a conversion operation has been stopped programmatically.

See Also

Reference

ConvertCtrl Class

Leadtools.Multimedia Namespace

Help Version 21.0.2021.7.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2021 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-2021 LEAD Technologies, Inc. All Rights Reserved.