Class VideoEditCoreX

Class VideoEditCoreX. Implements the IDisposable. Implements the INotifyPropertyChanged.

Inheritance

object

VideoEditCoreX

Implements

IDisposable

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

Assembly: VisioForge.Core.dll

Syntax

public class VideoEditCoreX : IDisposable, INotifyPropertyChanged

Constructors

VideoEditCoreX()

Initializes a new instance of the VideoEditCoreX class.

Declaration

public VideoEditCoreX()

VideoEditCoreX(IVideoView)

Initializes a new instance of the VideoEditCoreX class.

Declaration

public VideoEditCoreX(IVideoView videoView)

Parameters

Type	Name	Description
IVideoView	videoView	The video view.

Properties

Audio_Effects

Gets the audio effects.

Declaration

public List<IVideoEditXAudioEffect> Audio_Effects { get; }

Property Value

Type	Description
List<IVideoEditXAudioEffect>	The audio effects.

Audio_Transitions

Gets the audio transitions.

Declaration

public List<AudioTransition> Audio_Transitions { get; }

Property Value

Type	Description
List<AudioTransition>	The audio transitions.

AutoTransitions

Gets or sets a value indicating whether automatic transitions will be added between tracks.

Declaration

public bool AutoTransitions { get; set; }

Property Value

Type	Description
bool

ConsoleUsage

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

Declaration

public bool ConsoleUsage { get; set; }

Property Value

Type	Description
bool

Debug_Dir

Gets or sets debug directory.

Declaration

public string Debug_Dir { get; set; }

Property Value

Type	Description
string	The debug dir.

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	true if [debug disable message dialogs]; otherwise, false.

Debug_Mode

Gets or sets a value indicating whether debug mode enabled.

Declaration

public bool Debug_Mode { get; set; }

Property Value

Type	Description
bool	true if [debug mode]; otherwise, false.

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	true if debug telemetry enabled; otherwise, false.

Remarks

Only anonymous data will be send.

Fonts

Gets the fonts names.

Declaration

public ObservableCollection<FontDescriptionX> Fonts { get; }

Property Value

Type	Description
ObservableCollection<FontDescriptionX>	The fonts names.

Output_AudioChannels

Gets or sets the output audio channels.

Declaration

public int Output_AudioChannels { get; set; }

Property Value

Type	Description
int

Output_AudioSampleRate

Gets or sets the output audio sample rate.

Declaration

public int Output_AudioSampleRate { get; set; }

Property Value

Type	Description
int

Output_Format

Gets or sets the output format.

Declaration

public IVideoEditXBaseOutput Output_Format { get; set; }

Property Value

Type	Description
IVideoEditXBaseOutput

Output_VideoCrop

Gets or sets the output video crop settings.

Declaration

public CropVideoEffect Output_VideoCrop { get; set; }

Property Value

Type	Description
CropVideoEffect

Output_VideoFrameRate

Gets or sets the output video frame rate.

Declaration

public VideoFrameRate Output_VideoFrameRate { get; set; }

Property Value

Type	Description
VideoFrameRate

Output_VideoRotateFlip

Gets or sets the output video rotate/flip.

Declaration

public FlipRotateVideoEffect Output_VideoRotateFlip { get; set; }

Property Value

Type	Description
FlipRotateVideoEffect

Output_VideoSize

Gets or sets the resolution of the output video.

Declaration

public Size Output_VideoSize { get; set; }

Property Value

Type	Description
Size

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.

SmartRender

Gets or sets a value indicating whether smart render mode (without reencoding if possible) is enabled.

Declaration

public bool SmartRender { get; set; }

Property Value

Type	Description
bool

State

Gets the state.

Declaration

public PlaybackState State { get; }

Property Value

Type	Description
PlaybackState	The state.

Video_Effects

Gets the video effects.

Declaration

public ObservableCollection<IVideoEditXVideoEffect> Video_Effects { get; }

Property Value

Type	Description
ObservableCollection<IVideoEditXVideoEffect>	The video effects.

Video_TextOverlays

Gets the text overlays.

Declaration

public List<TextOverlay> Video_TextOverlays { get; }

Property Value

Type	Description
List<TextOverlay>	The text overlays.

Video_Transitions

Gets the video transitions.

Declaration

public ObservableCollection<VideoTransition> Video_Transitions { get; }

Property Value

Type	Description
ObservableCollection<VideoTransition>	The video transitions.

Methods

Dispose()

Disposes this instance.

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.

Duration()

Gets duration.

Declaration

public TimeSpan Duration()

Returns

Type	Description
TimeSpan	TimeSpan.

~VideoEditCoreX()

Finalizes an instance of the VideoEditCoreX class.

Declaration

protected ~VideoEditCoreX()

GetLogger()

Gets the logger.

Declaration

public ILogger GetLogger()

Returns

Type	Description
ILogger	ILogger.

GetSnapshot()

Gets the snapshot (in Preview mode).

Declaration

public Bitmap GetSnapshot()

Returns

Type	Description
Bitmap	Bitmap.

Input_AddAudioFile(string, TimeSpan?)

Adds audio stream from a specified file.

Declaration

public bool Input_AddAudioFile(string filename, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
string	filename	The filename.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if successful, false otherwise.

Input_AddAudioFile(string, TimeSpan, TimeSpan, TimeSpan?)

Adds audio stream from a specified file.

Declaration

public bool Input_AddAudioFile(string filename, TimeSpan startTime, TimeSpan stopTime, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
string	filename	The filename.
TimeSpan	startTime	The start time.
TimeSpan	stopTime	The stop time.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if successful, false otherwise.

Input_AddAudioFile(AudioFileSource, TimeSpan?)

Adds audio stream from a specified file.

Declaration

public bool Input_AddAudioFile(AudioFileSource source, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
AudioFileSource	source	The source.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if successful, false otherwise.

Input_AddAudioFromStream(Stream, TimeSpan?, TimeSpan?, TimeSpan?)

Adds audio stream from a specified stream.

Declaration

public bool Input_AddAudioFromStream(Stream stream, TimeSpan? startTime, TimeSpan? stopTime, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
Stream	stream	The stream (seekable).
TimeSpan?	startTime	The start time.
TimeSpan?	stopTime	The stop time.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if successful, false otherwise.

Input_AddAudioVideoFile(string, TimeSpan?, TimeSpan?, TimeSpan?)

Adds audio/video streams from a specified file.

Declaration

public bool Input_AddAudioVideoFile(string filename, TimeSpan? startTime = null, TimeSpan? stopTime = null, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
string	filename	The filename.
TimeSpan?	startTime	The start time.
TimeSpan?	stopTime	The stop time.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if successful, false otherwise.

Input_AddAudioVideoFromStream(Stream, TimeSpan?, TimeSpan?, TimeSpan?)

Adds audio/video data from a specified seekable stream.

Declaration

public bool Input_AddAudioVideoFromStream(Stream stream, TimeSpan? startTime = null, TimeSpan? stopTime = null, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
Stream	stream	The stream.
TimeSpan?	startTime	The start time.
TimeSpan?	stopTime	The stop time.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if successful, false otherwise.

Input_AddImageFile(string, TimeSpan, TimeSpan?)

Adds an image from the specified file.

Declaration

public bool Input_AddImageFile(string filename, TimeSpan duration, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
string	filename	The filename.
TimeSpan	duration	The duration.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if added, false otherwise.

Input_AddImageFile(ImageFileSource, TimeSpan?)

Adds an image from a specified source.

Declaration

public bool Input_AddImageFile(ImageFileSource source, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
ImageFileSource	source	The source.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if successful, false otherwise.

Input_AddImageFromStream(Stream, TimeSpan, TimeSpan?)

Adds an image from the specified seekable stream.

Declaration

public bool Input_AddImageFromStream(Stream stream, TimeSpan duration, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
Stream	stream	The stream.
TimeSpan	duration	The duration.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if added, false otherwise.

Input_AddTestClip(TimeSpan, TimeSpan, TimeSpan, string)

Adds the test clip.

Declaration

public bool Input_AddTestClip(TimeSpan startTime, TimeSpan stopTime, TimeSpan insertTime, string id = "blue")

Parameters

Type	Name	Description
TimeSpan	startTime	The start time.
TimeSpan	stopTime	The stop time.
TimeSpan	insertTime	The insert time.
string	id	The identifier.

Returns

Type	Description
bool	true if successful, false otherwise.

Input_AddVideoFile(string, TimeSpan?)

Adds video stream from a specified file.

Declaration

public bool Input_AddVideoFile(string filename, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
string	filename	The filename.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if successful, false otherwise.

Input_AddVideoFile(string, TimeSpan, TimeSpan, TimeSpan?)

Adds video stream from a specified file.

Declaration

public bool Input_AddVideoFile(string filename, TimeSpan startTime, TimeSpan stopTime, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
string	filename	The filename.
TimeSpan	startTime	The start time.
TimeSpan	stopTime	The stop time.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if successful, false otherwise.

Input_AddVideoFile(VideoFileSource, TimeSpan?)

Adds video stream from a specified file.

Declaration

public bool Input_AddVideoFile(VideoFileSource source, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
VideoFileSource	source	The source.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if successful, false otherwise.

Input_AddVideoFromStream(Stream, TimeSpan, TimeSpan, TimeSpan?)

Adds video stream from a specified seekable stream.

Declaration

public bool Input_AddVideoFromStream(Stream stream, TimeSpan startTime, TimeSpan stopTime, TimeSpan? insertTime = null)

Parameters

Type	Name	Description
Stream	stream	The stream.
TimeSpan	startTime	The start time.
TimeSpan	stopTime	The stop time.
TimeSpan?	insertTime	The insert time.

Returns

Type	Description
bool	true if successful, false otherwise.

Input_AddVideoLayer()

Adds video input layer.

Declaration

public int Input_AddVideoLayer()

Returns

Type	Description
int	System.Int32.

Input_Clear_List()

Clears a list of the input files.

Declaration

public void Input_Clear_List()

OnPropertyChanged(string)

OnPropertyChanged API.

Declaration

protected virtual void OnPropertyChanged(string propertyName = null)

Parameters

Type	Name	Description
string	propertyName	Property name.

Position_Get()

Gets position.

Declaration

public TimeSpan Position_Get()

Returns

Type	Description
TimeSpan	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.

SDKInit()

Initialize the SDK.

Declaration

public static bool SDKInit()

Returns

Type	Description
bool	true if successful, false otherwise.

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

Declaration

public bool Settings_Save(string jsonFilename, string infoFilename)

Parameters

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

Returns

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

Start()

Starts.

Declaration

public bool Start()

Returns

Type	Description
bool	true if successfull, false otherwise.

Stop()

Stops the playback.

Declaration

public bool Stop()

Returns

Type	Description
bool	true if successfull, false otherwise.

Video_Transitions_Names()

Gets the transition names.

Declaration

public ObservableCollection<string> Video_Transitions_Names()

Returns

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

Events

OnError

Occurs when error happened.

Declaration

public event EventHandler<ErrorsEventArgs> OnError

Event Type

Type	Description
EventHandler<ErrorsEventArgs>

OnPause

This event occurs whenever the playback pauses.

Declaration

public event EventHandler<EventArgs> OnPause

Event Type

Type	Description
EventHandler<EventArgs>

OnProgress

Event occurring when new progress value available.

Declaration

public event EventHandler<ProgressEventArgs> OnProgress

Event Type

Type	Description
EventHandler<ProgressEventArgs>

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>

PropertyChanged

Property changed event.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
PropertyChangedEventHandler

Implements

IDisposable

INotifyPropertyChanged

See Also

IDisposable

INotifyPropertyChanged

IDisposable

INotifyPropertyChanged

IDisposable

INotifyPropertyChanged

IDisposable

INotifyPropertyChanged

IDisposable

INotifyPropertyChanged

IDisposable

INotifyPropertyChanged

IDisposable

INotifyPropertyChanged

IDisposable

INotifyPropertyChanged

IDisposable

INotifyPropertyChanged

IDisposable