Class PvStreamRTP

Receive data from a RTP transmitter.

Inheritance

object

PvStream

PvStreamRTP

Implements

IDisposable

Inherited Members

PvStream.swigCMemOwn

PvStream.Dispose()

PvStream.CreateAndOpen(PvDeviceInfo, ref PvResult)

PvStream.CreateAndOpen(string, ref PvResult)

PvStream.Free(PvStream)

PvStream.Close()

PvStream.GetType()

PvStream.AbortQueuedBuffers()

PvStream.QueueBuffer(PvBuffer)

PvStream.RetrieveBuffer(out PvBuffer, ref PvResult, uint)

PvStream.RetrieveBuffer(out PvBuffer, ref PvResult)

PvStream.RegisterEventSink(PvStreamEventSink)

PvStream.UnregisterEventSink(PvStreamEventSink)

PvStream.QueuedBufferCount

PvStream.QueuedBufferMaximum

PvStream.Channel

PvStream.IsOpen

PvStream.Parameters

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: eBUSDotNetReceive

Assembly: eBUSDotNetReceive.dll

Syntax

public class PvStreamRTP : PvStream, IDisposable

Constructors

PvStreamRTP()

Constructor.

Declaration

public PvStreamRTP()

Properties

LocalIPAddress

Gets the local IP address used by the stream.

Declaration

public string LocalIPAddress { get; }

Property Value

Type	Description
string

LocalPort

Gets the local socket port used by the stream.

Declaration

public ushort LocalPort { get; }

Property Value

Type	Description
ushort

MulticastIPAddress

Gets the multicast IP address of the stream.

Declaration

public string MulticastIPAddress { get; }

Property Value

Type	Description
string

TCPServerIPAddress

Gets the IP address of the TCP server stream. Only valid in TCP mode.

Declaration

public string TCPServerIPAddress { get; }

Property Value

Type	Description
string

TCPServerPort

Gets the port of the TCP stream server. Only valid in TCP mode.

Declaration

public ushort TCPServerPort { get; }

Property Value

Type	Description
ushort

ThreadPriority

Gets or sets the thread priority of the data receiver thread.

Declaration

public uint ThreadPriority { get; set; }

Property Value

Type	Description
uint

Type

Type property of PvStreamRTP.

Declaration

public override PvStreamType Type { get; }

Property Value

Type	Description
PvStreamType

Overrides

PvStream.Type

Methods

Dispose(bool)

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

Overrides

PvStream.Dispose(bool)

Open(PvDeviceInfo)

Opens a stream from a #PvDeviceInfo. Not supported with RTP.

Declaration

public override PvResult Open(PvDeviceInfo aDeviceInfo)

Parameters

Type	Name	Description
PvDeviceInfo	aDeviceInfo	The PvDeviceInfo input.

Returns

Type	Description
PvResult	#PvResult::Code::NOT_SUPPORTED

Overrides

PvStream.Open(PvDeviceInfo)

Open(SWIGTYPE_p_PvSessionInfoSDP, string)

Opens the stream from a SDP session info.

Declaration

public PvResult Open(SWIGTYPE_p_PvSessionInfoSDP aSession, string aLocalIPAddress)

Parameters

Type	Name	Description
SWIGTYPE_p_PvSessionInfoSDP	aSession	The SDP for a given stream.
string	aLocalIPAddress

Returns

Type	Description
PvResult	#PvResult::Code::NOT_SUPPORTED

Open(SWIGTYPE_p_PvSessionInfoSDP, string, ushort)

Opens the stream from a SDP session info.

Declaration

public PvResult Open(SWIGTYPE_p_PvSessionInfoSDP aSession, string aLocalIPAddress, ushort aLocalPort)

Parameters

Type	Name	Description
SWIGTYPE_p_PvSessionInfoSDP	aSession	The SDP for a given stream.
string	aLocalIPAddress
ushort	aLocalPort	A local port to receive from.

Returns

Type	Description
PvResult	#PvResult::Code::NOT_SUPPORTED

Open(string)

Opens a stream from a device info string. Not supported with RTP.

Declaration

public override PvResult Open(string aInfo)

Parameters

Type	Name	Description
string	aInfo	The device info, formatted as a string.

Returns

Type	Description
PvResult	#PvResult::Code::NOT_SUPPORTED

Overrides

PvStream.Open(string)

Open(string, ushort)

Opens the stream object for unicast RTP receiving.

Declaration

public PvResult Open(string aLocalIpAddress, ushort aLocalPort)

Parameters

Type	Name	Description
string	aLocalIpAddress	A local IP address to receive from.
ushort	aLocalPort	A local port to receive from.

Returns

Type	Description
PvResult	#PvResult::Code::OK on success.

Open(string, ushort, string)

Opens the stream object for multicast RTP receiving.

Declaration

public PvResult Open(string aMulticastAddress, ushort aDataPort, string aLocalIpAddress)

Parameters

Type	Name	Description
string	aMulticastAddress	The multicast IP address of the stream.
ushort	aDataPort	The stream port.
string	aLocalIpAddress	A local IP address to receive from.

Returns

Type	Description
PvResult	#PvResult::Code::OK on success.

OpenTCP(string, ushort)

Opens the stream object for TCP receiving.

Declaration

public PvResult OpenTCP(string aServerIpAddress, ushort aServerPort)

Parameters

Type	Name	Description
string	aServerIpAddress	The IP address of the RTP server.
ushort	aServerPort	The RTP server port.

Returns

Type	Description
PvResult	#PvResult::Code::OK on success.

PrepareFor(uint, uint, PvPixelType)

Tells the stream object to expect uncompressed images of a specific format.

Declaration

public PvResult PrepareFor(uint aWidth, uint aHeight, PvPixelType aPixelType)

Parameters

Type	Name	Description
uint	aWidth	The image's width to receive.
uint	aHeight	The image's height to receive.
PvPixelType	aPixelType	The image's pixel type to receive.

Returns

Type	Description
PvResult	#PvResult::Code::OK on success.

PrepareFor(uint, uint, PvPixelType, ushort)

Tells the stream object to expect uncompressed images of a specific format.

Declaration

public PvResult PrepareFor(uint aWidth, uint aHeight, PvPixelType aPixelType, ushort aPaddingX)

Parameters

Type	Name	Description
uint	aWidth	The image's width to receive.
uint	aHeight	The image's height to receive.
PvPixelType	aPixelType	The image's pixel type to receive.
ushort	aPaddingX	The image's padding to receive.

Returns

Type	Description
PvResult	#PvResult::Code::OK on success.

PrepareForH264()

Tells the stream object to expect an H.264 stream.

Declaration

public PvResult PrepareForH264()

Returns

Type	Description
PvResult	#PvResult::Code::OK on success.

ResetPayloadType()

Resets the expected stream attributes to undefined.

Declaration

public PvResult ResetPayloadType()

Returns

Type	Description
PvResult	#PvResult::Code::OK on success.

Implements

IDisposable