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... | |
![]() | |
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... | |
PvGenParameterArray * | GetParameters () |
Get the parameters defining how data is received from a GigE Vision transmitter. More... | |
Additional Inherited Members | |
![]() | |
static PvStream * | CreateAndOpen (const PvDeviceInfo *aDeviceInfo, PvResult *aResult) |
Dynamically allocates a PvStream of the right type. More... | |
static PvStream * | CreateAndOpen (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... | |
![]() | |
PvStream () | |
Constructor. | |
Receive data from a RTP transmitter.
This provides a means of opening a connection to the data receiver and obtaining data from it.
PvString PvStreamRTP::GetLocalIPAddress | ( | ) | const |
Returns the local IPaddress used by the stream.
uint16_t PvStreamRTP::GetLocalPort | ( | ) | const |
Returns the local socket port used by the stream.
PvString PvStreamRTP::GetMulticastIPAddress | ( | ) | const |
Returns the multicast IP address of the stream.
PvString PvStreamRTP::GetTCPServerIPAddress | ( | ) | const |
Returns the IP address of the server stream.
Only valid in TCP mode.
uint16_t PvStreamRTP::GetTCPServerPort | ( | ) | const |
Returns the port of the stream server.
Only valid in TCP mode.
uint32_t PvStreamRTP::GetThreadPriority | ( | ) | const |
Returns thread priority of the data receiver thread.
|
virtual |
|
virtual |
Opens a stream from a PvDeviceInfo. Not supported with RTP.
[in] | aDeviceInfo | The PvDeviceInfo input. |
Implements PvStream.
Opens a stream from a device info string. Not supported with RTP.
[in] | aInfo | The device info, formatted as a string. |
Implements PvStream.
PvResult PvStreamRTP::Open | ( | const PvSessionInfoSDP * | aSession, |
const PvString & | aLocalIPAddress, | ||
uint16_t | aLocalPort = 0 |
||
) |
Opens the stream from a SDP session info.
[in] | aSession | The SDP for a given stream. |
[in] | aLocalIpAddress | A local IP address to receive from. |
[in] | aLocalPort | A local port to receive from. |
Opens the stream object for unicast RTP receiving.
[in] | aLocalIpAddress | A local IP address to receive from. |
[in] | aLocalPort | A local port to receive from. |
PvResult PvStreamRTP::Open | ( | const PvString & | aMulticastAddress, |
uint16_t | aDataPort, | ||
const PvString & | aLocalIpAddress | ||
) |
Opens the stream object for multicast RTP receiving.
[in] | aMulticastAddress | The multicast IP address of the stream. |
[in] | aDataPort | The stream port. |
[in] | aLocalIpAddress | A local IP address to receive from. |
Opens the stream object for TCP receiving.
[in] | aServerIPAddress | The RTP server IP address. |
[in] | aServerPort | The RTP server port. |
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.
[in] | aWidth | The image's width to receive. |
[in] | aHeight | The image's height to receive. |
[in] | aPixelType | The image's pixel type to receive. |
[in] | aPaddingX | The image's padding to receive. |
PvResult PvStreamRTP::PrepareForH264 | ( | ) |
Tells the stream object to expect an H.264 stream.
PvResult PvStreamRTP::ResetPayloadType | ( | ) |
Resets the expected stream attributes to undefined.
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.
[in] | aPriority | See PvPipeline::SetBufferHandlingThreadPriority for description of the supported values |
Copyright (c) 2002-2021 Pleora Technologies Inc.
www.pleora.com