Class LVCOutput

Live Video Compositor output. Implements the IDisposable.

Inheritance

object

LVCOutput

LVCAudioOutput

LVCVideoAudioOutput

LVCVideoOutput

Implements

IDisposable

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 LVCOutput : IDisposable

Constructors

LVCOutput(string, LiveVideoCompositor, MediaBlock, LVCMediaType, bool)

Initializes a new instance of the LVCOutput class.

Declaration

public LVCOutput(string name, LiveVideoCompositor compositor, MediaBlock mainBlock, LVCMediaType mediaType, bool autostart)

Parameters

Type	Name	Description
string	name	The name.
LiveVideoCompositor	compositor	The compositor.
MediaBlock	mainBlock	The main block.
LVCMediaType	mediaType	Type of the media.
bool	autostart	if set to true autostart wtih a main pipeline.

Fields

_bridgeSourceBlock

The bridge source block.

Declaration

protected MediaBlock _bridgeSourceBlock

Field Value

Type	Description
MediaBlock

_compositor

The compositor.

Declaration

protected LiveVideoCompositor _compositor

Field Value

Type	Description
LiveVideoCompositor

_context

The context.

Declaration

protected ContextX _context

Field Value

Type	Description
ContextX

_mainBlock

The main block.

Declaration

protected MediaBlock _mainBlock

Field Value

Type	Description
MediaBlock

_mediaType

The media type.

Declaration

protected LVCMediaType _mediaType

Field Value

Type	Description
LVCMediaType

disposedValue

The disposed value.

Declaration

protected bool disposedValue

Field Value

Type	Description
bool

Properties

AutoStart

Gets or sets a value indicating whether an output automatically started with a main pipeline.

Declaration

public bool AutoStart { get; set; }

Property Value

Type	Description
bool	true if automatically started; otherwise, false.

Channel

Gets or sets the channel.

Declaration

public int Channel { get; set; }

Property Value

Type	Description
int	The channel.

Name

Gets the name.

Declaration

public string Name { get; }

Property Value

Type	Description
string	The name.

Pipeline

Gets the pipeline.

Declaration

public MediaBlocksPipeline Pipeline { get; }

Property Value

Type	Description
MediaBlocksPipeline	The pipeline.

Methods

Build(string, string)

Builds.

Declaration

public virtual void Build(string uniqueName, string uniqueName2 = null)

Parameters

Type	Name	Description
string	uniqueName	The unique name 1.
string	uniqueName2	The unique name 2.

Exceptions

Type	Condition
ArgumentOutOfRangeException	_mediaType - null

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.

~LVCOutput()

Finalizes an instance of the LVCOutput class.

Declaration

protected ~LVCOutput()

GetFilenameOrURL()

Gets the filename or URL.

Declaration

public string GetFilenameOrURL()

Returns

Type	Description
string	System.String.

SetAndConnectMainBlock(MediaBlock)

Sets the and connect the main block.

Declaration

protected bool SetAndConnectMainBlock(MediaBlock mainBlock)

Parameters

Type	Name	Description
MediaBlock	mainBlock	The main block.

Returns

Type	Description
bool	true if successful, false otherwise.

SetFilenameOrURL(string)

Sets the filename or URL.

Declaration

public void SetFilenameOrURL(string value)

Parameters

Type	Name	Description
string	value	The value.

StartAsync()

Starts.

Declaration

public Task<bool> StartAsync()

Returns

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

StopAsync(bool)

Stops.

Declaration

public Task<bool> StopAsync(bool force = false)

Parameters

Type	Name	Description
bool	force	If set to true force, pipiline will be stopped as fast as possible, instead of accurate stop using the end-of-stream message. If you have output files it may cause problems with unfinished frames.

Returns

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

Implements

IDisposable

See Also

IDisposable