Class MediaBranch<TIOutput, TIOutputCollection, TIInput, TIInputCollection, TIElement, TSource, TSink, TPipe, TTrack, TBranch, TFrame, TBuffer, TBufferCollection, TFormat>
A media branch.
Inheritance
Inherited Members
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public abstract class MediaBranch<TIOutput, TIOutputCollection, TIInput, TIInputCollection, TIElement, TSource, TSink, TPipe, TTrack, TBranch, TFrame, TBuffer, TBufferCollection, TFormat> : Dynamic, IMediaElement, IElement where TIOutput : class, IMediaOutput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat>, TIElement where TIOutputCollection : IMediaOutputCollection<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat, TIOutputCollection> where TIInput : class, IMediaInput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat>, TIElement where TIInputCollection : IMediaInputCollection<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat, TIInputCollection> where TIElement : IMediaElement where TSource : MediaSource<TIOutput, TIInput, TIInputCollection, TSource, TFrame, TBuffer, TBufferCollection, TFormat>, TIOutput where TSink : MediaSink<TIOutput, TIOutputCollection, TIInput, TSink, TFrame, TBuffer, TBufferCollection, TFormat>, TIInput where TPipe : MediaPipe<TIOutput, TIOutputCollection, TIInput, TIInputCollection, TPipe, TFrame, TBuffer, TBufferCollection, TFormat>, TIOutput, TIInput where TTrack : MediaTrack<TIOutput, TIOutputCollection, TIInput, TIInputCollection, TIElement, TSource, TSink, TPipe, TTrack, TBranch, TFrame, TBuffer, TBufferCollection, TFormat> where TBranch : MediaBranch<TIOutput, TIOutputCollection, TIInput, TIInputCollection, TIElement, TSource, TSink, TPipe, TTrack, TBranch, TFrame, TBuffer, TBufferCollection, TFormat>, TIElement where TFrame : MediaFrame<TBuffer, TBufferCollection, TFormat, TFrame> where TBuffer : MediaBuffer<TFormat, TBuffer> where TBufferCollection : MediaBufferCollection<TBuffer, TBufferCollection, TFormat> where TFormat : MediaFormat<TFormat>
Type Parameters
Name | Description |
---|---|
TIOutput | The type of the output interface. |
TIOutputCollection | The type of the output interface collection. |
TIInput | The type of the input interface. |
TIInputCollection | The type of the input interface collection. |
TIElement | The type of the element interface |
TSource | The type of the source. |
TSink | The type of the sink. |
TPipe | The type of the pipe. |
TTrack | The type of the track. |
TBranch | The type of the branch. |
TFrame | The type of the frame. |
TBuffer | The type of the buffer. |
TBufferCollection | The type of the buffer collection. |
TFormat | The type of the format. |
Constructors
MediaBranch(TTrack[])
Initializes a new instance of the MediaBranch<TIOutput, TIOutputCollection, TIInput, TIInputCollection, TIElement, TSource, TSink, TPipe, TTrack, TBranch, TFrame, TBuffer, TBufferCollection, TFormat> class.
Declaration
public MediaBranch(TTrack[] tracks)
Parameters
Type | Name | Description |
---|---|---|
TTrack[] | tracks |
Properties
ActiveTrack
Gets the first active track.
Declaration
public TTrack ActiveTrack { get; }
Property Value
Type | Description |
---|---|
TTrack |
ActiveTracks
Gets the active tracks.
Declaration
public TTrack[] ActiveTracks { get; }
Property Value
Type | Description |
---|---|
TTrack[] |
Deactivated
Gets or sets a value indicating whether this branch is deactivated. A branch is deactivated if its active tracks are deactivated.
Declaration
public bool Deactivated { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Disabled
Gets a value indicating whether this branch is disabled. A branch is disabled if its active tracks are disabled.
Declaration
public bool Disabled { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
ExternalId
Gets or sets the external identifier.
Declaration
public string ExternalId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Id
Gets the identifier.
Declaration
public string Id { get; }
Property Value
Type | Description |
---|---|
System.String |
Label
Gets a label that identifies this class.
Declaration
public abstract string Label { get; }
Property Value
Type | Description |
---|---|
System.String |
Muted
Gets or sets a value indicating whether any of the tracks in this branch are muted. Setting a value will apply to all elements.
Declaration
public bool Muted { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Paused
Gets a value indicating whether this branch is paused. A branch is paused if its active tracks are paused.
Declaration
public bool Paused { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Persistent
Gets or sets a value indicating whether this instance is persistent.
If true
, this instance will not be destroyed unless
Destroy() is called explicitly on this instance.
It will survive destruction of any parent elements that are
being destroyed.
Declaration
public bool Persistent { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
PipelineJson
Gets the pipeline JSON with this as the central point.
Declaration
public string PipelineJson { get; }
Property Value
Type | Description |
---|---|
System.String |
Track
Gets the first track.
Declaration
public TTrack Track { get; }
Property Value
Type | Description |
---|---|
TTrack |
Tracks
Gets the tracks.
Declaration
public TTrack[] Tracks { get; }
Property Value
Type | Description |
---|---|
TTrack[] |
Methods
ArrayFromTracks(List<TTrack>)
Creates an array of tracks from a list of tracks.
Declaration
protected abstract TTrack[] ArrayFromTracks(List<TTrack> tracks)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<TTrack> | tracks | The list of tracks. |
Returns
Type | Description |
---|---|
TTrack[] |
Destroy()
Destroys this instance.
Declaration
public virtual bool Destroy()
Returns
Type | Description |
---|---|
System.Boolean |
ToString()
Returns a string that represents this instance.
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
System.String |