Class FileSinkBlock

File sink block. Implements the MediaBlock. Implements the IMediaBlockInternals. Implements the IDisposable.

Inheritance
object
MediaBlock
FileSinkBlock
Implements
Inherited Members
Namespace: VisioForge.Core.MediaBlocks.Sinks
Assembly: VisioForge.Core.dll
Syntax
public class FileSinkBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals, IMediaBlockDynamicInputs

Constructors

FileSinkBlock(string, bool)

Initializes a new instance of the FileSinkBlock class.

Declaration
public FileSinkBlock(string filename, bool addQueue = true)
Parameters
Type Name Description
string filename

The filename.
bool addQueue

True to add queue.

Properties

Filename

Gets or sets the filename.

Declaration
public string Filename { get; set; }
Property Value
Type Description
string

The filename.

Input

Gets the input.

Declaration
public override MediaBlockPad Input { get; }
Property Value
Type Description
MediaBlockPad

The input.
Overrides
MediaBlock.Input

Inputs

Gets the inputs.

Declaration
public override MediaBlockPad[] Inputs { get; }
Property Value
Type Description
MediaBlockPad[]

The inputs.
Overrides
MediaBlock.Inputs

Output

Gets the output.

Declaration
public override MediaBlockPad Output { get; }
Property Value
Type Description
MediaBlockPad

The output.
Overrides
MediaBlock.Output

Outputs

Gets the outputs.

Declaration
public override MediaBlockPad[] Outputs { get; }
Property Value
Type Description
MediaBlockPad[]

The outputs.
Overrides
MediaBlock.Outputs

Type

Gets the type.

Declaration
public override MediaBlockType Type { get; }
Property Value
Type Description
MediaBlockType

The type.
Overrides
MediaBlock.Type

Methods

Build()

Builds this instance.

Declaration
public override bool Build()
Returns
Type Description
bool

true if successful, false otherwise.
Overrides
MediaBlock.Build()

CleanUp()

Cleans up.

Declaration
public void CleanUp()

CreateNewInput(MediaBlockPadMediaType)

Creates the new input. Returns the one available pad.

Declaration
public MediaBlockPad CreateNewInput(MediaBlockPadMediaType mediaType)
Parameters
Type Name Description
MediaBlockPadMediaType mediaType

Type of the media.
Returns
Type Description
MediaBlockPad

MediaBlockPad.

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides
MediaBlock.Dispose(bool)

GetCore()

Gets core.

Declaration
public BaseElement GetCore()
Returns
Type Description
BaseElement

VisioForge.Core.GStreamer.Base.BaseElement.

GetElement()

Gets the element.

Declaration
public Element GetElement()
Returns
Type Description
Element

Gst.Element.

GetFilenameOrURL()

Gets the filename or URL.

Declaration
public string GetFilenameOrURL()
Returns
Type Description
string

System.String.

GetInput(MediaBlockPadMediaType)

Gets the existing input.

Declaration
public MediaBlockPad GetInput(MediaBlockPadMediaType mediaType)
Parameters
Type Name Description
MediaBlockPadMediaType mediaType

Type of the media.
Returns
Type Description
MediaBlockPad

MediaBlockPad.

IsAvailable()

Determines whether this media block is available. Correct NuGet SDK redist should be included into your project.

Declaration
public static bool IsAvailable()
Returns
Type Description
bool

true if this media block is available; otherwise, false.

SetFilenameOrURL(string)

Sets the filename or URL.

Declaration
public void SetFilenameOrURL(string value)
Parameters
Type Name Description
string value

The value.

Implements

IMediaBlock
IDisposable
IMediaBlockInternals
IMediaBlockDynamicInputs

Extension Methods

MediaBlockHelper.SendEndOfStream(MediaBlock)
MediaBlockHelper.SendEvent(MediaBlock, Event)
MediaBlockHelper.SetState(MediaBlock, State)

See Also