Table of Contents

Class BridgeConfiguration

Namespace
VisioForge.Core.MediaBlocks.Bridge
Assembly
VisioForge.Core.dll

Configuration for creating bridge instances.

public class BridgeConfiguration

Inheritance

Inherited Members

Properties

AudioInfo

Gets or sets audio format information for audio bridges. Optional for audio bridge configuration.

public AudioInfoX AudioInfo { get; set; }

Property Value

AudioInfoX

BridgeType

Gets or sets the type of bridge to create.

public BridgeType BridgeType { get; set; }

Property Value

BridgeType

ChannelName

Gets or sets the channel name for the bridge connection. If not specified, the Identifier will be used as the channel name.

public string ChannelName { get; set; }

Property Value

string

CustomSettings

Gets or sets additional settings specific to certain bridge types.

public object CustomSettings { get; set; }

Property Value

object

CustomSyncFlag

Gets or sets custom synchronization flag for Bridge type.

public bool CustomSyncFlag { get; set; }

Property Value

bool

Identifier

Gets or sets the identifier for the bridge connection.

public Guid Identifier { get; set; }

Property Value

Guid

IsSink

Gets or sets a value indicating whether to create a sink (true) or source (false).

public bool IsSink { get; set; }

Property Value

bool

MediaType

Gets or sets the media type for the bridge.

public MediaBlockPadMediaType MediaType { get; set; }

Property Value

MediaBlockPadMediaType

VideoInfo

Gets or sets video format information for video bridges. Required for some bridge types when MediaType is Video.

public VideoFrameInfoX VideoInfo { get; set; }

Property Value

VideoFrameInfoX

Methods

Create(BridgeType, MediaBlockPadMediaType, bool, Guid)

Creates a configuration for a specific bridge scenario.

public static BridgeConfiguration Create(BridgeType bridgeType, MediaBlockPadMediaType mediaType, bool isSink, Guid identifier)

Parameters

bridgeType BridgeType

The type of bridge.

mediaType MediaBlockPadMediaType

The media type.

isSink bool

Whether this is a sink or source.

identifier Guid

The connection identifier.

Returns

BridgeConfiguration

A new BridgeConfiguration instance.

CreateAudio(BridgeType, bool, AudioInfoX)

Creates a configuration for an audio bridge.

public static BridgeConfiguration CreateAudio(BridgeType bridgeType, bool isSink, AudioInfoX audioInfo = null)

Parameters

bridgeType BridgeType

The type of bridge.

isSink bool

Whether to create a sink or source.

audioInfo AudioInfoX

Optional audio format information.

Returns

BridgeConfiguration

A configured BridgeConfiguration instance.

CreateDefault()

Creates a default configuration for a video bridge sink with a new GUID.

public static BridgeConfiguration CreateDefault()

Returns

BridgeConfiguration

A new BridgeConfiguration instance.

CreateVideo(BridgeType, bool, VideoFrameInfoX)

Creates a configuration for a video bridge.

public static BridgeConfiguration CreateVideo(BridgeType bridgeType, bool isSink, VideoFrameInfoX videoInfo = null)

Parameters

bridgeType BridgeType

The type of bridge.

isSink bool

Whether to create a sink or source.

videoInfo VideoFrameInfoX

Optional video format information.

Returns

BridgeConfiguration

A configured BridgeConfiguration instance.

CreateWithNewId(BridgeType, MediaBlockPadMediaType, bool)

Creates a configuration for a specific bridge scenario with a new GUID.

public static BridgeConfiguration CreateWithNewId(BridgeType bridgeType, MediaBlockPadMediaType mediaType, bool isSink)

Parameters

bridgeType BridgeType

The type of bridge.

mediaType MediaBlockPadMediaType

The media type.

isSink bool

Whether this is a sink or source.

Returns

BridgeConfiguration

A new BridgeConfiguration instance.

GetEffectiveChannelName()

Gets the effective channel name for the bridge. Returns ChannelName if set, otherwise returns Identifier as string.

public string GetEffectiveChannelName()

Returns

string

The channel name to use for the bridge.