Class VideoEditCore

VideoEditCore class. Main Video Edit SDK class that perform all real work.

Inheritance
object
VideoEditCore
Implements
Inherited Members
Namespace: VisioForge.Core.VideoEdit
Assembly: VisioForge.Core.dll
Syntax
public class VideoEditCore : IDisposable, IVideoEditCore, IMPVCVECore, INotifyPropertyChanged, IAsyncDisposable

Constructors

VideoEditCore(bool)

Initializes a new instance of the VideoEditCore class.

Declaration
public VideoEditCore(bool initialize = true)
Parameters
Type Name Description
bool initialize

if set to true [initialize].

VideoEditCore(IVideoView, bool)

Initializes a new instance of the VideoEditCore class.

Declaration
public VideoEditCore(IVideoView videoView, bool initialize = true)
Parameters
Type Name Description
IVideoView videoView

The video view.
bool initialize

if set to true [initialize].

Properties

Audio_Channel_Mapper

Gets or sets an audio channel mapper settings.

Declaration
public AudioChannelMapperSettings Audio_Channel_Mapper { get; set; }
Property Value
Type Description
AudioChannelMapperSettings

Audio_Effects_Enabled

Gets or sets a value indicating whether audio effects enabled.

Declaration
public bool Audio_Effects_Enabled { get; set; }
Property Value
Type Description
bool

Audio_Enhancer_Enabled

Gets or sets a value indicating whether audio enhancer enabled.

Declaration
public bool Audio_Enhancer_Enabled { get; set; }
Property Value
Type Description
bool

Audio_Preview_Enabled

Gets or sets a value indicating whether audio playback enabled during preview.

Declaration
public bool Audio_Preview_Enabled { get; set; }
Property Value
Type Description
bool

Audio_VUMeter_Enabled

Gets or sets a value indicating whether audio VU meter enabled.

Declaration
public bool Audio_VUMeter_Enabled { get; set; }
Property Value
Type Description
bool

Audio_VUMeter_Pro_Enabled

Gets or sets a value indicating whether audio VU meter Pro enabled.

Declaration
public bool Audio_VUMeter_Pro_Enabled { get; set; }
Property Value
Type Description
bool
Remarks

New VU-meter and other audio visualization.

Audio_VUMeter_Pro_Volume

Gets or sets a volume used by volume meter, in percents.

Declaration
[JsonIgnore]
public int Audio_VUMeter_Pro_Volume { get; set; }
Property Value
Type Description
int

Barcode_Reader_Enabled

Gets or sets a value indicating whether barcode detection is enabled.

Declaration
public bool Barcode_Reader_Enabled { get; set; }
Property Value
Type Description
bool

Barcode_Reader_Type

Gets or sets barcode type to detect.

Declaration
public BarcodeType Barcode_Reader_Type { get; set; }
Property Value
Type Description
BarcodeType

ChromaKey

Gets or sets chroma key settings.

Declaration
public ChromaKeySettings ChromaKey { get; set; }
Property Value
Type Description
ChromaKeySettings

ConsoleUsage

Gets or sets a value indicating whether console usage is enabled.

Declaration
public bool ConsoleUsage { get; set; }
Property Value
Type Description
bool

CustomRedist_Auto

Gets or sets a value indicating whether custom redist usage will be configured automatically. If your app folder (or x86/x64 subfolders) contains redist files SDK will use them.

Declaration
public bool CustomRedist_Auto { get; set; }
Property Value
Type Description
bool

CustomRedist_DisableDialog

Gets or sets a value indicating whether custom redist warning dialog disabled. During the start, SDK checking base redist state. If not redist available, SDK shows a dialog. Use this property to disable dialog.

Declaration
public bool CustomRedist_DisableDialog { get; set; }
Property Value
Type Description
bool

CustomRedist_Path

Gets or sets custom redist path, where placed all .ax files. Application folder will be used if value not set.

Declaration
public string CustomRedist_Path { get; set; }
Property Value
Type Description
string

Custom_Audio_Decoder

Gets or sets custom audio decoder.

Declaration
public string Custom_Audio_Decoder { get; set; }
Property Value
Type Description
string

Custom_Video_Decoder

Gets or sets custom video decoder.

Declaration
public string Custom_Video_Decoder { get; set; }
Property Value
Type Description
string

Debug_Dir

Gets or sets debug directory.

Declaration
public string Debug_Dir { get; set; }
Property Value
Type Description
string

Debug_DisableMessageDialogs

Gets or sets a value indicating whether message dialog will be shown in case of error if OnError event is not implemented.

Declaration
public bool Debug_DisableMessageDialogs { get; set; }
Property Value
Type Description
bool

Debug_Mode

Gets or sets a value indicating whether debug mode enabled.

Declaration
public bool Debug_Mode { get; set; }
Property Value
Type Description
bool

Debug_Telemetry

Gets or sets a value indicating whether sending telemetry enabled (only during debugging in Visual Studio).

Declaration
public bool Debug_Telemetry { get; set; }
Property Value
Type Description
bool
Remarks

Only anonymous data will be send.

Gets or sets capture timecode source.

Declaration
public DecklinkCaptureTimecodeSource Decklink_Input_Capture_Timecode_Source { get; set; }
Property Value
Type Description
DecklinkCaptureTimecodeSource

Gets or sets Decklink output settings.

Declaration
public DecklinkOutputSettings Decklink_Output { get; set; }
Property Value
Type Description
DecklinkOutputSettings

Dynamic_Reconnection

Gets or sets a value indicating whether dynamic reconnection enabled.

Declaration
public bool Dynamic_Reconnection { get; set; }
Property Value
Type Description
bool
Remarks

By default, the basic render engine loads every source before rendering a project. This can result in a long start-up time. With dynamic reconnection, sources are loaded only when needed. This can shorten the start-up time, but possibly interfere with smooth playback. Generally, the more source clips that a project uses, the more you might benefit from dynamic reconnection.

Loop

Gets or sets a value indicating whether loop during playback is enabled.

Declaration
public bool Loop { get; set; }
Property Value
Type Description
bool

Mode

Gets or sets editing mode.

Declaration
public VideoEditMode Mode { get; set; }
Property Value
Type Description
VideoEditMode

Motion_Detection

Gets or sets motion detection settings.

Declaration
public MotionDetectionSettings Motion_Detection { get; set; }
Property Value
Type Description
MotionDetectionSettings

Motion_DetectionEx

Gets or sets object detection settings.

Declaration
public MotionDetectionExSettings Motion_DetectionEx { get; set; }
Property Value
Type Description
MotionDetectionExSettings

Network_Streaming_Audio_Enabled

Gets or sets a value indicating whether audio stream for network streaming enabled.

Declaration
public bool Network_Streaming_Audio_Enabled { get; set; }
Property Value
Type Description
bool

Network_Streaming_Enabled

Gets or sets a value indicating whether network streaming enabled.

Declaration
public bool Network_Streaming_Enabled { get; set; }
Property Value
Type Description
bool

Network_Streaming_Format

Gets or sets network streaming format.

Declaration
public NetworkStreamingFormat Network_Streaming_Format { get; set; }
Property Value
Type Description
NetworkStreamingFormat

Network_Streaming_Network_Port

Gets or sets port number for network streaming.

Declaration
public int Network_Streaming_Network_Port { get; set; }
Property Value
Type Description
int

Network_Streaming_Output

Gets or sets network streaming output settings.

Declaration
public INetworkStreamingOutput Network_Streaming_Output { get; set; }
Property Value
Type Description
INetworkStreamingOutput

Network_Streaming_URL

Gets or sets client connection address. Contains computer name (or IP) and port number.

Declaration
public string Network_Streaming_URL { get; set; }
Property Value
Type Description
string

Network_Streaming_WMV_Maximum_Clients

Gets or sets maximum number of allowed clients.

Declaration
public int Network_Streaming_WMV_Maximum_Clients { get; set; }
Property Value
Type Description
int

Output_Filename

Gets or sets name of the output file for recording.

Declaration
public string Output_Filename { get; set; }
Property Value
Type Description
string

Output_Format

Gets or sets output file format.

Declaration
public IVideoEditBaseOutput Output_Format { get; set; }
Property Value
Type Description
IVideoEditBaseOutput

Start_DelayEnabled

Gets or sets a value indicating whether delayed start will be enabled. This feature can be used to start multiple SDK controls almost at the same time. If this property set to true use Start as usual to connect to required sources and build graph. At required time call StartDelayed to start capture/preview at almost 0 time, because all preparations is done already.

Declaration
public bool Start_DelayEnabled { get; set; }
Property Value
Type Description
bool

Tags

Gets or sets tag that will be written to output file.

Declaration
[JsonIgnore]
public MediaFileTags Tags { get; set; }
Property Value
Type Description
MediaFileTags

UseLibMediaInfo

Gets or sets a value indicating whether libMediaInfo will be used to get info from video files.

Declaration
public bool UseLibMediaInfo { get; set; }
Property Value
Type Description
bool

VideoHeight

Gets or sets video height.

Declaration
public int VideoHeight { get; set; }
Property Value
Type Description
int

VideoView

Gets or sets the video view.

Declaration
[JsonIgnore]
public IVideoView VideoView { get; set; }
Property Value
Type Description
IVideoView

VideoWidth

Gets or sets video width.

Declaration
public int VideoWidth { get; set; }
Property Value
Type Description
int

Video_Crop

Gets or sets video crop settings.

Declaration
public VideoCropSettings Video_Crop { get; set; }
Property Value
Type Description
VideoCropSettings

Video_Custom_Resizer_CLSID

Gets or sets custom resizer filter CLSID.

Declaration
public Guid Video_Custom_Resizer_CLSID { get; set; }
Property Value
Type Description
Guid
Remarks

http://msdn.microsoft.com/en-us/library/windows/desktop/dd377478(v=vs.85).aspx .

Video_Effects_AllowMultipleStreams

Gets or sets a value indicating whether video effects can use independent preview/output streams.

Declaration
public bool Video_Effects_AllowMultipleStreams { get; set; }
Property Value
Type Description
bool

Video_Effects_Enabled

Gets or sets a value indicating whether video effects (CPU) enabled.

Declaration
public bool Video_Effects_Enabled { get; set; }
Property Value
Type Description
bool

Video_Effects_GPU_Enabled

Gets or sets a value indicating whether video effects (GPU) enabled.

Declaration
public bool Video_Effects_GPU_Enabled { get; set; }
Property Value
Type Description
bool

Video_FrameRate

Gets or sets output frame rate.

Declaration
public VideoFrameRate Video_FrameRate { get; set; }
Property Value
Type Description
VideoFrameRate

Video_Preview_Enabled

Gets or sets a value indicating whether video preview is enabled.

Declaration
public bool Video_Preview_Enabled { get; set; }
Property Value
Type Description
bool

Video_Renderer

Gets or sets video renderer settings.

Declaration
public VideoRendererSettings Video_Renderer { get; set; }
Property Value
Type Description
VideoRendererSettings

Video_Resize

Gets or sets a value indicating whether resize is enabled.

Declaration
public bool Video_Resize { get; set; }
Property Value
Type Description
bool

Video_Resize_Height

Gets or sets new video height.

Declaration
public int Video_Resize_Height { get; set; }
Property Value
Type Description
int

Video_Resize_Width

Gets or sets new video width.

Declaration
public int Video_Resize_Width { get; set; }
Property Value
Type Description
int

Video_Rotation

Gets or sets video rotation mode.

Declaration
public RotateMode Video_Rotation { get; set; }
Property Value
Type Description
RotateMode

Video_Subtitles

Gets or sets video subtitles settings.

Declaration
public SubtitlesSettings Video_Subtitles { get; set; }
Property Value
Type Description
SubtitlesSettings

Virtual_Camera_Output_AlternativeAudioFilterName

Gets or sets the name of the Virtual Camera SDK output alternative audio filter. Filter can be in common or audio renderer category.

Declaration
public string Virtual_Camera_Output_AlternativeAudioFilterName { get; set; }
Property Value
Type Description
string

Virtual_Camera_Output_Enabled

Gets or sets a value indicating whether output to virtual video camera enabled.

Declaration
public bool Virtual_Camera_Output_Enabled { get; set; }
Property Value
Type Description
bool

Virtual_Camera_Output_LicenseKey

Gets or sets Virtual Camera SDK license key.

Declaration
public string Virtual_Camera_Output_LicenseKey { get; set; }
Property Value
Type Description
string

Methods

Audio_Codecs()

Gets the audio codecs list.

Declaration
public ObservableCollection<string> Audio_Codecs()
Returns
Type Description
ObservableCollection<string>

List<System.String>.

Audio_Effects_Add(int, AudioEffectType, string, bool, TimeSpan, TimeSpan)

Adds audio effect.

Declaration
public void Audio_Effects_Add(int streamIndex, AudioEffectType effectType, string name, bool enabled, TimeSpan startTime, TimeSpan stopTime)
Parameters
Type Name Description
int streamIndex

Stream index.
AudioEffectType effectType

Effect type.
string name

Name.
bool enabled

true if enabled, false if disabled.
TimeSpan startTime

Start time.
TimeSpan stopTime

Stop time.

Audio_Effects_Amplify(int, string, int, bool)

Sets parameters for the amplify effect.

Declaration
public void Audio_Effects_Amplify(int streamIndex, string name, int volume, bool separate)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
int volume

Sets the amplification for a channel. Default value is 10000, which means that no amplification occurs. A value of 20000 raises the amplification by 2. If separate is True, then every channel will be amplified by it's channel amplification value. If separate is False, then every channel is amplified with the value of channel 0.
bool separate

Enables or Disables separate amplification. If Enabled every channel will be amplified by it's own amplification value. If Disabled every channel will be amplified with the amplification value of channel 0.

Audio_Effects_BandPass(int, string, float, float, bool)

Sets the parameters for the Band Pass effect.

Declaration
public void Audio_Effects_BandPass(int streamIndex, string name, float cutOffHigh, float cutOffLow, bool separate)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
float cutOffHigh

Specifies the high cutoff frequency for a specific channel.
float cutOffLow

Specifies the low cutoff frequency for a specific channel.
bool separate

Enables or Disables separate cutoff. If Enabled every channel will be processed by it's own cutoff value. If disabled every channel will be processed with the cutoff value of channel 0.
Remarks

Filter to cutoff a certain Frequency Range. Each Channel can separate cutoff the Frequency range.

Audio_Effects_ChannelOrderEx(int, string, byte[,])

Sets parameters for the channel order effect.

Declaration
public void Audio_Effects_ChannelOrderEx(int streamIndex, string name, byte[,] orders)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
byte[,] orders

Specifies the order of the channels. 2xn array, each pair is byte x byte, first byte is target channel, second byte is source channel.

Audio_Effects_Clear(int)

Deletes all the inserted audio effects.

Declaration
public void Audio_Effects_Clear(int streamIndex)
Parameters
Type Name Description
int streamIndex

Stream index.

Audio_Effects_Count(int)

Gets the count of audio effects in use.

Declaration
public int Audio_Effects_Count(int streamIndex)
Parameters
Type Name Description
int streamIndex

Stream index.
Returns
Type Description
int

System.Int32.

Audio_Effects_DS_Chorus(int, string, float, float, float, float, DSChorusPhase, DSChorusWaveForm, float)

Sets the parameters for the DS Chorus effect.

Declaration
public void Audio_Effects_DS_Chorus(int streamIndex, string name, float delay, float depth, float feedback, float frequency, DSChorusPhase phase, DSChorusWaveForm waveformTriangle, float wetDryMix)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
float delay

Specifies the delay of the filter (0 - 20.0).
float depth

Specifies the depth of the filter (0 - 100.0).
float feedback

Specifies the feedback of the filter (-99.0 - 99.0).
float frequency

Specifies the frequency of the filter (0 - 10.0).
DSChorusPhase phase

Specifies the phase angle.
DSChorusWaveForm waveformTriangle

Specifies the waveform type of the filter.
float wetDryMix

Specifies the wet and dry mix (0 - 100.0).
Remarks

Chorus is a voice-doubling effect created by echoing the original sound with a slight delay and slightly modulating the delay of the echo.

Audio_Effects_DS_Compressor(int, string, float, float, float, float, float, float)

Sets the parameters for the DS Compressor effect.

Declaration
public void Audio_Effects_DS_Compressor(int streamIndex, string name, float attack, float gain, float preDelay, float ratio, float release, float threshold)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
float attack

Specifies the attack time in ms (0.01 - 500).
float gain

Specifies the gain of the filter (-60.0 - 60.0).
float preDelay

Specifies the pre-delay of the filter (0.0 - 4.0).
float ratio

Specifies the ratio of the filter (1.0 - 100.0).
float release

Specifies the release time in ms (50.0 - 3000.0).
float threshold

Specifies the threshold of the filter (-60.0 - 0.0).
Remarks

Compression is a reduction in the fluctuation of a signal above a certain amplitude.

Audio_Effects_DS_Distortion(int, string, float, float, float, float, float)

Sets the parameters for the DS Distortion effect.

Declaration
public void Audio_Effects_DS_Distortion(int streamIndex, string name, float edge, float gain, float postEQBandwidth, float postEQCenterFrequency, float preLowpassCutOff)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
float edge

Specifies the edge of the filter (0.0 - 100.0).
float gain

Specifies the gain of the filter (-60.0 - 0).
float postEQBandwidth

Specifies the bandwidth of the equalizer (100.0 - 8000.0).
float postEQCenterFrequency

Specifies the center frequency of the distortion equalizer (100.0 - 8000.0).
float preLowpassCutOff

Specifies the low pass cutoff of the filter (100.0 - 8000.0).
Remarks

Distortion is achieved by adding harmonics to the signal in such a way that, as the level increases, the top of the waveform becomes squared off or clipped.

Audio_Effects_DS_Echo(int, string, float, float, float, int, float)

Sets the parameters for the DS Echo effect.

Declaration
public void Audio_Effects_DS_Echo(int streamIndex, string name, float feedback, float leftDelay, float rightDelay, int panDelay, float wetDryMix)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
float feedback

Specifies the feedback of the filter (0 - 100.0).
float leftDelay

Specifies the left delay of the filter (1.0 - 2000.0).
float rightDelay

Specifies the right delay of the filter (1.0 - 2000.0).
int panDelay

The pan delay.
float wetDryMix

Specifies the wet and dry mix of the filter (0.0 - 100.0).
Remarks

An echo effect causes sounds to be repeated after a fixed delay, usually at a diminished volume. As the repeated sounds are fed back into the mix, they are repeated again.

Audio_Effects_DS_Flanger(int, string, float, float, float, float, int, DSFlangerWaveForm, float)

Sets the parameters for the DS Flanger effect.

Declaration
public void Audio_Effects_DS_Flanger(int streamIndex, string name, float delay, float depth, float feedback, float frequency, int phase, DSFlangerWaveForm waveform, float wetDryMix)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
float delay

Specifies the delay of the filter (0.0 - 4.0).
float depth

Specifies the depth of the filter (0.0 - 100.0).
float feedback

Specifies the feedback of the filter (-99.0 - 99.0).
float frequency

Specifies the frequency of the filter (0.0 - 10.0).
int phase

Specifies the phase angle.
DSFlangerWaveForm waveform

Specifies the waveform type of the filter.
float wetDryMix

Specifies the wet and dry mix of the filter (0.0 - 100.0).
Remarks

Flange, also called flanger, is an echo effect in which the delay between the original signal and its echo is very short and varies over time. The result is sometimes referred to as a sweeping sound. The term flange originated with the practice of grabbing the flanges of a tape reel to change the speed.

Audio_Effects_DS_Gargle(int, string, int, DSGargleWaveForm)

Sets the parameters for the DS Gargle effect.

Declaration
public void Audio_Effects_DS_Gargle(int streamIndex, string name, int rateHz, DSGargleWaveForm waveForm)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
int rateHz

Specifies the frequency of the gargle filter (1 - 1000).
DSGargleWaveForm waveForm

Specifies the waveform type of the filter.
Remarks

The gargle effect modulates the amplitude of the signal.

Audio_Effects_DS_ParamEQ(int, string, float, float, float)

Sets the parameters for the DS ParamEQ effect.

Declaration
public void Audio_Effects_DS_ParamEQ(int streamIndex, string name, float bandwidth, float center, float gain)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
float bandwidth

Specifies the bandwidth of the equalizer (1.0 - 36.0).
float center

Specifies the center frequency of the equalizer (80.0 - 16000.0).
float gain

Specifies the gain of the equalizer (-15.0 - 15.0).
Remarks

A parametric equalizer amplifies or attenuates signals of a given frequency. Parametric equalizer effects for different pitches can be applied in parallel by setting multiple instances of the effect on the same buffer. In this way, the application can have tone control similar to that provided by a hardware equalizer.

Audio_Effects_DS_Reverb(int, string, float, float, float, float, float, DSI3DL2ReverbPreset, int, int, float, int, float, int, int, float)

Sets the parameters for the DS Reverb effect.

Declaration
public void Audio_Effects_DS_Reverb(int streamIndex, string name, float decayHFRatio, float decayTime, float density, float diffusion, float HFReference, DSI3DL2ReverbPreset preset, int quality, int reflections, float reflectionsDelay, int reverbValue, float reverbDelay, int room, int roomHF, float roomRollOffFactor)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
float decayHFRatio

Specifies the decay HF ratio for the filter (0.1 - 2.0, 0.83 by default).
float decayTime

Specifies the decay time for the filter (0.1 - 20.0, 1.49 by default).
float density

Specifies the density value for the filter (0 - 100.0, 100.0 by default).
float diffusion

Specifies the diffusion value for the filter (0 - 100.0, 100.0 by default).
float HFReference

Specifies the HF reference for the filter (20.0 - 20000.0, 5000.0 by default).
DSI3DL2ReverbPreset preset

Specifies the preset name.
int quality

Specifies the quality of the filter (0 - 3, 2 by default).
int reflections

Specifies the reflections value for the filter (-10000 - -1000, -2602 by default).
float reflectionsDelay

Specifies the reflections delay for the filter (0.0 - 0.3, 0.007 by default).
int reverbValue

Specifies the reverb value for the filter (-10000 - 2000, 200 by default).
float reverbDelay

Specifies the reverb delay for the filter (0.0 - 0.1, 0.011 by default).
int room

Specifies the room value for the filter (-10000 - 0, -1000 by default).
int roomHF

Specifies the room HF value of the filter (-10000 - 0, -100 by default).
float roomRollOffFactor

Specifies the room roll off factor for the filter (0.0 - 10.0, 0.0 by default).
Remarks

Environmental Reverberation filter.

Audio_Effects_DS_WavesReverb(int, string, float, float, float, float)

Sets the parameters for the DS Waves Reverb effect.

Declaration
public void Audio_Effects_DS_WavesReverb(int streamIndex, string name, float highFreqRTRatio, float inGain, float reverbMix, float reverbTime)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
float highFreqRTRatio

Specifies the high frequency ratio (0.001 - 0.999, 0.001 by default).
float inGain

Specifies in-gain of the filter (-96.0 - 0.0, 0.0 by default).
float reverbMix

Specifies the reverb mix of the filter (-96.0 - 0.0, 0.0 by default).
float reverbTime

Specifies the reverb time of the filter (0.001 - 3000.0, 1000.0 by default).
Remarks

The waves reverberation effect is intended for use with music. The waves reverberation DirectX Media Object (DMO) is based on the Waves MaxxVerb technology, which is licensed to Microsoft.

Audio_Effects_DynamicAmplify(int, string, int, int, int)

Sets the parameters for the Dynamic Amplify effect.

Declaration
public void Audio_Effects_DynamicAmplify(int streamIndex, string name, int attackTime, int maxAmplification, int releaseTime)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
int attackTime

Specifies the amplification value than will be used when amplifying.
int maxAmplification

Sets the amplification for a channel. Default value is 10000, which means that no amplification occurs. A value of 20000 raises the amplification by 2.
int releaseTime

Specifies the time in milliseconds that the DSP will wait to continue amplification, after the maximum has been reached.
Remarks

DSP Filter to automatically keep the volume eat a specific maximum value.

Audio_Effects_DynamicAmplify_GetCurrentAmp(int, string)

Gets the value for the current amplification level.

Declaration
public double Audio_Effects_DynamicAmplify_GetCurrentAmp(int streamIndex, string name)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
Returns
Type Description
double

System.Double.

Audio_Effects_Enable(int, string, bool)

Enables selected audio effect.

Declaration
public void Audio_Effects_Enable(int streamIndex, string name, bool enable)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
bool enable

true if enabled, false if disabled.

Audio_Effects_Equalizer(int, string, bool, float)

Sets the parameters for the Equalizer effect.

Declaration
public void Audio_Effects_Equalizer(int streamIndex, string name, bool separate, float maxGainDB = 20)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
bool separate

Enables or Disables separate equalization. If Enabled every channel will be equalized by it's own amplification value. If Disabled every channel will be equalized with the amplification value of channel 0.
float maxGainDB

Max gain in dB (20 by default).
Remarks

Equalizer Filter that can equalize from 1 (2 point FFT) up to 4096 bands (8192 point FFT). Each channel can be equalized separately.

Audio_Effects_Equalizer_Band_Get(int, string, int)

Gets the current level of audio volume for the selected equalizer band (slider).

Declaration
public int Audio_Effects_Equalizer_Band_Get(int streamIndex, string name, int index)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
int index

Band index.
Returns
Type Description
int

System.Int32.

Audio_Effects_Equalizer_Band_Set(int, string, int, int)

Sets the current level of audio volume for the selected equalizer band (slider).

Declaration
public void Audio_Effects_Equalizer_Band_Set(int streamIndex, string name, int index, int value)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
int index

Band index.
int value

Gain value (in dB).

Audio_Effects_Equalizer_Preset_Set(int, string, EqualizerPreset)

Sets the equalizer preset value.

Declaration
public void Audio_Effects_Equalizer_Preset_Set(int streamIndex, string name, EqualizerPreset preset)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
EqualizerPreset preset

Preset.

Audio_Effects_Equalizer_Presets()

Gets equalizer presets list.

Declaration
public ObservableCollection<string> Audio_Effects_Equalizer_Presets()
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

Audio_Effects_Fades(int, string, int, int, TimeSpan, TimeSpan, bool)

Sets the parameters for the Fade effect.

Declaration
public void Audio_Effects_Fades(int streamIndex, string name, int startVolume, int stopVolume, TimeSpan startTime, TimeSpan stopTime, bool separate)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
int startVolume

Start volume.
int stopVolume

Stop volume.
TimeSpan startTime

Start time.
TimeSpan stopTime

Stop time.
bool separate

Enables or Disables separate fades. If Enabled every channel will be faded by it's own fade value. If Disabled every channel will be faded with the fade value of channel 0.

Audio_Effects_Flanger(int, string, float, float, bool, bool)

Sets the parameters for the Flanger effect.

Declaration
public void Audio_Effects_Flanger(int streamIndex, string name, float delay, float frequency, bool phaseInvert, bool separate)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
float delay

Specifies the delay time in seconds.
float frequency

Specifies the flanger frequency.
bool phaseInvert

Specifies whether the added signal should be inverted.
bool separate

Enables or Disables separate amplification. If Enabled every channel will be amplified by it's own amplification value. If Disabled every channel will be amplified with the amplification value of channel 0.
Remarks

Filter to flange audio data. Every channel can be controlled separately.

Audio_Effects_HighPass(int, string, int, bool)

Sets the parameters for the High Pass effect.

Declaration
public void Audio_Effects_HighPass(int streamIndex, string name, int cutOff, bool separate)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
int cutOff

The cut Off.
bool separate

Enables or Disables separate cutoff. If Enabled every channel will be processed by it's own cutoff value. If Disabled every channel will be processed with the cutoff value of channel 0.
Remarks

Filter that cuts Frequencies from a specified frequency to half of the sampling rate. Each channel can be separate processed with different cutoff values.

Audio_Effects_LowPass(int, string, int, bool)

Sets the parameters for the Low Pass effect.

Declaration
public void Audio_Effects_LowPass(int streamIndex, string name, int cutOff, bool separate)
Parameters
Type Name Description
int streamIndex

The stream Index.
string name

The name.
int cutOff

Specifies the cutoff frequency for a specific channel at which the cutoff will end.
bool separate

Enables or Disables separate cutoff. If Enabled every channel will be processed by it's own cutoff value. If Disabled every channel will be processed with the cutoff value of channel 0.
Remarks

Filter that cuts frequencies from 0 to a specified frequency. Each channel can be separate processed with different cutoff values.

Audio_Effects_Notch(int, string, int, bool)

Sets the parameters for the Notch effect.

Declaration
public void Audio_Effects_Notch(int streamIndex, string name, int cutOff, bool separate)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
int cutOff

Specifies the cutoff frequency for a specific channel at which the cutoff will have it's maximum amplification.
bool separate

Enables or Disables separate cutoff. If Enabled every channel will be processed by it's own cutoff value. If Disabled every channel will be processed with the cutoff value of channel 0.
Remarks

Filter that cuts frequency's in a wide range of specified frequency. Each channel can be separate processed with different cutoff values.

Audio_Effects_ParametricEQ(int, string, float, float, float, bool)

Sets the parameters for the ParametricEQ effect.

Declaration
public void Audio_Effects_ParametricEQ(int streamIndex, string name, float frequency, float gain, float q, bool separate)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
float frequency

Specifies the center frequency of the filter.
float gain

Specifies the gain in DB of the filter.
float q

Specifies the Q (bandwidth) of the filter.
bool separate

Enables or Disables separate amplification. If Enabled every channel will be amplified by it's own amplification value. If Disabled every channel will be amplified with the amplification value of channel 0.
Remarks

Parametric equalizer filter. Every channel can be controlled separately.

Audio_Effects_PhaseInvert(int, string, bool, bool)

Sets the parameters for the Phase Invert effect.

Declaration
public void Audio_Effects_PhaseInvert(int streamIndex, string name, bool invert, bool separate)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
bool invert

Enables and Disables phase invert for a specific channel.
bool separate

Enables or Disables separate invert. If Enabled every channel will be inverted by it's own invert value. If Disabled every channel will be inverted by the value of channel 0.
Remarks

Phase invert component that inverts specific channels.

Audio_Effects_Phaser(int, string, byte, byte, byte, float, bool, byte, float)

Sets the parameters for the Phaser effect.

Declaration
public void Audio_Effects_Phaser(int streamIndex, string name, byte depth, byte dryWetRatio, byte feedback, float frequency, bool separate, byte stages, float startPhase)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
byte depth

Sets Phaser depth (0 - 255).
byte dryWetRatio

Sets dry-wet mix ratio. 0 - dry, 255 - wet (0 - 255).
byte feedback

Sets phaser feedback. 0 - no feedback, 100 = 100% feedback, -100 = -100% feedback (-100 - 100).
float frequency

Sets phaser's LFO frequency.
bool separate

Enables or Disables separate phasing. If Enabled every channel will be phased by it's own phasing value. If Disabled every channel will be phased with the phasing value of channel 0.
byte stages

Sets phaser stages. Recommended from 2 to 24.
float startPhase

Sets phaser's LFO start phase in radians. Needed for stereo phasers.
Remarks

Class for phasing amplify audio data. Phasing can be done separate on each channel.

Audio_Effects_PitchShift(int, string, float)

Sets the parameters for the Pitch Shift effect.

Declaration
public void Audio_Effects_PitchShift(int streamIndex, string name, float pitch)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
float pitch

Specifies the pitch. Default value is 1.0f, which means that no pitch is done.
Remarks

Pitch shift filter to increase speed and pitch of audio data.

Audio_Effects_SetCurrentChannel(int, string, sbyte)

Sets the current audio channel for the audio effects.

Declaration
public void Audio_Effects_SetCurrentChannel(int streamIndex, string name, sbyte channel)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
sbyte channel

Channel. -1 to process all channels.

Audio_Effects_Sound3D(int, string, int)

Sets the parameters for the Sound3D effect.

Declaration
public void Audio_Effects_Sound3D(int streamIndex, string name, int volume)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
int volume

Sets the 3D amplification value. A value of 1000 is the same as disabling the filter. Values smaller then 1000 is the same as doing a downmix (mono) of the 2 channels. Values higher then 10000 will distort the sound.
Remarks

3D Sound amplification filter that works on 2 channels only. The difference between left and right channel is calculated and added to the main signal.

Audio_Effects_TrebleEnhancer(int, string, int, bool, int)

Sets the parameters for the Treble Enhancer effect.

Declaration
public void Audio_Effects_TrebleEnhancer(int streamIndex, string name, int frequency, bool separate, int volume)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
int frequency

Specifies the frequency range that will be used to amplify. Range is frequency to (sample rate div 2).
bool separate

Enables or Disables separate amplification. If Enabled every channel will be amplified by it's own amplification value. If Disabled every channel will be amplified with the amplification value of channel 0.
int volume

Sets the amplification for a channel. Default value is 0, which means that no amplification occurs. The value shouldn't go over 10000. If separate is True, then every channel will be amplified by its own channel amplification value. If separate is False, then every channel is amplified with the value of channel 0.
Remarks

Filter to amplify high frequency's of audio data. The frequency range can be adjusted.

Audio_Effects_TrueBass(int, string, int, bool, int)

Sets the parameters for the True Bass effect.

Declaration
public void Audio_Effects_TrueBass(int streamIndex, string name, int frequency, bool separate, int volume)
Parameters
Type Name Description
int streamIndex

Stream index.
string name

The name.
int frequency

Specifies the frequency range that will be used to amplify. Range is 0 to frequency.
bool separate

Enables or Disables separate amplification. If Enabled every channel will be amplified by it's own amplification value. If Disabled every channel will be amplified with the amplification value of channel 0.
int volume

Sets the amplification for a channel. Default value is 0, which means that no amplification occurs. The value shouldn't go over 10000. If separate is True, then every channel will be amplified by its own channel amplification value. If separate is False, then every channel is amplified with the value of channel 0.
Remarks

Filter to amplify low frequency's of audio data. The frequency range can be adjusted.

Audio_Enhancer_AutoGain(int, bool)

Applies audio auto gain enhancement.

Declaration
public void Audio_Enhancer_AutoGain(int streamIndex, bool enabled)
Parameters
Type Name Description
int streamIndex

Stream index. -1 for all streams.
bool enabled

Enabled.

Audio_Enhancer_AutoGainAsync(int, bool)

Applies audio auto gain enhancement (async).

Declaration
public Task Audio_Enhancer_AutoGainAsync(int streamIndex, bool enabled)
Parameters
Type Name Description
int streamIndex

Stream index. -1 for all streams.
bool enabled

Enabled.
Returns
Type Description
Task

Task.

Audio_Enhancer_InputGains(int, AudioEnhancerGains)

Applies audio input gains enhancement.

Declaration
public void Audio_Enhancer_InputGains(int streamIndex, AudioEnhancerGains gains)
Parameters
Type Name Description
int streamIndex

Stream index. -1 for all streams.
AudioEnhancerGains gains

Gains.

Audio_Enhancer_InputGainsAsync(int, AudioEnhancerGains)

Applies audio input gains enhancement (async).

Declaration
public Task Audio_Enhancer_InputGainsAsync(int streamIndex, AudioEnhancerGains gains)
Parameters
Type Name Description
int streamIndex

Stream index. -1 for all streams.
AudioEnhancerGains gains

Gains.
Returns
Type Description
Task

Task.

Audio_Enhancer_Normalize(int, bool)

Applies audio normalize enhancement.

Declaration
public void Audio_Enhancer_Normalize(int streamIndex, bool enabled)
Parameters
Type Name Description
int streamIndex

The stream index. -1 for all streams.
bool enabled

Enabled.

Audio_Enhancer_NormalizeAsync(int, bool)

Applies audio normalize enhancement (async).

Declaration
public Task Audio_Enhancer_NormalizeAsync(int streamIndex, bool enabled)
Parameters
Type Name Description
int streamIndex

The stream index. -1 for all streams.
bool enabled

Enabled.
Returns
Type Description
Task

Task.

Audio_Enhancer_OutputGains(int, AudioEnhancerGains)

Applies audio output gains enhancement.

Declaration
public void Audio_Enhancer_OutputGains(int streamIndex, AudioEnhancerGains gains)
Parameters
Type Name Description
int streamIndex

Stream index. -1 for all streams.
AudioEnhancerGains gains

Gains.

Audio_Enhancer_OutputGainsAsync(int, AudioEnhancerGains)

Applies audio output gains enhancement (async).

Declaration
public Task Audio_Enhancer_OutputGainsAsync(int streamIndex, AudioEnhancerGains gains)
Parameters
Type Name Description
int streamIndex

Stream index. -1 for all streams.
AudioEnhancerGains gains

Gains.
Returns
Type Description
Task

Task.

Audio_Enhancer_Timeshift(int, int)

Applies audio delay.

Declaration
public void Audio_Enhancer_Timeshift(int streamIndex, int timeshift)
Parameters
Type Name Description
int streamIndex

Stream index. -1 for all streams.
int timeshift

Time shift delay (milliseconds). Range is [-2000; 2000].

Audio_Enhancer_TimeshiftAsync(int, int)

Applies audio delay (async).

Declaration
public Task Audio_Enhancer_TimeshiftAsync(int streamIndex, int timeshift)
Parameters
Type Name Description
int streamIndex

Stream index. -1 for all streams.
int timeshift

Time shift delay (milliseconds). Range is [-2000; 2000].
Returns
Type Description
Task

Task.

Audio_OutputDevice_Balance_Get(int)

Returns current balance value for selected audio output device (in percents).

Declaration
public int Audio_OutputDevice_Balance_Get(int streamIndex)
Parameters
Type Name Description
int streamIndex

Stream index.
Returns
Type Description
int

System.Int32.

Audio_OutputDevice_Balance_Set(int, int)

Sets current balance value for selected audio output device (in percents).

Declaration
public void Audio_OutputDevice_Balance_Set(int streamIndex, int balance)
Parameters
Type Name Description
int streamIndex

Stream index.
int balance

Balance value.

Audio_OutputDevice_Volume_Get(int)

Gets current volume value for selected audio output device (in percents).

Declaration
public int Audio_OutputDevice_Volume_Get(int streamIndex)
Parameters
Type Name Description
int streamIndex

Stream index.
Returns
Type Description
int

System.Int32.

Audio_OutputDevice_Volume_Set(int, int)

Sets audio volume (in percents).

Declaration
public void Audio_OutputDevice_Volume_Set(int streamIndex, int volume)
Parameters
Type Name Description
int streamIndex

Stream index.
int volume

Volume level.

Audio_OutputDevices()

Gets audio output device list.

Declaration
public ObservableCollection<string> Audio_OutputDevices()
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

CallVideoRendererUpdate(int, int, bool)

Calls the video renderer update.

Declaration
public void CallVideoRendererUpdate(int width, int height, bool updateHandle)
Parameters
Type Name Description
int width

The width.
int height

The height.
bool updateHandle

if set to true update handle.

ConvertHexStringToByteArray(string)

Converts HEX string to byte array.

Declaration
public byte[] ConvertHexStringToByteArray(string hexString)
Parameters
Type Name Description
string hexString

HEX string.
Returns
Type Description
byte[]

System.Byte[].
Exceptions
Type Condition
Exception

Hex string is null.

CreateAsync()

Create as an asynchronous operation.

Declaration
public static Task<VideoEditCore> CreateAsync()
Returns
Type Description
Task<VideoEditCore>

A Task<VideoEditCore> representing the asynchronous operation.

CreateAsync(IVideoView)

Create as an asynchronous operation.

Declaration
public static Task<VideoEditCore> CreateAsync(IVideoView videoView)
Parameters
Type Name Description
IVideoView videoView

The video view.
Returns
Type Description
Task<VideoEditCore>

A Task<VideoEditCore> representing the asynchronous operation.

CustomRedist_Enable(bool)

Enables or disables custom redist usage.

Declaration
public void CustomRedist_Enable(bool enabled)
Parameters
Type Name Description
bool enabled

True to enable custom redist, false to disable.

CustomRedist_IsEnabled()

Gets custom redist status.

Declaration
public bool CustomRedist_IsEnabled()
Returns
Type Description
bool

The bool.

Gets the Decklink output audio renderers.

Declaration
public ObservableCollection<string> Decklink_Output_AudioRenderers()
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

Gets audio rendering statistics.

Declaration
public DecklinkRendererProps Decklink_Output_GetAudioProps()
Returns
Type Description
DecklinkRendererProps

DecklinkRendererProps.

Gets video rendering statistics.

Declaration
public DecklinkRendererProps Decklink_Output_GetVideoProps()
Returns
Type Description
DecklinkRendererProps

DecklinkRendererProps.

Gets the Decklink output video renderers.

Declaration
public ObservableCollection<string> Decklink_Output_VideoRenderers()
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

DirectShow_Filters()

Gets DirectShow filter list.

Declaration
public ObservableCollection<string> DirectShow_Filters()
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

DirectShow_Filters_Blacklist_Add(string)

Adds the DirectShow filter to the black list.

Declaration
public void DirectShow_Filters_Blacklist_Add(string filter)
Parameters
Type Name Description
string filter

Filter name.

DirectShow_Filters_Blacklist_Clear()

Clears the filters black list.

Declaration
public void DirectShow_Filters_Blacklist_Clear()
Remarks

All available filters will be available for use.

DirectShow_Filters_EventWatcher_Add(string)

Adds "watcher" for specified filter.

Declaration
public void DirectShow_Filters_EventWatcher_Add(string name)
Parameters
Type Name Description
string name

Filter name.

DirectShow_Filters_EventWatcher_Clear()

Clears "watchers".

Declaration
public void DirectShow_Filters_EventWatcher_Clear()

DirectShow_Filters_ProblemFilters()

Gets the list of the filters, which are not functional right with Video Edit SDK.

Declaration
public ObservableCollection<string> DirectShow_Filters_ProblemFilters()
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

DirectShow_Filters_ProblemFilters_Fill()

Fills the list of the filters, which are not functional right with Video Capture SDK.

Declaration
public void DirectShow_Filters_ProblemFilters_Fill()

Dispose()

Dispose method.

Declaration
public void Dispose()

Dispose(bool)

Dispose method.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Disposing parameter.

DisposeAsync()

Dispose as an asynchronous operation.

Declaration
public ValueTask DisposeAsync()
Returns
Type Description
ValueTask

A Task<ValueTask> representing the asynchronous operation.

Duration()

Returns duration.

Declaration
public TimeSpan Duration()
Returns
Type Description
TimeSpan

The TimeSpan.

FastEdit_CutFileAsync(string, TimeSpan, TimeSpan, string)

Cuts video file.

Declaration
public Task<bool> FastEdit_CutFileAsync(string inputFile, TimeSpan startTime, TimeSpan stopTime, string outputFile)
Parameters
Type Name Description
string inputFile

File name.
TimeSpan startTime

Start time.
TimeSpan stopTime

Stop time.
string outputFile

Output file.
Returns
Type Description
Task<bool>

Task<System.Boolean>.
Remarks

FFMPEG files required for deployment.

FastEdit_ExtractAudioStreamAsync(string, TimeSpan, TimeSpan, string)

Extract audio stream to file.

Declaration
public Task<bool> FastEdit_ExtractAudioStreamAsync(string inputFile, TimeSpan startTime, TimeSpan stopTime, string outputFile)
Parameters
Type Name Description
string inputFile

File name.
TimeSpan startTime

Start time.
TimeSpan stopTime

Stop time.
string outputFile

Output file.
Returns
Type Description
Task<bool>

Task<System.Boolean>.
Remarks

FFMPEG files required for deployment.

FastEdit_JoinFilesAsync(string[], string)

Joins video files (without reencoding). Files must have absolutely same format - video/audio codec used, resolution, frame rate, sample rate and so on. If not please use standard way with reencoding.

Declaration
public Task<bool> FastEdit_JoinFilesAsync(string[] inputFiles, string outputFile)
Parameters
Type Name Description
string[] inputFiles

Input file.
string outputFile

Output file.
Returns
Type Description
Task<bool>

System.Threading.Tasks.Task<bool>.
Remarks

FFMPEG files required for deployment.

FastEdit_MuxStreamsAsync(List<FFMPEGStream>, bool, string)

Mux streams from multiple files.

Declaration
public Task<bool> FastEdit_MuxStreamsAsync(List<FFMPEGStream> sourceStreams, bool shortest, string outputFile)
Parameters
Type Name Description
List<FFMPEGStream> sourceStreams

Source streams.
bool shortest

True to cut all streams to shortest stream.
string outputFile

Output file.
Returns
Type Description
Task<bool>

Task<System.Boolean>.

FastEdit_StopAsync()

Stops fast edit operation.

Declaration
public Task<bool> FastEdit_StopAsync()
Returns
Type Description
Task<bool>

System.Threading.Tasks.Task<bool>.

FastEncrypt_GetProgress()

Gets fast encrypt progress.

Declaration
public int FastEncrypt_GetProgress()
Returns
Type Description
int

int.

FastEncrypt_Pause()

Pauses encryption.

Declaration
public void FastEncrypt_Pause()

FastEncrypt_Resume()

Resumes encryption.

Declaration
public void FastEncrypt_Resume()

FastEncrypt_Start(string, string, EncryptionKeyType, object, bool, string, bool, string, Guid)

Encrypts the file without reencoding. H264 / AAC files are supported.

Declaration
public bool FastEncrypt_Start(string sourceFile, string outputFile, EncryptionKeyType keyType, object key, bool v9, string licenseKey = null, bool consoleUsage = false, string debugFolder = null, Guid customSplitterSource = default)
Parameters
Type Name Description
string sourceFile

Source file.
string outputFile

Output file.
EncryptionKeyType keyType

Key type.
object key

Key.
bool v9

True to use v9 AES-256 encryption SDK engine.
string licenseKey

Encryption SDK license key.
bool consoleUsage

Console usage.
string debugFolder

Debug directory.
Guid customSplitterSource

Custom source splitter filter GUID, must support IFileSourceFilter interface.
Returns
Type Description
bool

Returns bool.
Remarks

Source file must contain H264 video and / or AAC / PCM audio.

FastEncrypt_Start(string[], string, EncryptionKeyType, object, bool, string, bool, string, Guid)

Encrypts the file without reencoding. H264 / AAC are files supported.

Declaration
public bool FastEncrypt_Start(string[] sourceFiles, string outputFile, EncryptionKeyType keyType, object key, bool v9, string licenseKey = null, bool consoleUsage = false, string debugFolder = null, Guid customSplitterSource = default)
Parameters
Type Name Description
string[] sourceFiles

Source files.
string outputFile

Output file.
EncryptionKeyType keyType

Key type.
object key

Key.
bool v9

True to use v9 encryption SDK engine (AES-256).
string licenseKey

Encryption SDK license key.
bool consoleUsage

Console usage.
string debugFolder

Debug directory.
Guid customSplitterSource

Custom source splitter filter GUID, must support IFileSourceFilter interface.
Returns
Type Description
bool

Returns bool.
Remarks

Source file must contain H264 video and / or AAC / PCM audio.

FastEncrypt_Stop()

Stops encryption.

Declaration
public void FastEncrypt_Stop()

~VideoEditCore()

Finalizes an instance of the VideoEditCore class.

Declaration
protected ~VideoEditCore()

Frame_GetCurrent()

Gets the current video frame.

Declaration
public Bitmap Frame_GetCurrent()
Returns
Type Description
Bitmap

Bitmap.

Frame_GetCurrentAsBuffer(out int, out int)

Gets the current video frame.

Declaration
public byte[] Frame_GetCurrentAsBuffer(out int width, out int height)
Parameters
Type Name Description
int width

Frame width.
int height

Frame height.
Returns
Type Description
byte[]

System.Byte[].

Frame_GetCurrentFromRenderer(out TimeSpan)

Gets the current video frame from video renderer. EVR and VMR-9 are supported.

Declaration
public Bitmap Frame_GetCurrentFromRenderer(out TimeSpan timestamp)
Parameters
Type Name Description
TimeSpan timestamp

Timestamp in milliseconds.
Returns
Type Description
Bitmap

The Bitmap.
Remarks

Timestamp supported for EVR renderer.

Frame_Save(string, ImageFormat, int, int, int)

Saves the current frame in one of the available formats.

Declaration
public bool Frame_Save(string filename, ImageFormat format, int quality, int customWidth, int customHeight)
Parameters
Type Name Description
string filename

Output file name.
ImageFormat format

Image format.
int quality

JPEG quality.
int customWidth

Custom width.
int customHeight

Custom height.
Returns
Type Description
bool

Return bool.

Frame_SaveAsync(string, ImageFormat, int, int, int)

Saves the current frame in one of the available formats (async).

Declaration
public Task<bool> Frame_SaveAsync(string filename, ImageFormat format, int quality, int customWidth, int customHeight)
Parameters
Type Name Description
string filename

Output file name.
ImageFormat format

Image format.
int quality

JPEG quality.
int customWidth

Custom width.
int customHeight

Custom height.
Returns
Type Description
Task<bool>

Task<System.Boolean>.

GetCore()

Gets core.

Declaration
public VideoEditCore GetCore()
Returns
Type Description
VideoEditCore

The VideoEditCore.

GetFileLength(string, out TimeSpan, out TimeSpan, out TimeSpan, out TimeSpan, out TimeSpan, out TimeSpan)

Returns each stream duration (in milliseconds).

Declaration
public void GetFileLength(string filename, out TimeSpan video, out TimeSpan audio1, out TimeSpan audio2, out TimeSpan audio3, out TimeSpan audio4, out TimeSpan audio5)
Parameters
Type Name Description
string filename

File name.
TimeSpan video

Video stream duration.
TimeSpan audio1

Audio stream 1 duration.
TimeSpan audio2

Audio stream 2 duration.
TimeSpan audio3

Audio stream 3 duration.
TimeSpan audio4

Audio stream 4 duration.
TimeSpan audio5

Audio stream 5 duration.

GetLogger()

Gets logger.

Declaration
public ILogger GetLogger()
Returns
Type Description
ILogger

The Serilog.ILogger.

GetProgress()

Gets the progress. Should be called from the same thread as the Start method was called.

Declaration
public int GetProgress()
Returns
Type Description
int

int.

GetVersion()

Gets SDK version (static).

Declaration
public static Version GetVersion()
Returns
Type Description
Version

Version.

GetVideoRenderer()

Gets video renderer.

Declaration
public object GetVideoRenderer()
Returns
Type Description
object

Returns VisioForge.Core.DirectShow.Classes.DSVideoRendererBase.

GetVideoRendererCore()

Gets the video renderer core.

Declaration
public IVideoRendererBase GetVideoRendererCore()
Returns
Type Description
IVideoRendererBase

IVideoRendererBase.

GetVideoResolution()

Gets the video resolution.

Declaration
public Size GetVideoResolution()
Returns
Type Description
Size

Types.Size.

HWEncodersAvailable()

Gets information about installed VisioForge filters and codecs that we can use.

Declaration
public static HWEncodersAvailableInfo HWEncodersAvailable()
Returns
Type Description
HWEncodersAvailableInfo

HWEncodersAvailableInfo.

Helpful_GetFrameFromFile(string, TimeSpan, bool, MediaPlayerSourceMode)

Gets frame from the file.

Declaration
public Bitmap Helpful_GetFrameFromFile(string filename, TimeSpan timestamp, bool oldWay, MediaPlayerSourceMode engine)
Parameters
Type Name Description
string filename

File name.
TimeSpan timestamp

Timestamp.
bool oldWay

If true - old way (using IMediaDet interface), if false - Sample Grabber will be used.
MediaPlayerSourceMode engine

Engine. LAV and DirectShow are supported.
Returns
Type Description
Bitmap

Bitmap.

Helpful_GetFrameFromFileAsync(string, TimeSpan, bool, MediaPlayerSourceMode)

Gets frame from the file (async).

Declaration
public Task<Bitmap> Helpful_GetFrameFromFileAsync(string filename, TimeSpan timestamp, bool oldWay, MediaPlayerSourceMode engine)
Parameters
Type Name Description
string filename

File name.
TimeSpan timestamp

Timestamp.
bool oldWay

If true - old way (using IMediaDet interface), if false - Sample Grabber will be used.
MediaPlayerSourceMode engine

Engine. LAV and DirectShow are supported.
Returns
Type Description
Task<Bitmap>

Task<Bitmap>.

Input_AddAudioFile(string, string)

Add audio stream from a specified file. Use ConnectedVideoFile to get synchronized sound.

Declaration
public bool Input_AddAudioFile(string filename, string connectedVideoFile = null)
Parameters
Type Name Description
string filename

File name.
string connectedVideoFile

Video file name to synchronize audio and video streams. Can be empty string.
Returns
Type Description
bool

The bool.

Input_AddAudioFile(AudioSource, TimeSpan?, int, AudioTrackEffect[], TimelineAudioTrackCustomSettings)

Add audio stream from a specified file.

Declaration
public bool Input_AddAudioFile(AudioSource fileSource, TimeSpan? timelineInsertTime = null, int targetStreamIndex = 0, AudioTrackEffect[] effects = null, TimelineAudioTrackCustomSettings customTimelineSettings = null)
Parameters
Type Name Description
AudioSource fileSource

File source.
TimeSpan? timelineInsertTime

Timeline insert position.
int targetStreamIndex

Target stream index.
AudioTrackEffect[] effects

Audio effects (applied only to a track).
TimelineAudioTrackCustomSettings customTimelineSettings

Custom timeline audio track settings.
Returns
Type Description
bool

The bool.

Input_AddAudioFileAsync(string, string)

Adds audio stream from a specified file. Use ConnectedVideoFile property to get synchronized sound.

Declaration
public Task<bool> Input_AddAudioFileAsync(string filename, string connectedVideoFile = null)
Parameters
Type Name Description
string filename

File name.
string connectedVideoFile

Video file name to synchronize audio and video streams. Can be empty string.
Returns
Type Description
Task<bool>

Task<System.Boolean>.

Input_AddAudioFileAsync(AudioSource, TimeSpan?, int, AudioTrackEffect[], TimelineAudioTrackCustomSettings)

Add audio stream from a specified file (async.).

Declaration
public Task<bool> Input_AddAudioFileAsync(AudioSource fileSource, TimeSpan? timelineInsertTime = null, int targetStreamIndex = 0, AudioTrackEffect[] effects = null, TimelineAudioTrackCustomSettings customTimelineSettings = null)
Parameters
Type Name Description
AudioSource fileSource

File source.
TimeSpan? timelineInsertTime

Timeline insert position.
int targetStreamIndex

Target stream index.
AudioTrackEffect[] effects

Audio effects (applied only to a track).
TimelineAudioTrackCustomSettings customTimelineSettings

Custom timeline audio track settings.
Returns
Type Description
Task<bool>

Task<System.Boolean>.

Input_AddImageFile(List<ImageSource>, TimeSpan?, VideoEditStretchMode, int, int, int)

Adds image file(s).

Declaration
public bool Input_AddImageFile(List<ImageSource> images, TimeSpan? timelineInsertTime, VideoEditStretchMode stretchMode, int targetVideoStream, int customWidth, int customHeight)
Parameters
Type Name Description
List<ImageSource> images

Images.
TimeSpan? timelineInsertTime

Timeline insert time.
VideoEditStretchMode stretchMode

Stretch mode.
int targetVideoStream

Target video stream. Some formats support several video streams. Also required for PIP mode.
int customWidth

Custom width.
int customHeight

Custom height.
Returns
Type Description
bool

The bool.

Input_AddImageFile(string, TimeSpan, TimeSpan?, VideoEditStretchMode, int, int, int)

Add image file.

Declaration
public bool Input_AddImageFile(string filename, TimeSpan duration, TimeSpan? timelineInsertTime, VideoEditStretchMode stretchMode, int targetVideoStream, int customWidth, int customHeight)
Parameters
Type Name Description
string filename

File name.
TimeSpan duration

Fragment duration.
TimeSpan? timelineInsertTime

Timeline insert time.
VideoEditStretchMode stretchMode

Stretch mode.
int targetVideoStream

Target video stream. Some formats support several video streams. Also required for PIP mode.
int customWidth

Custom width.
int customHeight

Custom height.
Returns
Type Description
bool

The bool.

Input_AddImageFileAsync(List<ImageSource>, TimeSpan?, VideoEditStretchMode, int, int, int)

Adds image file(s) (async.).

Declaration
public Task<bool> Input_AddImageFileAsync(List<ImageSource> images, TimeSpan? timelineInsertTime, VideoEditStretchMode stretchMode, int targetVideoStream, int customWidth, int customHeight)
Parameters
Type Name Description
List<ImageSource> images

Images.
TimeSpan? timelineInsertTime

Timeline insert time.
VideoEditStretchMode stretchMode

Stretch mode.
int targetVideoStream

Target video stream. Some formats support several video streams. Also required for PIP mode.
int customWidth

Custom width.
int customHeight

Custom height.
Returns
Type Description
Task<bool>

Task<System.Boolean>.

Input_AddImageFileAsync(string, TimeSpan, TimeSpan?, VideoEditStretchMode, int, int, int)

Add image file (async.).

Declaration
public Task<bool> Input_AddImageFileAsync(string filename, TimeSpan duration, TimeSpan? timelineInsertTime, VideoEditStretchMode stretchMode, int targetVideoStream = 0, int customWidth = 0, int customHeight = 0)
Parameters
Type Name Description
string filename

File name.
TimeSpan duration

Fragment duration.
TimeSpan? timelineInsertTime

Timeline insert time.
VideoEditStretchMode stretchMode

Stretch mode.
int targetVideoStream

Target video stream. Some formats support several video streams. Also required for PIP mode.
int customWidth

Custom width.
int customHeight

Custom height.
Returns
Type Description
Task<bool>

Task<System.Boolean>.

Input_AddVideoBlank(TimeSpan, TimeSpan?, int, int, Color, int)

Adds blank video. You can use it to add custom images from memory in OnVideoFrameBitmap or OnVideoFrameBuffer event.

Declaration
public bool Input_AddVideoBlank(TimeSpan duration, TimeSpan? timelineInsertTime, int videoWidth, int videoHeight, Color color, int targetVideoStream)
Parameters
Type Name Description
TimeSpan duration

Fragment duration.
TimeSpan? timelineInsertTime

Timeline insert time.
int videoWidth

Video width.
int videoHeight

Video height.
Color color

Color.
int targetVideoStream

Target video stream. Some formats support several video streams. Also required for PIP mode.
Returns
Type Description
bool

The bool.

Input_AddVideoBlankAsync(TimeSpan, TimeSpan?, int, int, Color, int)

Adds blank video. You can use it to add custom images from memory in OnVideoFrameBitmap or OnVideoFrameBuffer event (async.).

Declaration
public Task<bool> Input_AddVideoBlankAsync(TimeSpan duration, TimeSpan? timelineInsertTime, int videoWidth, int videoHeight, Color color, int targetVideoStream = 0)
Parameters
Type Name Description
TimeSpan duration

Fragment duration.
TimeSpan? timelineInsertTime

Timeline insert time.
int videoWidth

Video width.
int videoHeight

Video height.
Color color

Color.
int targetVideoStream

Target video stream. Some formats support several video streams. Also required for PIP mode.
Returns
Type Description
Task<bool>

Task<System.Boolean>.

Input_AddVideoFile(string)

Adds video stream from a specified file.

Declaration
public bool Input_AddVideoFile(string filename)
Parameters
Type Name Description
string filename

File name.
Returns
Type Description
bool

The bool.

Input_AddVideoFile(VideoSource, TimeSpan?, int, int, int)

Add video stream from a specified file.

Declaration
public bool Input_AddVideoFile(VideoSource fileSource, TimeSpan? timelineInsertTime = null, int targetVideoStream = 0, int customWidth = 0, int customHeight = 0)
Parameters
Type Name Description
VideoSource fileSource

File source.
TimeSpan? timelineInsertTime

Timeline insert time.
int targetVideoStream

Target video stream. Some formats support several video streams. Also required for PIP mode.
int customWidth

Custom stream width. Can be used for PIP or to resize.
int customHeight

Custom stream height. Can be used for PIP or to resize.
Returns
Type Description
bool

The bool.
Remarks

Specify FileBeginTime and FileEndTime to insert part of the file (-1 for the full file). Specify TimelineInsertTime to insert audio on the insert position (-1 to insert after previous).

Input_AddVideoFileAsync(string)

Adds video stream from a specified file (async.).

Declaration
public Task<bool> Input_AddVideoFileAsync(string filename)
Parameters
Type Name Description
string filename

File name.
Returns
Type Description
Task<bool>

Task<System.Boolean>.

Input_AddVideoFileAsync(VideoSource, TimeSpan?, int, int, int)

Add video stream from a specified file (async.).

Declaration
public Task<bool> Input_AddVideoFileAsync(VideoSource fileSource, TimeSpan? timelineInsertTime = null, int targetVideoStream = 0, int customWidth = 0, int customHeight = 0)
Parameters
Type Name Description
VideoSource fileSource

File source.
TimeSpan? timelineInsertTime

Timeline insert time.
int targetVideoStream

Target video stream. Some formats support several video streams. Also required for PIP mode.
int customWidth

Custom stream width. Can be used for PIP or to resize.
int customHeight

Custom stream height. Can be used for PIP or to resize.
Returns
Type Description
Task<bool>

Task<System.Boolean>.
Remarks

Specify FileBeginTime and FileEndTime to insert part of the file (-1 for the full file). Specify TimelineInsertTime to insert audio on the insert position (-1 to insert after previous).

Input_AddVideoFile_PIP(VideoSource, VideoSource, TimeSpan?, TimeSpan, VideoEditPIPMode, bool, int, int, int, Rectangle?, Rectangle?)

Add PIP video pair from a specified files.

Declaration
public bool Input_AddVideoFile_PIP(VideoSource fileSource1, VideoSource fileSource2, TimeSpan? timelineInsertTime, TimeSpan duration, VideoEditPIPMode mode, bool letterbox, int customWidth = 0, int customHeight = 0, int targetVideoStream = 0, Rectangle? rectangle1 = null, Rectangle? rectangle2 = null)
Parameters
Type Name Description
VideoSource fileSource1

First source file.
VideoSource fileSource2

Second source file.
TimeSpan? timelineInsertTime

Timeline insert time.
TimeSpan duration

Transition duration.
VideoEditPIPMode mode

Mode.
bool letterbox

Letterbox usage for horizontal/vertical mode.
int customWidth

Custom output width.
int customHeight

Custom output height.
int targetVideoStream

Target video stream. Some formats support several video streams. Also required for PIP mode.
Rectangle? rectangle1

Rectangle for a first file using custom PIP mode.
Rectangle? rectangle2

Rectangle for a second file using custom PIP mode.
Returns
Type Description
bool

The bool.
Remarks

Specify TimelineInsertTime to insert video on the insert position (-1 to insert after previous).

Input_AddVideoFile_PIPAsync(VideoSource, VideoSource, TimeSpan?, TimeSpan, VideoEditPIPMode, bool, int, int, int, Rectangle?, Rectangle?)

Add PIP video pair from a specified files (async.).

Declaration
public Task<bool> Input_AddVideoFile_PIPAsync(VideoSource fileSource1, VideoSource fileSource2, TimeSpan? timelineInsertTime, TimeSpan duration, VideoEditPIPMode mode, bool letterbox, int customWidth = 0, int customHeight = 0, int targetVideoStream = 0, Rectangle? rectangle1 = null, Rectangle? rectangle2 = null)
Parameters
Type Name Description
VideoSource fileSource1

First source file.
VideoSource fileSource2

Second source file.
TimeSpan? timelineInsertTime

Timeline insert time.
TimeSpan duration

Transition duration.
VideoEditPIPMode mode

Mode.
bool letterbox

Letterbox usage for horizontal/vertical mode.
int customWidth

Custom output width.
int customHeight

Custom output height.
int targetVideoStream

Target video stream. Some formats support several video streams. Also required for PIP mode.
Rectangle? rectangle1

Rectangle for a first file using custom PIP mode.
Rectangle? rectangle2

Rectangle for a second file using custom PIP mode.
Returns
Type Description
Task<bool>

Task<System.Boolean>.
Remarks

Specify TimelineInsertTime to insert video on the insert position (-1 to insert after previous).

Input_Clear_List()

Clears a list of the input files.

Declaration
public void Input_Clear_List()

Input_Timeline_Load(string)

Adds timeline from a specified XML file.

Declaration
public bool Input_Timeline_Load(string filename)
Parameters
Type Name Description
string filename

File name.
Returns
Type Description
bool

The bool.
Remarks

Check IXml2Dex interface - https://msdn.microsoft.com/en-us/library/windows/desktop/dd390609(v=vs.85).aspx .

Input_Timeline_Save(string)

Saves timeline to a specified XML file.

Declaration
public bool Input_Timeline_Save(string filename)
Parameters
Type Name Description
string filename

File name.
Returns
Type Description
bool

The bool.
Remarks

Check IXml2Dex interface - https://msdn.microsoft.com/en-us/library/windows/desktop/dd390609(v=vs.85).aspx .

IsAsync()

Determines whether this instance is asynchronous.

Declaration
public bool IsAsync()
Returns
Type Description
bool

true if this instance is asynchronous; otherwise, false.

MotionDetection_Update()

Updates motion detection settings.

Declaration
public void MotionDetection_Update()

Network_Streaming_WMV_Access_AddItem(string, string, bool)

Adds network address to the list of allowed/disallowed addresses for network streaming.

Declaration
public bool Network_Streaming_WMV_Access_AddItem(string ip, string mask, bool blocked)
Parameters
Type Name Description
string ip

IP address.
string mask

Mask.
bool blocked

true to block IP.
Returns
Type Description
bool

true if successful, false otherwise.

Network_Streaming_WMV_Access_DeleteItem(int, bool)

Deletes network address from the list of allowed/disallowed addresses for network streaming.

Declaration
public bool Network_Streaming_WMV_Access_DeleteItem(int index, bool blocked)
Parameters
Type Name Description
int index

Item index.
bool blocked

True to delete item from blocked IP list.
Returns
Type Description
bool

true if successful, false otherwise.

Network_Streaming_WMV_Access_GetCount(bool)

Gets item count of allowed/disallowed addresses list.

Declaration
public int Network_Streaming_WMV_Access_GetCount(bool blocked)
Parameters
Type Name Description
bool blocked

True to get count of items of blocked IP list.
Returns
Type Description
int

System.Int32.

Network_Streaming_WMV_Clients_GetCount()

Gets current connected clients count.

Declaration
public int Network_Streaming_WMV_Clients_GetCount()
Returns
Type Description
int

System.Int32.

Network_Streaming_WMV_Clients_GetInfo(int, out int, out string, out string)

Gets information about selected client.

Declaration
public void Network_Streaming_WMV_Clients_GetInfo(int index, out int port, out string networkAddress, out string dnsName)
Parameters
Type Name Description
int index

Client index.
int port

Port.
string networkAddress

IP address.
string dnsName

DNS name.

Object_Detection_Update()

Updates object detection settings.

Declaration
public void Object_Detection_Update()

OnPropertyChanged(string)

OnPropertyChanged API.

Declaration
protected virtual void OnPropertyChanged(string propertyName = null)
Parameters
Type Name Description
string propertyName

Property name.

Pause()

Pauses process.

Declaration
public void Pause()

PauseAsync()

Pause (async).

Declaration
public Task PauseAsync()
Returns
Type Description
Task

The Task.

Position_Get()

Gets current position in milliseconds.

Declaration
public TimeSpan Position_Get()
Returns
Type Description
TimeSpan

TimeSpan.

Position_Set(TimeSpan)

Sets current position.

Declaration
public void Position_Set(TimeSpan position)
Parameters
Type Name Description
TimeSpan position

The position.

Progress()

Gets progress.

Declaration
public int Progress()
Returns
Type Description
int

System.Int32.

RefreshLists(bool, bool)

Refreshes the lists of codecs, devices or DirectShow filters.

Declaration
public void RefreshLists(bool codecs, bool filters)
Parameters
Type Name Description
bool codecs

Enumerate video and audio codecs.
bool filters

Enumerate DirectShow filters.

Resume()

Resumes playback.

Declaration
public void Resume()

ResumeAsync()

Resume (async).

Declaration
public Task ResumeAsync()
Returns
Type Description
Task

The Task.

SDK_BuildDate()

Gets SDK build date.

Declaration
public DateTime SDK_BuildDate()
Returns
Type Description
DateTime

DateTime.

SDK_Version()

Gets SDK version.

Declaration
public Version SDK_Version()
Returns
Type Description
Version

Version.

SetLicenseKey(string, string, string)

After buying a license of Video Edit SDK, you will receive the serial number. To get rid of nag screen during the run time, you will need to activate control via this method.

Declaration
public void SetLicenseKey(string licenseKey, string username, string email)
Parameters
Type Name Description
string licenseKey

License key.
string username

User name used during purchase.
string email

E-mail used during purchase.
Examples

VideoEdit1.SetLicenseKey(�your_license_key�, "username", "email").

Settings_Load(string)

Loads SDK settings from JSON file.

Declaration
public bool Settings_Load(string jsonFilename)
Parameters
Type Name Description
string jsonFilename

JSON settings file.
Returns
Type Description
bool

true if successful, false otherwise.

Settings_Save(string, string)

Saves current SDK control settings to file (XML).

Declaration
public bool Settings_Save(string jsonFilename, string infoFilename)
Parameters
Type Name Description
string jsonFilename

JSON file name.
string infoFilename

SDK info fil ename.
Returns
Type Description
bool

true if successful, false otherwise.

Start()

Starts the convert or preview process.

Declaration
public bool Start()
Returns
Type Description
bool

true if successful, false otherwise.

StartAsync()

Starts the capture or preview. (async).

Declaration
public Task<bool> StartAsync()
Returns
Type Description
Task<bool>

Task<System.Boolean>.

StartDelayed()

Starts delayed graph. Start_DelayEnabled must be true to use this method.

Declaration
public void StartDelayed()

StartDelayedAsync()

Starts delayed graph. Start_DelayEnabled must be true to use this method.

Declaration
public Task StartDelayedAsync()
Returns
Type Description
Task

The Task.

State()

Gets current state.

Declaration
public PlaybackState State()
Returns
Type Description
PlaybackState

PlaybackState.

Stop()

Stops the capture or preview process.

Declaration
public void Stop()

StopAsync()

Stops the capture or preview process (async).

Declaration
public Task StopAsync()
Returns
Type Description
Task

The Task.

Tags_GetDefaultAudioGenres()

Gets default audio genres.

Declaration
public ObservableCollection<string> Tags_GetDefaultAudioGenres()
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

Tags_GetDefaultVideoGenres()

Gets default video genres.

Declaration
public ObservableCollection<string> Tags_GetDefaultVideoGenres()
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

Test()

For testing purposes only. Please, do not call it.

Declaration
public void Test()

Video_Codecs()

Gets the video codec list.

Declaration
public ObservableCollection<string> Video_Codecs()
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

Video_Effects_Add(IVideoEffect)

Adds video effect.

Declaration
public void Video_Effects_Add(IVideoEffect effect)
Parameters
Type Name Description
IVideoEffect effect

Effect interface.

Video_Effects_Clear()

Clears video effects.

Declaration
public void Video_Effects_Clear()

Video_Effects_GPU_Add(IGPUVideoEffect)

Adds GPU video effect.

Declaration
public void Video_Effects_GPU_Add(IGPUVideoEffect effect)
Parameters
Type Name Description
IGPUVideoEffect effect

The effect.

Video_Effects_GPU_Clear()

Clears video effects.

Declaration
public void Video_Effects_GPU_Clear()

Video_Effects_GPU_Get(string)

Gets video effect interface by name.

Declaration
public IGPUVideoEffect Video_Effects_GPU_Get(string name)
Parameters
Type Name Description
string name

Effect name used during creation.
Returns
Type Description
IGPUVideoEffect

Returns IGPUVideoEffect.

Video_Effects_GPU_Remove(string)

Removes an effect.

Declaration
public void Video_Effects_GPU_Remove(string name)
Parameters
Type Name Description
string name

Effect name.

Video_Effects_Get(string)

Gets video effect interface by name.

Declaration
public IVideoEffect Video_Effects_Get(string name)
Parameters
Type Name Description
string name

Effect name used during creation.
Returns
Type Description
IVideoEffect

Returns IVideoEffect.

Video_Effects_Remove(string)

Removes an effect.

Declaration
public void Video_Effects_Remove(string name)
Parameters
Type Name Description
string name

Effect name.

Video_Filters_Add(CustomProcessingFilter)

Adds DirectShow filter to the list. You can use filters to process video.

Declaration
public void Video_Filters_Add(CustomProcessingFilter filter)
Parameters
Type Name Description
CustomProcessingFilter filter

Filter.

Video_Filters_Clear()

Clears filter list.

Declaration
public void Video_Filters_Clear()

Video_Renderer_Deinterlace_Modes()

Gets deinterlace modes list.

Declaration
public ObservableCollection<string> Video_Renderer_Deinterlace_Modes()
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

Video_Renderer_SetAuto()

Sets most suitable video renderer. Usually EVR or VMR-9.

Declaration
public void Video_Renderer_SetAuto()

Video_Renderer_Update()

Updates the screen settings.

Declaration
public void Video_Renderer_Update()

Video_Renderer_UpdateAsync()

Update screen settings (async).

Declaration
public Task Video_Renderer_UpdateAsync()
Returns
Type Description
Task

The Task.

Video_Renderer_VideoAdjust_GetRanges(VideoRendererAdjustment)

Gets video adjustment ranges.

Declaration
public VideoRendererVideoAdjustRanges Video_Renderer_VideoAdjust_GetRanges(VideoRendererAdjustment adjustment)
Parameters
Type Name Description
VideoRendererAdjustment adjustment

Adjustment type.
Returns
Type Description
VideoRendererVideoAdjustRanges

The VideoRendererVideoAdjustRanges.

Video_Renderer_VideoAdjust_GetRangesAsync(VideoRendererAdjustment)

Gets video adjustment ranges (async).

Declaration
public Task<VideoRendererVideoAdjustRanges> Video_Renderer_VideoAdjust_GetRangesAsync(VideoRendererAdjustment adjustment)
Parameters
Type Name Description
VideoRendererAdjustment adjustment

Adjustment type.
Returns
Type Description
Task<VideoRendererVideoAdjustRanges>

Task<VideoRendererVideoAdjustRanges>.

Video_Renderer_VideoAdjust_GetSupported()

Gets video adjustment supported values.

Declaration
public VideoRendererAdjustmentSupported Video_Renderer_VideoAdjust_GetSupported()
Returns
Type Description
VideoRendererAdjustmentSupported

The VideoRendererAdjustmentSupported.

Video_Renderer_VideoAdjust_GetSupportedAsync()

Gets video adjustment supported values (async).

Declaration
public Task<VideoRendererAdjustmentSupported> Video_Renderer_VideoAdjust_GetSupportedAsync()
Returns
Type Description
Task<VideoRendererAdjustmentSupported>

Task<VideoRendererAdjustmentSupported>.

Video_Renderer_VideoAdjust_GetValues(VideoRendererAdjustment)

Gets video adjustment value.

Declaration
public float? Video_Renderer_VideoAdjust_GetValues(VideoRendererAdjustment adjustment)
Parameters
Type Name Description
VideoRendererAdjustment adjustment

Adjustment type.
Returns
Type Description
float?

The float.

Video_Renderer_VideoAdjust_GetValuesAsync(VideoRendererAdjustment)

Gets video adjustment value (async).

Declaration
public Task<float?> Video_Renderer_VideoAdjust_GetValuesAsync(VideoRendererAdjustment adjustment)
Parameters
Type Name Description
VideoRendererAdjustment adjustment

Adjustment type.
Returns
Type Description
Task<float?>

The Task.

Video_Renderer_VideoAdjust_SetValue(VideoRendererAdjustment, float)

Sets video adjustment value.

Declaration
public bool Video_Renderer_VideoAdjust_SetValue(VideoRendererAdjustment adjustment, float value)
Parameters
Type Name Description
VideoRendererAdjustment adjustment

Adjustment type.
float value

Value.
Returns
Type Description
bool

The bool.

Video_Renderer_VideoAdjust_SetValueAsync(VideoRendererAdjustment, float)

Sets video adjustment value (async).

Declaration
public Task<bool> Video_Renderer_VideoAdjust_SetValueAsync(VideoRendererAdjustment adjustment, float value)
Parameters
Type Name Description
VideoRendererAdjustment adjustment

Adjustment type.
float value

Value.
Returns
Type Description
Task<bool>

Task<System.Boolean>.

Video_Transition_Add(TimeSpan, TimeSpan, int)

Add transition between tracks.

Declaration
public void Video_Transition_Add(TimeSpan startTime, TimeSpan stopTime, int id)
Parameters
Type Name Description
TimeSpan startTime

Start time.
TimeSpan stopTime

Stop time.
int id

Transition id.

Video_Transition_Add(TimeSpan, TimeSpan, int, bool)

Add transition between tracks.

Declaration
public void Video_Transition_Add(TimeSpan startTime, TimeSpan stopTime, int id, bool reverse)
Parameters
Type Name Description
TimeSpan startTime

Start time.
TimeSpan stopTime

Stop time.
int id

Transition id.
bool reverse

Reverse transition.

Video_Transition_Add(TimeSpan, TimeSpan, int, Color, int, int, int, int, int, int, int, int)

Add transition between tracks.

Declaration
public void Video_Transition_Add(TimeSpan startTime, TimeSpan stopTime, int id, Color borderColor, int borderSoftness, int borderWidth, int offsetX, int offsetY, int replicateX, int replicateY, int scaleX, int scaleY)
Parameters
Type Name Description
TimeSpan startTime

Start time.
TimeSpan stopTime

Stop time.
int id

Transition id.
Color borderColor

Border color.
int borderSoftness

Border softness.
int borderWidth

Border width.
int offsetX

Offset X value.
int offsetY

Offset Y value.
int replicateX

Replicate X value.
int replicateY

Replicate Y value.
int scaleX

Scale X value.
int scaleY

Scale Y value.

Video_Transition_Add(TimeSpan, TimeSpan, int, Color, int, int, int, int, int, int, int, int, bool)

Add transition between tracks.

Declaration
public void Video_Transition_Add(TimeSpan startTime, TimeSpan stopTime, int id, Color borderColor, int borderSoftness, int borderWidth, int offsetX, int offsetY, int replicateX, int replicateY, int scaleX, int scaleY, bool reverse)
Parameters
Type Name Description
TimeSpan startTime

Start time.
TimeSpan stopTime

Stop time.
int id

Transition id.
Color borderColor

Border color.
int borderSoftness

Border softness.
int borderWidth

Border width.
int offsetX

Offset X value.
int offsetY

Offset Y value.
int replicateX

Replicate X value.
int replicateY

Replicate Y value.
int scaleX

Scale X value.
int scaleY

Scale Y value.
bool reverse

Reverse transition.

Video_Transition_Add_FadeIn(TimeSpan, TimeSpan, Color, int, int)

Adds fade-in transition.

Declaration
public void Video_Transition_Add_FadeIn(TimeSpan startTime, TimeSpan stopTime, Color color, int startPerc = 0, int stopPerc = 100)
Parameters
Type Name Description
TimeSpan startTime

Start time.
TimeSpan stopTime

Stop time.
Color color

Fade color.
int startPerc

Start %. 0 by default.
int stopPerc

Stop %. 100 by default.

Video_Transition_Add_FadeOut(TimeSpan, TimeSpan, Color, int, int)

Adds fade-out transition.

Declaration
public void Video_Transition_Add_FadeOut(TimeSpan startTime, TimeSpan stopTime, Color color, int startPerc = 100, int stopPerc = 0)
Parameters
Type Name Description
TimeSpan startTime

Start time.
TimeSpan stopTime

Stop time.
Color color

Fade color.
int startPerc

Start %. 100 by default.
int stopPerc

Stop %. 0 by default.

Video_Transition_Clear()

Clears transitions.

Declaration
public void Video_Transition_Clear()

Video_Transition_GetIDFromName(string)

Gets transition ID from the name.

Declaration
public int Video_Transition_GetIDFromName(string name)
Parameters
Type Name Description
string name

Transition name.
Returns
Type Description
int

System.Int32.

Video_Transition_Names()

Gets transition names.

Declaration
public ObservableCollection<string> Video_Transition_Names()
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

WMV_CustomProfile_AudioCodecs(WMVStreamMode)

Gets WMV audio codec list.

Declaration
public ObservableCollection<string> WMV_CustomProfile_AudioCodecs(WMVStreamMode mode)
Parameters
Type Name Description
WMVStreamMode mode

Stream mode.
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

WMV_CustomProfile_AudioFormats(string, WMVStreamMode)

Gets WMV audio format list.

Declaration
public ObservableCollection<string> WMV_CustomProfile_AudioFormats(string codecName, WMVStreamMode mode)
Parameters
Type Name Description
string codecName

Audio codec name.
WMVStreamMode mode

Stream mode.
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

WMV_CustomProfile_SaveToFile(string, WMVOutput)

Saves custom profile to the file.

Declaration
public void WMV_CustomProfile_SaveToFile(string filename, WMVOutput wmvOutput)
Parameters
Type Name Description
string filename

File name.
WMVOutput wmvOutput

WMV output settings.

WMV_CustomProfile_VideoCodecs(WMVStreamMode)

Gets WMV video codec list.

Declaration
public ObservableCollection<string> WMV_CustomProfile_VideoCodecs(WMVStreamMode mode)
Parameters
Type Name Description
WMVStreamMode mode

Stream mode.
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

WMV_Internal_Profiles()

Gets WMV internal profile list.

Declaration
public ObservableCollection<string> WMV_Internal_Profiles()
Returns
Type Description
ObservableCollection<string>

ObservableCollection<System.String>.

WMV_Remux(List<WMVSourceStream>, string)

Remuxes WMV file without reencoding.

Declaration
public bool WMV_Remux(List<WMVSourceStream> sourceStreams, string outputFile)
Parameters
Type Name Description
List<WMVSourceStream> sourceStreams

Source streams.
string outputFile

Output file.
Returns
Type Description
bool

true if successful, false otherwise.

WMV_V8_Profiles(out List<string>, out List<string>)

Gets WMV V8 profiles list.

Declaration
public void WMV_V8_Profiles(out List<string> names, out List<string> descriptions)
Parameters
Type Name Description
List<string> names

Names list.
List<string> descriptions

Descriptions list.

Events

OnAudioFrameBuffer

This event occurs whenever each new audio frame is received.

Declaration
public event EventHandler<AudioFrameBufferEventArgs> OnAudioFrameBuffer
Event Type
Type Description
EventHandler<AudioFrameBufferEventArgs>

OnAudioVUMeter

This event occurs whenever each new video VU meter data is received.

Declaration
public event EventHandler<VUMeterEventArgs> OnAudioVUMeter
Event Type
Type Description
EventHandler<VUMeterEventArgs>

OnAudioVUMeterProFFTCalculated

This event occurs whenever each new audio VU meter Pro FFT value is received.

Declaration
public event EventHandler<VUMeterFFTEventArgs> OnAudioVUMeterProFFTCalculated
Event Type
Type Description
EventHandler<VUMeterFFTEventArgs>

OnAudioVUMeterProMaximumCalculated

This event occurs whenever each new audio VU meter Pro min/max level is received.

Declaration
public event EventHandler<VUMeterMaxSampleEventArgs> OnAudioVUMeterProMaximumCalculated
Event Type
Type Description
EventHandler<VUMeterMaxSampleEventArgs>

OnAudioVUMeterProVolume

This event occurs whenever each new audio VU meter Pro volume level is received.

Declaration
public event EventHandler<AudioLevelEventArgs> OnAudioVUMeterProVolume
Event Type
Type Description
EventHandler<AudioLevelEventArgs>

OnBarcodeDetected

This event occurs whenever each new barcode detected. Event args contain barcode data.

Declaration
public event EventHandler<BarcodeEventArgs> OnBarcodeDetected
Event Type
Type Description
EventHandler<BarcodeEventArgs>

OnError

This event occurs in a case of an error.

Declaration
public event EventHandler<ErrorsEventArgs> OnError
Event Type
Type Description
EventHandler<ErrorsEventArgs>

OnFFMPEGInfo

This event occurs in a case of a new FFMPEG info available. FFMPEG errors can be handled using OnError event.

Declaration
public event EventHandler<FFMPEGInfoEventArgs> OnFFMPEGInfo
Event Type
Type Description
EventHandler<FFMPEGInfoEventArgs>

OnFilterAdded

Event occurring when each new DirectShow filter added.

Declaration
public event EventHandler<FilterEventArgs> OnFilterAdded
Event Type
Type Description
EventHandler<FilterEventArgs>

OnLicenseRequired

This event occurs in a case of an license required.

Declaration
public event EventHandler<LicenseEventArgs> OnLicenseRequired
Event Type
Type Description
EventHandler<LicenseEventArgs>

OnMotionDetection

This event occurs whenever a new frame is received and motion is detected.

Declaration
public event EventHandler<MotionDetectionEventArgs> OnMotionDetection
Event Type
Type Description
EventHandler<MotionDetectionEventArgs>

OnMotionDetectionEx

This event occurs whenever each new video frame is received. Event args contain motion data.

Declaration
public event EventHandler<MotionDetectionExEventArgs> OnMotionDetectionEx
Event Type
Type Description
EventHandler<MotionDetectionExEventArgs>

OnProgress

Event occurring when new progress value available.

Declaration
public event EventHandler<ProgressEventArgs> OnProgress
Event Type
Type Description
EventHandler<ProgressEventArgs>

OnStart

This event occurs whenever the capture / preview starts.

Declaration
public event EventHandler<EventArgs> OnStart
Event Type
Type Description
EventHandler<EventArgs>

OnStop

This event occurs whenever the convert / preview stops.

Declaration
public event EventHandler<StopEventArgs> OnStop
Event Type
Type Description
EventHandler<StopEventArgs>

OnSubtitlesSettings

Subtitles settings event.

Declaration
public event EventHandler<SubtitlesSettingsEventArgs> OnSubtitlesSettings
Event Type
Type Description
EventHandler<SubtitlesSettingsEventArgs>

OnVideoFrameBitmap

This event occurs whenever each new video frame is received.

Declaration
public event EventHandler<VideoFrameBitmapEventArgs> OnVideoFrameBitmap
Event Type
Type Description
EventHandler<VideoFrameBitmapEventArgs>

OnVideoFrameBuffer

This event occurs whenever each new video frame is received.

Declaration
public event EventHandler<VideoFrameBufferEventArgs> OnVideoFrameBuffer
Event Type
Type Description
EventHandler<VideoFrameBufferEventArgs>

OnVideoFrameBufferOriginal

This event occurs whenever each new video frame is received (RGB24). Original frame without video effects or another processing.

Declaration
public event EventHandler<VideoFrameBufferEventArgs> OnVideoFrameBufferOriginal
Event Type
Type Description
EventHandler<VideoFrameBufferEventArgs>

OnVideoFrameBufferWPF

This event occurs whenever each new video frame is received (for WPF).

Declaration
public event EventHandler<VideoFrameBufferEventArgs> OnVideoFrameBufferWPF
Event Type
Type Description
EventHandler<VideoFrameBufferEventArgs>

OnWPFFillParameters

This event occurs whenever WPF screen parameters must be filled.

Declaration
public event EventHandler<EventArgs> OnWPFFillParameters
Event Type
Type Description
EventHandler<EventArgs>

PropertyChanged

Property changed event.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

WPFClose

This event occurs whenever WPF closed.

Declaration
public event EventHandler<EventArgs> WPFClose
Event Type
Type Description
EventHandler<EventArgs>

WPFPropertiesChanged

This event occurs whenever WPF properties changed.

Declaration
public event EventHandler<EventArgs> WPFPropertiesChanged
Event Type
Type Description
EventHandler<EventArgs>

Implements

IDisposable
IVideoEditCore
IMPVCVECore
INotifyPropertyChanged
IAsyncDisposable