Class MediaBlock
Base Media Block. Implements the IMediaBlock.
Inheritance
Inherited Members
Namespace: VisioForge.Core.MediaBlocks
Assembly: VisioForge.Core.dll
Syntax
public class MediaBlock : IMediaBlock, IDisposable
Fields
Context
The context.
Declaration
public ContextX Context
Field Value
Type | Description |
---|---|
ContextX |
_isBuilt
Is build flag.
Declaration
protected bool _isBuilt
Field Value
Type | Description |
---|---|
bool |
_pipeline
The pipeline.
Declaration
protected MediaBlocksPipeline _pipeline
Field Value
Type | Description |
---|---|
MediaBlocksPipeline |
_pipelineCtx
The pipeline context.
Declaration
protected BlockPipelineContext _pipelineCtx
Field Value
Type | Description |
---|---|
BlockPipelineContext |
disposedValue
The disposed value.
Declaration
protected bool disposedValue
Field Value
Type | Description |
---|---|
bool |
Properties
Input
Gets the input.
Declaration
public virtual MediaBlockPad Input { get; }
Property Value
Type | Description |
---|---|
MediaBlockPad | The input. |
Exceptions
Type | Condition |
---|---|
NotImplementedException |
Inputs
Gets the inputs.
Declaration
public virtual MediaBlockPad[] Inputs { get; }
Property Value
Type | Description |
---|---|
MediaBlockPad[] | The inputs. |
Exceptions
Type | Condition |
---|---|
NotImplementedException |
IsBuilt
Gets a value indicating whether this block is built.
Declaration
public bool IsBuilt { get; }
Property Value
Type | Description |
---|---|
bool |
|
Name
Gets or sets the name.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string | The name. |
Output
Gets the output.
Declaration
public virtual MediaBlockPad Output { get; }
Property Value
Type | Description |
---|---|
MediaBlockPad | The output. |
Exceptions
Type | Condition |
---|---|
NotImplementedException |
Outputs
Gets the outputs.
Declaration
public virtual MediaBlockPad[] Outputs { get; }
Property Value
Type | Description |
---|---|
MediaBlockPad[] | The outputs. |
Exceptions
Type | Condition |
---|---|
NotImplementedException |
Type
Gets or sets the type.
Declaration
public virtual MediaBlockType Type { get; set; }
Property Value
Type | Description |
---|---|
MediaBlockType | The type. |
Exceptions
Type | Condition |
---|---|
NotImplementedException | |
NotImplementedException |
Methods
Build()
Builds this instance.
Declaration
public virtual bool Build()
Returns
Type | Description |
---|---|
bool |
|
Exceptions
Type | Condition |
---|---|
NotImplementedException |
ClearPads()
Clears the pads.
Declaration
protected virtual void ClearPads()
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 |
|
~MediaBlock()
Finalizes an instance of the MediaBlock class.
Declaration
protected ~MediaBlock()
GetFreeOutputPadByType(MediaBlockPadMediaType)
Gets the free output pad by type.
Declaration
public MediaBlockPad GetFreeOutputPadByType(MediaBlockPadMediaType mediaType)
Parameters
Type | Name | Description |
---|---|---|
MediaBlockPadMediaType | mediaType | Media type. |
Returns
Type | Description |
---|---|
MediaBlockPad | MediaBlockPad. |
GetInputPadByType(MediaBlockPadMediaType)
Gets the input pad by type.
Declaration
public MediaBlockPad GetInputPadByType(MediaBlockPadMediaType mediaType)
Parameters
Type | Name | Description |
---|---|---|
MediaBlockPadMediaType | mediaType | Media type. |
Returns
Type | Description |
---|---|
MediaBlockPad | MediaBlockPad. |
GetOutputPadByType(MediaBlockPadMediaType)
Gets the output pad by type.
Declaration
public MediaBlockPad GetOutputPadByType(MediaBlockPadMediaType mediaType)
Parameters
Type | Name | Description |
---|---|---|
MediaBlockPadMediaType | mediaType | Media type. |
Returns
Type | Description |
---|---|
MediaBlockPad | MediaBlockPad. |
GetPipelineContext()
Gets the pipeline context.
Declaration
public BlockPipelineContext GetPipelineContext()
Returns
Type | Description |
---|---|
BlockPipelineContext | BlockPipelineContext. |
SetPipeline(MediaBlocksPipeline)
Sets the pipeline.
Declaration
public void SetPipeline(MediaBlocksPipeline pipeline)
Parameters
Type | Name | Description |
---|---|---|
MediaBlocksPipeline | pipeline | The pipeline. |
ToYAMLBlock()
Converts to YAML.
Declaration
public YAMLBlock ToYAMLBlock()
Returns
Type | Description |
---|---|
YAMLBlock | YAMLBlock. |