Class VoIPMediaSession

This class serves as a bridge, or mapping, between the media end points, typically provided by a separate package, and a media session. Its goal is to wire up the sources and sinks from the media end point to the transport functions provided by an RTP session.

For audio end points it will also attempt to encode and decode formats that the inbuilt C# encoder class understands. The encoder can be turned off if an application wishes to do its own audio encoding.

For video end points there are no C# encoders available so the application must always co-ordinate the encoding and decoding of samples sent to and received from the RTP transport.

Inheritance
System.Object
RTPSession
VoIPMediaSession
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: SIPSorcery.Media
Assembly: SIPSorcery.dll
Syntax
public class VoIPMediaSession : RTPSession, IMediaSession, IDisposable

Constructors

| Improve this Doc View Source

VoIPMediaSession(VoIPMediaSessionConfig)

Declaration
public VoIPMediaSession(VoIPMediaSessionConfig config)
Parameters
Type Name Description
VoIPMediaSessionConfig config
| Improve this Doc View Source

VoIPMediaSession(MediaEndPoints, VideoTestPatternSource)

Declaration
public VoIPMediaSession(MediaEndPoints mediaEndPoint, VideoTestPatternSource testPatternSource)
Parameters
Type Name Description
SIPSorceryMedia.Abstractions.MediaEndPoints mediaEndPoint
VideoTestPatternSource testPatternSource
| Improve this Doc View Source

VoIPMediaSession(MediaEndPoints, IPAddress, Int32, VideoTestPatternSource)

Declaration
public VoIPMediaSession(MediaEndPoints mediaEndPoint, IPAddress bindAddress = null, int bindPort = 0, VideoTestPatternSource testPatternSource = null)
Parameters
Type Name Description
SIPSorceryMedia.Abstractions.MediaEndPoints mediaEndPoint
System.Net.IPAddress bindAddress
System.Int32 bindPort
VideoTestPatternSource testPatternSource
| Improve this Doc View Source

VoIPMediaSession(Func<AudioFormat, Boolean>)

Default constructor which creates the simplest possible send only audio session. It does not wire up any devices or video processing.

Declaration
public VoIPMediaSession(Func<AudioFormat, bool> restrictFormats = null)
Parameters
Type Name Description
System.Func<SIPSorceryMedia.Abstractions.AudioFormat, System.Boolean> restrictFormats

Properties

| Improve this Doc View Source

AudioExtrasSource

Declaration
public AudioExtrasSource AudioExtrasSource { get; }
Property Value
Type Description
AudioExtrasSource
| Improve this Doc View Source

Media

Declaration
public MediaEndPoints Media { get; }
Property Value
Type Description
SIPSorceryMedia.Abstractions.MediaEndPoints
| Improve this Doc View Source

TestPatternSource

Declaration
public VideoTestPatternSource TestPatternSource { get; }
Property Value
Type Description
VideoTestPatternSource

Methods

| Improve this Doc View Source

Close(String)

Declaration
public override async void Close(string reason)
Parameters
Type Name Description
System.String reason
Overrides
| Improve this Doc View Source

PutOnHold()

Declaration
public async Task PutOnHold()
Returns
Type Description
System.Threading.Tasks.Task
| Improve this Doc View Source

RtpMediaPacketReceived(IPEndPoint, SDPMediaTypesEnum, RTPPacket)

Declaration
protected void RtpMediaPacketReceived(IPEndPoint remoteEndPoint, SDPMediaTypesEnum mediaType, RTPPacket rtpPacket)
Parameters
Type Name Description
System.Net.IPEndPoint remoteEndPoint
SDPMediaTypesEnum mediaType
RTPPacket rtpPacket
| Improve this Doc View Source

Start()

Declaration
public override async Task Start()
Returns
Type Description
System.Threading.Tasks.Task
Overrides
| Improve this Doc View Source

TakeOffHold()

Declaration
public async void TakeOffHold()

Events

| Improve this Doc View Source

OnVideoSinkSample

Declaration
public event VideoSinkSampleDecodedDelegate OnVideoSinkSample
Event Type
Type Description
SIPSorceryMedia.Abstractions.VideoSinkSampleDecodedDelegate

Implements

System.IDisposable

Extension Methods