Interface IMediaOutput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat>
A media output.
Inherited Members
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public interface IMediaOutput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat> : IOutput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat>, IMediaElement, IElement where TIOutput : IMediaOutput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat> where TIInput : IMediaInput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat> 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. |
TIInput | The type of the input interface. |
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. |
Properties
Content
Gets the content descriptor.
Declaration
string Content { get; }
Property Value
Type | Description |
---|---|
System.String |
MaxOutputBitrate
Gets the maximum allowed output bitrate, in kbps. A value of -1 indicates unset (no maximum).
Declaration
int MaxOutputBitrate { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
MaxOutputEncoding
Gets the maximum allowed output encoding.
Declaration
EncodingInfo MaxOutputEncoding { get; }
Property Value
Type | Description |
---|---|
EncodingInfo |
MinOutputBitrate
Gets the minimum allowed output bitrate, in kbps. A value of -1 indicates unset (no minimum).
Declaration
int MinOutputBitrate { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
MinOutputEncoding
Gets the minimum allowed output encoding.
Declaration
EncodingInfo MinOutputEncoding { get; }
Property Value
Type | Description |
---|---|
EncodingInfo |
OutputDeactivated
Gets whether output is deactivated.
Declaration
bool OutputDeactivated { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
OutputMuted
Gets whether output is muted.
Declaration
bool OutputMuted { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
OutputRtpStreamId
Gets the output RTP stream identifier.
Declaration
string OutputRtpStreamId { get; }
Property Value
Type | Description |
---|---|
System.String |
OutputSynchronizable
Gets whether output is synchronizable.
Declaration
bool OutputSynchronizable { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
OutputSynchronizationSource
Gets the output synchronization source.
Declaration
long OutputSynchronizationSource { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
SystemDelay
Gets the system delay in ticks.
Declaration
long SystemDelay { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
TargetOutputBitrate
Gets the target output bitrate, in kbps. A value of -1 indicates unset (no target).
Declaration
int TargetOutputBitrate { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
TargetOutputEncoding
Gets the target output encoding.
Declaration
EncodingInfo TargetOutputEncoding { get; }
Property Value
Type | Description |
---|---|
EncodingInfo |
Methods
GetCcmSequenceNumber()
Gets the CCM sequence number.
Declaration
int GetCcmSequenceNumber()
Returns
Type | Description |
---|---|
System.Int32 |
GetPipelineSystemDelay(TFormat)
Gets the total pipeline system delay in ticks for a given media format.
Declaration
long GetPipelineSystemDelay(TFormat outputFormat)
Parameters
Type | Name | Description |
---|---|---|
TFormat | outputFormat | The output format. |
Returns
Type | Description |
---|---|
System.Int64 | The total pipeline system delay in ticks. |
IncrementCcmSequenceNumber()
Increments the CCM sequence number.
Declaration
void IncrementCcmSequenceNumber()
ProcessControlFrames(MediaControlFrame[])
Processes control frames.
Declaration
void ProcessControlFrames(MediaControlFrame[] controlFrames)
Parameters
Type | Name | Description |
---|---|---|
MediaControlFrame[] | controlFrames | The control frames. |
ProcessSdpMediaDescriptionFromOutput(MediaDescription, Boolean, Boolean)
Processes a local SDP media description from an output.
Declaration
Error ProcessSdpMediaDescriptionFromOutput(MediaDescription mediaDescription, bool isOffer, bool isLocalDescription)
Parameters
Type | Name | Description |
---|---|---|
MediaDescription | mediaDescription | The media description. |
System.Boolean | isOffer | if set to |
System.Boolean | isLocalDescription | if set to |
Returns
Type | Description |
---|---|
Error |
ProcessSourceStatsFromOutput(MediaSourceStats)
Processes source stats from an output.
Declaration
void ProcessSourceStatsFromOutput(MediaSourceStats sourceStats)
Parameters
Type | Name | Description |
---|---|---|
MediaSourceStats | sourceStats | The source stats. |
ProcessTrackStatsFromOutput(MediaTrackStats)
Processes track stats from an output.
Declaration
void ProcessTrackStatsFromOutput(MediaTrackStats trackStats)
Parameters
Type | Name | Description |
---|---|---|
MediaTrackStats | trackStats | The track stats. |
Events
OnDisabledChange
Raised when the Disabled property changes state.
Declaration
event Action0 OnDisabledChange
Event Type
Type | Description |
---|---|
Action0 |
OnDisabledChangeWithCaller
Raised when the Disabled property changes state.
Declaration
event Action1<object> OnDisabledChangeWithCaller
Event Type
Type | Description |
---|---|
Action1<System.Object> |
OnPausedChange
Raised when the Paused property changes state.
Declaration
event Action0 OnPausedChange
Event Type
Type | Description |
---|---|
Action0 |
OnProcessControlFrames
Raised when control frames are processed.
Declaration
event Action1<MediaControlFrame[]> OnProcessControlFrames
Event Type
Type | Description |
---|---|
Action1<MediaControlFrame[]> |
OnRaiseControlFrameResponses
Raised when a control frame response is raised.
Declaration
event Action1<MediaControlFrame[]> OnRaiseControlFrameResponses
Event Type
Type | Description |
---|---|
Action1<MediaControlFrame[]> |
OnRaiseFrame
Raised when a frame is raised.
Declaration
event Action1<TFrame> OnRaiseFrame
Event Type
Type | Description |
---|---|
Action1<TFrame> |