Class MediaPlayerCoreX

Class MediaPlayerCoreX. Implements the INotifyPropertyChanged Implements the IDisposable Implements the IAsyncDisposable Implements the IMediaPlayerControls

Inheritance

object

MediaPlayerCoreX

Implements

IDisposable

IAsyncDisposable

IMediaPlayerControls

IVideoEffectsControls

INotifyPropertyChanged

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VisioForge.Core.MediaPlayerX

Assembly: VisioForge.Core.dll

Syntax

public class MediaPlayerCoreX : IDisposable, IAsyncDisposable, IMediaPlayerControls, IVideoEffectsControls, INotifyPropertyChanged

Constructors

MediaPlayerCoreX()

Initializes a new instance of the MediaPlayerCoreX class.

Declaration

public MediaPlayerCoreX()

MediaPlayerCoreX(IVideoView)

Initializes a new instance of the MediaPlayerCoreX class.

Declaration

public MediaPlayerCoreX(IVideoView videoView)

Parameters

Type	Name	Description
IVideoView	videoView	The video view.

Properties

Audio_OutputDevice

Gets or sets the audio output device.

Declaration

public IAudioRendererSettings Audio_OutputDevice { get; set; }

Property Value

Type	Description
IAudioRendererSettings	The audio output device.

Audio_OutputDevice_Mute

Gets or sets a value indicating whether audio output device mute is enabled.

Declaration

public bool Audio_OutputDevice_Mute { get; set; }

Property Value

Type	Description
bool

Audio_OutputDevice_Volume

Gets or sets the audio output device volume.

Declaration

public double Audio_OutputDevice_Volume { get; set; }

Property Value

Type	Description
double

Audio_Play

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

Declaration

public bool Audio_Play { get; set; }

Property Value

Type	Description
bool

Audio_Streams

Gets the audio streams.

Declaration

public ObservableCollection<AudioStreamInfo> Audio_Streams { get; }

Property Value

Type	Description
ObservableCollection<AudioStreamInfo>

Audio_VU_Meter_Enabled

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

Declaration

public bool Audio_VU_Meter_Enabled { get; set; }

Property Value

Type	Description
bool

Barcode_Reader

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

Declaration

public BarcodeReaderSettings Barcode_Reader { get; set; }

Property Value

Type	Description
BarcodeReaderSettings

Custom_Audio_Outputs

Gets the custom audio outputs. Outputs will be cleared when media is closed.

Declaration

public List<MediaBlock> Custom_Audio_Outputs { get; }

Property Value

Type	Description
List<MediaBlock>	The custom audio outputs.

Custom_Video_Outputs

Gets the custom video outputs. Outputs will be cleared when media is closed.

Declaration

public List<MediaBlock> Custom_Video_Outputs { get; }

Property Value

Type	Description
List<MediaBlock>	The custom video outputs.

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.

Face_Tracking

Gets or sets face tracking settings.

Declaration

public FaceTrackingSettings Face_Tracking { get; set; }

Property Value

Type	Description
FaceTrackingSettings

Fonts

Gets the fonts names.

Declaration

public ObservableCollection<FontDescriptionX> Fonts { get; }

Property Value

Type	Description
ObservableCollection<FontDescriptionX>	The fonts names.

Motion_Detection

Gets or sets object detection settings.

Declaration

public MotionDetectionExSettings Motion_Detection { get; set; }

Property Value

Type	Description
MotionDetectionExSettings

SDK_BuildDate

Gets SDK build date.

Declaration

public static DateTime SDK_BuildDate { get; }

Property Value

Type	Description
DateTime	The SDK build date.

SDK_Version

Gets SDK version.

Declaration

public static Version SDK_Version { get; }

Property Value

Type	Description
Version	The SDK version.

Segment_Start

Gets or sets segment start position.

Declaration

public TimeSpan Segment_Start { get; set; }

Property Value

Type	Description
TimeSpan

Segment_Stop

Gets or sets segment stop position.

Declaration

public TimeSpan Segment_Stop { get; set; }

Property Value

Type	Description
TimeSpan

Snapshot_Grabber_Enabled

Gets or sets a value indicating whether the snapshot grabber is enabled. It should be enabled before calling Start/StartAsync method.

Declaration

public bool Snapshot_Grabber_Enabled { get; set; }

Property Value

Type	Description
bool	true if the snapshot grabber enabled; otherwise, false.

State

Gets or sets the state.

Declaration

public PlaybackState State { get; }

Property Value

Type	Description
PlaybackState	The state.

Subtitle_Streams

Gets the subtitle streams.

Declaration

public ObservableCollection<SubtitleStreamInfo> Subtitle_Streams { get; }

Property Value

Type	Description
ObservableCollection<SubtitleStreamInfo>

Subtitles_Enabled

Gets or sets a value indicating whether subtitles is enabled.

Declaration

public bool Subtitles_Enabled { get; set; }

Property Value

Type	Description
bool

Subtitles_ExternalFile

Gets or sets the subtitles external file.

Declaration

public string Subtitles_ExternalFile { get; set; }

Property Value

Type	Description
string

Subtitles_Settings

Gets or sets the subtitles settings.

Declaration

public SubtitleOverlaySettings Subtitles_Settings { get; set; }

Property Value

Type	Description
SubtitleOverlaySettings

Video_Composition_Enabled

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

Declaration

public bool Video_Composition_Enabled { get; set; }

Property Value

Type	Description
bool

Video_Play

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

Declaration

public bool Video_Play { get; set; }

Property Value

Type	Description
bool

Video_Streams

Gets the video streams.

Declaration

public ObservableCollection<VideoStreamInfo> Video_Streams { get; }

Property Value

Type	Description
ObservableCollection<VideoStreamInfo>

Methods

Audio_Effects_AddOrUpdate(BaseAudioEffect)

Adds/updates the audio effect.

Declaration

public void Audio_Effects_AddOrUpdate(BaseAudioEffect effect)

Parameters

Type	Name	Description
BaseAudioEffect	effect	The effect.

Audio_Effects_Clear()

Clear audio effects.

Declaration

public void Audio_Effects_Clear()

Audio_Effects_Remove(BaseAudioEffect)

Removes the audio effect.

Declaration

public void Audio_Effects_Remove(BaseAudioEffect effect)

Parameters

Type	Name	Description
BaseAudioEffect	effect	The effect.

Audio_OutputDevicesAsync(AudioOutputDeviceAPI?)

Gets the output audio devices asynchronous.

Declaration

public Task<AudioOutputDeviceInfo[]> Audio_OutputDevicesAsync(AudioOutputDeviceAPI? api = null)

Parameters

Type	Name	Description
AudioOutputDeviceAPI?	api	The API.

Returns

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

Audio_Stream_Select(AudioStreamInfo)

Selects the audio stream.

Declaration

public bool Audio_Stream_Select(AudioStreamInfo stream)

Parameters

Type	Name	Description
AudioStreamInfo	stream	The stream.

Returns

Type	Description
bool	true if successful, false otherwise.

Debug_SavePipeline(string)

Saves the pipeline.

Declaration

public void Debug_SavePipeline(string name)

Parameters

Type	Name	Description
string	name	The name.

Dispose()

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

Declaration

public void Dispose()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	true to release both managed and unmanaged resources; false to release only unmanaged resources.

DisposeAsync()

Dispose as an asynchronous operation.

Declaration

public ValueTask DisposeAsync()

Returns

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

Duration()

Gets duration.

Declaration

public TimeSpan Duration()

Returns

Type	Description
TimeSpan	TimeSpan.

DurationAsync()

Gets duration (async).

Declaration

public Task<TimeSpan> DurationAsync()

Returns

Type	Description
Task<TimeSpan>	Task<TimeSpan>.

~MediaPlayerCoreX()

Finalizes an instance of the MediaPlayerCoreX class.

Declaration

protected ~MediaPlayerCoreX()

GetContext()

Gets the context.

Declaration

public ContextX GetContext()

Returns

Type	Description
ContextX	GSTContext.

GetLogger()

Gets the logger.

Declaration

public ILogger GetLogger()

Returns

Type	Description
ILogger	ILogger.

NextFrame()

Performs frame step.

Declaration

public bool NextFrame()

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.

OpenAsync(string)

Opens the specified file (async).

Declaration

public Task<bool> OpenAsync(string filename)

Parameters

Type	Name	Description
string	filename	The filename.

Returns

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

OpenAsync(Uri)

Opens the specified URI (async).

Declaration

public Task<bool> OpenAsync(Uri uri)

Parameters

Type	Name	Description
Uri	uri	The URI.

Returns

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

OpenAsync(IMediaPlayerBaseSourceSettings)

Opens the specified source (async).

Declaration

public Task<bool> OpenAsync(IMediaPlayerBaseSourceSettings source)

Parameters

Type	Name	Description
IMediaPlayerBaseSourceSettings	source	The source.

Returns

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

Pause()

Pauses playback.

Declaration

public bool Pause()

Returns

Type	Description
bool	true if successful, false otherwise.

PauseAsync()

Pauses playback (async).

Declaration

public Task<bool> PauseAsync()

Returns

Type	Description
Task<bool>	The Task.

Play()

Plays this instance.

Declaration

public bool Play()

Returns

Type	Description
bool	true if successfull, false otherwise.

PlayAsync()

Start playback (async).

Declaration

public Task<bool> PlayAsync()

Returns

Type	Description
Task<bool>	The Task.

Position_Get()

Gets position.

Declaration

public TimeSpan Position_Get()

Returns

Type	Description
TimeSpan	TimeSpan.

Position_GetAsync()

Gets position (async).

Declaration

public Task<TimeSpan> Position_GetAsync()

Returns

Type	Description
Task<TimeSpan>	Task<TimeSpan>.

Position_Set(TimeSpan, bool)

Sets position.

Declaration

public void Position_Set(TimeSpan position, bool seekToKeyframe = false)

Parameters

Type	Name	Description
TimeSpan	position	The position.
bool	seekToKeyframe	True to seek to a keyframe.

Position_SetAsync(TimeSpan, bool)

Sets position (async).

Declaration

public Task Position_SetAsync(TimeSpan position, bool seekToKeyframe = false)

Parameters

Type	Name	Description
TimeSpan	position	The position.
bool	seekToKeyframe	True to seek to a keyframe.

Returns

Type	Description
Task	Task.

Position_SetRange(TimeSpan, TimeSpan, bool)

Sets start and stop position for playback.

Declaration

public void Position_SetRange(TimeSpan startPosition, TimeSpan stopPosition, bool seekToKeyframe = false)

Parameters

Type	Name	Description
TimeSpan	startPosition	The start position.
TimeSpan	stopPosition	The stop position.
bool	seekToKeyframe	if set to true seek to keyframe.

Position_SetRangeAsync(TimeSpan, TimeSpan, bool)

Sets start and stop position for playback (async.).

Declaration

public Task Position_SetRangeAsync(TimeSpan startPosition, TimeSpan stopPosition, bool seekToKeyframe = false)

Parameters

Type	Name	Description
TimeSpan	startPosition	The start position.
TimeSpan	stopPosition	The stop position.
bool	seekToKeyframe	if set to true seek to keyframe.

Returns

Type	Description
Task	Task.

PrevFrame()

Performs frame step backward.

Declaration

public bool PrevFrame()

Returns

Type	Description
bool	true if successful, false otherwise.

Rate_Get()

Gets the rate.

Declaration

public double Rate_Get()

Returns

Type	Description
double	System.Double.

Rate_GetAsync()

Gets the rate (async).

Declaration

public Task<double> Rate_GetAsync()

Returns

Type	Description
Task<double>	Task<System.Double>.

Rate_Set(double)

Sets the rate.

Declaration

public bool Rate_Set(double rate)

Parameters

Type	Name	Description
double	rate	The rate.

Returns

Type	Description
bool	true if successful, false otherwise.

Rate_SetAsync(double)

Sets the rate (async).

Declaration

public Task<bool> Rate_SetAsync(double rate)

Parameters

Type	Name	Description
double	rate	The rate.

Returns

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

Resume()

Resumes playback.

Declaration

public bool Resume()

Returns

Type	Description
bool	true if successful, false otherwise.

ResumeAsync()

Resumes playback (async).

Declaration

public Task<bool> ResumeAsync()

Returns

Type	Description
Task<bool>	The Task.

SetCustomErrorHandler(IMediaBlocksPipelineCustomErrorHandler)

Sets the custom error handler.

Declaration

public void SetCustomErrorHandler(IMediaBlocksPipelineCustomErrorHandler errorHandler)

Parameters

Type	Name	Description
IMediaBlocksPipelineCustomErrorHandler	errorHandler	The error handler.

SetLicenseKey(string, string, string)

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

Declaration

public void SetLicenseKey(string licenseKey, string username, string email)

Parameters

Type	Name	Description
string	licenseKey	License key.
string	username	User name used during purchase.
string	email	E-mail used during purchase.

Examples

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

Settings_Load(string)

Loads SDK settings from JSON file.

Declaration

public bool Settings_Load(string jsonFilename)

Parameters

Type	Name	Description
string	jsonFilename	JSON settings file.

Returns

Type	Description
bool	Returns bool.

Settings_Save(string, string)

Saves current SDK control settings to file (JSON).

Declaration

public bool Settings_Save(string jsonFilename, string infoFilename)

Parameters

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

Returns

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

Snapshot_Get()

Gets the snapshot as VideoFrameX.

Declaration

public VideoFrameX Snapshot_Get()

Returns

Type	Description
VideoFrameX	Bitmap.

Snapshot_GetAsync()

Gets the snapshot as Bitmap (async).

Declaration

public Task<VideoFrameX> Snapshot_GetAsync()

Returns

Type	Description
Task<VideoFrameX>	Task<Bitmap>.

Snapshot_GetSK()

Gets the snapshot as SKBitmap.

Declaration

public SKBitmap Snapshot_GetSK()

Returns

Type	Description
SKBitmap	SKBitmap.

Snapshot_GetSKAsync()

Gets the snapshot as SKBitmap (async).

Declaration

public Task<SKBitmap> Snapshot_GetSKAsync()

Returns

Type	Description
Task<SKBitmap>	Task<SKBitmap>.

Snapshot_Save(string, SKEncodedImageFormat, int)

Saves snapshot to a file.

Declaration

public bool Snapshot_Save(string filename, SKEncodedImageFormat format, int quality = 85)

Parameters

Type	Name	Description
string	filename	File name.
SKEncodedImageFormat	format	Format.
int	quality	The quality [0..100].

Returns

Type	Description
bool	true if successful, false otherwise.

Snapshot_SaveAsync(string, SKEncodedImageFormat, int)

Saves snapshot to a file (async).

Declaration

public Task<bool> Snapshot_SaveAsync(string filename, SKEncodedImageFormat format, int quality = 85)

Parameters

Type	Name	Description
string	filename	File name.
SKEncodedImageFormat	format	Format.
int	quality	The quality [0..100].

Returns

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

Stop()

Stops the playback.

Declaration

public void Stop()

StopAsync()

Stops the playback (async).

Declaration

public Task StopAsync()

Returns

Type	Description
Task	Task.

Subtitles_Settings_Update()

Updates the subtitle settings.

Declaration

public void Subtitles_Settings_Update()

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 puctures are strings.

Video_Composition_Add(VideoCompositionElement)

Adds the composition element.

Declaration

public void Video_Composition_Add(VideoCompositionElement element)

Parameters

Type	Name	Description
VideoCompositionElement	element	The element.

Video_Composition_Clear()

Clears video composition elements.

Declaration

public void Video_Composition_Clear()

Video_Composition_Remove(VideoCompositionElement)

Removes the composition element.

Declaration

public void Video_Composition_Remove(VideoCompositionElement element)

Parameters

Type	Name	Description
VideoCompositionElement	element	The element.

Video_Effects_AddOrUpdateAsync(BaseVideoEffect)

Adds/updates the video effect.

Declaration

public Task Video_Effects_AddOrUpdateAsync(BaseVideoEffect effect)

Parameters

Type	Name	Description
BaseVideoEffect	effect	The effect.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Video_Effects_Clear()

Clears the video effects.

Declaration

public void Video_Effects_Clear()

Video_Effects_Get(string)

Gets the video effect.

Declaration

public BaseVideoEffect Video_Effects_Get(string effectName)

Parameters

Type	Name	Description
string	effectName	Name of the effect.

Returns

Type	Description
BaseVideoEffect	BaseVideoEffect.

Video_Effects_RemoveAsync(string)

Removes the video effect.

Declaration

public Task Video_Effects_RemoveAsync(string name)

Parameters

Type	Name	Description
string	name	The name.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Video_Effects_RemoveAsync(BaseVideoEffect)

Removes the video effect.

Declaration

public Task Video_Effects_RemoveAsync(BaseVideoEffect effect)

Parameters

Type	Name	Description
BaseVideoEffect	effect	The effect.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Video_Stream_Select(VideoStreamInfo)

Selects the video stream.

Declaration

public bool Video_Stream_Select(VideoStreamInfo stream)

Parameters

Type	Name	Description
VideoStreamInfo	stream	The stream.

Returns

Type	Description
bool	true if successful, false otherwise.

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<VUMeterXEventArgs> OnAudioVUMeter

Event Type

Type	Description
EventHandler<VUMeterXEventArgs>

OnBarcodeDetected

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

Declaration

public event EventHandler<BarcodeEventArgs> OnBarcodeDetected

Event Type

Type	Description
EventHandler<BarcodeEventArgs>

OnError

This event occurs whenever error is happened,.

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>

OnLicenseRequired

This event occurs in a case of an license required.

Declaration

public event EventHandler<LicenseEventArgs> OnLicenseRequired

Event Type

Type	Description
EventHandler<LicenseEventArgs>

OnMotionDetection

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

Declaration

public event EventHandler<MotionDetectionExEventArgs> OnMotionDetection

Event Type

Type	Description
EventHandler<MotionDetectionExEventArgs>

OnPause

This event occurs whenever the playback pauses.

Declaration

public event EventHandler<EventArgs> OnPause

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 playback is stopped.

Declaration

public event EventHandler<StopEventArgs> OnStop

Event Type

Type	Description
EventHandler<StopEventArgs>

OnStreamsInfoAvailable

Event occurring on file streams information is available..

Declaration

public event EventHandler<EventArgs> OnStreamsInfoAvailable

Event Type

Type	Description
EventHandler<EventArgs>

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<VideoFrameXBufferEventArgs> OnVideoFrameBuffer

Event Type

Type	Description
EventHandler<VideoFrameXBufferEventArgs>

OnVideoFrameSKBitmap

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

Declaration

public event EventHandler<VideoFrameSKBitmapEventArgs> OnVideoFrameSKBitmap

Event Type

Type	Description
EventHandler<VideoFrameSKBitmapEventArgs>

PropertyChanged

Property changed event.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
PropertyChangedEventHandler

Implements

IDisposable

IAsyncDisposable

IMediaPlayerControls

IVideoEffectsControls

INotifyPropertyChanged

See Also

INotifyPropertyChanged

IDisposable

IAsyncDisposable

IMediaPlayerControls

INotifyPropertyChanged

IDisposable

IMediaPlayerControls

INotifyPropertyChanged

IDisposable

IMediaPlayerControls

IDisposable

IMediaPlayerControls

INotifyPropertyChanged

IDisposable

IMediaPlayerControls

INotifyPropertyChanged

IDisposable

IMediaPlayerControls

INotifyPropertyChanged

IDisposable

IAsyncDisposable

IMediaPlayerControls

INotifyPropertyChanged

IDisposable

IAsyncDisposable

IMediaPlayerControls

INotifyPropertyChanged

IDisposable

IAsyncDisposable

IMediaPlayerControls

INotifyPropertyChanged

IDisposable

IMediaPlayerControls

INotifyPropertyChanged

IDisposable

IMediaPlayerControls