Interface IMediaInput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat>
A media input.
Inherited Members
Namespace: FM.LiveSwitch
Assembly: FM.LiveSwitch.dll
Syntax
public interface IMediaInput<TIOutput, TIInput, TFrame, TBuffer, TBufferCollection, TFormat> : IInput<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
InputDeactivated
Gets whether input is deactivated.
Declaration
bool InputDeactivated { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
InputMuted
Gets whether input is muted.
Declaration
bool InputMuted { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
InputRtpStreamId
Gets or sets the input RTP stream identifier.
Declaration
string InputRtpStreamId { get; set; }
Property Value
Type | Description |
---|---|
System.String |
InputSynchronizationSource
Gets or sets the input synchronization source.
Declaration
long InputSynchronizationSource { get; set; }
Property Value
Type | Description |
---|---|
System.Int64 |
MaxInputBitrate
Gets the maximum allowed input bitrate, in kbps. A value of -1 indicates unset (no maximum).
Declaration
int MaxInputBitrate { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
MaxInputEncoding
Gets the maximum allowed input encoding.
Declaration
EncodingInfo MaxInputEncoding { get; }
Property Value
Type | Description |
---|---|
EncodingInfo |
MinInputBitrate
Gets the minimum allowed input bitrate, in kbps. A value of -1 indicates unset (no minimum).
Declaration
int MinInputBitrate { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
MinInputEncoding
Gets the minimum allowed input encoding.
Declaration
EncodingInfo MinInputEncoding { get; }
Property Value
Type | Description |
---|---|
EncodingInfo |
ProcessFramePolicy
Gets or sets the ProcessFramePolicy for this media input.
Declaration
ProcessFramePolicy ProcessFramePolicy { get; set; }
Property Value
Type | Description |
---|---|
ProcessFramePolicy |
SystemDelay
Gets the system delay in ticks.
Declaration
long SystemDelay { get; }
Property Value
Type | Description |
---|---|
System.Int64 |
Methods
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. |
ProcessControlFrameResponses(MediaControlFrame[])
Processes control frame responses.
Declaration
void ProcessControlFrameResponses(MediaControlFrame[] controlFrameResponses)
Parameters
Type | Name | Description |
---|---|---|
MediaControlFrame[] | controlFrameResponses | The control frame responses. |
ProcessFrame(TFrame)
Processes a frame.
Declaration
bool ProcessFrame(TFrame frame)
Parameters
Type | Name | Description |
---|---|---|
TFrame | frame | The frame. |
Returns
Type | Description |
---|---|
System.Boolean |
ProcessSdpMediaDescriptionFromInput(MediaDescription, Boolean, Boolean)
Processes a local SDP media description from an input.
Declaration
Error ProcessSdpMediaDescriptionFromInput(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 |
ProcessSinkStatsFromInput(MediaSinkStats)
Processes sink stats from an input.
Declaration
void ProcessSinkStatsFromInput(MediaSinkStats sinkStats)
Parameters
Type | Name | Description |
---|---|---|
MediaSinkStats | sinkStats | The stats. |
ProcessTrackStatsFromInput(MediaTrackStats)
Processes track stats from an input.
Declaration
void ProcessTrackStatsFromInput(MediaTrackStats trackStats)
Parameters
Type | Name | Description |
---|---|---|
MediaTrackStats | trackStats | The stats. |
Events
OnDisabledChange
Raised when the Disabled property changes state.
Declaration
event Action0 OnDisabledChange
Event Type
Type | Description |
---|---|
Action0 |
OnPausedChange
Raised when the Paused property changes state.
Declaration
event Action0 OnPausedChange
Event Type
Type | Description |
---|---|
Action0 |
OnProcessControlFrameResponses
Raised when control frame responses are processed.
Declaration
event Action1<MediaControlFrame[]> OnProcessControlFrameResponses
Event Type
Type | Description |
---|---|
Action1<MediaControlFrame[]> |
OnProcessFrame
Raised when a frame is processed.
Declaration
event Action1<TFrame> OnProcessFrame
Event Type
Type | Description |
---|---|
Action1<TFrame> |
OnRaiseControlFrames
Raised when control frames are raised.
Declaration
event Action1<MediaControlFrame[]> OnRaiseControlFrames
Event Type
Type | Description |
---|---|
Action1<MediaControlFrame[]> |