Class LVCInput
Live Video Compositor input. Implements the IDisposable.
Implements
Inherited Members
Namespace: VisioForge.Core.LiveVideoCompositor
Assembly: VisioForge.Core.dll
Syntax
public class LVCInput : IDisposable
Constructors
LVCInput(string, LiveVideoCompositor, MediaBlock, LVCMediaType, bool, MediaBlock, bool)
Initializes a new instance of the LVCInput class.
Declaration
protected LVCInput(string name, LiveVideoCompositor compositor, MediaBlock mainBlock, LVCMediaType mediaType, bool autostart, MediaBlock processingBlock = null, bool live = true)
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 |
MediaBlock | processingBlock | The processing block. |
bool | live | if set to |
Fields
_bridgeSinkBlock
The bridge sink block.
Declaration
protected MediaBlock _bridgeSinkBlock
Field Value
Type | Description |
---|---|
MediaBlock |
_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 |
_processingBlock
The processing block (optional).
Declaration
protected MediaBlock _processingBlock
Field Value
Type | Description |
---|---|
MediaBlock |
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 |
|
ID
Gets the identifier.
Declaration
public int ID { get; }
Property Value
Type | Description |
---|---|
int | The identifier. |
MediaType
Gets the type of the media.
Declaration
public LVCMediaType MediaType { get; }
Property Value
Type | Description |
---|---|
LVCMediaType | The type of the media. |
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. |
UniqueName
Gets the unique name.
Declaration
public string UniqueName { get; set; }
Property Value
Type | Description |
---|---|
string | The unique name. |
UniqueName2
Gets the unique name (2).
Declaration
public string UniqueName2 { get; set; }
Property Value
Type | Description |
---|---|
string | The unique name (2). |
Methods
Build(int, string, int, string)
Builds.
Declaration
public virtual void Build(int id, string uniqueName, int id2 = -1, string uniqueName2 = null)
Parameters
Type | Name | Description |
---|---|---|
int | id | The identifier. |
string | uniqueName | Unique name. |
int | id2 | The identifier 2. |
string | uniqueName2 | 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 |
|
~LVCInput()
Finalizes an instance of the LVCInput class.
Declaration
protected ~LVCInput()
PauseAsync()
Pauses.
Declaration
public Task PauseAsync()
Returns
Type | Description |
---|---|
Task | Task. |
ResumeAsync()
Resumes.
Declaration
public Task ResumeAsync()
Returns
Type | Description |
---|---|
Task | A Task<System.Boolean> representing the asynchronous operation. |
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<bool> StopAsync()
Returns
Type | Description |
---|---|
Task<bool> | A Task<System.Boolean> representing the asynchronous operation. |