public class VideoCaptureCore : IVideoCaptureControls, IVideoEffectsControls, IVideoCaptureCore, IMPVCVECore, INotifyPropertyChanged, IAsyncDisposable, IDisposable

Constructors

VideoCaptureCore(bool)

Initializes a new instance of the VideoCaptureCore class.

Declaration

public VideoCaptureCore(bool initialize = true)

Parameters

Type	Name	Description
bool	initialize	if set to `true` initialize.

VideoCaptureCore(IVideoView, bool)

Initializes a new instance of the VideoCaptureCore class.

Declaration

public VideoCaptureCore(IVideoView videoView, bool initialize = true)

Parameters

Type	Name	Description
IVideoView	videoView	The video view.
bool	initialize	if set to `true` initialize.

Properties

Additional_Audio_CaptureDevice_MixChannels

Gets or sets a value indicating whether multiple audio streams will be mixed into one.

Declaration

public bool Additional_Audio_CaptureDevice_MixChannels { get; set; }

Property Value

Type	Description
bool

Remarks

Only two audio source streams are currently supported.

Audio_CaptureDevice

Gets or sets the audio capture device. Set this property before you configure audio capture.

Declaration

public AudioCaptureSource Audio_CaptureDevice { get; set; }

Property Value

Type	Description
AudioCaptureSource

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_Decoder

Gets or sets audio decoder used during IP capture (if FFMPEG decoding is disabled).

Declaration

public string Audio_Decoder { get; set; }

Property Value

Type	Description
string

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_OutputDevice

Gets or sets the device name for playing audio. Set this property before you configure audio output. Make sure that Audio_PlayAudio = true for it to work.

Declaration

public string Audio_OutputDevice { get; set; }

Property Value

Type	Description
string

Remarks

Use NULL as device name to made output to NULL renderer instead real device.

Audio_PCM_Converter

Gets or sets audio PCM converter settings.

Declaration

public AudioPCMConverterSettings Audio_PCM_Converter { get; set; }

Property Value

Type	Description
AudioPCMConverterSettings

Audio_PlayAudio

Gets or sets a value indicating whether audio playback enabled.

Declaration

public bool Audio_PlayAudio { get; set; }

Property Value

Type	Description
bool

Audio_RecordAudio

Gets or sets a value indicating whether audio recording enabled. The audio capture device must be selected first.

Declaration

public bool Audio_RecordAudio { get; set; }

Property Value

Type	Description
bool

Audio_Sample_Grabber_Enabled

Gets or sets a value indicating whether audio sample grabber enabled.

Declaration

public bool Audio_Sample_Grabber_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

BDA_Source

Gets or sets BDA source.

Declaration

public BDASourceSettings BDA_Source { get; set; }

Property Value

Type	Description
BDASourceSettings

Barcode_Reader_Enabled

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

Declaration

[JsonIgnore]
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

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_Source

Gets or sets custom source settings.

Declaration

public CustomSourceSettings Custom_Source { get; set; }

Property Value

Type	Description
CustomSourceSettings

DV_Decoder_Video_Resolution

Gets or sets DV decoder video resolution.

Declaration

public DVVideoResolution DV_Decoder_Video_Resolution { get; set; }

Property Value

Type	Description
DVVideoResolution

Remarks

Several different video resolutions are possible. See the description of the DVVideoResolution type to learn more.

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_EnableUsageTracking

Gets or sets a value indicating whether usage tracking enabled.

Declaration

public bool Debug_EnableUsageTracking { get; set; }

Property Value

Type	Description
bool

Remarks

DEPRECATED. Only anonymous data will be send.

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.

Decklink_Input

Gets or sets Decklink input.

Declaration

public DecklinkInput Decklink_Input { get; set; }

Property Value

Type	Description
DecklinkInput

Decklink_Input_Capture_Timecode_Source

Gets or sets capture timecode source.

Declaration

public DecklinkCaptureTimecodeSource Decklink_Input_Capture_Timecode_Source { get; set; }

Property Value

Type	Description
DecklinkCaptureTimecodeSource

Decklink_Input_IREUSA

Gets or sets a value indicating whether USA 7.5 IRE for NTSC video used. False for 0.0 IRE in Japan.

Declaration

public bool Decklink_Input_IREUSA { get; set; }

Property Value

Type	Description
bool

Decklink_Input_SMPTE

Gets or sets a value indicating whether SMPTE component levels mode will be used. False for Betacam.

Declaration

public bool Decklink_Input_SMPTE { get; set; }

Property Value

Type	Description
bool

Decklink_Output

Gets or sets Decklink output settings.

Declaration

public DecklinkOutputSettings Decklink_Output { get; set; }

Property Value

Type	Description
DecklinkOutputSettings

Decklink_Source

Gets or sets Decklink source settings.

Declaration

public DecklinkSourceSettings Decklink_Source { get; set; }

Property Value

Type	Description
DecklinkSourceSettings

DirectCapture_Muxer

Gets or sets DirectCapture muxer filter name.

Declaration

public string DirectCapture_Muxer { get; set; }

Property Value

Type	Description
string

Remarks

Currently can be used for MP4 and MKV outputs.

Face_Tracking

Gets or sets face tracking settings.

Declaration

public FaceTrackingSettings Face_Tracking { get; set; }

Property Value

Type	Description
FaceTrackingSettings

IP_Camera_Source

Gets or sets IP camera source settings.

Declaration

public IPCameraSourceSettings IP_Camera_Source { get; set; }

Property Value

Type	Description
IPCameraSourceSettings

MPEG_Audio_Decoder

Gets or sets MPEG audio decoder. This parameter allows you to set the decoder used for MPEG-2 audio.

Declaration

public string MPEG_Audio_Decoder { get; set; }

Property Value

Type	Description
string

MPEG_Demuxer

Gets or sets MPEG demuxer filter.

Declaration

public string MPEG_Demuxer { get; set; }

Property Value

Type	Description
string

MPEG_Video_Decoder

Gets or sets MPEG video decoder. This parameter allows you to set the decoder used for MPEG-2 video.

Declaration

public string MPEG_Video_Decoder { get; set; }

Property Value

Type	Description
string

Mode

Gets or sets video capture mode.

Declaration

public VideoCaptureMode Mode { get; set; }

Property Value

Type	Description
VideoCaptureMode

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

MultiScreen_Enabled

Gets or sets a value indicating whether multiscreen enabled.

Declaration

public bool MultiScreen_Enabled { get; set; }

Property Value

Type	Description
bool

Remarks

This parameter is used to display video on multiple screens.

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

OSD_Enabled

Gets or sets a value indicating whether OSD enabled. Should be set before Play method call.

Declaration

public bool OSD_Enabled { get; set; }

Property Value

Type	Description
bool

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 the format of the output file for recording.

Declaration

public IVideoCaptureBaseOutput Output_Format { get; set; }

Property Value

Type	Description
IVideoCaptureBaseOutput

PIP_AddSampleGrabbers

Gets or sets a value indicating whether video sample grabbers will be added. You can use OnVideoFrameBitmap / OnVideoFrameBuffer to catch frames. SourceName property of event args will be PIP1, PIP2, etc.

Declaration

public bool PIP_AddSampleGrabbers { get; set; }

Property Value

Type	Description
bool

PIP_ChromaKeySettings

Gets or sets the PIP chroma-key settings.

Declaration

public PIPChromaKeySettings PIP_ChromaKeySettings { get; set; }

Property Value

Type	Description
PIPChromaKeySettings

PIP_Mode

Gets or sets Picture-In-Picture Mode.

Declaration

public PIPMode PIP_Mode { get; set; }

Property Value

Type	Description
PIPMode

PIP_ResizeQuality

Gets or sets PIP resize quality.

Declaration

public PIPResizeQuality PIP_ResizeQuality { get; set; }

Property Value

Type	Description
PIPResizeQuality

Push_Source

Gets or sets push source settings.

Declaration

public PushSourceSettings Push_Source { get; set; }

Property Value

Type	Description
PushSourceSettings

Screen_Capture_Source

Gets or sets screen capture source settings.

Declaration

public ScreenCaptureSourceSettings Screen_Capture_Source { get; set; }

Property Value

Type	Description
ScreenCaptureSourceSettings

SeparateCapture_AutostartCapture

Gets or sets a value indicating whether autostart mode enabled.

Declaration

public bool SeparateCapture_AutostartCapture { get; set; }

Property Value

Type	Description
bool

SeparateCapture_Enabled

Gets or sets a value indicating whether separate capture enabled. Please read article in help file for more information about "separate capture".

Declaration

public bool SeparateCapture_Enabled { get; set; }

Property Value

Type	Description
bool

SeparateCapture_FileSizeThreshold

Gets or sets time threshold for split by file size mode, in bytes.

Declaration

public long SeparateCapture_FileSizeThreshold { get; set; }

Property Value

Type	Description
long

SeparateCapture_Filename_Mask

Gets or sets file name mask for split by duration or size. Check available mask samples in remarks.

Declaration

public string SeparateCapture_Filename_Mask { get; set; }

Property Value

Type	Description
string

Remarks

By default folder that specified in Output_Filename property will be used. Mask contains file name and current date and time with format specifiers supported by DateTime - https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx . Each specifier must have % before name. Final mask looks like output %yyyy-%MM-%dd %hh-%mm-%ss.%ext. %ext specifier - original extension.

SeparateCapture_GMFMode

Gets or sets a value indicating whether GMF mode enabled (default is true). Please read article in help file for more information about "separate capture".

Declaration

public bool SeparateCapture_GMFMode { get; set; }

Property Value

Type	Description
bool

SeparateCapture_Mode

Gets or sets separate capture mode.

Declaration

public SeparateCaptureMode SeparateCapture_Mode { get; set; }

Property Value

Type	Description
SeparateCaptureMode

SeparateCapture_TimeThreshold

Gets or sets time threshold for split by duration mode, in milliseconds.

Declaration

public TimeSpan SeparateCapture_TimeThreshold { get; set; }

Property Value

Type	Description
TimeSpan

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

TVTuner_Channel

Gets or sets the current TV tuner channel.

Declaration

[JsonIgnore]
public int TVTuner_Channel { get; set; }

Property Value

Type	Description
int

TVTuner_Country

Gets or sets country name.

Declaration

public string TVTuner_Country { get; set; }

Property Value

Type	Description
string

TVTuner_FM_Tuning_StartFrequency

Gets or sets start frequency for FM Tuning.

Declaration

public int TVTuner_FM_Tuning_StartFrequency { get; set; }

Property Value

Type	Description
int

TVTuner_FM_Tuning_Step

Gets or sets step used for FM Tuning.

Declaration

public int TVTuner_FM_Tuning_Step { get; set; }

Property Value

Type	Description
int

TVTuner_FM_Tuning_StopFrequency

Gets or sets stop frequency for FM Tuning.

Declaration

public int TVTuner_FM_Tuning_StopFrequency { get; set; }

Property Value

Type	Description
int

TVTuner_Frequency

Gets or sets value of TV Tuner current frequency.

Declaration

public int TVTuner_Frequency { get; set; }

Property Value

Type	Description
int

TVTuner_InputType

Gets or sets TV input type - Antenna or Cable.

Declaration

public string TVTuner_InputType { get; set; }

Property Value

Type	Description
string

TVTuner_Mode

Gets or sets current TV tuner mode.

Declaration

public TVTunerMode TVTuner_Mode { get; set; }

Property Value

Type	Description
TVTunerMode

TVTuner_Name

Gets or sets the current TV tuner. Set this property before you configure TV tuner.

Declaration

public string TVTuner_Name { get; set; }

Property Value

Type	Description
string

TVTuner_TVFormat

Gets or sets TV format.

Declaration

public TVTunerVideoFormat TVTuner_TVFormat { get; set; }

Property Value

Type	Description
TVTunerVideoFormat

Timeshift_Settings

Gets or sets timeshift settings.

Declaration

public TimeshiftSettings Timeshift_Settings { get; set; }

Property Value

Type	Description
TimeshiftSettings

VLC_Path

Gets or sets LibVLC path. Plugins must be located in VLC\Plugins.

Declaration

public string VLC_Path { get; set; }

Property Value

Type	Description
string

VideoView

Gets or sets the video view.

Declaration

[JsonIgnore]
public IVideoView VideoView { get; set; }

Property Value

Type	Description
IVideoView

Video_CaptureDevice

Gets or sets the video capture device. Set this property before you configure video capture.

Declaration

public VideoCaptureSource Video_CaptureDevice { get; set; }

Property Value

Type	Description
VideoCaptureSource

Video_Crop

Gets or sets video crop settings.

Declaration

public VideoCropSettings Video_Crop { get; set; }

Property Value

Type	Description
VideoCropSettings

Video_Decoder

Gets or sets video decoder used during IP capture (if FFMPEG decoding is disabled).

Declaration

public string Video_Decoder { get; set; }

Property Value

Type	Description
string

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_Effects_MergeImageLogos

Gets or sets a value indicating whether all image logos will be merged into one. That can improve performance if you have 3 or more image logos.

Declaration

public bool Video_Effects_MergeImageLogos { get; set; }

Property Value

Type	Description
bool

Video_Effects_MergeTextLogos

Gets or sets a value indicating whether all text logos will be merged into one. That can improve performance if you have 3 or more text logos.

Declaration

public bool Video_Effects_MergeTextLogos { 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 video resize settings. Use VideoResizeSettings, MaxineUpscaleSettings or MaxineSuperResSettings classes.

Declaration

public IVideoResizeSettings Video_Resize { get; set; }

Property Value

Type	Description
IVideoResizeSettings

Video_ResizeOrCrop_Enabled

Gets or sets a value indicating whether resize or crop enabled.

Declaration

public bool Video_ResizeOrCrop_Enabled { get; set; }

Property Value

Type	Description
bool

Video_Rotation

Gets or sets video rotation mode.

Declaration

public RotateMode Video_Rotation { get; set; }

Property Value

Type	Description
RotateMode

Video_Sample_Grabber_Enabled

Gets or sets a value indicating whether video sample grabber enabled.

Declaration

public bool Video_Sample_Grabber_Enabled { get; set; }

Property Value

Type	Description
bool

Video_Sample_Grabber_UseForVideoEffects

Gets or sets a value indicating whether video sample grabber will be used for video effects.

Declaration

public bool Video_Sample_Grabber_UseForVideoEffects { get; set; }

Property Value

Type	Description
bool

Video_Still_Frames_Grabber_Enabled

Gets or sets a value indicating whether video still frames grabber enabled.

Declaration

public bool Video_Still_Frames_Grabber_Enabled { get; set; }

Property Value

Type	Description
bool

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

Additional_Audio_CaptureDevice_Add(string)

Adds additional audio capture device.

Declaration

public void Additional_Audio_CaptureDevice_Add(string name)

Parameters

Type	Name	Description
string	name	Device name.

Additional_Audio_CaptureDevice_Add(string, string)

Adds additional audio capture device.

Declaration

public void Additional_Audio_CaptureDevice_Add(string name, string format)

Parameters

Type	Name	Description
string	name	Device name.
string	format	Audio format.

Additional_Audio_CaptureDevice_Clear()

Clears additional audio capture device.

Declaration

public void Additional_Audio_CaptureDevice_Clear()

Additional_Audio_CaptureDevice_GetVolume(int)

Gets the volume of the audio capturing device.

Declaration

public Tuple<int, bool> Additional_Audio_CaptureDevice_GetVolume(int index)

Parameters

Type	Name	Description
int	index	Device index.

Returns

Type	Description
Tuple<int, bool>	Tuple<System.Int32, System.Boolean>. Volume value (in percents) and auto-gain flag.

Additional_Audio_CaptureDevice_GetVolumeAsync(int)

Gets the volume of the audio capturing device (async).

Declaration

public Task<Tuple<int, bool>> Additional_Audio_CaptureDevice_GetVolumeAsync(int index)

Parameters

Type	Name	Description
int	index	Device index.

Returns

Type	Description
Task<Tuple<int, bool>>	Task<Tuple<System.Int32, System.Boolean>>. Volume value (in percents) and auto-gain flag.

Additional_Audio_CaptureDevice_SetVolume(int, int, bool)

Sets the volume of the additional audio capturing device.

Declaration

public bool Additional_Audio_CaptureDevice_SetVolume(int index, int volume, bool autoGain)

Parameters

Type	Name	Description
int	index	Device index.
int	volume	Volume level, in percent.
bool	autoGain	Enables auto gain.

Returns

Type	Description
bool	The bool.

Additional_Audio_CaptureDevice_SetVolumeAsync(int, int, bool)

Sets the volume of the additional audio capturing device (async).

Declaration

public Task<bool> Additional_Audio_CaptureDevice_SetVolumeAsync(int index, int volume, bool autoGain)

Parameters

Type	Name	Description
int	index	Device index.
int	volume	Volume level, in percent.
bool	autoGain	Enables auto gain.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

Audio_CaptureDevice_GetDevicePath(int)

Gets device path for selected audio capture device.

Declaration

public string Audio_CaptureDevice_GetDevicePath(int index)

Parameters

Type	Name	Description
int	index	Item index.

Returns

Type	Description
string	System.String.

Audio_CaptureDevice_GetMixerValues()

Gets audio mixer values.

Declaration

public AudioMixerValues Audio_CaptureDevice_GetMixerValues()

Returns

Type	Description
AudioMixerValues	The AudioMixerValues.

Audio_CaptureDevice_GetMixerValuesAsync()

Gets audio mixer values (async).

Declaration

public Task<AudioMixerValues> Audio_CaptureDevice_GetMixerValuesAsync()

Returns

Type	Description
Task<AudioMixerValues>	Task<AudioMixerValues>.

Audio_CaptureDevice_GetVolume()

Gets the volume of the audio capturing device.

Declaration

public Tuple<int, bool> Audio_CaptureDevice_GetVolume()

Returns

Type	Description
Tuple<int, bool>	Tuple<System.Int32, System.Boolean>. Volume (in percents) and auto-gain flag.

Audio_CaptureDevice_GetVolumeAsync()

Gets the volume of the audio capturing device.

Declaration

public Task<Tuple<int, bool>> Audio_CaptureDevice_GetVolumeAsync()

Returns

Type	Description
Task<Tuple<int, bool>>	Task<Tuple<System.Int32, System.Boolean>>. Volume (in percents) and auto-gain flag.

Audio_CaptureDevice_SetDefault()

Sets the audio capture device to default.

Declaration

public bool Audio_CaptureDevice_SetDefault()

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

Audio_CaptureDevice_SetMixerValue(AudioMixerValues, AudioMixerValueType)

Sets mixer value for audio capture device.

Declaration

public bool Audio_CaptureDevice_SetMixerValue(AudioMixerValues value, AudioMixerValueType type)

Parameters

Type	Name	Description
AudioMixerValues	value	Value.
AudioMixerValueType	type	Type.

Returns

Type	Description
bool	The bool.

Audio_CaptureDevice_SetMixerValueAsync(AudioMixerValues, AudioMixerValueType)

Sets mixer value for audio capture device (async).

Declaration

public Task<bool> Audio_CaptureDevice_SetMixerValueAsync(AudioMixerValues value, AudioMixerValueType type)

Parameters

Type	Name	Description
AudioMixerValues	value	Value.
AudioMixerValueType	type	Type.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

Audio_CaptureDevice_SetVolume(int, bool)

Sets the volume of the audio capturing device.

Declaration

public bool Audio_CaptureDevice_SetVolume(int volume, bool autoGain)

Parameters

Type	Name	Description
int	volume	Volume level, in percent.
bool	autoGain	Enables auto gain.

Returns

Type	Description
bool	The bool.

Audio_CaptureDevice_SetVolumeAsync(int, bool)

Sets the volume of the audio capturing device (async).

Declaration

public Task<bool> Audio_CaptureDevice_SetVolumeAsync(int volume, bool autoGain)

Parameters

Type	Name	Description
int	volume	Volume level, in percent.
bool	autoGain	Enables auto gain.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

Audio_CaptureDevice_SettingsDialog_Show(nint, string)

Displays the dialog box with the settings of the selected audio capture device filter.

Declaration

public void Audio_CaptureDevice_SettingsDialog_Show(nint parent, string deviceName)

Parameters

Type	Name	Description
nint	parent	Parent handle.
string	deviceName	Device name.

Audio_CaptureDevices()

Gets an audio capture device list.

Declaration

public ObservableCollection<AudioCaptureDeviceInfo> Audio_CaptureDevices()

Returns

Type	Description
ObservableCollection<AudioCaptureDeviceInfo>	ObservableCollection<AudioCaptureDeviceInfo>.

Audio_Codecs()

Gets an audio codecs list.

Declaration

public ObservableCollection<string> Audio_Codecs()

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<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	Index of the stream.

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), in %. 0 if error happen.

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(bool)

Applies audio auto gain enhancement.

Declaration

public void Audio_Enhancer_AutoGain(bool enabled)

Parameters

Type	Name	Description
bool	enabled	Enabled.

Audio_Enhancer_AutoGainAsync(bool)

Applies audio auto gain enhancement (async).

Declaration

public Task Audio_Enhancer_AutoGainAsync(bool enabled)

Parameters

Type	Name	Description
bool	enabled	Is enabled.

Returns

Type	Description
Task	Task.

Audio_Enhancer_InputGains(AudioEnhancerGains)

Applies audio input gains enhancement.

Declaration

public void Audio_Enhancer_InputGains(AudioEnhancerGains gains)

Parameters

Type	Name	Description
AudioEnhancerGains	gains	Gains.

Audio_Enhancer_InputGainsAsync(AudioEnhancerGains)

Applies audio input gains enhancement.

Declaration

public Task Audio_Enhancer_InputGainsAsync(AudioEnhancerGains gains)

Parameters

Type	Name	Description
AudioEnhancerGains	gains	Gains.

Returns

Type	Description
Task	Task.

Audio_Enhancer_Normalize(bool)

Applies audio normalize enhancement.

Declaration

public void Audio_Enhancer_Normalize(bool enabled)

Parameters

Type	Name	Description
bool	enabled	Enabled.

Audio_Enhancer_NormalizeAsync(bool)

Applies audio normalize enhancement (async).

Declaration

public Task Audio_Enhancer_NormalizeAsync(bool enabled)

Parameters

Type	Name	Description
bool	enabled	Enabled.

Returns

Type	Description
Task	Task.

Audio_Enhancer_OutputGains(AudioEnhancerGains)

Applies audio output gains enhancement.

Declaration

public void Audio_Enhancer_OutputGains(AudioEnhancerGains gains)

Parameters

Type	Name	Description
AudioEnhancerGains	gains	Gains.

Audio_Enhancer_OutputGainsAsync(AudioEnhancerGains)

Applies audio output gains enhancement (async).

Declaration

public Task Audio_Enhancer_OutputGainsAsync(AudioEnhancerGains gains)

Parameters

Type	Name	Description
AudioEnhancerGains	gains	Gains.

Returns

Type	Description
Task	Task.

Audio_Enhancer_Timeshift(int)

Applies audio delay.

Declaration

public void Audio_Enhancer_Timeshift(int timeshift)

Parameters

Type	Name	Description
int	timeshift	Time shift delay (milliseconds). Range is [-2000; 2000].

Audio_Enhancer_TimeshiftAsync(int)

Applies audio delay (async).

Declaration

public Task Audio_Enhancer_TimeshiftAsync(int timeshift)

Parameters

Type	Name	Description
int	timeshift	Time shift delay (milliseconds). Range is [-2000; 2000].

Returns

Type	Description
Task	Task.

Audio_OutputDevice_Balance_Get()

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

Declaration

public int Audio_OutputDevice_Balance_Get()

Returns

Type	Description
int	System.Int32.

Audio_OutputDevice_Balance_Set(int)

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

Declaration

public int Audio_OutputDevice_Balance_Set(int balance)

Parameters

Type	Name	Description
int	balance	Balance value.

Returns

Type	Description
int	System.Int32.

Audio_OutputDevice_Volume_Get()

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

Declaration

public int Audio_OutputDevice_Volume_Get()

Returns

Type	Description
int	System.Int32.

Audio_OutputDevice_Volume_Set(int)

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

Declaration

public void Audio_OutputDevice_Volume_Set(int volume)

Parameters

Type	Name	Description
int	volume	Volume value.

Audio_OutputDevices()

Gets audio output device list.

Declaration

public ObservableCollection<string> Audio_OutputDevices()

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<System.String>.

Audio_OutputDevices_WASAPI()

Gets audio output device list (WASAPI).

Declaration

public ObservableCollection<string> Audio_OutputDevices_WASAPI()

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<System.String>.

BDA_GetParameters()

Gets frequency and other parameters for BDA device.

Declaration

public BDATuningParameters BDA_GetParameters()

Returns

Type	Description
BDATuningParameters	The BDATuningParameters.

BDA_Receivers()

Gets BDA receiver list.

Declaration

public ObservableCollection<string> BDA_Receivers()

Returns

Type	Description
ObservableCollection<string>	System.Collections.Generic.List<string>.

BDA_ScanChannels()

Starts BDA channel scanning.

Declaration

public bool BDA_ScanChannels()

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

BDA_SetParameters(BDATuningParameters)

Sets frequency and other parameters for BDA device.

Declaration

public void BDA_SetParameters(BDATuningParameters bdaTuningParameters)

Parameters

Type	Name	Description
BDATuningParameters	bdaTuningParameters	BDA tuning parameters.

BDA_Sources()

Gets BDA source list.

Declaration

public ObservableCollection<string> BDA_Sources()

Returns

Type	Description
ObservableCollection<string>	System.Collections.Generic.ObservableCollection<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.

CaptureScreenToImage()

Captures screen to Image.

Declaration

public Bitmap CaptureScreenToImage()

Returns

Type	Description
Bitmap	The Bitmap.

CaptureScreenToImage(Rectangle)

Captures screen to Image.

Declaration

public Bitmap CaptureScreenToImage(Rectangle rect)

Parameters

Type	Name	Description
Rectangle	rect	The rectangle.

Returns

Type	Description
Bitmap	Bitmap.

CaptureWindowToImage(nint)

Captures window to Bitmap.

Declaration

public Bitmap CaptureWindowToImage(nint windowHandle)

Parameters

Type	Name	Description
nint	windowHandle	Window handle.

Returns

Type	Description
Bitmap	Bitmap.

CaptureWindowToImage(nint, Rectangle)

Captures window to Bitmap.

Declaration

public Bitmap CaptureWindowToImage(nint windowHandle, Rectangle rect)

Parameters

Type	Name	Description
nint	windowHandle	Window handle.
Rectangle	rect	Capture rectangle.

Returns

Type	Description
Bitmap	Bitmap.

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
NullReferenceException	hex string is null.

CreateAsync()

Create as an asynchronous operation.

Declaration

public static Task<VideoCaptureCore> CreateAsync()

Returns

Type	Description
Task<VideoCaptureCore>	A Task<VideoCaptureCore> representing the asynchronous operation.

CreateAsync(IVideoView)

Create as an asynchronous operation.

Declaration

public static Task<VideoCaptureCore> CreateAsync(IVideoView videoView)

Parameters

Type	Name	Description
IVideoView	videoView	The video view.

Returns

Type	Description
Task<VideoCaptureCore>	A Task<VideoCaptureCore> representing the asynchronous operation.

CustomAPICall(string)

CUstom API call.

Declaration

public object CustomAPICall(string api)

Parameters

Type	Name	Description
string	api	API command.

Returns

Type	Description
object	object.

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.

CustomRedist_VirtualCameraRegister()

Registers Virtual Camera SDK and network virtual streaming filters. Admin rights required.

Declaration

public bool CustomRedist_VirtualCameraRegister()

Returns

Type	Description
bool	The bool.

DV_GetMode()

Gets current DV mode.

Declaration

public DVCommand DV_GetMode()

Returns

Type	Description
DVCommand	The DVCommand.

DV_GetModeAsync()

Gets current DV mode (async).

Declaration

public Task<DVCommand> DV_GetModeAsync()

Returns

Type	Description
Task<DVCommand>	The Task.

DV_GetTimecode()

Gets DV timecode.

Declaration

public Tuple<TimeSpan, uint> DV_GetTimecode()

Returns

Type	Description
Tuple<TimeSpan, uint>	The Tuple. TimeSpan is a timecode, uint is frames count.

DV_GetTimecodeAsync()

Gets DV timecode (async).

Declaration

public Task<Tuple<TimeSpan, uint>> DV_GetTimecodeAsync()

Returns

Type	Description
Task<Tuple<TimeSpan, uint>>	The Task. TimeSpan is a timecode, uint is frames count.

DV_GetTimecodeIntl()

Gets DV timecode.

Declaration

public Tuple<TimeSpan, uint> DV_GetTimecodeIntl()

Returns

Type	Description
Tuple<TimeSpan, uint>	The Tuple. TimeSpan is a timecode, uint is frames count.

DV_SendCommand(DVCommand)

Sends different controlling commands for DV/HDV camcorder.

Declaration

public bool DV_SendCommand(DVCommand command)

Parameters

Type	Name	Description
DVCommand	command	DV command.

Returns

Type	Description
bool	The bool.

DV_SendCommandAsync(DVCommand)

Sends different controlling commands for DV/HDV camcorder.

Declaration

public Task<bool> DV_SendCommandAsync(DVCommand command)

Parameters

Type	Name	Description
DVCommand	command	DV command.

Returns

Type	Description
Task<bool>	The Task.

DV_SendCommandIntl(DVCommand)

Sends different controlling commands for DV/HDV camcorder (intl).

Declaration

public bool DV_SendCommandIntl(DVCommand command)

Parameters

Type	Name	Description
DVCommand	command	DV command.

Returns

Type	Description
bool	The bool.

Decklink_CaptureDevicesAsync()

Gets DeckLink capture device list.

Declaration

public Task<List<DecklinkDeviceInfo>> Decklink_CaptureDevicesAsync()

Returns

Type	Description
Task<List<DecklinkDeviceInfo>>	Task<List<DecklinkDeviceInfo>>.

Decklink_Input_GetVideoFramesCount(out long, out long)

Gets Decklink input video frames count.

Declaration

public bool Decklink_Input_GetVideoFramesCount(out long droppedFrames, out long totalFrames)

Parameters

Type	Name	Description
long	droppedFrames	Dropped frames.
long	totalFrames	Total frames.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

Decklink_Input_GetVideoFramesCountAsync()

Gets Decklink input video frames count - dropped and total.

Declaration

public Task<Tuple<bool, long, long>> Decklink_Input_GetVideoFramesCountAsync()

Returns

Type	Description
Task<Tuple<bool, long, long>>	Task<Tuple<System.Boolean, System.Int64, System.Int64>>.

Decklink_Output_AudioRenderers()

Gets the Decklink output audio renderers.

Declaration

public string[] Decklink_Output_AudioRenderers()

Returns

Type	Description
string[]	System.String[].

Decklink_Output_GetAudioProps()

Gets audio rendering statistics.

Declaration

public DecklinkRendererProps Decklink_Output_GetAudioProps()

Returns

Type	Description
DecklinkRendererProps	DecklinkRendererProps.

Decklink_Output_GetVideoProps()

Gets video rendering statistics.

Declaration

public DecklinkRendererProps Decklink_Output_GetVideoProps()

Returns

Type	Description
DecklinkRendererProps	Returns DecklinkRendererProps.

Decklink_Output_VideoRenderers()

Gets the Decklink output video renderers.

Declaration

public string[] Decklink_Output_VideoRenderers()

Returns

Type	Description
string[]	System.String[].

DirectShow_Filter_GetAudioFormats(FilterCategoryX, string, MediaTypeCategory, out List<string>)

Gets audio filter output formats.

Declaration

public void DirectShow_Filter_GetAudioFormats(FilterCategoryX category, string name, MediaTypeCategory mediaType, out List<string> formats)

Parameters

Type	Name	Description
FilterCategoryX	category	Category.
string	name	Name.
MediaTypeCategory	mediaType	Media type.
List<string>	formats	Formats.

DirectShow_Filter_GetVideoFormats(FilterCategoryX, string, MediaTypeCategory, out List<VideoCaptureDeviceFormat>)

Gets video filter output formats.

Declaration

public void DirectShow_Filter_GetVideoFormats(FilterCategoryX category, string name, MediaTypeCategory mediaType, out List<VideoCaptureDeviceFormat> formats)

Parameters

Type	Name	Description
FilterCategoryX	category	Category.
string	name	Name.
MediaTypeCategory	mediaType	Media type.
List<VideoCaptureDeviceFormat>	formats	Formats.

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_ProblemFilters()

Gets the list of the filters, which are not functional right with Video Capture 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()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

Declaration

public ValueTask DisposeAsync()

Returns

Type	Description
ValueTask	A task that represents the asynchronous dispose operation.

Duration_Frames()

Gets a number of frames.

Declaration

public long Duration_Frames()

Returns

Type	Description
long	System.Int64.

Duration_Time()

Gets a duration of the video.

Declaration

public TimeSpan Duration_Time()

Returns

Type	Description
TimeSpan	TimeSpan.

~VideoCaptureCore()

Finalizes an instance of the VideoCaptureCore class.

Declaration

protected ~VideoCaptureCore()

Frame_GetCurrent()

Frames the get current.

Declaration

public Bitmap Frame_GetCurrent()

Returns

Type	Description
Bitmap	System.Drawing.Bitmap.

Frame_GetCurrentAsBuffer(ref byte[], out int, out int)

Gets the current video frame (RGB24).

Declaration

public bool Frame_GetCurrentAsBuffer(ref byte[] buffer, out int width, out int height)

Parameters

Type	Name	Description
byte[]	buffer	RGB24 buffer.
int	width	Frame width.
int	height	Frame height.

Returns

Type	Description
bool	The bool.

Frame_GetCurrentAsBuffer(out int, out int)

Gets the current video frame (RGB24).

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	The timestamp.

Returns

Type	Description
Bitmap	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 = 85, int customWidth = 0, int customHeight = 0)

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>	Return bool.

GetCore()

Gets core.

Declaration

public VideoCaptureCore GetCore()

Returns

Type	Description
VideoCaptureCore	The VideoCaptureCore.

GetLogger()

Gets logger.

Declaration

public ILogger GetLogger()

Returns

Type	Description
ILogger	Serilog.ILogger.

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	Returns frame as image or null if method was unable to get a frame.

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>.

IP_Camera_CheckAvailable(IPAddress, int, ProtocolType, TimeSpan)

Check URL availability. Do not confirm, camera stream correct or not, just fast availability check. To check that all correct use IP Preview mode and normal playback.

Declaration

public bool IP_Camera_CheckAvailable(IPAddress ip, int port, ProtocolType protocol, TimeSpan timeout)

Parameters

Type	Name	Description
IPAddress	ip	IP address.
int	port	The port.
ProtocolType	protocol	The protocol. Use TCP or UDP.
TimeSpan	timeout	Timeout.

Returns

Type	Description
bool	`true` if available, `false` otherwise.

IP_Camera_CheckAvailable(Uri, int, ProtocolType, TimeSpan)

Check URL availability. Do not confirm, camera stream correct or not, just fast availability check. To check that all correct use IP Preview mode and normal playback.

Declaration

public bool IP_Camera_CheckAvailable(Uri url, int port, ProtocolType protocol, TimeSpan timeout)

Parameters

Type	Name	Description
Uri	url	Camera URL.
int	port	The port.
ProtocolType	protocol	The protocol. Use TCP or UDP.
TimeSpan	timeout	Timeout.

Returns

Type	Description
bool	`true` if available., `false` otherwise.

Exceptions

Type	Condition
NullReferenceException	url is null.

IP_Camera_NDI_ListSources(bool, string[], string[])

List NDI sources.

Declaration

public Uri[] IP_Camera_NDI_ListSources(bool showOnlyLocalSources = false, string[] groups = null, string[] extraIPs = null)

Parameters

Type	Name	Description
bool	showOnlyLocalSources	True to list only sources on this PC.
string[]	groups	Which groups do you want to search in for sources.
string[]	extraIPs	The list of additional IP addresses that exist that we should query for sources on. For instance, if you want to find the sources on a remote machine that is not on your local sub-net then you can put a comma separated list of those IP addresses here and those sources will be available locally even though they are not mDNS discoverable. An example might be "12.0.0.8,13.0.12.8".

Returns

Type	Description
Uri[]	Uri[].

IP_Camera_NDI_ListSourcesAsync(bool, string[], string[])

List NDI sources.

Declaration

public Task<Uri[]> IP_Camera_NDI_ListSourcesAsync(bool showOnlyLocalSources = false, string[] groups = null, string[] extraIPs = null)

Parameters

Type	Name	Description
bool	showOnlyLocalSources	True to list only sources on this PC.
string[]	groups	Which groups do you want to search in for sources.
string[]	extraIPs	The list of additional IP addresses that exist that we should query for sources on. For instance, if you want to find the sources on a remote machine that is not on your local sub-net then you can put a comma separated list of those IP addresses here and those sources will be available locally even though they are not mDNS discoverable. An example might be "12.0.0.8,13.0.12.8".

Returns

Type	Description
Task<Uri[]>	Uri[].

IP_Camera_ONVIF_ListSourcesAsync(TimeSpan?, CancellationTokenSource?)

Lists ONVIF sources.

Declaration

public Task<Uri[]> IP_Camera_ONVIF_ListSourcesAsync(TimeSpan? timeout, CancellationTokenSource? cts)

Parameters

Type	Name	Description
TimeSpan?	timeout	Timeout.
CancellationTokenSource	cts	Cancellation token (optional).

Returns

Type	Description
Task<Uri[]>	A Task<Uri[]> representing the asynchronous operation.

IP_Camera_ONVIF_ListSourcesAsyncEx(Action<DiscoveryDevice>, TimeSpan?, CancellationTokenSource?)

Lists ONVIF sources.

Declaration

public Task IP_Camera_ONVIF_ListSourcesAsyncEx(Action<DiscoveryDevice> onDeviceDiscovered, TimeSpan? timeout, CancellationTokenSource? cts)

Parameters

Type	Name	Description
Action<DiscoveryDevice>	onDeviceDiscovered	The device discovered callback.
TimeSpan?	timeout	The timeout.
CancellationTokenSource	cts	Cancellation token (optional).

Returns

Type	Description
Task	A Task<Uri[]> representing the asynchronous operation.

IP_Camera_ONVIF_ListSourcesAsyncEx(TimeSpan?, CancellationTokenSource?)

Lists ONVIF sources.

Declaration

public Task<IEnumerable<DiscoveryDevice>> IP_Camera_ONVIF_ListSourcesAsyncEx(TimeSpan? timeout, CancellationTokenSource? cts)

Parameters

Type	Name	Description
TimeSpan?	timeout	Timeout.
CancellationTokenSource	cts	Cancellation token (optional).

Returns

Type	Description
Task<IEnumerable<DiscoveryDevice>>	A Task<Uri[]> representing the asynchronous operation.

IP_Camera_RTSP_FFMPEG_GetPosition()

Gets current position for IP camera or server with RTSP protocol.

Declaration

public TimeSpan? IP_Camera_RTSP_FFMPEG_GetPosition()

Returns

Type	Description
TimeSpan?	System.Nullable<TimeSpan>.

IP_Camera_RTSP_FFMPEG_GetPositionAsync()

Gets current position for IP camera or server with RTSP protocol (async).

Declaration

public Task<TimeSpan?> IP_Camera_RTSP_FFMPEG_GetPositionAsync()

Returns

Type	Description
Task<TimeSpan?>	Task<System.Nullable<TimeSpan>>.

IP_Camera_RTSP_FFMPEG_SetPosition(TimeSpan)

Sets current position for IP camera or server with RTSP protocol.

Declaration

public bool IP_Camera_RTSP_FFMPEG_SetPosition(TimeSpan position)

Parameters

Type	Name	Description
TimeSpan	position	Position.

Returns

Type	Description
bool	The bool.

IP_Camera_RTSP_FFMPEG_SetPositionAsync(TimeSpan)

Sets current position for IP camera or server with RTSP protocol (async).

Declaration

public Task<bool> IP_Camera_RTSP_FFMPEG_SetPositionAsync(TimeSpan position)

Parameters

Type	Name	Description
TimeSpan	position	Position.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

IsAsync()

Determines whether this instance is asynchronous.

Declaration

public bool IsAsync()

Returns

Type	Description
bool	`true` if this instance is asynchronous; otherwise, `false`.

IsSourceConnected()

Returns true if source connected and we received first video frame.

Declaration

public bool IsSourceConnected()

Returns

Type	Description
bool	Return bool.

MotionDetection_Update()

Updates motion detection settings.

Declaration

public void MotionDetection_Update()

MultiScreen_AddScreen(nint, int, int)

Adds additional screen.

Declaration

public void MultiScreen_AddScreen(nint screenHandle, int width, int height)

Parameters

Type	Name	Description
nint	screenHandle	Screen handle.
int	width	Screen width.
int	height	Screen height.

MultiScreen_AddScreen(IVideoView, int, int)

Adds additional screen.

Declaration

public void MultiScreen_AddScreen(IVideoView videoView, int width, int height)

Parameters

Type	Name	Description
IVideoView	videoView	Video view.
int	width	Screen width.
int	height	Screen height.

MultiScreen_Clear()

Clears the additional screens.

Declaration

public void MultiScreen_Clear()

MultiScreen_SetParameters(int, VideoRendererStretchMode, bool, bool)

Sets the additional parameters for the selected screen.

Declaration

public void MultiScreen_SetParameters(int id, VideoRendererStretchMode stretch, bool flipHorizontal, bool flipVertical)

Parameters

Type	Name	Description
int	id	Screen ID.
VideoRendererStretchMode	stretch	Stretch mode.
bool	flipHorizontal	True to flip screen horizontally.
bool	flipVertical	True to flip screen vertically.

MultiScreen_SetParametersAsync(int, VideoRendererStretchMode, bool, bool)

Sets the additional parameters for the selected screen (async).

Declaration

public Task MultiScreen_SetParametersAsync(int id, VideoRendererStretchMode stretch, bool flipHorizontal, bool flipVertical)

Parameters

Type	Name	Description
int	id	Screen ID.
VideoRendererStretchMode	stretch	Stretch mode.
bool	flipHorizontal	True to flip screen horizontally.
bool	flipVertical	True to flip screen vertically.

Returns

Type	Description
Task	The Task.

MultiScreen_SetZoom(int, int, int, int)

Sets zoom properties for the additional screen.

Declaration

public void MultiScreen_SetZoom(int id, int ratio, int shiftX, int shiftY)

Parameters

Type	Name	Description
int	id	Screen ID.
int	ratio	Zoom ratio value, in percents, starting from 0.
int	shiftX	Shift X coordinate. Shifts screen capture to the left or to the right (horizontally) by certain value.
int	shiftY	Shift Y coordinate. Shifts screen capture to the bottom or to the top (vertically) by certain value.

MultiScreen_SetZoomAsync(int, int, int, int)

Sets zoom properties for the additional screen (async).

Declaration

public Task MultiScreen_SetZoomAsync(int id, int ratio, int shiftX, int shiftY)

Parameters

Type	Name	Description
int	id	Screen ID.
int	ratio	Zoom ratio value, in percents, starting from 0.
int	shiftX	Shift X coordinate. Shifts screen capture to the left or to the right (horizontally) by certain value.
int	shiftY	Shift Y coordinate. Shifts screen capture to the bottom or to the top (vertically) by certain value.

Returns

Type	Description
Task	The Task.

MultiScreen_UpdateSize(int, int, int)

Sets the new size for the additional screen.

Declaration

public void MultiScreen_UpdateSize(int id, int width, int height)

Parameters

Type	Name	Description
int	id	Screen ID.
int	width	Screen width.
int	height	Screen height.

MultiScreen_UpdateSizeAsync(int, int, int)

Sets the new size for the additional screen (async).

Declaration

public Task MultiScreen_UpdateSizeAsync(int id, int width, int height)

Parameters

Type	Name	Description
int	id	Screen ID.
int	width	Screen width.
int	height	Screen height.

Returns

Type	Description
Task	Task.

NDI_ListSourcesExAsync(BaseContext, bool, string[], string[])

List NDI sources.

Declaration

public static Task<Uri[]> NDI_ListSourcesExAsync(BaseContext context, bool showOnlyLocalSources = false, string[] groups = null, string[] extraIPs = null)

Parameters

Type	Name	Description
BaseContext	context	Context.
bool	showOnlyLocalSources	True to list only sources on this PC.
string[]	groups	Which groups do you want to search in for sources.
string[]	extraIPs	The list of additional IP addresses that exist that we should query for sources on. For instance, if you want to find the sources on a remote machine that is not on your local sub-net then you can put a comma separated list of those IP addresses here and those sources will be available locally even though they are not mDNS discoverable. An example might be "12.0.0.8,13.0.12.8".

Returns

Type	Description
Task<Uri[]>	Uri[].

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)

Networks the streaming WMV access delete item.

Declaration

public bool Network_Streaming_WMV_Access_DeleteItem(int index, bool blocked)

Parameters

Type	Name	Description
int	index	The index.
bool	blocked	if set to `true` blocked.

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.

OSD_Layers_Clear()

Clears all layers.

Declaration

public void OSD_Layers_Clear()

OSD_Layers_Clear(int)

Clears layer.

Declaration

public void OSD_Layers_Clear(int id)

Parameters

Type	Name	Description
int	id	ID.

OSD_Layers_Create(int, int, int, int, bool)

Creates new layer.

Declaration

public bool OSD_Layers_Create(int left, int top, int width, int height, bool enabled)

Parameters

Type	Name	Description
int	left	Left.
int	top	Top.
int	width	Width.
int	height	Height.
bool	enabled	Enabled / disabled.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

OSD_Layers_Delete(int)

Deletes selected layer.

Declaration

public bool OSD_Layers_Delete(int id)

Parameters

Type	Name	Description
int	id	ID.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

OSD_Layers_Draw_Image(int, Bitmap, Rectangle, Rectangle, bool, Color)

Draws an image from file.

Declaration

public bool OSD_Layers_Draw_Image(int id, Bitmap image, Rectangle srcRect, Rectangle destRect, bool useColorKey = false, Color colorKey = default)

Parameters

Type	Name	Description
int	id	ID.
Bitmap	image	Image.
Rectangle	srcRect	Source rectangle. Can be empty to use source image and draw at (0,0).
Rectangle	destRect	Destination rect. Width and height can be 0 to use original image width/height.
bool	useColorKey	True to use color key.
Color	colorKey	The color key.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

Exceptions

Type	Condition
ArgumentNullException	image - OSD image is null.

OSD_Layers_Draw_Image(int, string, Rectangle, Rectangle, bool, Color)

Draws an image on the selected layer.

Declaration

public bool OSD_Layers_Draw_Image(int id, string filename, Rectangle srcRect, Rectangle destRect, bool useColorKey = false, Color colorKey = default)

Parameters

Type	Name	Description
int	id	ID.
string	filename	File name.
Rectangle	srcRect	Source rectangle. Can be empty to use source image and draw at (0,0).
Rectangle	destRect	Destination rect. Width and height can be 0 to use original image width/height.
bool	useColorKey	Use color key.
Color	colorKey	Color key.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

OSD_Layers_Draw_Image(int, string, int, int, bool, Color)

Draws an image on the selected layer.

Declaration

public bool OSD_Layers_Draw_Image(int id, string filename, int left, int top, bool useColorKey = false, Color colorKey = default)

Parameters

Type	Name	Description
int	id	ID.
string	filename	File name.
int	left	Left.
int	top	Top.
bool	useColorKey	Use color key.
Color	colorKey	Color key.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

OSD_Layers_Draw_Text(int, int, int, string, Font, Color)

Displays text on the selected layer.

Declaration

public bool OSD_Layers_Draw_Text(int id, int left, int top, string text, Font font, Color color)

Parameters

Type	Name	Description
int	id	ID.
int	left	Left.
int	top	Top.
string	text	Text.
Font	font	Font.
Color	color	Color.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

OSD_Layers_Enable(int, bool)

Clears layer.

Declaration

public void OSD_Layers_Enable(int id, bool enabled)

Parameters

Type	Name	Description
int	id	ID.
bool	enabled	Enabled or disabled.

OSD_Layers_GetBitmap(int, out Bitmap)

Gets HBITMAP for the selected layer.

Declaration

public bool OSD_Layers_GetBitmap(int id, out Bitmap bitmap)

Parameters

Type	Name	Description
int	id	ID.
Bitmap	bitmap	Bitmap.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

OSD_Layers_Move(int, int, int)

Moves OSD layer.

Declaration

public bool OSD_Layers_Move(int id, int x, int y)

Parameters

Type	Name	Description
int	id	ID.
int	x	New X.
int	y	New Y.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

OSD_Layers_Render()

Renders OSD layers.

Declaration

public bool OSD_Layers_Render()

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

OSD_Layers_SetTransparency(int, byte)

Sets transparency level.

Declaration

public bool OSD_Layers_SetTransparency(int id, byte value)

Parameters

Type	Name	Description
int	id	ID.
byte	value	Transparency level (0-255).

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

OnPropertyChanged(string)

OnPropertyChanged API.

Declaration

protected virtual void OnPropertyChanged(string propertyName = null)

Parameters

Type	Name	Description
string	propertyName	Property name.

OutputFilename_ChangeOnTheFly(string)

Changes the name of the output file without completely stopping the capturing process.

Declaration

public bool OutputFilename_ChangeOnTheFly(string filename)

Parameters

Type	Name	Description
string	filename	The filename.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

OutputFilename_ChangeOnTheFlyAsync(string)

Changes the name of the output file without completely stopping the capturing process (async).

Declaration

public Task<bool> OutputFilename_ChangeOnTheFlyAsync(string filename)

Parameters

Type	Name	Description
string	filename	The filename.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

PIP_Background_Color_Set(Color)

Sets PIP background color.

Declaration

public void PIP_Background_Color_Set(Color color)

Parameters

Type	Name	Description
Color	color	Color.

PIP_Background_Image_Clear()

Clears background image.

Declaration

public void PIP_Background_Image_Clear()

PIP_Background_Image_Set(string)

Sets background image file name.

Declaration

public void PIP_Background_Image_Set(string filename)

Parameters

Type	Name	Description
string	filename	Image file name.

PIP_CustomOutputSize_Clear()

Clears custom output size.

Declaration

public void PIP_CustomOutputSize_Clear()

PIP_CustomOutputSize_Set(int, int)

Sets custom output size (Custom mode).

Declaration

public void PIP_CustomOutputSize_Set(int width, int height)

Parameters

Type	Name	Description
int	width	Width.
int	height	Height.

PIP_Sources_Add_IPCamera(IPCameraSourceSettings, int, int, int, int)

Adds IP camera.

Declaration

public bool PIP_Sources_Add_IPCamera(IPCameraSourceSettings source, int outLeft, int outTop, int outWidth, int outHeight)

Parameters

Type	Name	Description
IPCameraSourceSettings	source	IP camera source settings.
int	outLeft	Left.
int	outTop	Top.
int	outWidth	Width.
int	outHeight	Height.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

PIP_Sources_Add_ScreenSource(ScreenCaptureSourceSettings, int, int, int, int)

Adds screen source.

Declaration

public bool PIP_Sources_Add_ScreenSource(ScreenCaptureSourceSettings screenSource, int outLeft, int outTop, int outWidth, int outHeight)

Parameters

Type	Name	Description
ScreenCaptureSourceSettings	screenSource	Screen source.
int	outLeft	Left.
int	outTop	Top.
int	outWidth	Width.
int	outHeight	Height.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

PIP_Sources_Add_VideoCaptureDevice(string, string, bool, VideoFrameRate, string, int, int, int, int)

Add video capture device source.

Declaration

public bool PIP_Sources_Add_VideoCaptureDevice(string deviceName, string format, bool useBestFormat, VideoFrameRate frameRate, string input, int left, int top, int width, int height)

Parameters

Type	Name	Description
string	deviceName	Video capture device name. You can use the device path instead of the name if you have several devices with the same name.
string	format	Video format.
bool	useBestFormat	True to use best video format.
VideoFrameRate	frameRate	Frame rate.
string	input	Input name.
int	left	Left.
int	top	Top.
int	width	Width.
int	height	Height.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

PIP_Sources_Add_VideoCaptureDevice(VideoCaptureSource, int, int, int, int, string)

Add video capture device source.

Declaration

public bool PIP_Sources_Add_VideoCaptureDevice(VideoCaptureSource device, int left, int top, int width, int height, string crossbarInput = null)

Parameters

Type	Name	Description
VideoCaptureSource	device	Video capture device.
int	left	Left.
int	top	Top.
int	width	Width.
int	height	Height.
string	crossbarInput	Crossbar input name. Null if no crossbar.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

PIP_Sources_Add_VideoFile(string, int, int, int, int)

Adds video file.

Declaration

public bool PIP_Sources_Add_VideoFile(string filename, int outLeft, int outTop, int outWidth, int outHeight)

Parameters

Type	Name	Description
string	filename	Video file name.
int	outLeft	Left.
int	outTop	Top.
int	outWidth	Width.
int	outHeight	Height.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

PIP_Sources_Clear()

Clears the list of PIP devices.

Declaration

public void PIP_Sources_Clear()

PIP_Sources_Count()

Count of PIP sources.

Declaration

public int PIP_Sources_Count()

Returns

Type	Description
int	System.Int32.

PIP_Sources_Delete(int)

Deletes Picture-In-Picture device.

Declaration

public bool PIP_Sources_Delete(int index)

Parameters

Type	Name	Description
int	index	Source index.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

PIP_Sources_Device_GetCrossbar(string)

Initializes crossbar from selected device.

Declaration

public bool PIP_Sources_Device_GetCrossbar(string deviceName)

Parameters

Type	Name	Description
string	deviceName	Device name.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

PIP_Sources_Device_GetCrossbarInputs()

Gets crossbar input list.

Declaration

public ObservableCollection<string> PIP_Sources_Device_GetCrossbarInputs()

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<System.String>.

PIP_Sources_ScreenSource_Update(int, int, int, bool)

Updates screen source settings.

Declaration

public bool PIP_Sources_ScreenSource_Update(int index, int left, int top, bool grabMouseCursor)

Parameters

Type	Name	Description
int	index	Index.
int	left	Left.
int	top	Top.
bool	grabMouseCursor	True to grab mouse cursor.

Returns

Type	Description
bool	The bool.

PIP_Sources_ScreenSource_UpdateAsync(int, int, int, bool)

Updates screen source settings (async).

Declaration

public Task<bool> PIP_Sources_ScreenSource_UpdateAsync(int index, int left, int top, bool grabMouseCursor)

Parameters

Type	Name	Description
int	index	Index.
int	left	Left.
int	top	Top.
bool	grabMouseCursor	True to grab mouse cursor.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

PIP_Sources_SetFlipSettings(int, bool, bool)

Sets source flip settings for the selected Picture-In-Picture device.

Declaration

public bool PIP_Sources_SetFlipSettings(int index, bool horizontal, bool vertical)

Parameters

Type	Name	Description
int	index	Source index.
bool	horizontal	Flip horizontally.
bool	vertical	Flip vertically.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

PIP_Sources_SetFlipSettingsAsync(int, bool, bool)

Sets source flip settings for the selected Picture-In-Picture device (async.).

Declaration

public Task<bool> PIP_Sources_SetFlipSettingsAsync(int index, bool horizontal, bool vertical)

Parameters

Type	Name	Description
int	index	Source index.
bool	horizontal	Flip horizontally.
bool	vertical	Flip vertically.

Returns

Type	Description
Task<bool>	`true` if successful, `false` otherwise.

PIP_Sources_SetSourceOrder(int, int)

Sets source order.

Declaration

public bool PIP_Sources_SetSourceOrder(int index, int order)

Parameters

Type	Name	Description
int	index	Device index.
int	order	Stream order. From 0 to streams count - 1.

Returns

Type	Description
bool	The bool.

PIP_Sources_SetSourceOrderAsync(int, int)

Sets source order (async).

Declaration

public Task<bool> PIP_Sources_SetSourceOrderAsync(int index, int order)

Parameters

Type	Name	Description
int	index	Device index.
int	order	Stream order. From 0 to streams count - 1.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

PIP_Sources_SetSourcePosition(int, Rectangle)

Sets the position of the video screen for the selected Picture-In-Picture device.

Declaration

public bool PIP_Sources_SetSourcePosition(int index, Rectangle rect)

Parameters

Type	Name	Description
int	index	Source index.
Rectangle	rect	Rectangle.

Returns

Type	Description
bool	The bool.

PIP_Sources_SetSourcePositionAsync(int, Rectangle)

Sets the position of the video screen for the selected Picture-In-Picture device (async).

Declaration

public Task<bool> PIP_Sources_SetSourcePositionAsync(int index, Rectangle rect)

Parameters

Type	Name	Description
int	index	Source index.
Rectangle	rect	Rectangle.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

PIP_Sources_SetSourceSettings(int, int, bool, bool, bool)

Sets source settings for the selected Picture-In-Picture device.

Declaration

public bool PIP_Sources_SetSourceSettings(int index, int transparency, bool flipX, bool flipY, bool disabled = false)

Parameters

Type	Name	Description
int	index	Source index.
int	transparency	Transparency level.
bool	flipX	Flip horizontally.
bool	flipY	Flip vertically.
bool	disabled	True to disable stream.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

PIP_Sources_SetSourceSettingsAsync(int, int, bool, bool, bool)

Sets source settings for the selected Picture-In-Picture device (async).

Declaration

public Task<bool> PIP_Sources_SetSourceSettingsAsync(int index, int transparency, bool flipX, bool flipY, bool disabled = false)

Parameters

Type	Name	Description
int	index	Source index.
int	transparency	Transparency level.
bool	flipX	Flip horizontally.
bool	flipY	Flip vertically.
bool	disabled	True to disable stream.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

PIP_Sources_SetTransparencySettings(int, double)

Sets source transparency settings for the selected Picture-In-Picture device.

Declaration

public bool PIP_Sources_SetTransparencySettings(int index, double transparency)

Parameters

Type	Name	Description
int	index	Source index.
double	transparency	Transparency [0.0-1.0].

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

PIP_Sources_SetTransparencySettingsAsync(int, double)

Sets source transparency settings for the selected Picture-In-Picture device (async.).

Declaration

public Task<bool> PIP_Sources_SetTransparencySettingsAsync(int index, double transparency)

Parameters

Type	Name	Description
int	index	Source index.
double	transparency	Transparency [0.0-1.0].

Returns

Type	Description
Task<bool>	`true` if successful, `false` otherwise.

PIP_Video_CaptureDevice_CameraControl_Get(string, CameraControlProperty)

Gets camera control settings.

Declaration

public VideoCaptureDeviceCameraControlValue PIP_Video_CaptureDevice_CameraControl_Get(string deviceName, CameraControlProperty property)

Parameters

Type	Name	Description
string	deviceName	The device name.
CameraControlProperty	property	Property type.

Returns

Type	Description
VideoCaptureDeviceCameraControlValue	VideoCaptureDeviceCameraControlValue.

PIP_Video_CaptureDevice_CameraControl_GetAsync(string, CameraControlProperty)

Gets camera control settings (async).

Declaration

public Task<VideoCaptureDeviceCameraControlValue> PIP_Video_CaptureDevice_CameraControl_GetAsync(string deviceName, CameraControlProperty property)

Parameters

Type	Name	Description
string	deviceName	The device name.
CameraControlProperty	property	Property type.

Returns

Type	Description
Task<VideoCaptureDeviceCameraControlValue>	Task<VideoCaptureDeviceCameraControlValue>.

PIP_Video_CaptureDevice_CameraControl_GetRange(string, CameraControlProperty)

Gets range of available values for camera control.

Declaration

public VideoCaptureDeviceCameraControlRanges PIP_Video_CaptureDevice_CameraControl_GetRange(string deviceName, CameraControlProperty property)

Parameters

Type	Name	Description
string	deviceName	The device name.
CameraControlProperty	property	Property type.

Returns

Type	Description
VideoCaptureDeviceCameraControlRanges	The VideoCaptureDeviceCameraControlRanges.

PIP_Video_CaptureDevice_CameraControl_GetRangeAsync(string, CameraControlProperty)

Gets range of available values for camera control (async).

Declaration

public Task<VideoCaptureDeviceCameraControlRanges> PIP_Video_CaptureDevice_CameraControl_GetRangeAsync(string deviceName, CameraControlProperty property)

Parameters

Type	Name	Description
string	deviceName	The device name.
CameraControlProperty	property	Property type.

Returns

Type	Description
Task<VideoCaptureDeviceCameraControlRanges>	Task<VideoCaptureDeviceCameraControlRanges>.

PIP_Video_CaptureDevice_CameraControl_Set(string, CameraControlProperty, VideoCaptureDeviceCameraControlValue)

Sets camera control settings.

Declaration

public bool PIP_Video_CaptureDevice_CameraControl_Set(string deviceName, CameraControlProperty property, VideoCaptureDeviceCameraControlValue value)

Parameters

Type	Name	Description
string	deviceName	The device name.
CameraControlProperty	property	Property type.
VideoCaptureDeviceCameraControlValue	value	Value.

Returns

Type	Description
bool	The bool.

PIP_Video_CaptureDevice_CameraControl_SetAsync(string, CameraControlProperty, VideoCaptureDeviceCameraControlValue)

Sets camera control settings (async).

Declaration

public Task<bool> PIP_Video_CaptureDevice_CameraControl_SetAsync(string deviceName, CameraControlProperty property, VideoCaptureDeviceCameraControlValue value)

Parameters

Type	Name	Description
string	deviceName	The device name.
CameraControlProperty	property	Property type.
VideoCaptureDeviceCameraControlValue	value	Value.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

PIP_Video_CaptureDevice_VideoAdjust_GetRanges(string, VideoHardwareAdjustment)

Gets the available ranges for the selected adjustment.

Declaration

public VideoCaptureDeviceAdjustRanges PIP_Video_CaptureDevice_VideoAdjust_GetRanges(string deviceName, VideoHardwareAdjustment adjustType)

Parameters

Type	Name	Description
string	deviceName	PIP device name.
VideoHardwareAdjustment	adjustType	Adjustment type.

Returns

Type	Description
VideoCaptureDeviceAdjustRanges	The VideoCaptureDeviceAdjustRanges.

PIP_Video_CaptureDevice_VideoAdjust_GetRangesAsync(string, VideoHardwareAdjustment)

Gets the available ranges for the selected adjustment (async).

Declaration

public Task<VideoCaptureDeviceAdjustRanges> PIP_Video_CaptureDevice_VideoAdjust_GetRangesAsync(string deviceName, VideoHardwareAdjustment adjustType)

Parameters

Type	Name	Description
string	deviceName	PIP device name.
VideoHardwareAdjustment	adjustType	Adjustment type.

Returns

Type	Description
Task<VideoCaptureDeviceAdjustRanges>	Task<VideoCaptureDeviceAdjustRanges>.

PIP_Video_CaptureDevice_VideoAdjust_GetValue(string, VideoHardwareAdjustment)

Gets the current value for the selected adjustment.

Declaration

public VideoCaptureDeviceAdjustValue PIP_Video_CaptureDevice_VideoAdjust_GetValue(string deviceName, VideoHardwareAdjustment adjustType)

Parameters

Type	Name	Description
string	deviceName	PIP device name.
VideoHardwareAdjustment	adjustType	Adjustment type.

Returns

Type	Description
VideoCaptureDeviceAdjustValue	The VideoCaptureDeviceAdjustValue.

PIP_Video_CaptureDevice_VideoAdjust_GetValueAsync(string, VideoHardwareAdjustment)

Gets the current value for the selected adjustment.

Declaration

public Task<VideoCaptureDeviceAdjustValue> PIP_Video_CaptureDevice_VideoAdjust_GetValueAsync(string deviceName, VideoHardwareAdjustment adjustType)

Parameters

Type	Name	Description
string	deviceName	PIP device name.
VideoHardwareAdjustment	adjustType	Adjustment type.

Returns

Type	Description
Task<VideoCaptureDeviceAdjustValue>	Task<VideoCaptureDeviceAdjustValue>.

PIP_Video_CaptureDevice_VideoAdjust_SetValue(string, VideoHardwareAdjustment, VideoCaptureDeviceAdjustValue)

Sets the new value for the selected adjustment.

Declaration

public bool PIP_Video_CaptureDevice_VideoAdjust_SetValue(string deviceName, VideoHardwareAdjustment adjustType, VideoCaptureDeviceAdjustValue value)

Parameters

Type	Name	Description
string	deviceName	PIP device name.
VideoHardwareAdjustment	adjustType	Adjustment type.
VideoCaptureDeviceAdjustValue	value	Value.

Returns

Type	Description
bool	The bool.

PIP_Video_CaptureDevice_VideoAdjust_SetValueAsync(string, VideoHardwareAdjustment, VideoCaptureDeviceAdjustValue)

Sets the new value for the selected adjustment (async).

Declaration

public Task<bool> PIP_Video_CaptureDevice_VideoAdjust_SetValueAsync(string deviceName, VideoHardwareAdjustment adjustType, VideoCaptureDeviceAdjustValue value)

Parameters

Type	Name	Description
string	deviceName	PIP device name.
VideoHardwareAdjustment	adjustType	Adjustment type.
VideoCaptureDeviceAdjustValue	value	Value.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

Pause()

Pause.

Declaration

public bool Pause()

Returns

Type	Description
bool	The bool.

PauseAsync()

Pause (async).

Declaration

public Task<bool> PauseAsync()

Returns

Type	Description
Task<bool>	The bool.

Push_Source_AddVideoFrame(Bitmap)

Pushes video frame.

Declaration

public void Push_Source_AddVideoFrame(Bitmap frame)

Parameters

Type	Name	Description
Bitmap	frame	Frame bitmap. Width and height must be the same as source settings.

Push_Source_AddVideoFrame(nint, int, int, int)

Pushes video frame.

Declaration

public bool Push_Source_AddVideoFrame(nint frame, int frameSize, int width, int height)

Parameters

Type	Name	Description
nint	frame	Frame.
int	frameSize	Frame size.
int	width	Width.
int	height	Height.

Returns

Type	Description
bool	The bool.

Push_Source_AddVideoFrameAsync(Bitmap)

Pushes video frame (async).

Declaration

public Task Push_Source_AddVideoFrameAsync(Bitmap frame)

Parameters

Type	Name	Description
Bitmap	frame	Frame bitmap. Width and height must be the same as source settings.

Returns

Type	Description
Task	The Task.

Push_Source_AddVideoFrameAsync(nint, int, int, int)

Pushes video frame (async).

Declaration

public Task<bool> Push_Source_AddVideoFrameAsync(nint frame, int frameSize, int width, int height)

Parameters

Type	Name	Description
nint	frame	Frame.
int	frameSize	Frame size.
int	width	Width.
int	height	Height.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

RefreshLists(bool, bool, bool, bool)

Refreshes the lists of codecs, devices or DS filters.

Declaration

public void RefreshLists(bool devices, bool codecs, bool filters, bool ignoreDecklinkInDSListings = true)

Parameters

Type	Name	Description
bool	devices	Enumerate devices.
bool	codecs	Enumerate video and audio codecs.
bool	filters	Enumerate DirectShow filters.
bool	ignoreDecklinkInDSListings	Ignore Decklink/Blackmagic devices in DirectShow listings.

Resume()

Resume.

Declaration

public bool Resume()

Returns

Type	Description
bool	The bool.

ResumeAsync()

Resume (async).

Declaration

public Task<bool> ResumeAsync()

Returns

Type	Description
Task<bool>	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.

Screen_Capture_UpdateParameters(int, int, bool, bool)

Updates the screen capturing parameters.

Declaration

public void Screen_Capture_UpdateParameters(int left, int top, bool grabMouseCursor, bool highlightMouseCursor = false)

Parameters

Type	Name	Description
int	left	Left coordinate.
int	top	Top coordinate.
bool	grabMouseCursor	True to grab mouse cursor.
bool	highlightMouseCursor	True to highlight mouse cursor.

Screen_Capture_UpdateParametersAsync(int, int, bool, bool)

Updates the screen capturing parameters.

Declaration

public Task Screen_Capture_UpdateParametersAsync(int left, int top, bool grabMouseCursor, bool highlightMouseCursor = false)

Parameters

Type	Name	Description
int	left	Left coordinate.
int	top	Top coordinate.
bool	grabMouseCursor	True to grab mouse cursor.
bool	highlightMouseCursor	True to highlight mouse cursor.

Returns

Type	Description
Task	Task.

SeparateCapture_ChangeFilenameOnTheFly(string)

Changes file name on the fly. Separate capture must be enabled.

Declaration

public bool SeparateCapture_ChangeFilenameOnTheFly(string filename)

Parameters

Type	Name	Description
string	filename	New file name.

Returns

Type	Description
bool	The bool.

SeparateCapture_ChangeFilenameOnTheFlyAsync(string)

Changes file name on the fly (async). Separate capture must be enabled.

Declaration

public Task<bool> SeparateCapture_ChangeFilenameOnTheFlyAsync(string filename)

Parameters

Type	Name	Description
string	filename	New file name.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

SeparateCapture_Pause()

Pauses capture. Separate capture must be enabled.

Declaration

public bool SeparateCapture_Pause()

Returns

Type	Description
bool	The bool.

SeparateCapture_PauseAsync()

Pauses capture. Separate capture must be enabled.

Declaration

public Task<bool> SeparateCapture_PauseAsync()

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

SeparateCapture_Resume()

Resumes capture. Separate capture must be enabled.

Declaration

public bool SeparateCapture_Resume()

Returns

Type	Description
bool	The bool.

SeparateCapture_ResumeAsync()

Resumes capture (async). Separate capture must be enabled.

Declaration

public Task<bool> SeparateCapture_ResumeAsync()

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

SeparateCapture_Start(string)

Starts capture. Separate capture must be enabled.

Declaration

public bool SeparateCapture_Start(string filename)

Parameters

Type	Name	Description
string	filename	Output file name.

Returns

Type	Description
bool	The bool.

SeparateCapture_StartAsync(string)

Starts capture. Separate capture must be enabled.

Declaration

public Task<bool> SeparateCapture_StartAsync(string filename)

Parameters

Type	Name	Description
string	filename	Output file name.

Returns

Type	Description
Task<bool>	The Task.

SeparateCapture_Stop()

Stops capture. Separate capture must be enabled.

Declaration

public bool SeparateCapture_Stop()

Returns

Type	Description
bool	The bool.

SeparateCapture_StopAsync()

Stops capture (async). Separate capture must be enabled.

Declaration

public Task<bool> SeparateCapture_StopAsync()

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

SetLicenseKey(string, string, string)

After buying a license of Video Capture 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

VideoCaptureX1.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	Returns bool.

Settings_Save(string, string)

Saves current SDK control settings to file (JSON).

Declaration

public bool Settings_Save(string jsonFilename, string infoFilename)

Parameters

Type	Name	Description
string	jsonFilename	JSON file name.
string	infoFilename	SDK info filename.

Returns

Type	Description
bool	Returns true if the operation has been successful.

Special_Filters(SpecialFilterType)

Gets a special filter list.

Declaration

public ObservableCollection<string> Special_Filters(SpecialFilterType filterType)

Parameters

Type	Name	Description
SpecialFilterType	filterType	Filter type.

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<System.String>.

Start()

Starts the capture or preview.

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>	The Task.

StartDelayed()

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

Declaration

public bool StartDelayed()

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

StartDelayedAsync()

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

Declaration

public Task<bool> StartDelayedAsync()

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

State()

Gets current state of the component. Returns "Play" during capture or preview and "Free" when idle.

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.

TVTuner_Apply()

Applies TV tuner parameters.

Declaration

public void TVTuner_Apply()

TVTuner_ApplyAsync()

Applies TV tuner parameters.

Declaration

public Task TVTuner_ApplyAsync()

Returns

Type	Description
Task	The Task.

TVTuner_AudioFrequency()

Gets value of current frequency of the TV tuner audio channel.

Declaration

public int TVTuner_AudioFrequency()

Returns

Type	Description
int	System.Int32.

TVTuner_AudioSubChannel()

Gets audio sub channel.

Declaration

public TVTunerSubChannel TVTuner_AudioSubChannel()

Returns

Type	Description
TVTunerSubChannel	TVTunerSubChannel.

TVTuner_ChannelMax()

Gets maximal available channel number.

Declaration

public int TVTuner_ChannelMax()

Returns

Type	Description
int	int.

TVTuner_ChannelMin()

Gets minimal available channel number.

Declaration

public int TVTuner_ChannelMin()

Returns

Type	Description
int	int.

TVTuner_Countries()

Gets TV Tuner country list.

Declaration

public ObservableCollection<string> TVTuner_Countries()

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<System.String>.

TVTuner_Countries_GetPreferredFormatForCountry(string)

Gets preferable video format for selected country.

Declaration

public string TVTuner_Countries_GetPreferredFormatForCountry(string country)

Parameters

Type	Name	Description
string	country	Country name.

Returns

Type	Description
string	System.String.

TVTuner_Devices()

Gets TV Tuner list.

Declaration

public ObservableCollection<string> TVTuner_Devices()

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<System.String>.

TVTuner_Modes()

Gets TV Tuner mode list.

Declaration

public ObservableCollection<string> TVTuner_Modes()

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<System.String>.

TVTuner_Read()

Reads TV tuner parameters.

Declaration

public void TVTuner_Read()

TVTuner_ReadAsync()

Reads TV tuner parameters (async).

Declaration

public Task TVTuner_ReadAsync()

Returns

Type	Description
Task	The Task.

TVTuner_Signal()

Gets a value indicating whether TV tuner has a signal.

Declaration

public bool TVTuner_Signal()

Returns

Type	Description
bool	bool.

TVTuner_TVFormat_FromString(string)

Converts string to TV format.

Declaration

public TVTunerVideoFormat TVTuner_TVFormat_FromString(string format)

Parameters

Type	Name	Description
string	format	Format.

Returns

Type	Description
TVTunerVideoFormat	TVTunerVideoFormat.

TVTuner_TVFormats()

Gets TV Tuner format list.

Declaration

public ObservableCollection<string> TVTuner_TVFormats()

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<System.String>.

TVTuner_TuneChannels_Start()

Starts the channel tuning.

Declaration

public void TVTuner_TuneChannels_Start()

TVTuner_TuneChannels_StartAsync()

Starts the channel tuning (async.).

Declaration

public Task TVTuner_TuneChannels_StartAsync()

Returns

Type	Description
Task	The Task.

TVTuner_TuneChannels_Stop()

Stops the channel tuning.

Declaration

public void TVTuner_TuneChannels_Stop()

TVTuner_TuneChannels_StopAsync()

Stops the channel tuning (async.).

Declaration

public Task TVTuner_TuneChannels_StopAsync()

Returns

Type	Description
Task	The Task.

TVTuner_VideoFrequency()

Gets value of current frequency of the TV tuner video channel.

Declaration

public int TVTuner_VideoFrequency()

Returns

Type	Description
int	System.Int32.

TVTuner_VideoSubChannel()

Gets TV Tuner video subchannel.

Declaration

public TVTunerSubChannel TVTuner_VideoSubChannel()

Returns

Type	Description
TVTunerSubChannel	VisioForge.Core.Types.VideoCapture.TVTunerSubChannel.

Tags_GetDefaultAudioGenres()

Gets default audio genres.

Declaration

public string[] Tags_GetDefaultAudioGenres()

Returns

Type	Description
string[]	System.String[].

Tags_GetDefaultVideoGenres()

Gets default video genres.

Declaration

public string[] Tags_GetDefaultVideoGenres()

Returns

Type	Description
string[]	System.String[].

Test()

For Test purposes only, never call it.

Declaration

public void Test()

VideoInHeight()

Gets video input height.

Declaration

public int VideoInHeight()

Returns

Type	Description
int	System.Int32.

VideoInWidth()

Gets video input width.

Declaration

public int VideoInWidth()

Returns

Type	Description
int	System.Int32.

Video_CaptureDevice_CameraControl_Get(CameraControlProperty)

Gets camera control settings.

Declaration

public VideoCaptureDeviceCameraControlValue Video_CaptureDevice_CameraControl_Get(CameraControlProperty property)

Parameters

Type	Name	Description
CameraControlProperty	property	Property type.

Returns

Type	Description
VideoCaptureDeviceCameraControlValue	VideoCaptureDeviceCameraControlValue.

Video_CaptureDevice_CameraControl_GetAsync(CameraControlProperty)

Gets camera control settings (async).

Declaration

public Task<VideoCaptureDeviceCameraControlValue> Video_CaptureDevice_CameraControl_GetAsync(CameraControlProperty property)

Parameters

Type	Name	Description
CameraControlProperty	property	Property type.

Returns

Type	Description
Task<VideoCaptureDeviceCameraControlValue>	Task<VideoCaptureDeviceCameraControlValue>.

Video_CaptureDevice_CameraControl_GetRange(CameraControlProperty)

Gets range of available values for camera control.

Declaration

public VideoCaptureDeviceCameraControlRanges Video_CaptureDevice_CameraControl_GetRange(CameraControlProperty property)

Parameters

Type	Name	Description
CameraControlProperty	property	Property type.

Returns

Type	Description
VideoCaptureDeviceCameraControlRanges	The VideoCaptureDeviceCameraControlRanges.

Video_CaptureDevice_CameraControl_GetRangeAsync(CameraControlProperty)

Gets range of available values for camera control (async).

Declaration

public Task<VideoCaptureDeviceCameraControlRanges> Video_CaptureDevice_CameraControl_GetRangeAsync(CameraControlProperty property)

Parameters

Type	Name	Description
CameraControlProperty	property	Property type.

Returns

Type	Description
Task<VideoCaptureDeviceCameraControlRanges>	Task<VideoCaptureDeviceCameraControlRanges>.

Video_CaptureDevice_CameraControl_Set(CameraControlProperty, VideoCaptureDeviceCameraControlValue)

Sets camera control settings.

Declaration

public bool Video_CaptureDevice_CameraControl_Set(CameraControlProperty property, VideoCaptureDeviceCameraControlValue value)

Parameters

Type	Name	Description
CameraControlProperty	property	Property type.
VideoCaptureDeviceCameraControlValue	value	Value.

Returns

Type	Description
bool	The bool.

Video_CaptureDevice_CameraControl_SetAsync(CameraControlProperty, VideoCaptureDeviceCameraControlValue)

Sets camera control settings (async).

Declaration

public Task<bool> Video_CaptureDevice_CameraControl_SetAsync(CameraControlProperty property, VideoCaptureDeviceCameraControlValue value)

Parameters

Type	Name	Description
CameraControlProperty	property	Property type.
VideoCaptureDeviceCameraControlValue	value	Value.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

Video_CaptureDevice_CrossBar_ClearConnections()

Clears the list of crossbar connections.

Declaration

public void Video_CaptureDevice_CrossBar_ClearConnections()

Video_CaptureDevice_CrossBar_Connect(string, string, bool)

Sets the connection in the crossbar.

Declaration

public bool Video_CaptureDevice_CrossBar_Connect(string inputPin, string outputPin, bool connectRelated)

Parameters

Type	Name	Description
string	inputPin	Input pin name.
string	outputPin	Output pin name.
bool	connectRelated	Connect related pins.

Returns

Type	Description
bool	Returns true, if the operation was successful.

Video_CaptureDevice_CrossBar_GetConnectedInputForOutput(string)

Gets connected input for selected output.

Declaration

public string Video_CaptureDevice_CrossBar_GetConnectedInputForOutput(string outputPin)

Parameters

Type	Name	Description
string	outputPin	Output pin name.

Returns

Type	Description
string	System.String.

Video_CaptureDevice_CrossBar_GetInputsForOutput(string)

Gets selected input name list for selected output.

Declaration

public ObservableCollection<string> Video_CaptureDevice_CrossBar_GetInputsForOutput(string outputPin)

Parameters

Type	Name	Description
string	outputPin	Output pin name.

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<System.String>.

Video_CaptureDevice_CrossBar_GetRelated(string, string, out string, out string)

Gets related pins for selected input and output pins.

Declaration

public void Video_CaptureDevice_CrossBar_GetRelated(string inputPin, string outputPin, out string relatedInputPin, out string relatedOutputPin)

Parameters

Type	Name	Description
string	inputPin	Input pin name.
string	outputPin	Output pin name.
string	relatedInputPin	Related input pin name.
string	relatedOutputPin	Related output pin name.

Video_CaptureDevice_CrossBar_Init(string)

Initializes the crossbar.

Declaration

public bool Video_CaptureDevice_CrossBar_Init(string deviceName)

Parameters

Type	Name	Description
string	deviceName	Device name.

Returns

Type	Description
bool	Returns true, if the operation was successful.

Video_CaptureDevice_CrossBar_Outputs()

Gets crossbar output list.

Declaration

public ObservableCollection<string> Video_CaptureDevice_CrossBar_Outputs()

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<System.String>.

Video_CaptureDevice_Get_DroppedFramesCountFromDevice()

Gets the count of dropped frames.

Declaration

public Tuple<int, int> Video_CaptureDevice_Get_DroppedFramesCountFromDevice()

Returns

Type	Description
Tuple<int, int>	Task<Tuple<System.Int32, System.Int32>>. First item - dropped, second item - not dropped.

Video_CaptureDevice_Get_DroppedFramesCountFromDeviceAsync()

Gets the count of dropped frames.

Declaration

public Task<Tuple<int, int>> Video_CaptureDevice_Get_DroppedFramesCountFromDeviceAsync()

Returns

Type	Description
Task<Tuple<int, int>>	Task<Tuple<System.Int32, System.Int32>>. First item - dropped, second item - not dropped.

Video_CaptureDevice_InternalMPEGEncoder_ShowDialog(nint, string)

Displays the dialog box with the settings of the selected Internal MPEG encoder.

Declaration

public void Video_CaptureDevice_InternalMPEGEncoder_ShowDialog(nint parent, string name)

Parameters

Type	Name	Description
nint	parent	The parent.
string	name	The name.

Video_CaptureDevice_SetDefault()

Set the video capture device to default.

Declaration

public bool Video_CaptureDevice_SetDefault()

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

Video_CaptureDevice_SettingsDialog_Show(nint, string, PropertyPageType)

Displays the dialog box with the settings of the selected video capture device filter.

Declaration

public void Video_CaptureDevice_SettingsDialog_Show(nint parent, string deviceName, PropertyPageType propertyPage = PropertyPageType.Default)

Parameters

Type	Name	Description
nint	parent	Parent handle. Use IntPtr.Zero if you are do not want to have a parent.
string	deviceName	Device name.
PropertyPageType	propertyPage	Property page.

Video_CaptureDevice_SignalPresent()

Returns true, if video capture device has a video signal.

Declaration

public bool Video_CaptureDevice_SignalPresent()

Returns

Type	Description
bool	The bool.

Video_CaptureDevice_SignalPresentAsync()

Returns true, if video capture device has a video signal.

Declaration

public Task<bool> Video_CaptureDevice_SignalPresentAsync()

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

Video_CaptureDevice_VendorProperties_Get(VideoCaptureVendorAPIKey)

Gets specific vendor property for a camera. Two values. Please check description, depending from "key" value.

Declaration

public Tuple<object, object> Video_CaptureDevice_VendorProperties_Get(VideoCaptureVendorAPIKey key)

Parameters

Type	Name	Description
VideoCaptureVendorAPIKey	key	The key.

Returns

Type	Description
Tuple<object, object>	Tuple<System.Object, System.Object>.

Video_CaptureDevice_VendorProperties_GetAsync(VideoCaptureVendorAPIKey)

Gets specific vendor property for a camera. Two values. Please check description, depending from "key" value (async).

Declaration

public Task<Tuple<object, object>> Video_CaptureDevice_VendorProperties_GetAsync(VideoCaptureVendorAPIKey key)

Parameters

Type	Name	Description
VideoCaptureVendorAPIKey	key	Property key.

Returns

Type	Description
Task<Tuple<object, object>>	Task<Tuple<System.Object, System.Object>>.

Video_CaptureDevice_VendorProperties_GetKSPropertySet()

Gets video capture device IKsPropertySet interface.

Declaration

public object Video_CaptureDevice_VendorProperties_GetKSPropertySet()

Returns

Type	Description
object	System.Object.

Video_CaptureDevice_VendorProperties_GetKSPropertySetAsync()

Gets video capture device IKsPropertySet interface (async).

Declaration

public Task<object> Video_CaptureDevice_VendorProperties_GetKSPropertySetAsync()

Returns

Type	Description
Task<object>	Task<System.Object>.

Video_CaptureDevice_VendorProperties_Set(VideoCaptureVendorAPIKey, VideoCaptureVendorAPIValueType, object, object)

Sets specific vendor property for a camera.

Declaration

public bool Video_CaptureDevice_VendorProperties_Set(VideoCaptureVendorAPIKey key, VideoCaptureVendorAPIValueType valueType, object value1, object value2)

Parameters

Type	Name	Description
VideoCaptureVendorAPIKey	key	Property key.
VideoCaptureVendorAPIValueType	valueType	Property value type.
object	value1	Property value. Please check value / value type description to pass correct parameter.
object	value2	Property value 2. Please check value / value type description to pass correct parameter.

Returns

Type	Description
bool	The bool.

Video_CaptureDevice_VendorProperties_SetAsync(VideoCaptureVendorAPIKey, VideoCaptureVendorAPIValueType, object, object)

Sets specific vendor property for a camera (async).

Declaration

public Task<bool> Video_CaptureDevice_VendorProperties_SetAsync(VideoCaptureVendorAPIKey key, VideoCaptureVendorAPIValueType valueType, object value1, object value2)

Parameters

Type	Name	Description
VideoCaptureVendorAPIKey	key	Property key.
VideoCaptureVendorAPIValueType	valueType	Property value type.
object	value1	Property value. Please check value / value type description to pass correct parameter.
object	value2	Property value 2. Please check value / value type description to pass correct parameter.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

Video_CaptureDevice_VendorProperties_Supported(VideoCaptureVendorAPIKey)

Checks specific vendor interface support for a camera. First tuple value - "get" supported, second value - "set" supported.

Declaration

public Tuple<bool, bool> Video_CaptureDevice_VendorProperties_Supported(VideoCaptureVendorAPIKey key)

Parameters

Type	Name	Description
VideoCaptureVendorAPIKey	key	Property key.

Returns

Type	Description
Tuple<bool, bool>	Tuple<System.Boolean, System.Boolean>.

Video_CaptureDevice_VendorProperties_SupportedAsync(VideoCaptureVendorAPIKey)

Checks specific vendor interface support for a camera. First tuple value - "get" supported, second value - "set" supported. Async.

Declaration

public Task<Tuple<bool, bool>> Video_CaptureDevice_VendorProperties_SupportedAsync(VideoCaptureVendorAPIKey key)

Parameters

Type	Name	Description
VideoCaptureVendorAPIKey	key	Property key.

Returns

Type	Description
Task<Tuple<bool, bool>>	The Task.

Video_CaptureDevice_VideoAdjust_GetRanges(VideoHardwareAdjustment)

Gets the available ranges for the selected adjustment.

Declaration

public VideoCaptureDeviceAdjustRanges Video_CaptureDevice_VideoAdjust_GetRanges(VideoHardwareAdjustment adjustType)

Parameters

Type	Name	Description
VideoHardwareAdjustment	adjustType	Adjustment type.

Returns

Type	Description
VideoCaptureDeviceAdjustRanges	The VideoCaptureDeviceAdjustRanges.

Video_CaptureDevice_VideoAdjust_GetRangesAsync(VideoHardwareAdjustment)

Gets the available ranges for the selected adjustment (async).

Declaration

public Task<VideoCaptureDeviceAdjustRanges> Video_CaptureDevice_VideoAdjust_GetRangesAsync(VideoHardwareAdjustment adjustType)

Parameters

Type	Name	Description
VideoHardwareAdjustment	adjustType	Adjustment type.

Returns

Type	Description
Task<VideoCaptureDeviceAdjustRanges>	Task<VideoCaptureDeviceAdjustRanges>.

Video_CaptureDevice_VideoAdjust_GetValue(VideoHardwareAdjustment)

Gets the current value for the selected adjustment.

Declaration

public VideoCaptureDeviceAdjustValue Video_CaptureDevice_VideoAdjust_GetValue(VideoHardwareAdjustment adjustType)

Parameters

Type	Name	Description
VideoHardwareAdjustment	adjustType	Adjustment type.

Returns

Type	Description
VideoCaptureDeviceAdjustValue	VideoCaptureDeviceAdjustValue.

Video_CaptureDevice_VideoAdjust_GetValue(VideoHardwareAdjustment, out int, out bool)

Gets the current value for the selected adjustment.

Declaration

public bool Video_CaptureDevice_VideoAdjust_GetValue(VideoHardwareAdjustment adjustType, out int value, out bool auto)

Parameters

Type	Name	Description
VideoHardwareAdjustment	adjustType	Adjustment type.
int	value	Value.
bool	auto	Auto.

Returns

Type	Description
bool	The bool.

Video_CaptureDevice_VideoAdjust_GetValueAsync(VideoHardwareAdjustment)

Gets the current value for the selected adjustment (async).

Declaration

public Task<VideoCaptureDeviceAdjustValue> Video_CaptureDevice_VideoAdjust_GetValueAsync(VideoHardwareAdjustment adjustType)

Parameters

Type	Name	Description
VideoHardwareAdjustment	adjustType	Adjustment type.

Returns

Type	Description
Task<VideoCaptureDeviceAdjustValue>	Task<VideoCaptureDeviceAdjustValue>.

Video_CaptureDevice_VideoAdjust_SetValue(VideoHardwareAdjustment, VideoCaptureDeviceAdjustValue)

Sets the new value for the selected adjustment.

Declaration

public bool Video_CaptureDevice_VideoAdjust_SetValue(VideoHardwareAdjustment adjustType, VideoCaptureDeviceAdjustValue value)

Parameters

Type	Name	Description
VideoHardwareAdjustment	adjustType	Adjustment type.
VideoCaptureDeviceAdjustValue	value	Value.

Returns

Type	Description
bool	The bool.

Video_CaptureDevice_VideoAdjust_SetValueAsync(VideoHardwareAdjustment, VideoCaptureDeviceAdjustValue)

Sets the new value for the selected adjustment (async).

Declaration

public Task<bool> Video_CaptureDevice_VideoAdjust_SetValueAsync(VideoHardwareAdjustment adjustType, VideoCaptureDeviceAdjustValue value)

Parameters

Type	Name	Description
VideoHardwareAdjustment	adjustType	Adjustment type.
VideoCaptureDeviceAdjustValue	value	Value.

Returns

Type	Description
Task<bool>	Task<System.Boolean>.

Video_CaptureDevices()

Gets a video capture device list.

Declaration

public ObservableCollection<VideoCaptureDeviceInfo> Video_CaptureDevices()

Returns

Type	Description
ObservableCollection<VideoCaptureDeviceInfo>	ObservableCollection<VideoCaptureDeviceInfo>.

Video_Codecs()

Gets 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.

Remarks

You can specify filters parameters using either the settings dialog box or direct access to the filter interface with the help of the plug-in system.

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_SetCustomWindowHandle(nint)

Sets custom window handle for video rendering.

Declaration

public void Video_Renderer_SetCustomWindowHandle(nint handle)

Parameters

Type	Name	Description
nint	handle	The handle.

Video_Renderer_Update(int, int)

Update screen settings.

Declaration

public void Video_Renderer_Update(int newWidth = 0, int newHeight = 0)

Parameters

Type	Name	Description
int	newWidth	The new width.
int	newHeight	The new height.

Video_Renderer_UpdateAsync(int, int)

Update screen settings (async).

Declaration

public Task Video_Renderer_UpdateAsync(int newWidth = 0, int newHeight = 0)

Parameters

Type	Name	Description
int	newWidth	The new width.
int	newHeight	The new height.

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?	System.Nullable<System.Single>.

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?>	Task<System.Nullable<System.Single>>.

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>.

Virtual_Camera_Output_IsAvailable()

Checks if the virtual camera output is available.

Declaration

public bool Virtual_Camera_Output_IsAvailable()

Returns

Type	Description
bool	System.Boolean.

Virtual_Camera_Output_RegisterAsAdmin(bool)

Registers virtual camera output. Admin rights required. VisioForge.DotNet.Core.Redist.VirtualCamera NuGet package for x86 or x64 platforms should be added to the project.

Declaration

public bool Virtual_Camera_Output_RegisterAsAdmin(bool allowAppRestart)

Parameters

Type	Name	Description
bool	allowAppRestart	if set to `true` allows application restart with admin rights.

Returns

Type	Description
bool	`true` if successful, `false` otherwise.

WMV_CustomProfile_AudioCodecs(WMVStreamMode)

Gets WMV audio codec list.

Declaration

public ObservableCollection<string> WMV_CustomProfile_AudioCodecs(WMVStreamMode mode)

Parameters

Type	Name	Description
WMVStreamMode	mode	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	Mode.

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<System.String>.

WMV_CustomProfile_SaveToFile(WMVOutput, string)

Saves WMV custom profile to the file.

Declaration

public void WMV_CustomProfile_SaveToFile(WMVOutput wmvOutput, string filename)

Parameters

Type	Name	Description
WMVOutput	wmvOutput	WMV output settings.
string	filename	File name.

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 profiles list.

Declaration

public ObservableCollection<string> WMV_Internal_Profiles()

Returns

Type	Description
ObservableCollection<string>	ObservableCollection<System.String>.

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 audio 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>

OnBDAChannelFound

This event occurs whenever each new DVB-x / ATSC channel found.

Declaration

public event EventHandler<BDAChannelEventArgs> OnBDAChannelFound

Event Type

Type	Description
EventHandler<BDAChannelEventArgs>

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>

OnClosedCaptionsBuffer

This event occurs in a case of an new closed caption.

Declaration

public event EventHandler<ClosedCaptionsBufferEventArgs> OnClosedCaptionsBuffer

Event Type

Type	Description
EventHandler<ClosedCaptionsBufferEventArgs>

OnClosedCaptionsText

Closed captions text event.

Declaration

public event EventHandler<ClosedCaptionsTextEventArgs> OnClosedCaptionsText

Event Type

Type	Description
EventHandler<ClosedCaptionsTextEventArgs>

OnDataFrameBuffer

Occurs when new data frame buffer received. Current this event available only for FFMPEG engine.

Declaration

public event EventHandler<DataFrameEventArgs> OnDataFrameBuffer

Event Type

Type	Description
EventHandler<DataFrameEventArgs>

OnDecklinkInputDisconnected

This event occurs whenever Decklink input disconnected. Preview or capture should be started.

Declaration

public event EventHandler<EventArgs> OnDecklinkInputDisconnected

Event Type

Type	Description
EventHandler<EventArgs>

OnDecklinkInputReconnected

This event occurs whenever Decklink input reconnected. Preview or capture should be started.

Declaration

public event EventHandler<EventArgs> OnDecklinkInputReconnected

Event Type

Type	Description
EventHandler<EventArgs>

OnDeviceAdded

This event occurs whenever new device added.

Declaration

public event EventHandler<DeviceRemovedAddedEventArgs> OnDeviceAdded

Event Type

Type	Description
EventHandler<DeviceRemovedAddedEventArgs>

OnDeviceRemoved

This event occurs whenever device removed.

Declaration

public event EventHandler<DeviceRemovedAddedEventArgs> OnDeviceRemoved

Event Type

Type	Description
EventHandler<DeviceRemovedAddedEventArgs>

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>

OnFaceDetected

This event occurs whenever each new video frame is received and a face(s) detected.

Declaration

public event EventHandler<AFFaceDetectionEventArgs> OnFaceDetected

Event Type

Type	Description
EventHandler<AFFaceDetectionEventArgs>

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>

OnMJPEGLowLatencyRAWFrame

This event occurs whenever MJPEG low latency raw frame received.

Declaration

public event EventHandler<byte[]> OnMJPEGLowLatencyRAWFrame

Event Type

Type	Description
EventHandler<byte[]>

OnMotion

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

Declaration

public event EventHandler<MotionDetectionEventArgs> OnMotion

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>

OnNetworkSourceDisconnect

This event occurs whenever network source stopped or disconnected.

Declaration

public event EventHandler<EventArgs> OnNetworkSourceDisconnect

Event Type

Type	Description
EventHandler<EventArgs>

OnRTSPLowLatencyRAWFrame

This event occurs whenever RTSP low latency raw frame received.

Declaration

public event EventHandler<RawFrame> OnRTSPLowLatencyRAWFrame

Event Type

Type	Description
EventHandler<RawFrame>

OnScreenCaptureKeyDown

Occurs when key pressed.

Declaration

public event EventHandler<KeyEventArgs> OnScreenCaptureKeyDown

Event Type

Type	Description
EventHandler<KeyEventArgs>

OnScreenCaptureMouseClick

Occurs when mouse clicked.

Declaration

public event EventHandler<MouseEventArgs> OnScreenCaptureMouseClick

Event Type

Type	Description
EventHandler<MouseEventArgs>

OnSeparateCaptureStarted

This event occurs whenever the separate capture started.

Declaration

public event EventHandler<SeparateCaptureFileEventArgs> OnSeparateCaptureStarted

Event Type

Type	Description
EventHandler<SeparateCaptureFileEventArgs>

OnSeparateCaptureStopped

This event occurs whenever the separate capture stopped.

Declaration

public event EventHandler<SeparateCaptureFileEventArgs> OnSeparateCaptureStopped

Event Type

Type	Description
EventHandler<SeparateCaptureFileEventArgs>

OnSourceConnected

This event occurs whenever source connected and first video frame is received.

Declaration

public event EventHandler<SourceConnectedEventArgs> OnSourceConnected

Event Type

Type	Description
EventHandler<SourceConnectedEventArgs>

OnStart

This event occurs whenever the capture / preview starts.

Declaration

public event EventHandler<EventArgs> OnStart

Event Type

Type	Description
EventHandler<EventArgs>

OnStillVideoFrameBitmap

This event occurs whenever each new still video frame is received.

Declaration

public event EventHandler<VideoFrameBitmapEventArgs> OnStillVideoFrameBitmap

Event Type

Type	Description
EventHandler<VideoFrameBitmapEventArgs>

OnStillVideoFrameBuffer

This event occurs whenever each new still video frame is received.

Declaration

public event EventHandler<VideoFrameBufferEventArgs> OnStillVideoFrameBuffer

Event Type

Type	Description
EventHandler<VideoFrameBufferEventArgs>

OnStop

This event occurs whenever the capture / preview stop.

Declaration

public event EventHandler<StopEventArgs> OnStop

Event Type

Type	Description
EventHandler<StopEventArgs>

OnTVTunerTuneChannels

This event occurs whenever a channel search (tuning) and contains the presence of the signal, the number of the channel and its frequency.

Declaration

public event EventHandler<TVTunerTuneChannelsEventArgs> OnTVTunerTuneChannels

Event Type

Type	Description
EventHandler<TVTunerTuneChannelsEventArgs>

OnTimeshiftFileCreated

This event occurs in a case of a new timeshift file created. You can open file file in Media Player SDK.

Declaration

public event EventHandler<TimeshiftFileEventArgs> OnTimeshiftFileCreated

Event Type

Type	Description
EventHandler<TimeshiftFileEventArgs>

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 (RGB24).

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>

OnVideoFrameBufferRAW

This event occurs whenever each new video frame is received (RAW during IP capture).

Declaration

public event EventHandler<VideoFrameBufferEventArgs> OnVideoFrameBufferRAW

Event Type

Type	Description
EventHandler<VideoFrameBufferEventArgs>

Remarks

Not thread-safe, video data comes directly to this event, please, be very accurate.

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>

PropertyChanged

Property changed event.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
PropertyChangedEventHandler

Implements

IVideoCaptureControls

IVideoEffectsControls

IVideoCaptureCore

IMPVCVECore

INotifyPropertyChanged

IAsyncDisposable

IDisposable

Search Results for

Class VideoCaptureCore

Inheritance

Implements

Inherited Members

Namespace: VisioForge.Core.VideoCapture

Assembly: VisioForge.Core.dll

Syntax

Constructors

VideoCaptureCore(bool)

Declaration

Parameters

VideoCaptureCore(IVideoView, bool)

Declaration

Parameters

Properties

Additional_Audio_CaptureDevice_MixChannels

Declaration

Property Value

Remarks

Audio_CaptureDevice

Declaration

Property Value

Audio_Channel_Mapper

Declaration

Property Value

Audio_Decoder

Declaration

Property Value

Audio_Effects_Enabled

Declaration

Property Value

Audio_Enhancer_Enabled

Declaration

Property Value

Audio_OutputDevice

Declaration

Property Value

Remarks

Audio_PCM_Converter

Declaration

Property Value

Audio_PlayAudio

Declaration

Property Value

Audio_RecordAudio

Declaration

Property Value

Audio_Sample_Grabber_Enabled

Declaration

Property Value

Audio_VUMeter_Enabled

Declaration

Property Value

Audio_VUMeter_Pro_Enabled

Declaration

Property Value

Remarks

Audio_VUMeter_Pro_Volume

Declaration

Property Value

BDA_Source

Declaration

Property Value

Barcode_Reader_Enabled

Declaration

Property Value

Barcode_Reader_Type

Declaration

Property Value

ChromaKey

Declaration

Property Value

CustomRedist_Auto

Declaration

Property Value

CustomRedist_DisableDialog

Declaration

Property Value

CustomRedist_Path