Pleora Technologies Inc. eBUS SDK v6.2.8.5877 API



PvStreamRTP Class Reference

Receive data from a RTP transmitter. More...

Public Member Functions

 PvStreamRTP ()
 Constructor.
 
virtual ~PvStreamRTP ()
 Destructor.
 
PvResult Open (const PvDeviceInfo *aDeviceInfo)
 Opens a stream from a PvDeviceInfo. Not supported with RTP. More...
 
PvResult Open (const PvString &aInfo)
 Opens a stream from a device info string. Not supported with RTP. More...
 
PvResult PrepareFor (uint32_t aWidth, uint32_t aHeight, PvPixelType aPixelType, uint16_t aPaddingX=0)
 Tells the stream object to expect uncompressed images of a specific format. More...
 
PvResult PrepareForH264 ()
 Tells the stream object to expect an H.264 stream. More...
 
PvResult ResetPayloadType ()
 Resets the expected stream attributes to undefined. More...
 
PvResult Open (const PvSessionInfoSDP *aSession, const PvString &aLocalIPAddress, uint16_t aLocalPort=0)
 Opens the stream from a SDP session info. More...
 
PvResult Open (const PvString &aLocalIpAddress, uint16_t aLocalPort)
 Opens the stream object for unicast RTP receiving. More...
 
PvResult Open (const PvString &aMulticastAddress, uint16_t aDataPort, const PvString &aLocalIpAddress)
 Opens the stream object for multicast RTP receiving. More...
 
PvResult OpenTCP (const PvString &aServerIpAddress, uint16_t aServerPort)
 Opens the stream object for TCP receiving. More...
 
PvStreamType GetType () const
 Receiver type. More...
 
uint16_t GetLocalPort () const
 Returns the local socket port used by the stream. More...
 
PvString GetLocalIPAddress () const
 Returns the local IPaddress used by the stream. More...
 
PvString GetMulticastIPAddress () const
 Returns the multicast IP address of the stream. More...
 
PvString GetTCPServerIPAddress () const
 Returns the IP address of the server stream. More...
 
uint16_t GetTCPServerPort () const
 Returns the port of the stream server. More...
 
uint32_t GetThreadPriority () const
 Returns thread priority of the data receiver thread. More...
 
PvResult SetThreadPriority (uint32_t aPriority)
 Set the priority of the thread used to run the data receiver. More...
 
- Public Member Functions inherited from PvStream
virtual ~PvStream ()
 Destructor.
 
uint32_t GetQueuedBufferCount () const
 Get the number of buffers (PvBuffer objects) waiting to be filled with images by the data receiver. More...
 
uint32_t GetQueuedBufferMaximum () const
 Get the maximum number of buffers (PvBuffer objects) that can be queued at a time. More...
 
PvResult Close ()
 Close the stream channel receiver. More...
 
PvResult AbortQueuedBuffers ()
 Abort all pending block requests. More...
 
PvResult QueueBuffer (PvBuffer *aBuffer)
 Queue a buffer to receive a block. More...
 
PvResult RetrieveBuffer (PvBuffer **aBuffer, PvResult *aOperationResult, uint32_t aTimeout=0xFFFFFFFF)
 Attempt to retrieve a queued buffer. More...
 
uint16_t GetChannel ()
 Get the stream's Channel property. More...
 
bool IsOpen () const
 Test if the stream is open. More...
 
PvResult RegisterEventSink (PvStreamEventSink *aEventSink)
 Register an event sink used for callbacks. More...
 
PvResult UnregisterEventSink (PvStreamEventSink *aEventSink)
 Unregister an event sink. More...
 
PvGenParameterArrayGetParameters ()
 Get the parameters defining how data is received from a GigE Vision transmitter. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from PvStream
static PvStreamCreateAndOpen (const PvDeviceInfo *aDeviceInfo, PvResult *aResult)
 Dynamically allocates a PvStream of the right type. More...
 
static PvStreamCreateAndOpen (const PvString &aInfo, PvResult *aResult)
 Dynamically allocates a PvStream of the right type. More...
 
static void Free (PvStream *aStream)
 Frees an object allocated with CreateAndOpen. More...
 
- Protected Member Functions inherited from PvStream
 PvStream ()
 Constructor.
 

Detailed Description

Receive data from a RTP transmitter.

This provides a means of opening a connection to the data receiver and obtaining data from it.

Member Function Documentation

PvString PvStreamRTP::GetLocalIPAddress ( ) const

Returns the local IPaddress used by the stream.

Returns
Stream local IP address.
uint16_t PvStreamRTP::GetLocalPort ( ) const

Returns the local socket port used by the stream.

Returns
Stream local port.
PvString PvStreamRTP::GetMulticastIPAddress ( ) const

Returns the multicast IP address of the stream.

Returns
Stream multipcast IP addres if applicable.
PvString PvStreamRTP::GetTCPServerIPAddress ( ) const

Returns the IP address of the server stream.

Only valid in TCP mode.

Returns
Server IP address.
uint16_t PvStreamRTP::GetTCPServerPort ( ) const

Returns the port of the stream server.

Only valid in TCP mode.

Returns
Server port.
uint32_t PvStreamRTP::GetThreadPriority ( ) const

Returns thread priority of the data receiver thread.

Returns
Thread priority.
PvStreamType PvStreamRTP::GetType ( ) const
virtual

Receiver type.

Returns
Receiver type.

Reimplemented from PvStream.

PvResult PvStreamRTP::Open ( const PvDeviceInfo aDeviceInfo)
virtual

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

Parameters
[in]aDeviceInfoThe PvDeviceInfo input.
Returns
PvResult::Code::NOT_SUPPORTED

Implements PvStream.

PvResult PvStreamRTP::Open ( const PvString aInfo)
virtual

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

Parameters
[in]aInfoThe device info, formatted as a string.
Returns
PvResult::Code::NOT_SUPPORTED

Implements PvStream.

PvResult PvStreamRTP::Open ( const PvSessionInfoSDP aSession,
const PvString aLocalIPAddress,
uint16_t  aLocalPort = 0 
)

Opens the stream from a SDP session info.

Parameters
[in]aSessionThe SDP for a given stream.
[in]aLocalIpAddressA local IP address to receive from.
[in]aLocalPortA local port to receive from.
Returns
PvResult::Code::NOT_SUPPORTED
PvResult PvStreamRTP::Open ( const PvString aLocalIpAddress,
uint16_t  aLocalPort 
)

Opens the stream object for unicast RTP receiving.

Parameters
[in]aLocalIpAddressA local IP address to receive from.
[in]aLocalPortA local port to receive from.
Returns
PvResult::Code::OK on success.
PvResult PvStreamRTP::Open ( const PvString aMulticastAddress,
uint16_t  aDataPort,
const PvString aLocalIpAddress 
)

Opens the stream object for multicast RTP receiving.

Parameters
[in]aMulticastAddressThe multicast IP address of the stream.
[in]aDataPortThe stream port.
[in]aLocalIpAddressA local IP address to receive from.
Returns
PvResult::Code::OK on success.
PvResult PvStreamRTP::OpenTCP ( const PvString aServerIPAddress,
uint16_t  aServerPort 
)

Opens the stream object for TCP receiving.

Parameters
[in]aServerIPAddressThe RTP server IP address.
[in]aServerPortThe RTP server port.
Returns
PvResult::Code::OK on success.
PvResult PvStreamRTP::PrepareFor ( uint32_t  aWidth,
uint32_t  aHeight,
PvPixelType  aPixelType,
uint16_t  aPaddingX = 0 
)

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

Parameters
[in]aWidthThe image's width to receive.
[in]aHeightThe image's height to receive.
[in]aPixelTypeThe image's pixel type to receive.
[in]aPaddingXThe image's padding to receive.
Returns
PvResult::Code::OK on success.
PvResult PvStreamRTP::PrepareForH264 ( )

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

Returns
PvResult::Code::OK on success.
PvResult PvStreamRTP::ResetPayloadType ( )

Resets the expected stream attributes to undefined.

Returns
PvResult::Code::OK on success.
PvResult PvStreamRTP::SetThreadPriority ( uint32_t  aPriority)

Set the priority of the thread used to run the data receiver.

If you change the thread priorities, it may alterate the stability of the system. For this reason, if you report a bug to Pleora, ensure to clearly mention that you change threads priorities.

See GetThreadPriority

Parameters
[in]aPrioritySee PvPipeline::SetBufferHandlingThreadPriority for description of the supported values
Returns
Includes:

The documentation for this class was generated from the following files:

Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com