Class MediaBlockPad

MediaBlock pad.

Inheritance

object

MediaBlockPad

Implements

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: VisioForge.Core.MediaBlocks

Assembly: VisioForge.Core.dll

Syntax

public class MediaBlockPad : IDisposable

Constructors

MediaBlockPad(MediaBlock, MediaBlockPadDirection, MediaBlockPadMediaType, bool)

Initializes a new instance of the MediaBlockPad class.

Declaration

public MediaBlockPad(MediaBlock block, MediaBlockPadDirection direction, MediaBlockPadMediaType mediaType, bool onDemandConnect = false)

Parameters

Type	Name	Description
MediaBlock	block	The block.
MediaBlockPadDirection	direction	The direction.
MediaBlockPadMediaType	mediaType	Type of the media.
bool	onDemandConnect	if set to true use on demand connect.

Properties

Block

Gets the block.

Declaration

public MediaBlock Block { get; }

Property Value

Type	Description
MediaBlock	The block.

Direction

Gets the direction.

Declaration

public MediaBlockPadDirection Direction { get; }

Property Value

Type	Description
MediaBlockPadDirection	The direction.

MediaType

Gets the media type.

Declaration

public MediaBlockPadMediaType MediaType { get; }

Property Value

Type	Description
MediaBlockPadMediaType	The type of the media.

OnDemandConnect

Gets a value indicating whether pad will connect on demand after start.

Declaration

public bool OnDemandConnect { get; set; }

Property Value

Type	Description
bool

Tag

Gets or sets the custom tag object for internal usage.

Declaration

public object Tag { get; set; }

Property Value

Type	Description
object

Methods

BlockPadLive()

Blocks the pad in started pipeline.

Declaration

public bool BlockPadLive()

Returns

Type	Description
bool	true if successful, false otherwise.

Connect(MediaBlockPad)

Connects the specified pad.

Declaration

public void Connect(MediaBlockPad pad)

Parameters

Type	Name	Description
MediaBlockPad	pad	The pad.

ConnectLive(MediaBlockPad)

Links the pads in the started/paused pipeline.

Declaration

public bool ConnectLive(MediaBlockPad sinkPad)

Parameters

Type	Name	Description
MediaBlockPad	sinkPad	The sink pad.

Returns

Type	Description
bool	true if successful, false otherwise.

DisconnectLive(MediaBlockPad)

Unlinks the pads in the started/paused pipeline.

Declaration

public bool DisconnectLive(MediaBlockPad sinkPad)

Parameters

Type	Name	Description
MediaBlockPad	sinkPad	The sink pad.

Returns

Type	Description
bool	true if successful, false otherwise.

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.

~MediaBlockPad()

Finalizes an instance of the MediaBlockPad class.

Declaration

protected ~MediaBlockPad()

GetConnectedToPad()

Gets the connected pad.

Declaration

public MediaBlockPad GetConnectedToPad()

Returns

Type	Description
MediaBlockPad	MediaBlockPad.

GetInternalPad()

Gets the internal pad.

Declaration

public Pad GetInternalPad()

Returns

Type	Description
Pad	Gst.Pad.

IsActive()

Determines whether this instance is active.

Declaration

public bool IsActive()

Returns

Type	Description
bool	true if this instance is active; otherwise, false.

IsConnected()

Determines whether this pad is connected.

Declaration

public bool IsConnected()

Returns

Type	Description
bool	true if this instance is connected; otherwise, false.

IsConnectedLive()

Determines whether this pad is connected (live mode).

Declaration

public bool IsConnectedLive()

Returns

Type	Description
bool	true if is connected; otherwise, false.

IsInternalPadNull()

Determines whether internal pad is null.

Declaration

public bool IsInternalPadNull()

Returns

Type	Description
bool	true if internal pad is null; otherwise, false.

SetInternalPad(Pad)

Sets the internal pad.

Declaration

public void SetInternalPad(Pad pad)

Parameters

Type	Name	Description
Pad	pad	The pad.

ToString()

Returns a string that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents this instance.

Overrides

object.ToString()

UnblockPadLive()

Unblocks the pad in started pipeline.

Declaration

public bool UnblockPadLive()

Returns

Type	Description
bool	true if successful, false otherwise.

Events

OnEOS

Occurs when EOS happens on pad. This event should be assigned before starting the pipeline.

Declaration

public event EventHandler<EventArgs> OnEOS

Event Type

Type	Description
EventHandler<EventArgs>

Implements

IDisposable