Class MediaBlocksPipelineSnapshot

Namespace

VisioForge.Core.MediaBlocks.Serialization

Assembly

VisioForge.Core.dll

Captures a live VisioForge.Core.MediaBlocks.MediaBlocksPipeline back into a VisioForge.Core.MediaBlocks.Serialization.MediaBlocksPipelineDocument - the reverse of VisioForge.Core.MediaBlocks.Serialization.MediaBlocksPipelineMaterializer.

The graph is captured exactly; the settings are not always. A block's identity, type and pad connections are readable from any block, so the shape of the pipeline always round-trips. Its configuration is readable only from blocks that expose it - 153 of the 404 block types in this SDK do - and for the rest there is nothing to read. Those blocks are reported as MBS060 diagnostics rather than written out with no settings, because a document that looks complete and rebuilds a block on its defaults is worse than one that says what is missing. Check VisioForge.Core.MediaBlocks.Serialization.MediaBlocksPipelineSnapshotResult.Complete before treating a snapshot as a faithful copy.

public static class MediaBlocksPipelineSnapshot

Inheritance

object

MediaBlocksPipelineSnapshot

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Methods

Capture(MediaBlocksPipeline)

Captures the pipeline's current graph into a document.

public static MediaBlocksPipelineSnapshotResult Capture(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The pipeline to capture. It may be stopped or running.

Returns

MediaBlocksPipelineSnapshotResult

The document, with a diagnostic for everything that could not be captured.

Exceptions

ArgumentNullException

pipeline is null.