public class MediaPlayerCore : IMediaPlayerControls, IVideoEffectsControls, IDisposable, IMediaPlayerCore, IMPVCVECore, INotifyPropertyChanged, IAsyncDisposable

Constructors

MediaPlayerCore()

Initializes a new instance of the MediaPlayerCore class.

Declaration

public MediaPlayerCore()

MediaPlayerCore(bool)

Initializes a new instance of the MediaPlayerCore class.

Declaration

public MediaPlayerCore(bool initialize)

Parameters

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

MediaPlayerCore(IVideoView, bool)

Initializes a new instance of the MediaPlayerCore class.

Declaration

public MediaPlayerCore(IVideoView videoView, bool initialize = true)

Parameters

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

Properties

Audio_Channel_Mapper

Gets or sets an audio channel mapper settings.

Declaration

public AudioChannelMapperSettings Audio_Channel_Mapper { get; set; }

Property Value

Type	Description
AudioChannelMapperSettings

Audio_Effects_Enabled

Gets or sets a value indicating whether audio effects are enabled.

Declaration

public bool Audio_Effects_Enabled { get; set; }

Property Value

Type	Description
bool

Audio_Effects_Tempo_Enabled

Gets or sets a value indicating whether tempo effects is enabled.

Declaration

public bool Audio_Effects_Tempo_Enabled { get; set; }

Property Value

Type	Description
bool	`true` if tempo effect is enabled; otherwise, `false`.

Audio_Effects_Tempo_Value

Gets or sets the audio effects tempo value.

Declaration

public int Audio_Effects_Tempo_Value { get; set; }

Property Value

Type	Description
int	The audio effects tempo value.

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_Play = true for it to work.

Declaration

public string Audio_OutputDevice { get; set; }

Property Value

Type	Description
string

Audio_PlayAudio

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

Declaration

public bool Audio_PlayAudio { 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

public int Audio_VUMeter_Pro_Volume { get; set; }

Property Value

Type	Description
int

Barcode_Reader_Enabled

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

Declaration

public bool Barcode_Reader_Enabled { get; set; }

Property Value

Type	Description
bool

Barcode_Reader_Type

Gets or sets barcode type to detect.

Declaration

public BarcodeType Barcode_Reader_Type { get; set; }

Property Value

Type	Description
BarcodeType

ChromaKey

Gets or sets chroma key settings.

Declaration

public ChromaKeySettings ChromaKey { get; set; }

Property Value

Type	Description
ChromaKeySettings

ConsoleUsage

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

Declaration

public bool ConsoleUsage { get; set; }

Property Value

Type	Description
bool

CustomParameters

Gets or sets the custom parameters.

Declaration

public Dictionary<string, string> CustomParameters { get; set; }

Property Value

Type	Description
Dictionary<string, string>

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 will be disabled. During the start, SDK checking base redist state. If not redist available, SDK shows a dialog. Use this property to disable dialog.

Declaration

public bool CustomRedist_DisableDialog { get; set; }

Property Value

Type	Description
bool

CustomRedist_Path

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

Declaration

public string CustomRedist_Path { get; set; }

Property Value

Type	Description
string

Custom_Audio_Decoder

Gets or sets audio decoder name. Use empty string for default decoder.

Declaration

public string Custom_Audio_Decoder { get; set; }

Property Value

Type	Description
string

Custom_Splitter

Gets or sets custom splitter name. Use empty string for default splitter.

Declaration

public string Custom_Splitter { get; set; }

Property Value

Type	Description
string

Custom_Video_Decoder

Gets or sets video decoder name. Use empty string for default decoder.

Declaration

public string Custom_Video_Decoder { get; set; }

Property Value

Type	Description
string

Debug_Dir

Gets or sets debug directory.

Declaration

public string Debug_Dir { get; set; }

Property Value

Type	Description
string

Debug_DisableMessageDialogs

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

Declaration

public bool Debug_DisableMessageDialogs { get; set; }

Property Value

Type	Description
bool

Debug_Mode

Gets or sets a value indicating whether debug mode enabled.

Declaration

public bool Debug_Mode { get; set; }

Property Value

Type	Description
bool

Debug_Telemetry

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

Declaration

public bool Debug_Telemetry { get; set; }

Property Value

Type	Description
bool

Remarks

Only anonymous data will be send.

Encryption_Key

Sets encryption key - string, filename or binary key.

Declaration

public object Encryption_Key { set; }

Property Value

Type	Description
object

Encryption_KeyType

Gets or sets encryption key type.

Declaration

public EncryptionKeyType Encryption_KeyType { get; set; }

Property Value

Type	Description
EncryptionKeyType

Face_Tracking

Gets or sets face tracking settings.

Declaration

public FaceTrackingSettings Face_Tracking { get; set; }

Property Value

Type	Description
FaceTrackingSettings

Info_UseLibMediaInfo

Gets or sets a value indicating whether libMediaInfo will be used to read information about files.

Declaration

public bool Info_UseLibMediaInfo { get; set; }

Property Value

Type	Description
bool

Loop

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

Declaration

public bool Loop { get; set; }

Property Value

Type	Description
bool

Loop_DoNotSeekToBeginning

Gets or sets a value indicating whether seeking to start will be not performed when playback completed.

Declaration

public bool Loop_DoNotSeekToBeginning { get; set; }

Property Value

Type	Description
bool

MIDI_Renderer

Gets or sets MIDI renderer. Can be empty to use first in the list.

Declaration

public string MIDI_Renderer { get; set; }

Property Value

Type	Description
string

MaximalSpeedPlayback

Gets or sets a value indicating whether maximal speed playback enabled.

Declaration

public bool MaximalSpeedPlayback { get; set; }

Property Value

Type	Description
bool

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.

NDI_Output

Gets or sets NDI output settings. Video renderer output will be disabled. You can use OnVideoFrameXXX events to get rendered video frames.

Declaration

public NDIOutput NDI_Output { get; set; }

Property Value

Type	Description
NDIOutput

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

Play_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 Play_DelayEnabled { get; set; }

Property Value

Type	Description
bool

Play_PauseAtFirstFrame

Gets or sets a value indicating whether playback will be paused at first frame.

Declaration

public bool Play_PauseAtFirstFrame { get; set; }

Property Value

Type	Description
bool

ReversePlayback_CacheSize

Gets or sets reverse playback cache size (in frames).

Declaration

public int ReversePlayback_CacheSize { get; set; }

Property Value

Type	Description
int

ReversePlayback_Enabled

Gets or sets a value indicating whether reverse playback mode enabled.

Declaration

public bool ReversePlayback_Enabled { get; set; }

Property Value

Type	Description
bool

Selection_Active

Gets or sets a value indicating whether selection mode is active.

Declaration

public bool Selection_Active { get; set; }

Property Value

Type	Description
bool

Selection_Start

Gets or sets selection start position.

Declaration

public TimeSpan Selection_Start { get; set; }

Property Value

Type	Description
TimeSpan

Selection_Stop

Gets or sets selection stop position.

Declaration

public TimeSpan Selection_Stop { get; set; }

Property Value

Type	Description
TimeSpan

Source_Custom_CLSID

Gets or sets source custom filter CLSID.

Declaration

public string Source_Custom_CLSID { get; set; }

Property Value

Type	Description
string

Source_GPU_Mode

Gets or sets source GPU mode, if Source_Mode property set to GPU.

Declaration

public LAVGPUDecoder Source_GPU_Mode { get; set; }

Property Value

Type	Description
LAVGPUDecoder

Source_MemoryStream

Gets or sets source stream if Source_Mode = MediaPlayerSourceMode.Memory.

Declaration

[JsonIgnore]
public MemoryStreamSource Source_MemoryStream { get; set; }

Property Value

Type	Description
MemoryStreamSource

Source_Mode

Gets or sets source mode.

Declaration

public MediaPlayerSourceMode Source_Mode { get; set; }

Property Value

Type	Description
MediaPlayerSourceMode

VideoView

Gets or sets the video view.

Declaration

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

Property Value

Type	Description
IVideoView

Video_Crop

Gets or sets video crop settings.

Declaration

public VideoCropSettings Video_Crop { get; set; }

Property Value

Type	Description
VideoCropSettings

Video_Effects_Enabled

Gets or sets a value indicating whether video effects are 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_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_Sample_Grabber_UseForVideoEffects

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

Declaration

public bool Video_Sample_Grabber_UseForVideoEffects { 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 Camera SDK enabled. Video renderer output will be disabled. You can use OnVideoFrameXXX events to get rendered video frames.

Declaration

public bool Virtual_Camera_Output_Enabled { get; set; }

Property Value

Type	Description
bool

Virtual_Camera_Output_LicenseKey

Gets or sets Virtual Camera SDK license key.

Declaration

public string Virtual_Camera_Output_LicenseKey { get; set; }

Property Value

Type	Description
string

Methods

Audio_AdditionalStreams_Add(string)

Add additional audio stream.

Declaration

public void Audio_AdditionalStreams_Add(string filename)

Parameters

Type	Name	Description
string	filename	File name.

Audio_AdditionalStreams_Clear()

Clears additional audio streams.

Declaration

public void Audio_AdditionalStreams_Clear()

Audio_AdditionalStreams_GetCount()

Gets audio additional audio streams count.

Declaration

public int Audio_AdditionalStreams_GetCount()

Returns

Type	Description
int	System.Int32.

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

Adds audio effect.

Declaration

public void Audio_Effects_Add(int streamIndex, AudioEffectType effectType, string name, bool enabled, TimeSpan startTime, TimeSpan stopTime)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
AudioEffectType	effectType	Effect type.
string	name	Name.
bool	enabled	true if enabled, false if disabled.
TimeSpan	startTime	Start time.
TimeSpan	stopTime	Stop time.

Audio_Effects_Amplify(int, string, int, bool)

Sets parameters for the amplify effect.

Declaration

public void Audio_Effects_Amplify(int streamIndex, string name, int volume, bool separate)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
int	volume	Sets the amplification for a channel. Default value is 10000, which means that no amplification occurs. A value of 20000 raises the amplification by 2. If separate is True, then every channel will be amplified by it's channel amplification value. If separate is False, then every channel is amplified with the value of channel 0.
bool	separate	Enables or Disables separate amplification. If Enabled every channel will be amplified by it's own amplification value. If Disabled every channel will be amplified with the amplification value of channel 0.

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

Sets the parameters for the Band Pass effect.

Declaration

public void Audio_Effects_BandPass(int streamIndex, string name, float cutOffHigh, float cutOffLow, bool separate)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
float	cutOffHigh	Specifies the high cutoff frequency for a specific channel.
float	cutOffLow	Specifies the low cutoff frequency for a specific channel.
bool	separate	Enables or Disables separate cutoff. If Enabled every channel will be processed by it's own cutoff value. If disabled every channel will be processed with the cutoff value of channel 0.

Remarks

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

Audio_Effects_ChannelOrderEx(int, string, byte[,])

Sets parameters for the channel order effect.

Declaration

public void Audio_Effects_ChannelOrderEx(int streamIndex, string name, byte[,] orders)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
byte[,]	orders	Specifies the order of the channels. 2xn array, each pair is byte x byte, first byte is target channel, second byte is source channel.

Audio_Effects_Clear(int)

Deletes all the inserted audio effects.

Declaration

public void Audio_Effects_Clear(int streamIndex)

Parameters

Type	Name	Description
int	streamIndex	Stream index.

Audio_Effects_Count(int)

Gets the count of audio effects in use.

Declaration

public int Audio_Effects_Count(int streamIndex)

Parameters

Type	Name	Description
int	streamIndex	Stream index.

Returns

Type	Description
int	System.Int32.

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

Sets the parameters for the DS Chorus effect.

Declaration

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

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
float	delay	Specifies the delay of the filter (0 - 20.0).
float	depth	Specifies the depth of the filter (0 - 100.0).
float	feedback	Specifies the feedback of the filter (-99.0 - 99.0).
float	frequency	Specifies the frequency of the filter (0 - 10.0).
DSChorusPhase	phase	Specifies the phase angle.
DSChorusWaveForm	waveformTriangle	Specifies the waveform type of the filter.
float	wetDryMix	Specifies the wet and dry mix (0 - 100.0).

Remarks

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

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

Sets the parameters for the DS Compressor effect.

Declaration

public void Audio_Effects_DS_Compressor(int streamIndex, string name, float attack, float gain, float preDelay, float ratio, float release, float threshold)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
float	attack	Specifies the attack time in ms (0.01 - 500).
float	gain	Specifies the gain of the filter (-60.0 - 60.0).
float	preDelay	Specifies the pre-delay of the filter (0.0 - 4.0).
float	ratio	Specifies the ratio of the filter (1.0 - 100.0).
float	release	Specifies the release time in ms (50.0 - 3000.0).
float	threshold	Specifies the threshold of the filter (-60.0 - 0.0).

Remarks

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

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

Sets the parameters for the DS Distortion effect.

Declaration

public void Audio_Effects_DS_Distortion(int streamIndex, string name, float edge, float gain, float postEQBandwidth, float postEQCenterFrequency, float preLowpassCutOff)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
float	edge	Specifies the edge of the filter (0.0 - 100.0).
float	gain	Specifies the gain of the filter (-60.0 - 0).
float	postEQBandwidth	Specifies the bandwidth of the equalizer (100.0 - 8000.0).
float	postEQCenterFrequency	Specifies the center frequency of the distortion equalizer (100.0 - 8000.0).
float	preLowpassCutOff	Specifies the low pass cutoff of the filter (100.0 - 8000.0).

Remarks

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

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

Sets the parameters for the DS Echo effect.

Declaration

public void Audio_Effects_DS_Echo(int streamIndex, string name, float feedback, float leftDelay, float rightDelay, int panDelay, float wetDryMix)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
float	feedback	Specifies the feedback of the filter (0 - 100.0).
float	leftDelay	Specifies the left delay of the filter (1.0 - 2000.0).
float	rightDelay	Specifies the right delay of the filter (1.0 - 2000.0).
int	panDelay	The pan delay.
float	wetDryMix	Specifies the wet and dry mix of the filter (0.0 - 100.0).

Remarks

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

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

Sets the parameters for the DS Flanger effect.

Declaration

public void Audio_Effects_DS_Flanger(int streamIndex, string name, float delay, float depth, float feedback, float frequency, int phase, DSFlangerWaveForm waveform, float wetDryMix)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
float	delay	Specifies the delay of the filter (0.0 - 4.0).
float	depth	Specifies the depth of the filter (0.0 - 100.0).
float	feedback	Specifies the feedback of the filter (-99.0 - 99.0).
float	frequency	Specifies the frequency of the filter (0.0 - 10.0).
int	phase	Specifies the phase angle.
DSFlangerWaveForm	waveform	Specifies the waveform type of the filter.
float	wetDryMix	Specifies the wet and dry mix of the filter (0.0 - 100.0).

Remarks

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

Audio_Effects_DS_Gargle(int, string, int, DSGargleWaveForm)

Sets the parameters for the DS Gargle effect.

Declaration

public void Audio_Effects_DS_Gargle(int streamIndex, string name, int rateHz, DSGargleWaveForm waveForm)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
int	rateHz	Specifies the frequency of the gargle filter (1 - 1000).
DSGargleWaveForm	waveForm	Specifies the waveform type of the filter.

Remarks

The gargle effect modulates the amplitude of the signal.

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

Sets the parameters for the DS ParamEQ effect.

Declaration

public void Audio_Effects_DS_ParamEQ(int streamIndex, string name, float bandwidth, float center, float gain)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
float	bandwidth	Specifies the bandwidth of the equalizer (1.0 - 36.0).
float	center	Specifies the center frequency of the equalizer (80.0 - 16000.0).
float	gain	Specifies the gain of the equalizer (-15.0 - 15.0).

Remarks

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

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

Sets the parameters for the DS Reverb effect.

Declaration

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

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
float	decayHFRatio	Specifies the decay HF ratio for the filter (0.1 - 2.0, 0.83 by default).
float	decayTime	Specifies the decay time for the filter (0.1 - 20.0, 1.49 by default).
float	density	Specifies the density value for the filter (0 - 100.0, 100.0 by default).
float	diffusion	Specifies the diffusion value for the filter (0 - 100.0, 100.0 by default).
float	HFReference	Specifies the HF reference for the filter (20.0 - 20000.0, 5000.0 by default).
DSI3DL2ReverbPreset	preset	Specifies the preset name.
int	quality	Specifies the quality of the filter (0 - 3, 2 by default).
int	reflections	Specifies the reflections value for the filter (-10000 - -1000, -2602 by default).
float	reflectionsDelay	Specifies the reflections delay for the filter (0.0 - 0.3, 0.007 by default).
int	reverbValue	Specifies the reverb value for the filter (-10000 - 2000, 200 by default).
float	reverbDelay	Specifies the reverb delay for the filter (0.0 - 0.1, 0.011 by default).
int	room	Specifies the room value for the filter (-10000 - 0, -1000 by default).
int	roomHF	Specifies the room HF value of the filter (-10000 - 0, -100 by default).
float	roomRollOffFactor	Specifies the room roll off factor for the filter (0.0 - 10.0, 0.0 by default).

Remarks

Environmental Reverberation filter.

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

Sets the parameters for the DS Waves Reverb effect.

Declaration

public void Audio_Effects_DS_WavesReverb(int streamIndex, string name, float highFreqRTRatio, float inGain, float reverbMix, float reverbTime)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
float	highFreqRTRatio	Specifies the high frequency ratio (0.001 - 0.999, 0.001 by default).
float	inGain	Specifies in-gain of the filter (-96.0 - 0.0, 0.0 by default).
float	reverbMix	Specifies the reverb mix of the filter (-96.0 - 0.0, 0.0 by default).
float	reverbTime	Specifies the reverb time of the filter (0.001 - 3000.0, 1000.0 by default).

Remarks

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

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

Sets the parameters for the Dynamic Amplify effect.

Declaration

public void Audio_Effects_DynamicAmplify(int streamIndex, string name, int attackTime, int maxAmplification, int releaseTime)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
int	attackTime	Specifies the amplification value than will be used when amplifying.
int	maxAmplification	Sets the amplification for a channel. Default value is 10000, which means that no amplification occurs. A value of 20000 raises the amplification by 2.
int	releaseTime	Specifies the time in milliseconds that the DSP will wait to continue amplification, after the maximum has been reached.

Remarks

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

Audio_Effects_DynamicAmplify_GetCurrentAmp(int, string)

Gets the value for the current amplification level.

Declaration

public double Audio_Effects_DynamicAmplify_GetCurrentAmp(int streamIndex, string name)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.

Returns

Type	Description
double	System.Double.

Audio_Effects_Enable(int, string, bool)

Enables selected audio effect.

Declaration

public void Audio_Effects_Enable(int streamIndex, string name, bool enable)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
bool	enable	true if enabled, false if disabled.

Audio_Effects_Equalizer(int, string, bool, float)

Sets the parameters for the Equalizer effect.

Declaration

public void Audio_Effects_Equalizer(int streamIndex, string name, bool separate, float maxGainDB = 20)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
bool	separate	Enables or Disables separate equalization. If Enabled every channel will be equalized by it's own amplification value. If Disabled every channel will be equalized with the amplification value of channel 0.
float	maxGainDB	Max gain in dB (20 by default).

Remarks

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

Audio_Effects_Equalizer_Band_Get(int, string, int)

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

Declaration

public int Audio_Effects_Equalizer_Band_Get(int streamIndex, string name, int index)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
int	index	Band index.

Returns

Type	Description
int	System.Int32.

Audio_Effects_Equalizer_Band_Set(int, string, int, int)

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

Declaration

public void Audio_Effects_Equalizer_Band_Set(int streamIndex, string name, int index, int value)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
int	index	Band index.
int	value	Gain value (in dB).

Audio_Effects_Equalizer_Preset_Set(int, string, EqualizerPreset)

Sets the equalizer preset value.

Declaration

public void Audio_Effects_Equalizer_Preset_Set(int streamIndex, string name, EqualizerPreset preset)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
EqualizerPreset	preset	Preset.

Audio_Effects_Equalizer_Presets()

Gets equalizer presets list.

Declaration

public ObservableCollection<string> Audio_Effects_Equalizer_Presets()

Returns

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

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

Sets the parameters for the Fade effect.

Declaration

public void Audio_Effects_Fades(int streamIndex, string name, int startVolume, int stopVolume, TimeSpan startTime, TimeSpan stopTime, bool separate)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
int	startVolume	Start volume.
int	stopVolume	Stop volume.
TimeSpan	startTime	Start time.
TimeSpan	stopTime	Stop time.
bool	separate	Enables or Disables separate fades. If Enabled every channel will be faded by it's own fade value. If Disabled every channel will be faded with the fade value of channel 0.

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

Sets the parameters for the Flanger effect.

Declaration

public void Audio_Effects_Flanger(int streamIndex, string name, float delay, float frequency, bool phaseInvert, bool separate)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
float	delay	Specifies the delay time in seconds.
float	frequency	Specifies the flanger frequency.
bool	phaseInvert	Specifies whether the added signal should be inverted.
bool	separate	Enables or Disables separate amplification. If Enabled every channel will be amplified by it's own amplification value. If Disabled every channel will be amplified with the amplification value of channel 0.

Remarks

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

Audio_Effects_HighPass(int, string, int, bool)

Sets the parameters for the High Pass effect.

Declaration

public void Audio_Effects_HighPass(int streamIndex, string name, int cutOff, bool separate)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
int	cutOff	The cut Off.
bool	separate	Enables or Disables separate cutoff. If Enabled every channel will be processed by it's own cutoff value. If Disabled every channel will be processed with the cutoff value of channel 0.

Remarks

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

Audio_Effects_LowPass(int, string, int, bool)

Sets the parameters for the Low Pass effect.

Declaration

public void Audio_Effects_LowPass(int streamIndex, string name, int cutOff, bool separate)

Parameters

Type	Name	Description
int	streamIndex	The stream Index.
string	name	The name.
int	cutOff	Specifies the cutoff frequency for a specific channel at which the cutoff will end.
bool	separate	Enables or Disables separate cutoff. If Enabled every channel will be processed by it's own cutoff value. If Disabled every channel will be processed with the cutoff value of channel 0.

Remarks

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

Audio_Effects_Notch(int, string, int, bool)

Sets the parameters for the Notch effect.

Declaration

public void Audio_Effects_Notch(int streamIndex, string name, int cutOff, bool separate)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
int	cutOff	Specifies the cutoff frequency for a specific channel at which the cutoff will have it's maximum amplification.
bool	separate	Enables or Disables separate cutoff. If Enabled every channel will be processed by it's own cutoff value. If Disabled every channel will be processed with the cutoff value of channel 0.

Remarks

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

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

Sets the parameters for the ParametricEQ effect.

Declaration

public void Audio_Effects_ParametricEQ(int streamIndex, string name, float frequency, float gain, float q, bool separate)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
float	frequency	Specifies the center frequency of the filter.
float	gain	Specifies the gain in DB of the filter.
float	q	Specifies the Q (bandwidth) of the filter.
bool	separate	Enables or Disables separate amplification. If Enabled every channel will be amplified by it's own amplification value. If Disabled every channel will be amplified with the amplification value of channel 0.

Remarks

Parametric equalizer filter. Every channel can be controlled separately.

Audio_Effects_PhaseInvert(int, string, bool, bool)

Sets the parameters for the Phase Invert effect.

Declaration

public void Audio_Effects_PhaseInvert(int streamIndex, string name, bool invert, bool separate)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
bool	invert	Enables and Disables phase invert for a specific channel.
bool	separate	Enables or Disables separate invert. If Enabled every channel will be inverted by it's own invert value. If Disabled every channel will be inverted by the value of channel 0.

Remarks

Phase invert component that inverts specific channels.

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

Sets the parameters for the Phaser effect.

Declaration

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

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
byte	depth	Sets Phaser depth (0 - 255).
byte	dryWetRatio	Sets dry-wet mix ratio. 0 - dry, 255 - wet (0 - 255).
byte	feedback	Sets phaser feedback. 0 - no feedback, 100 = 100% feedback, -100 = -100% feedback (-100 - 100).
float	frequency	Sets phaser's LFO frequency.
bool	separate	Enables or Disables separate phasing. If Enabled every channel will be phased by it's own phasing value. If Disabled every channel will be phased with the phasing value of channel 0.
byte	stages	Sets phaser stages. Recommended from 2 to 24.
float	startPhase	Sets phaser's LFO start phase in radians. Needed for stereo phasers.

Remarks

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

Audio_Effects_PitchShift(int, string, float)

Sets the parameters for the Pitch Shift effect.

Declaration

public void Audio_Effects_PitchShift(int streamIndex, string name, float pitch)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
float	pitch	Specifies the pitch. Default value is 1.0f, which means that no pitch is done.

Remarks

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

Audio_Effects_SetCurrentChannel(int, string, sbyte)

Sets the current audio channel for the audio effects.

Declaration

public void Audio_Effects_SetCurrentChannel(int streamIndex, string name, sbyte channel)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
sbyte	channel	Channel. -1 to process all channels.

Audio_Effects_Sound3D(int, string, int)

Sets the parameters for the Sound3D effect.

Declaration

public void Audio_Effects_Sound3D(int streamIndex, string name, int volume)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
int	volume	Sets the 3D amplification value. A value of 1000 is the same as disabling the filter. Values smaller then 1000 is the same as doing a downmix (mono) of the 2 channels. Values higher then 10000 will distort the sound.

Remarks

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

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

Sets the parameters for the Treble Enhancer effect.

Declaration

public void Audio_Effects_TrebleEnhancer(int streamIndex, string name, int frequency, bool separate, int volume)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
int	frequency	Specifies the frequency range that will be used to amplify. Range is frequency to (sample rate div 2).
bool	separate	Enables or Disables separate amplification. If Enabled every channel will be amplified by it's own amplification value. If Disabled every channel will be amplified with the amplification value of channel 0.
int	volume	Sets the amplification for a channel. Default value is 0, which means that no amplification occurs. The value shouldn't go over 10000. If separate is True, then every channel will be amplified by its own channel amplification value. If separate is False, then every channel is amplified with the value of channel 0.

Remarks

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

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

Sets the parameters for the True Bass effect.

Declaration

public void Audio_Effects_TrueBass(int streamIndex, string name, int frequency, bool separate, int volume)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
string	name	The name.
int	frequency	Specifies the frequency range that will be used to amplify. Range is 0 to frequency.
bool	separate	Enables or Disables separate amplification. If Enabled every channel will be amplified by it's own amplification value. If Disabled every channel will be amplified with the amplification value of channel 0.
int	volume	Sets the amplification for a channel. Default value is 0, which means that no amplification occurs. The value shouldn't go over 10000. If separate is True, then every channel will be amplified by its own channel amplification value. If separate is False, then every channel is amplified with the value of channel 0.

Remarks

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

Audio_Effects_UseCustomAudioEffectsFilters(List<Guid>)

Allows custom audio effect filters usage. Adds CLSIDs for a custom audio filters. One item - for an each audio stream.

Declaration

public void Audio_Effects_UseCustomAudioEffectsFilters(List<Guid> clsidList)

Parameters

Type	Name	Description
List<Guid>	clsidList	CLSID list.

Audio_Enhancer_AutoGain(int, bool)

Applies audio auto gain enhancement.

Declaration

public void Audio_Enhancer_AutoGain(int streamIndex, bool enabled)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
bool	enabled	Enabled.

Audio_Enhancer_AutoGainAsync(int, bool)

Applies audio auto gain enhancement (async).

Declaration

public Task Audio_Enhancer_AutoGainAsync(int streamIndex, bool enabled)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
bool	enabled	Enabled.

Returns

Type	Description
Task	Task.

Audio_Enhancer_AutoGainIntl(int, bool)

Applies audio auto gain enhancement.

Declaration

public void Audio_Enhancer_AutoGainIntl(int streamIndex, bool enabled)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
bool	enabled	Enabled.

Audio_Enhancer_InputGains(int, AudioEnhancerGains)

Applies audio input gains enhancement.

Declaration

public void Audio_Enhancer_InputGains(int streamIndex, AudioEnhancerGains gains)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
AudioEnhancerGains	gains	Gains.

Audio_Enhancer_InputGainsAsync(int, AudioEnhancerGains)

Applies audio input gains enhancement (async).

Declaration

public Task Audio_Enhancer_InputGainsAsync(int streamIndex, AudioEnhancerGains gains)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
AudioEnhancerGains	gains	Gains.

Returns

Type	Description
Task	Task.

Audio_Enhancer_InputGainsIntl(int, AudioEnhancerGains)

Applies audio input gains enhancement.

Declaration

public void Audio_Enhancer_InputGainsIntl(int streamIndex, AudioEnhancerGains gains)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
AudioEnhancerGains	gains	Gains.

Audio_Enhancer_Normalize(int, bool)

Applies audio normalize enhancement.

Declaration

public void Audio_Enhancer_Normalize(int streamIndex, bool enabled)

Parameters

Type	Name	Description
int	streamIndex	The stream index. -1 for all streams.
bool	enabled	Enabled.

Audio_Enhancer_NormalizeAsync(int, bool)

Applies audio normalize enhancement (async).

Declaration

public Task Audio_Enhancer_NormalizeAsync(int streamIndex, bool enabled)

Parameters

Type	Name	Description
int	streamIndex	The stream index. -1 for all streams.
bool	enabled	Enabled.

Returns

Type	Description
Task	Task.

Audio_Enhancer_NormalizeIntl(int, bool)

Applies audio normalize enhancement.

Declaration

public void Audio_Enhancer_NormalizeIntl(int streamIndex, bool enabled)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
bool	enabled	Enabled.

Audio_Enhancer_OutputGains(int, AudioEnhancerGains)

Applies audio output gains enhancement.

Declaration

public void Audio_Enhancer_OutputGains(int streamIndex, AudioEnhancerGains gains)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
AudioEnhancerGains	gains	Gains.

Audio_Enhancer_OutputGainsAsync(int, AudioEnhancerGains)

Applies audio output gains enhancement (async).

Declaration

public Task Audio_Enhancer_OutputGainsAsync(int streamIndex, AudioEnhancerGains gains)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
AudioEnhancerGains	gains	Gains.

Returns

Type	Description
Task	Task.

Audio_Enhancer_OutputGainsIntl(int, AudioEnhancerGains)

Applies audio output gains enhancement.

Declaration

public void Audio_Enhancer_OutputGainsIntl(int streamIndex, AudioEnhancerGains gains)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
AudioEnhancerGains	gains	Gains.

Audio_Enhancer_Timeshift(int, int)

Applies audio delay.

Declaration

public void Audio_Enhancer_Timeshift(int streamIndex, int timeshift)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
int	timeshift	Time shift delay (milliseconds). Range is [-2000; 2000].

Audio_Enhancer_TimeshiftAsync(int, int)

Applies audio delay (async).

Declaration

public Task Audio_Enhancer_TimeshiftAsync(int streamIndex, int timeshift)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
int	timeshift	Time shift delay (milliseconds). Range is [-2000; 2000].

Returns

Type	Description
Task	Task.

Audio_Enhancer_TimeshiftIntl(int, int)

Applies audio delay.

Declaration

public void Audio_Enhancer_TimeshiftIntl(int streamIndex, int timeshift)

Parameters

Type	Name	Description
int	streamIndex	Stream index. -1 for all streams.
int	timeshift	Time shift delay (milliseconds). Range is [-2000; 2000].

Audio_OutputDevice_Balance_Get(int)

Gets current balance value for selected audio output device.

Declaration

public int Audio_OutputDevice_Balance_Get(int streamIndex)

Parameters

Type	Name	Description
int	streamIndex	Stream index.

Returns

Type	Description
int	System.Int32.

Audio_OutputDevice_Balance_Set(int, int)

Sets current balance value for selected audio output device.

Declaration

public void Audio_OutputDevice_Balance_Set(int streamIndex, int balance)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
int	balance	Balance.

Audio_OutputDevice_Volume_Get(int)

Gets current volume value for selected audio output device.

Declaration

public int Audio_OutputDevice_Volume_Get(int streamIndex)

Parameters

Type	Name	Description
int	streamIndex	Stream index.

Returns

Type	Description
int	System.Int32.

Audio_OutputDevice_Volume_Set(int, int)

Sets current volume value for selected audio output device.

Declaration

public void Audio_OutputDevice_Volume_Set(int streamIndex, int volume)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
int	volume	Volume.

Audio_OutputDevices()

Gets audio output device list.

Declaration

public ObservableCollection<string> Audio_OutputDevices()

Returns

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

Audio_Streams_AllInOne()

Returns true if splitter have one pin for all audio streams and only one stream can be used at the same time.

Declaration

public bool Audio_Streams_AllInOne()

Returns

Type	Description
bool	Returns bool.

Audio_Streams_Count()

Gets audio streams count (if playback started already).

Declaration

public int Audio_Streams_Count()

Returns

Type	Description
int	Returns int.

Audio_Streams_Set(int, bool)

Enables/disables audio stream.

Declaration

public bool Audio_Streams_Set(int streamIndex, bool enabled)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
bool	enabled	true if enabled, false if disabled.

Returns

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

Audio_Streams_SetAsync(int, bool)

Enables/disables audio stream (async).

Declaration

public Task<bool> Audio_Streams_SetAsync(int streamIndex, bool enabled)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
bool	enabled	true if enabled, false if disabled.

Returns

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

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	The update handle flag.

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[]	Byte array.

CreateAsync()

Create as an asynchronous operation.

Declaration

public static Task<MediaPlayerCore> CreateAsync()

Returns

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

CreateAsync(IVideoView)

Create as an asynchronous operation.

Declaration

public static Task<MediaPlayerCore> CreateAsync(IVideoView videoView)

Parameters

Type	Name	Description
IVideoView	videoView	The video view.

Returns

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

CustomRedist_Enable(bool)

Enables or disables custom redist usage.

Declaration

public void CustomRedist_Enable(bool enabled)

Parameters

Type	Name	Description
bool	enabled	True to enable custom redist, false to disable.

CustomRedist_IsEnabled()

Gets custom redist status.

Declaration

public bool CustomRedist_IsEnabled()

Returns

Type	Description
bool	The bool.

DVD_Chapter_GetCurrent()

Gets current chapter number.

Declaration

public int DVD_Chapter_GetCurrent()

Returns

Type	Description
int	System.Int32.

DVD_Chapter_Next()

Play next chapter.

Declaration

public bool DVD_Chapter_Next()

Returns

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

DVD_Chapter_NextAsync()

Play next chapter (async).

Declaration

public Task<bool> DVD_Chapter_NextAsync()

Returns

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

DVD_Chapter_Prev()

Play previous chapter.

Declaration

public bool DVD_Chapter_Prev()

Returns

Type	Description
bool	Returns bool.

DVD_Chapter_PrevAsync()

Play previous chapter (async).

Declaration

public Task<bool> DVD_Chapter_PrevAsync()

Returns

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

DVD_Chapter_Replay()

Replay current chapter.

Declaration

public bool DVD_Chapter_Replay()

Returns

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

DVD_Chapter_ReplayAsync()

Replay current chapter (async).

Declaration

public Task<bool> DVD_Chapter_ReplayAsync()

Returns

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

DVD_Chapter_Select(int)

Starts playback from the specified chapter in the current title.

Declaration

public void DVD_Chapter_Select(int index)

Parameters

Type	Name	Description
int	index	Chapter index.

DVD_Chapter_SelectAsync(int)

Starts playback from the specified chapter in the current title (async).

Declaration

public Task DVD_Chapter_SelectAsync(int index)

Parameters

Type	Name	Description
int	index	Chapter index.

Returns

Type	Description
Task	Returns Task.

DVD_Menu_ResumePlayback()

Replay current chapter.

Declaration

public bool DVD_Menu_ResumePlayback()

Returns

Type	Description
bool	Returns bool.

DVD_Menu_ResumePlaybackAsync()

Replay current chapter (async).

Declaration

public Task<bool> DVD_Menu_ResumePlaybackAsync()

Returns

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

DVD_Menu_Show(DVDMenu)

Displays the specified menu, if available.

Declaration

public bool DVD_Menu_Show(DVDMenu menuType)

Parameters

Type	Name	Description
DVDMenu	menuType	Menu type.

Returns

Type	Description
bool	Returns bool.

DVD_Menu_ShowAsync(DVDMenu)

Displays the specified menu, if available (async).

Declaration

public Task<bool> DVD_Menu_ShowAsync(DVDMenu menuType)

Parameters

Type	Name	Description
DVDMenu	menuType	Menu type.

Returns

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

DVD_Select_AudioStream(int)

Selects the audio stream to play.

Declaration

public void DVD_Select_AudioStream(int streamIndex)

Parameters

Type	Name	Description
int	streamIndex	The stream index.

DVD_Select_AudioStreamAsync(int)

Selects the audio stream to play (async).

Declaration

public Task DVD_Select_AudioStreamAsync(int streamIndex)

Parameters

Type	Name	Description
int	streamIndex	The stream index.

Returns

Type	Description
Task	Returns Task.

DVD_Select_SubpictureStream(int)

Method sets the subpicture stream to display.

Declaration

public void DVD_Select_SubpictureStream(int streamIndex)

Parameters

Type	Name	Description
int	streamIndex	The stream index.

DVD_Select_SubpictureStreamAsync(int)

Method sets the subpicture stream to display (async).

Declaration

public Task DVD_Select_SubpictureStreamAsync(int streamIndex)

Parameters

Type	Name	Description
int	streamIndex	The stream index.

Returns

Type	Description
Task	Returns Task.

DVD_SetDisplayMode(DVDDisplayMode)

Sets the specified video mode display (wide screen, letterbox, or pan-scan) for playback.

Declaration

public void DVD_SetDisplayMode(DVDDisplayMode mode)

Parameters

Type	Name	Description
DVDDisplayMode	mode	Display mode.

DVD_SetDisplayModeAsync(DVDDisplayMode)

Sets the specified video mode display (wide screen, letterbox, or pan-scan) for playback (async).

Declaration

public Task DVD_SetDisplayModeAsync(DVDDisplayMode mode)

Parameters

Type	Name	Description
DVDDisplayMode	mode	Display mode.

Returns

Type	Description
Task	Returns Task.

DVD_SetSpeed(double, bool)

Plays forward / backward at the specified speed from the current location.

Declaration

public bool DVD_SetSpeed(double speed, bool backward)

Parameters

Type	Name	Description
double	speed	Speed.
bool	backward	false for forward playback, true for backward playback.

Returns

Type	Description
bool	Returns bool.

DVD_SetSpeedAsync(double, bool)

Plays forward / backward at the specified speed from the current location (async).

Declaration

public Task<bool> DVD_SetSpeedAsync(double speed, bool backward)

Parameters

Type	Name	Description
double	speed	Speed.
bool	backward	false for forward playback, true for backward playback.

Returns

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

DVD_Title_GetCurrent()

Returns current title number.

Declaration

public int DVD_Title_GetCurrent()

Returns

Type	Description
int	The int.

DVD_Title_GetDuration()

Returns current title duration.

Declaration

public TimeSpan DVD_Title_GetDuration()

Returns

Type	Description
TimeSpan	The TimeSpan.

DVD_Title_GetDurationAsync()

Returns current title duration (async).

Declaration

public Task<TimeSpan> DVD_Title_GetDurationAsync()

Returns

Type	Description
Task<TimeSpan>	Task<TimeSpan>.

DVD_Title_Play(int)

Starts playback from the first chapter in the specified title.

Declaration

public void DVD_Title_Play(int titleIndex)

Parameters

Type	Name	Description
int	titleIndex	Title index.

DVD_Title_PlayAsync(int)

Starts playback from the first chapter in the specified title (async).

Declaration

public Task DVD_Title_PlayAsync(int titleIndex)

Parameters

Type	Name	Description
int	titleIndex	Title index.

Returns

Type	Description
Task	Returns Task.

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. Sets the name(s) of filters that will be unavailable in use with Media Player SDK. For instance, you can use this method from preventing user to use some filters that is not functional correctly with Media Player SDK.

Declaration

public void DirectShow_Filters_Blacklist_Add(string filter)

Parameters

Type	Name	Description
string	filter	The filter.

DirectShow_Filters_Blacklist_Clear()

Clears the filters black list. All available filters will be available for use.

Declaration

public void DirectShow_Filters_Blacklist_Clear()

Dispose()

Dispose.

Declaration

public void Dispose()

Dispose(bool)

Dispose.

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 number of frames.

Declaration

public long Duration_Frames()

Returns

Type	Description
long	The long.

Duration_Time()

Gets duration.

Declaration

public TimeSpan Duration_Time()

Returns

Type	Description
TimeSpan	The TimeSpan.

Duration_TimeAsync()

Gets duration (async).

Declaration

public Task<TimeSpan> Duration_TimeAsync()

Returns

Type	Description
Task<TimeSpan>	Task<TimeSpan>.

~MediaPlayerCore()

Finalizes an instance of the MediaPlayerCore class.

Declaration

protected ~MediaPlayerCore()

Frame_GetCurrent()

Gets the current video frame.

Declaration

public Bitmap Frame_GetCurrent()

Returns

Type	Description
Bitmap	Bitmap.

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

Gets the current video frame (RGB24).

Declaration

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

Frame_GetCurrentAsBuffer(out int, out int)

Gets the current video frame.

Declaration

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

Parameters

Type	Name	Description
int	width	Frame width.
int	height	Frame height.

Returns

Type	Description
byte[]	System.Byte[].

Frame_GetCurrentFromRenderer(out TimeSpan)

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

Declaration

public Bitmap Frame_GetCurrentFromRenderer(out TimeSpan timestamp)

Parameters

Type	Name	Description
TimeSpan	timestamp	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 jpegQuality = 85, int customWidth = 0, int customHeight = 0)

Parameters

Type	Name	Description
string	filename	Output file name.
ImageFormat	format	Image format.
int	jpegQuality	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 jpegQuality = 85, int customWidth = 0, int customHeight = 0)

Parameters

Type	Name	Description
string	filename	Output file name.
ImageFormat	format	Image format.
int	jpegQuality	JPEG quality.
int	customWidth	Custom width.
int	customHeight	Custom height.

Returns

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

GetContext()

Gets the context.

Declaration

public DSContext GetContext()

Returns

Type	Description
DSContext	DSContext.

GetCore()

Gets core.

Declaration

public MediaPlayerCore GetCore()

Returns

Type	Description
MediaPlayerCore	The MediaPlayerCore.

GetDVDControl()

Gets the DVD control.

Declaration

public IDvdControl2 GetDVDControl()

Returns

Type	Description
IDvdControl2	IDvdControl2.

GetDVDInfo()

Gets the DVD information.

Declaration

public IDvdInfo2 GetDVDInfo()

Returns

Type	Description
IDvdInfo2	IDvdInfo2.

GetSourceMode()

Gets the source mode.

Declaration

public MediaPlayerSourceMode GetSourceMode()

Returns

Type	Description
MediaPlayerSourceMode	MediaPlayerSourceMode.

GetVideoRenderer()

Gets the video renderer.

Declaration

public VideoRendererSettings GetVideoRenderer()

Returns

Type	Description
VideoRendererSettings	VideoRendererSettings.

GetVideoRendererCore()

Gets video renderer.

Declaration

public IVideoRendererBase GetVideoRendererCore()

Returns

Type	Description
IVideoRendererBase	Returns IVideoRendererBase.

GetVideoResolution()

Gets the video resolution.

Declaration

public Size GetVideoResolution()

Returns

Type	Description
Size	Types.Size.

Helpful_GetFrameFromFile(string, TimeSpan, bool, MediaPlayerSourceMode)

Gets frame from the file.

Declaration

public Bitmap Helpful_GetFrameFromFile(string filename, TimeSpan timestamp, bool oldWay, MediaPlayerSourceMode engine)

Parameters

Type	Name	Description
string	filename	File name.
TimeSpan	timestamp	Timestamp.
bool	oldWay	If true - old way (using IMediaDet interface), if false - Sample Grabber will be used.
MediaPlayerSourceMode	engine	Engine. LAV and DirectShow are supported.

Returns

Type	Description
Bitmap	Bitmap.

Helpful_GetFrameFromFileAsync(string, TimeSpan, bool, MediaPlayerSourceMode)

Gets frame from the file (async).

Declaration

public Task<Bitmap> Helpful_GetFrameFromFileAsync(string filename, TimeSpan timestamp, bool oldWay, MediaPlayerSourceMode engine)

Parameters

Type	Name	Description
string	filename	File name.
TimeSpan	timestamp	Timestamp.
bool	oldWay	If true - old way (using IMediaDet interface), if false - Sample Grabber will be used.
MediaPlayerSourceMode	engine	Engine. LAV and DirectShow are supported.

Returns

Type	Description
Task<Bitmap>	Task<Bitmap>.

Helpful_SecondsToTimeFormatted(int)

Gets formatted time.

Declaration

public string Helpful_SecondsToTimeFormatted(int seconds)

Parameters

Type	Name	Description
int	seconds	Time in seconds.

Returns

Type	Description
string	System.String.

Info_Read(string, bool)

Reads file info.

Declaration

public bool Info_Read(string filename, bool allowLibMediaInfoUsage)

Parameters

Type	Name	Description
string	filename	File name.
bool	allowLibMediaInfoUsage	True to allow LibMediaInfo usage.

Returns

Type	Description
bool	The bool.

Info_Read(string, bool, object, EncryptionKeyType, bool)

Reads file info.

Declaration

public bool Info_Read(string filename, bool encryptedFile, object encryptionKey, EncryptionKeyType encryptionKeyType, bool allowLibMediaInfoUsage)

Parameters

Type	Name	Description
string	filename	File name.
bool	encryptedFile	True if file is encrypted.
object	encryptionKey	Encryption key.
EncryptionKeyType	encryptionKeyType	Encryption key type.
bool	allowLibMediaInfoUsage	True to allow LibMediaInfo usage.

Returns

Type	Description
bool	The bool.

Info_ReadDVD(string)

Reads DVD info.

Declaration

public bool Info_ReadDVD(string path)

Parameters

Type	Name	Description
string	path	DVD path.

Returns

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

IsAsync()

Determines whether this instance is asynchronous.

Declaration

public bool IsAsync()

Returns

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

IsFileCrypted(string, string, bool)

Checks if the file is encrypted.

Declaration

public bool IsFileCrypted(string filename, string password, bool v9 = false)

Parameters

Type	Name	Description
string	filename	File name.
string	password	Password.
bool	v9	v9 SDK used.

Returns

Type	Description
bool	`true` if file is crypted; otherwise, `false`.

IsFileCrypted(string, EncryptionKeyType, object, bool)

Checks if file is encrypted.

Declaration

public bool IsFileCrypted(string filename, EncryptionKeyType keyType, object key, bool v9)

Parameters

Type	Name	Description
string	filename	File name.
EncryptionKeyType	keyType	Key type.
object	key	Key. string if password or filename, byte[] if binary data.
bool	v9	v9 SDK used.

Returns

Type	Description
bool	`true` if file is crypted; otherwise, `false`.

MIDI_Renderers()

Gets MIDI renderer list.

Declaration

public ObservableCollection<string> MIDI_Renderers()

Returns

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

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	Control handle.
int	width	Width.
int	height	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_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_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	Width.
int	height	Height.

Multiple_Video_Streams_Mappings_Add(int, nint, int, int)

Adds mapping video stream index - screen handle, for video files with multiple video streams.

Declaration

public void Multiple_Video_Streams_Mappings_Add(int streamIndex, nint screenHandle, int screenWidth, int screenHeight)

Parameters

Type	Name	Description
int	streamIndex	Stream index.
nint	screenHandle	Screen handle.
int	screenWidth	Screen width.
int	screenHeight	Screen height.

Multiple_Video_Streams_Mappings_Clear()

Clears mappings for multiple video streams.

Declaration

public void Multiple_Video_Streams_Mappings_Clear()

NextFrame()

Shows the next frame.

Declaration

public bool NextFrame()

Returns

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

NextFrameOld()

Shows next frame (old implementation, useful for some decoders).

Declaration

public bool NextFrameOld()

Returns

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

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.

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

PIP_Sources_Add(string, int, int, int, int)

Adds video file.

Declaration

public bool PIP_Sources_Add(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_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_SetSourceOrder(int, int)

Sets layer settings.

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	`true` if successful, `false` otherwise.

PIP_Sources_SetSourceOrderAsync(int, int)

Sets layer settings (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, float)

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

Declaration

public bool PIP_Sources_SetSourcePosition(int index, Rectangle rect, float alpha)

Parameters

Type	Name	Description
int	index	Source index.
Rectangle	rect	Rectangle.
float	alpha	Stream transparency, from 0.0 (fully transparent) to 1.0 (full opaque).

Returns

Type	Description
bool	The bool.

PIP_Sources_SetSourcePositionAsync(int, Rectangle, float)

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, float alpha)

Parameters

Type	Name	Description
int	index	Source index.
Rectangle	rect	Rectangle.
float	alpha	Stream transparency, from 0.0 (fully transparent) to 1.0 (full opaque).

Returns

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

Pause()

Pause.

Declaration

public bool Pause()

Returns

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

PauseAsync()

Pause (async).

Declaration

public Task<bool> PauseAsync()

Returns

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

Play()

Start playback.

Declaration

public bool Play()

Returns

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

PlayAsync()

Starts playback (async).

Declaration

public Task<bool> PlayAsync()

Returns

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

PlayDelayed()

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

Declaration

public void PlayDelayed()

Playlist_Add(string)

Adds the filename or URL to the playlist.

Declaration

public bool Playlist_Add(string path)

Parameters

Type	Name	Description
string	path	The filename or URL.

Returns

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

Playlist_Clear()

Clears the playlist.

Declaration

public bool Playlist_Clear()

Returns

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

Playlist_GetCount()

Gets the playlist items count.

Declaration

public int Playlist_GetCount()

Returns

Type	Description
int	System.Int32.

Playlist_GetFilename(int)

Get the filename from the playlist.

Declaration

public string Playlist_GetFilename(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

Type	Description
string	System.String.

Playlist_GetPosition()

Gets the position in the playlist.

Declaration

public int Playlist_GetPosition()

Returns

Type	Description
int	System.Int32.

Playlist_Insert(string, int)

Inserts the file name into the playlist.

Declaration

public bool Playlist_Insert(string filename, int index)

Parameters

Type	Name	Description
string	filename	The filename.
int	index	The index.

Returns

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

Playlist_PlayNext()

Plays the next file.

Declaration

public bool Playlist_PlayNext()

Returns

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

Playlist_PlayNextAsync()

Plays the next file (async.).

Declaration

public Task<bool> Playlist_PlayNextAsync()

Returns

Type	Description
Task<bool>	A Task<System.Boolean> representing the asynchronous operation.

Playlist_PlayPrevious()

Plays the previous file.

Declaration

public bool Playlist_PlayPrevious()

Returns

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

Playlist_PlayPreviousAsync()

Plays the previous file (async.).

Declaration

public Task<bool> Playlist_PlayPreviousAsync()

Returns

Type	Description
Task<bool>	A Task<System.Boolean> representing the asynchronous operation.

Playlist_Remove(string)

Removes the file name from the playlist.

Declaration

public bool Playlist_Remove(string filename)

Parameters

Type	Name	Description
string	filename	The filename.

Returns

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

Playlist_RemoveAt(int)

Removes the playlist item at index.

Declaration

public bool Playlist_RemoveAt(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

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

Playlist_Reset()

Sets the playlist position to zero.

Declaration

public void Playlist_Reset()

Playlist_SetPosition(int)

Sets the position in the playlist.

Declaration

public bool Playlist_SetPosition(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

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

Position_Get_Frame()

Gets current position in frames.

Declaration

public long Position_Get_Frame()

Returns

Type	Description
long	The long.

Position_Get_FrameAsync()

Gets current position in frames (async).

Declaration

public Task<long> Position_Get_FrameAsync()

Returns

Type	Description
Task<long>	Task<System.Int64>.

Position_Get_Time()

Gets current position.

Declaration

public TimeSpan Position_Get_Time()

Returns

Type	Description
TimeSpan	The TimeSpan.

Position_Get_TimeAsync()

Gets current position (async).

Declaration

public Task<TimeSpan> Position_Get_TimeAsync()

Returns

Type	Description
Task<TimeSpan>	Task<TimeSpan>.

Position_Set_Frame(long)

Sets current position in frames.

Declaration

public bool Position_Set_Frame(long position)

Parameters

Type	Name	Description
long	position	Frame number.

Returns

Type	Description
bool	The bool.

Position_Set_FrameAsync(long)

Sets current position in frames (async).

Declaration

public Task<bool> Position_Set_FrameAsync(long position)

Parameters

Type	Name	Description
long	position	Frame number.

Returns

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

Position_Set_Time(TimeSpan)

Sets current position.

Declaration

public bool Position_Set_Time(TimeSpan position)

Parameters

Type	Name	Description
TimeSpan	position	Time.

Returns

Type	Description
bool	The bool.

Position_Set_TimeAsync(TimeSpan)

Sets current position (async).

Declaration

public Task<bool> Position_Set_TimeAsync(TimeSpan position)

Parameters

Type	Name	Description
TimeSpan	position	Time.

Returns

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

PreviousFrame()

Shows previous frame.

Declaration

public bool PreviousFrame()

Returns

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

Resume()

Resume.

Declaration

public bool Resume()

Returns

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

ResumeAsync()

Resume (async).

Declaration

public Task<bool> ResumeAsync()

Returns

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

ReversePlayback_GoToFrame(int)

Go to specified frame.

Declaration

public void ReversePlayback_GoToFrame(int number)

Parameters

Type	Name	Description
int	number	Frame number.

ReversePlayback_NextFrame()

Go to next frame.

Declaration

public void ReversePlayback_NextFrame()

ReversePlayback_PreviousFrame()

Go to previouse frame.

Declaration

public void ReversePlayback_PreviousFrame()

SDK_BuildDate()

Gets SDK build date.

Declaration

public DateTime SDK_BuildDate()

Returns

Type	Description
DateTime	DateTime.

SDK_Version()

Gets SDK version.

Declaration

public Version SDK_Version()

Returns

Type	Description
Version	Version.

SetLicenseKey(string, string, string)

After buying a license of Media Player 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

MediaPlayer1.SetLicenseKey(“your_license_key”, "username", "email").

SetSpeed(double)

Sets playback speed.

Declaration

public bool SetSpeed(double speed)

Parameters

Type	Name	Description
double	speed	Speed.

Returns

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

SetSpeedAsync(double)

Sets playback speed (async).

Declaration

public Task<bool> SetSpeedAsync(double speed)

Parameters

Type	Name	Description
double	speed	Speed.

Returns

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

SetSpeedIntl(double)

Sets playback speed.

Declaration

public bool SetSpeedIntl(double speed)

Parameters

Type	Name	Description
double	speed	Speed.

Returns

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

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

Returns

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

State()

Gets current status.

Declaration

public PlaybackState State()

Returns

Type	Description
PlaybackState	PlaybackState.

Stop()

Stops playback.

Declaration

public void Stop()

StopAsync()

Stops playback (async).

Declaration

public Task StopAsync()

Returns

Type	Description
Task	The Task.

Tags_Read(string)

Reads tags. Many formats like MP4, MP3, Ogg Vorbis, WMV are supported.

Declaration

public MediaFileTags Tags_Read(string filename)

Parameters

Type	Name	Description
string	filename	File name.

Returns

Type	Description
MediaFileTags	The MediaFileTags.

Remarks

All values except pictures are strings.

Test()

Test method. For debugging only.

Declaration

public void Test()

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

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

Declaration

public void Video_Filters_Add(string name)

Parameters

Type	Name	Description
string	name	Filter name.

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_Filters_Delete(string)

Deletes filter from the list.

Declaration

public bool Video_Filters_Delete(string name)

Parameters

Type	Name	Description
string	name	Filter name.

Returns

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

Video_FrameRate()

Gets video frame rate.

Declaration

public VideoFrameRate Video_FrameRate()

Returns

Type	Description
VideoFrameRate	VideoFrameRate.

Video_Height()

Gets video height.

Declaration

public int Video_Height()

Returns

Type	Description
int	System.Int32.

Video_Renderer_Deinterlace_Modes()

Gets deinterlace modes list.

Declaration

public ObservableCollection<string> Video_Renderer_Deinterlace_Modes()

Returns

Type	Description
ObservableCollection<string>	List<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

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	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	`true` if successful, `false` otherwise.

Video_Renderer_VideoAdjust_SetValueAsync(VideoRendererAdjustment, float)

Sets video adjustment value (async).

Declaration

public Task<bool> Video_Renderer_VideoAdjust_SetValueAsync(VideoRendererAdjustment adjustment, float value)

Parameters

Type	Name	Description
VideoRendererAdjustment	adjustment	Adjustment type.
float	value	Value.

Returns

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

Video_Stream_Select(int)

Selects the video stream.

Declaration

public bool Video_Stream_Select(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

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

Video_Stream_SelectAsync(int)

Selects the video stream (async).

Declaration

public Task<bool> Video_Stream_SelectAsync(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

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

Video_Width()

Gets video width.

Declaration

public int Video_Width()

Returns

Type	Description
int	System.Int32.

Events

OnAudioFrameBuffer

This event occurs whenever each new audio frame is received.

Declaration

public event EventHandler<AudioFrameBufferEventArgs> OnAudioFrameBuffer

Event Type

Type	Description
EventHandler<AudioFrameBufferEventArgs>

OnAudioVUMeter

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

Declaration

public event EventHandler<VUMeterEventArgs> OnAudioVUMeter

Event Type

Type	Description
EventHandler<VUMeterEventArgs>

OnAudioVUMeterProFFTCalculated

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

Declaration

public event EventHandler<VUMeterFFTEventArgs> OnAudioVUMeterProFFTCalculated

Event Type

Type	Description
EventHandler<VUMeterFFTEventArgs>

OnAudioVUMeterProMaximumCalculated

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

Declaration

public event EventHandler<VUMeterMaxSampleEventArgs> OnAudioVUMeterProMaximumCalculated

Event Type

Type	Description
EventHandler<VUMeterMaxSampleEventArgs>

OnAudioVUMeterProVolume

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

Declaration

public event EventHandler<AudioLevelEventArgs> OnAudioVUMeterProVolume

Event Type

Type	Description
EventHandler<AudioLevelEventArgs>

OnBarcodeDetected

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

Declaration

public event EventHandler<BarcodeEventArgs> OnBarcodeDetected

Event Type

Type	Description
EventHandler<BarcodeEventArgs>

OnDVDChapterChanged

Event occurring on a DVD chapter changed.

Declaration

public event EventHandler<EventArgs> OnDVDChapterChanged

Event Type

Type	Description
EventHandler<EventArgs>

OnDVDDomainChanged

Event occurring on a DVD domain changed.

Declaration

public event EventHandler<DVDDomainChangedEventArgs> OnDVDDomainChanged

Event Type

Type	Description
EventHandler<DVDDomainChangedEventArgs>

OnDVDParentalLevelChanged

Event occurring on a DVD parental level changed.

Declaration

public event EventHandler<DVDParentalLevelChangedEventArgs> OnDVDParentalLevelChanged

Event Type

Type	Description
EventHandler<DVDParentalLevelChangedEventArgs>

OnDVDPlaybackError

Event occurring on a DVD playback error.

Declaration

public event EventHandler<DVDEventArgs> OnDVDPlaybackError

Event Type

Type	Description
EventHandler<DVDEventArgs>

OnDVDTitleChanged

Event occurring on a DVD title changed.

Declaration

public event EventHandler<EventArgs> OnDVDTitleChanged

Event Type

Type	Description
EventHandler<EventArgs>

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>

OnError

This event occurs in a case of an error.

Declaration

public event EventHandler<ErrorsEventArgs> OnError

Event Type

Type	Description
EventHandler<ErrorsEventArgs>

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>

OnLoop

This event occurs whenever playback is completed and restarted because Loop property set to true.

Declaration

public event EventHandler<EventArgs> OnLoop

Event Type

Type	Description
EventHandler<EventArgs>

OnMIDIFileInfo

This event occurs whenever the new MIDI file playback info available.

Declaration

public event EventHandler<MIDIInfoEventArgs> OnMIDIFileInfo

Event Type

Type	Description
EventHandler<MIDIInfoEventArgs>

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>

OnNetworkSourceStop

This event occurs whenever network source stopped or disconnected.

Declaration

public event EventHandler<EventArgs> OnNetworkSourceStop

Event Type

Type	Description
EventHandler<EventArgs>

Remarks

Available only for FFMPEG engine.

OnNewFilePlaybackStarted

This event occurs whenever the new file playback started.

Declaration

public event EventHandler<NewFilePlaybackEventArgs> OnNewFilePlaybackStarted

Event Type

Type	Description
EventHandler<NewFilePlaybackEventArgs>

OnPause

This event occurs whenever the playback pauses.

Declaration

public event EventHandler<EventArgs> OnPause

Event Type

Type	Description
EventHandler<EventArgs>

OnPlaylistFinished

Occurs when playlist finished.

Declaration

public event EventHandler<EventArgs> OnPlaylistFinished

Event Type

Type	Description
EventHandler<EventArgs>

OnResume

This event occurs whenever the playback resumes.

Declaration

public event EventHandler<EventArgs> OnResume

Event Type

Type	Description
EventHandler<EventArgs>

OnStart

This event occurs whenever the playback starts.

Declaration

public event EventHandler<EventArgs> OnStart

Event Type

Type	Description
EventHandler<EventArgs>

OnStop

This event occurs whenever the playback stop.

Declaration

public event EventHandler<StopEventArgs> OnStop

Event Type

Type	Description
EventHandler<StopEventArgs>

OnVideoFrameBitmap

This event occurs whenever each new video frame is received.

Declaration

public event EventHandler<VideoFrameBitmapEventArgs> OnVideoFrameBitmap

Event Type

Type	Description
EventHandler<VideoFrameBitmapEventArgs>

OnVideoFrameBuffer

This event occurs whenever each new video frame is received.

Declaration

public event EventHandler<VideoFrameBufferEventArgs> OnVideoFrameBuffer

Event Type

Type	Description
EventHandler<VideoFrameBufferEventArgs>

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

IMediaPlayerControls

IVideoEffectsControls

IDisposable

IMediaPlayerCore

IMPVCVECore

INotifyPropertyChanged

IAsyncDisposable

Search Results for

Class MediaPlayerCore

Inheritance

Implements

Inherited Members

Namespace: VisioForge.Core.MediaPlayer

Assembly: VisioForge.Core.dll

Syntax

Constructors

MediaPlayerCore()

Declaration

MediaPlayerCore(bool)

Declaration

Parameters

MediaPlayerCore(IVideoView, bool)

Declaration

Parameters

Properties

Audio_Channel_Mapper

Declaration

Property Value

Audio_Effects_Enabled

Declaration

Property Value

Audio_Effects_Tempo_Enabled

Declaration

Property Value

Audio_Effects_Tempo_Value

Declaration

Property Value

Audio_Enhancer_Enabled

Declaration

Property Value

Audio_OutputDevice

Declaration

Property Value

Audio_PlayAudio

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

Barcode_Reader_Enabled

Declaration

Property Value

Barcode_Reader_Type

Declaration

Property Value

ChromaKey

Declaration

Property Value

ConsoleUsage

Declaration

Property Value

CustomParameters

Declaration

Property Value

CustomRedist_Auto

Declaration

Property Value

CustomRedist_DisableDialog

Declaration

Property Value

CustomRedist_Path

Declaration

Property Value

Custom_Audio_Decoder

Declaration

Property Value

Custom_Splitter