Class LiveVideoCompositor

Live Video Compositor. Implements the IDisposable.

Inheritance

object

LiveVideoCompositor

Implements

IDisposable

IAsyncDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: VisioForge.Core.LiveVideoCompositor

Assembly: VisioForge.Core.dll

Syntax

public class LiveVideoCompositor : IDisposable, IAsyncDisposable

Constructors

LiveVideoCompositor(LiveVideoCompositorSettings)

Initializes a new instance of the LiveVideoCompositor class.

Declaration

public LiveVideoCompositor(LiveVideoCompositorSettings settings)

Parameters

Type	Name	Description
LiveVideoCompositorSettings	settings	The settings.

Properties

Background

Gets or sets the background.

Declaration

public VideoMixerBackground Background { get; set; }

Property Value

Type	Description
VideoMixerBackground	The background.

Settings

Gets the settings.

Declaration

public LiveVideoCompositorSettings Settings { get; }

Property Value

Type	Description
LiveVideoCompositorSettings

Video_Overlay_Enabled

Gets or sets a value indicating whether video overlay manager enabled.

Declaration

public bool Video_Overlay_Enabled { get; set; }

Property Value

Type	Description
bool	true if video overlay manager enabled; otherwise, false.

Methods

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.

DurationAsync()

Gets the duration.

Declaration

public Task<TimeSpan> DurationAsync()

Returns

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

~LiveVideoCompositor()

Finalizes an instance of the LiveVideoCompositor class.

Declaration

protected ~LiveVideoCompositor()

GetAudioMixer()

Gets the audio mixer.

Declaration

public AudioMixerBlock GetAudioMixer()

Returns

Type	Description
AudioMixerBlock	AudioMixerBlock.

GetContext()

Gets the context.

Declaration

public ContextX GetContext()

Returns

Type	Description
ContextX	ContextX.

GetPipeline()

Gets the pipeline.

Declaration

public MediaBlocksPipeline GetPipeline()

Returns

Type	Description
MediaBlocksPipeline	MediaBlocksPipeline.

GetVideoMixer()

Gets the video mixer.

Declaration

public VideoMixerBlock GetVideoMixer()

Returns

Type	Description
VideoMixerBlock	VideoMixerBlock.

Input_AddAsync(LVCAudioInput)

Adds the audio input.

Declaration

public Task<bool> Input_AddAsync(LVCAudioInput input)

Parameters

Type	Name	Description
LVCAudioInput	input	The input.

Returns

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

Input_AddAsync(LVCFileVideoAudioInput, bool)

Adds the file video/audio input.

Declaration

public Task<bool> Input_AddAsync(LVCFileVideoAudioInput input, bool start = false)

Parameters

Type	Name	Description
LVCFileVideoAudioInput	input	The input.
bool	start	if set to true start after adding.

Returns

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

Input_AddAsync(LVCVideoAudioInput, bool)

Adds the video/audio input.

Declaration

public Task<bool> Input_AddAsync(LVCVideoAudioInput input, bool start = false)

Parameters

Type	Name	Description
LVCVideoAudioInput	input	The input.
bool	start	if set to true start after adding.

Returns

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

Input_AddAsync(LVCVideoInput)

Adds the video input.

Declaration

public Task<bool> Input_AddAsync(LVCVideoInput input)

Parameters

Type	Name	Description
LVCVideoInput	input	The input.

Returns

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

Input_FileVideoAudio_Get(int)

Gets the file video/audio input.

Declaration

public LVCFileVideoAudioInput Input_FileVideoAudio_Get(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

Type	Description
LVCFileVideoAudioInput	LVCFileVideoAudioInput.

Input_Get(int)

Gets the input.

Declaration

public LVCInput Input_Get(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

Type	Description
LVCInput	LVCInput.

Input_RemoveAtAsync(int)

Removes the input.

Declaration

public Task<bool> Input_RemoveAtAsync(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

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

Input_VideoAudio_Get(int)

Gets the video/audio input.

Declaration

public LVCVideoAudioInput Input_VideoAudio_Get(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

Type	Description
LVCVideoAudioInput	LVCVideoAudioInput.

Input_VideoStream_Get(int)

Gets the video input.

Declaration

public VideoMixerStream Input_VideoStream_Get(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

Type	Description
VideoMixerStream	VideoMixerStream.

Input_VideoStream_Update(int, VideoMixerStream)

Updates the video input.

Declaration

public void Input_VideoStream_Update(int index, VideoMixerStream stream)

Parameters

Type	Name	Description
int	index	The index.
VideoMixerStream	stream	The stream.

Output_AddAsync(LVCAudioOutput, bool)

Adds the audio output.

Declaration

public Task<bool> Output_AddAsync(LVCAudioOutput output, bool start = false)

Parameters

Type	Name	Description
LVCAudioOutput	output	The output.
bool	start	if set to true start.

Returns

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

Output_AddAsync(LVCVideoAudioOutput, bool)

Adds the video/audio output.

Declaration

public Task<bool> Output_AddAsync(LVCVideoAudioOutput output, bool start = false)

Parameters

Type	Name	Description
LVCVideoAudioOutput	output	The output.
bool	start	if set to true start.

Returns

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

Output_AddAsync(LVCVideoOutput, bool)

Adds the video output.

Declaration

public Task<bool> Output_AddAsync(LVCVideoOutput output, bool start = false)

Parameters

Type	Name	Description
LVCVideoOutput	output	The output.
bool	start	if set to true start.

Returns

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

Output_Audio_Get(int)

Gets the audio output.

Declaration

public LVCAudioOutput Output_Audio_Get(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

Type	Description
LVCAudioOutput	LVCAudioOutput.

Output_Get(int)

Gets the output.

Declaration

public LVCOutput Output_Get(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

Type	Description
LVCOutput	LVCOutput.

Output_Get(string)

Gets the output.

Declaration

public LVCOutput Output_Get(string name)

Parameters

Type	Name	Description
string	name	The name.

Returns

Type	Description
LVCOutput	LVCOutput.

Output_RemoveAsync(string)

Removes the output.

Declaration

public Task<bool> Output_RemoveAsync(string name)

Parameters

Type	Name	Description
string	name	The name.

Returns

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

Output_RemoveAtAsync(int)

Removes the output.

Declaration

public Task<bool> Output_RemoveAtAsync(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

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

Output_VideoAudio_Get(int)

Gets the video/audio output.

Declaration

public LVCVideoAudioOutput Output_VideoAudio_Get(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

Type	Description
LVCVideoAudioOutput	LVCVideoAudioOutput.

Output_Video_Get(int)

Gets the video output.

Declaration

public LVCVideoOutput Output_Video_Get(int index)

Parameters

Type	Name	Description
int	index	The index.

Returns

Type	Description
LVCVideoOutput	LVCVideoOutput.

SetLicenseKey(string, string, string)

Sets the license key.

Declaration

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

Parameters

Type	Name	Description
string	licenseKey	The license key.
string	userName	Name of the user.
string	email	The email.

StartAsync()

Starts.

Declaration

public Task<bool> StartAsync()

Returns

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

StopAsync()

Stops.

Declaration

public Task StopAsync()

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Switch(int)

Switches the specified index.

Declaration

public void Switch(int index)

Parameters

Type	Name	Description
int	index	The index.

Video_Effects_AddOrUpdateAsync(BaseVideoEffect, int)

Adds/updates the video effect.

Declaration

public Task Video_Effects_AddOrUpdateAsync(BaseVideoEffect effect, int channel = 0)

Parameters

Type	Name	Description
BaseVideoEffect	effect	The effect.
int	channel	The channel.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Video_Effects_Clear(int)

Clears the video effects.

Declaration

public void Video_Effects_Clear(int channel = 0)

Parameters

Type	Name	Description
int	channel	The channel.

Video_Effects_Get(string, int)

Gets the video effect.

Declaration

public BaseVideoEffect Video_Effects_Get(string effectName, int channel = 0)

Parameters

Type	Name	Description
string	effectName	Name of the effect.
int	channel	The channel.

Returns

Type	Description
BaseVideoEffect	BaseVideoEffect.

Video_Effects_RemoveAsync(string, int)

Removes the video effect.

Declaration

public Task Video_Effects_RemoveAsync(string name, int channel = 0)

Parameters

Type	Name	Description
string	name	The name.
int	channel	The channel.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Video_Effects_RemoveAsync(BaseVideoEffect, int)

Removes the video effect.

Declaration

public Task Video_Effects_RemoveAsync(BaseVideoEffect effect, int channel = 0)

Parameters

Type	Name	Description
BaseVideoEffect	effect	The effect.
int	channel	The channel.

Returns

Type	Description
Task	A Task representing the asynchronous operation.

Video_Overlay_Add(IOverlayManagerElement, int)

Adds overlay.

Declaration

public void Video_Overlay_Add(IOverlayManagerElement overlay, int channel = 0)

Parameters

Type	Name	Description
IOverlayManagerElement	overlay	The overlay.
int	channel	The channel.

Video_Overlay_Clear(int)

Clears all overlays.

Declaration

public void Video_Overlay_Clear(int channel = 0)

Parameters

Type	Name	Description
int	channel	The channel.

Video_Overlay_Remove(IOverlayManagerElement, int)

Removes overlay.

Declaration

public void Video_Overlay_Remove(IOverlayManagerElement overlay, int channel = 0)

Parameters

Type	Name	Description
IOverlayManagerElement	overlay	The overlay.
int	channel	The channel.

Video_Overlay_RemoveAt(int, int)

Removes overlay at specified index.

Declaration

public void Video_Overlay_RemoveAt(int index, int channel = 0)

Parameters

Type	Name	Description
int	index	The index.
int	channel	The channel.

Video_Overlay_Update(IOverlayManagerElement, int)

Updates overlay.

Declaration

public void Video_Overlay_Update(IOverlayManagerElement overlay, int channel = 0)

Parameters

Type	Name	Description
IOverlayManagerElement	overlay	The overlay.
int	channel	The channel.

Events

OnError

Occurs when error happened.

Declaration

public event EventHandler<ErrorsEventArgs> OnError

Event Type

Type	Description
EventHandler<ErrorsEventArgs>

Implements

IDisposable

IAsyncDisposable

See Also

IDisposable

IDisposable

IAsyncDisposable

INotifyPropertyChanged

IDisposable

IMediaPlayerControls