mediax::rtp::RtpPayloader Class Reference

Manage an RTP stream. More...

#include <rtp_payloader.h>

Inheritance diagram for mediax::rtp::RtpPayloader:

Collaboration diagram for mediax::rtp::RtpPayloader:

Public Member Functions
	RtpPayloader ()=default
	Construct a new Rtp Payloader object.
virtual	~RtpPayloader ()=default
	Destroy the Rtp Payloader object.
	RtpPayloader (RtpPayloader const &)=delete
	Construct a new Rtp Payloader object.
RtpPayloader &	operator= (RtpPayloader const &)=delete
	Construct a new Rtp Payloader object.
virtual void	SetStreamInfo (const ::mediax::rtp::StreamInformation &stream_information)=0
	Configure an RTP output stream.
virtual bool	Open ()=0
	Open the RTP stream.
virtual void	Close ()=0
	Close the RTP stream.
virtual void	Stop ()
	Stop a stream so it can be quickly restarted. Do not close.
virtual void	Start ()
	Restart a stopped stream.
virtual int	Transmit (uint8_t *rgbframe, bool blocking=true)=0
	Transmit an RGB buffer.
mediax::rtp::ColourspaceType	GetColourSpace () const
	Get the Colour Space object of the incoming stream.
void	SetColourSpace (mediax::rtp::ColourspaceType colourspace)
	Set the Colour Space object.
uint32_t	GetHeight () const
	Get the Height object of the incoming stream.
void	SetHeight (uint32_t height)
	Set the Height object.
uint32_t	GetWidth () const
	Get the Width object of the incoming stream.
void	SetWidth (uint32_t width)
	Set the Width object.
uint32_t	GetFrameRate () const
	Get the Frame Rate of the incoming stream.
void	SetFrameRate (uint32_t framerate)
	Set the Frame Rate object.
std::string	GetIpAddress () const
	Get the Ip Address of the incoming stream.
void	SetIpAddress (std::string_view ip_address)
	Set the Ip Address object.
uint32_t	GetPort () const
	Get the Port of the incoming stream.
void	SetPort (uint32_t port)
	Set the Port object.
std::vector< uint8_t > &	GetBuffer ()
	Get the Buffer object.
uint32_t	GetBufferSize () const
	Get the Buffer Size object.
void	SetBufferSize (uint32_t size)
	Set the Buffer Size object.

Protected Member Functions
::mediax::rtp::RtpPortType &	GetEgressPort ()
	Get the Egress Port object.

Private Attributes
::mediax::rtp::RtpPortType	egress_
	Egress port.
std::vector< uint8_t >	frame_
	Data buffer.

Detailed Description

Manage an RTP stream.

Member Function Documentation

Close()

virtual void mediax::rtp::RtpPayloader::Close ( )

pure virtual

Close the RTP stream.

Implemented in mediax::rtp::av1::gst::RtpAv1GstPayloader, mediax::rtp::h264::gst::nvidia::RtpH264GstNvidiaPayloader, mediax::rtp::h264::gst::omx::RtpH264GstOmxPayloader, mediax::rtp::h264::gst::open::RtpH264GstOpenPayloader, mediax::rtp::h264::gst::vaapi::RtpH264GstVaapiPayloader, mediax::rtp::h264::gst::x264::RtpH264Gstx264Payloader, mediax::rtp::h264::RtpH264Payloader, mediax::rtp::h264::nvenc::RtpH264Payloader, mediax::rtp::h264::vaapi::RtpH264VaapiPayloader, mediax::rtp::h265::gst::RtpH265GstPayloader, mediax::rtp::h265::gst::vaapi::RtpH265GstVaapiPayloader, mediax::rtp::jpeg::gst::RtpJpegGstPayloader, mediax::rtp::jpeg::gst::vaapi::RtpJpegGstVaapiPayloader, and mediax::rtp::uncompressed::RtpUncompressedPayloader.

GetBuffer()

std::vector< uint8_t > & mediax::rtp::RtpPayloader::GetBuffer ( )

inline

Get the Buffer object.

Returns

std::vector<uint8_t>&

GetBufferSize()

uint32_t mediax::rtp::RtpPayloader::GetBufferSize ( ) const

inline

Get the Buffer Size object.

Returns

uint32_t

GetColourSpace()

mediax::rtp::ColourspaceType mediax::rtp::RtpPayloader::GetColourSpace

(

)

const

Get the Colour Space object of the incoming stream.

Note

This may be invalid id no SAP/SDP announcement has been received yet.

Returns

ColourspaceType

GetEgressPort()

mediax::rtp::RtpPortType & mediax::rtp::RtpPayloader::GetEgressPort ( )

protected

Get the Egress Port object.

Returns

mediax::rtp::RtpPortType&

GetFrameRate()

uint32_t mediax::rtp::RtpPayloader::GetFrameRate

(

)

const

Get the Frame Rate of the incoming stream.

Note

This may be invalid id no SAP/SDP announcement has been received yet.

Returns

uint32_t

GetHeight()

uint32_t mediax::rtp::RtpPayloader::GetHeight

(

)

const

Get the Height object of the incoming stream.

Note

This may be invalid id no SAP/SDP announcement has been received yet.

Returns

uint32_t

GetIpAddress()

std::string mediax::rtp::RtpPayloader::GetIpAddress

(

)

const

Get the Ip Address of the incoming stream.

Note

This may be invalid id no SAP/SDP announcement has been received yet.

Returns

std::string

GetPort()

uint32_t mediax::rtp::RtpPayloader::GetPort

(

)

const

Get the Port of the incoming stream.

Note

This may be invalid id no SAP/SDP announcement has been received yet.

Returns

uint32_t

GetWidth()

uint32_t mediax::rtp::RtpPayloader::GetWidth

(

)

const

Get the Width object of the incoming stream.

Note

This may be invalid id no SAP/SDP announcement has been received yet.

Returns

uint32_t

Open()

virtual bool mediax::rtp::RtpPayloader::Open ( )

pure virtual

Open the RTP stream.

Returns

true

false

Implemented in mediax::rtp::av1::gst::RtpAv1GstPayloader, mediax::rtp::h264::gst::nvidia::RtpH264GstNvidiaPayloader, mediax::rtp::h264::gst::omx::RtpH264GstOmxPayloader, mediax::rtp::h264::gst::open::RtpH264GstOpenPayloader, mediax::rtp::h264::gst::vaapi::RtpH264GstVaapiPayloader, mediax::rtp::h264::gst::x264::RtpH264Gstx264Payloader, mediax::rtp::h264::RtpH264Payloader, mediax::rtp::h264::nvenc::RtpH264Payloader, mediax::rtp::h264::vaapi::RtpH264VaapiPayloader, mediax::rtp::h265::gst::RtpH265GstPayloader, mediax::rtp::h265::gst::vaapi::RtpH265GstVaapiPayloader, mediax::rtp::jpeg::gst::RtpJpegGstPayloader, mediax::rtp::jpeg::gst::vaapi::RtpJpegGstVaapiPayloader, and mediax::rtp::uncompressed::RtpUncompressedPayloader.

operator=()

RtpPayloader & mediax::rtp::RtpPayloader::operator= ( RtpPayloader const &  )

delete

Construct a new Rtp Payloader object.

Returns

RtpPayloader&

SetBufferSize()

void mediax::rtp::RtpPayloader::SetBufferSize ( uint32_t  size )

inline

Set the Buffer Size object.

Parameters

size

SetColourSpace()

void mediax::rtp::RtpPayloader::SetColourSpace

(

mediax::rtp::ColourspaceType

colourspace

)

Set the Colour Space object.

Parameters

colourspace

SetFrameRate()

void mediax::rtp::RtpPayloader::SetFrameRate

(

uint32_t

framerate

)

Set the Frame Rate object.

Parameters

framerate

SetHeight()

void mediax::rtp::RtpPayloader::SetHeight

(

uint32_t

height

)

Set the Height object.

Parameters

height

SetIpAddress()

void mediax::rtp::RtpPayloader::SetIpAddress

(

std::string_view

ip_address

)

Set the Ip Address object.

Parameters

ip_address

SetPort()

void mediax::rtp::RtpPayloader::SetPort

(

uint32_t

port

)

Set the Port object.

Parameters

port

SetStreamInfo()

virtual void mediax::rtp::RtpPayloader::SetStreamInfo ( const ::mediax::rtp::StreamInformation &  stream_information )

pure virtual

Configure an RTP output stream.

Parameters

stream_information

set the stream information

Implemented in mediax::rtp::uncompressed::RtpUncompressedPayloader, mediax::rtp::av1::gst::RtpAv1GstPayloader, mediax::rtp::h264::gst::nvidia::RtpH264GstNvidiaPayloader, mediax::rtp::h264::gst::omx::RtpH264GstOmxPayloader, mediax::rtp::h264::gst::open::RtpH264GstOpenPayloader, mediax::rtp::h264::gst::vaapi::RtpH264GstVaapiPayloader, mediax::rtp::h264::gst::x264::RtpH264Gstx264Payloader, mediax::rtp::h265::gst::RtpH265GstPayloader, mediax::rtp::h265::gst::vaapi::RtpH265GstVaapiPayloader, mediax::rtp::jpeg::gst::RtpJpegGstPayloader, and mediax::rtp::jpeg::gst::vaapi::RtpJpegGstVaapiPayloader.

SetWidth()

void mediax::rtp::RtpPayloader::SetWidth

(

uint32_t

width

)

Set the Width object.

Parameters

width

Start()

void mediax::rtp::RtpPayloader::Start ( )

virtual

Restart a stopped stream.

Reimplemented in mediax::rtp::av1::gst::RtpAv1GstPayloader, mediax::rtp::h264::gst::nvidia::RtpH264GstNvidiaPayloader, mediax::rtp::h264::gst::omx::RtpH264GstOmxPayloader, mediax::rtp::h264::gst::open::RtpH264GstOpenPayloader, mediax::rtp::h264::gst::vaapi::RtpH264GstVaapiPayloader, mediax::rtp::h264::gst::x264::RtpH264Gstx264Payloader, mediax::rtp::h264::RtpH264Payloader, mediax::rtp::h264::nvenc::RtpH264Payloader, mediax::rtp::h264::vaapi::RtpH264VaapiPayloader, mediax::rtp::h265::gst::RtpH265GstPayloader, mediax::rtp::h265::gst::vaapi::RtpH265GstVaapiPayloader, mediax::rtp::jpeg::gst::RtpJpegGstPayloader, and mediax::rtp::jpeg::gst::vaapi::RtpJpegGstVaapiPayloader.

Stop()

void mediax::rtp::RtpPayloader::Stop ( )

virtual

Stop a stream so it can be quickly restarted. Do not close.

Reimplemented in mediax::rtp::av1::gst::RtpAv1GstPayloader, mediax::rtp::h264::gst::nvidia::RtpH264GstNvidiaPayloader, mediax::rtp::h264::gst::omx::RtpH264GstOmxPayloader, mediax::rtp::h264::gst::open::RtpH264GstOpenPayloader, mediax::rtp::h264::gst::vaapi::RtpH264GstVaapiPayloader, mediax::rtp::h264::gst::x264::RtpH264Gstx264Payloader, mediax::rtp::h264::RtpH264Payloader, mediax::rtp::h264::nvenc::RtpH264Payloader, mediax::rtp::h264::vaapi::RtpH264VaapiPayloader, mediax::rtp::h265::gst::RtpH265GstPayloader, mediax::rtp::h265::gst::vaapi::RtpH265GstVaapiPayloader, mediax::rtp::jpeg::gst::RtpJpegGstPayloader, and mediax::rtp::jpeg::gst::vaapi::RtpJpegGstVaapiPayloader.

Transmit()

virtual int mediax::rtp::RtpPayloader::Transmit ( uint8_t *  rgbframe, bool  blocking = true  )

pure virtual

Transmit an RGB buffer.

Parameters

rgbframe	pointer to the frame data
blocking	defaults to true, will wait till frame has been transmitted

Returns

int

Implemented in mediax::rtp::av1::gst::RtpAv1GstPayloader, mediax::rtp::h264::gst::nvidia::RtpH264GstNvidiaPayloader, mediax::rtp::h264::gst::omx::RtpH264GstOmxPayloader, mediax::rtp::h264::gst::open::RtpH264GstOpenPayloader, mediax::rtp::h264::gst::vaapi::RtpH264GstVaapiPayloader, mediax::rtp::h264::gst::x264::RtpH264Gstx264Payloader, mediax::rtp::h264::RtpH264Payloader, mediax::rtp::h264::nvenc::RtpH264Payloader, mediax::rtp::h264::vaapi::RtpH264VaapiPayloader, mediax::rtp::h265::gst::RtpH265GstPayloader, mediax::rtp::h265::gst::vaapi::RtpH265GstVaapiPayloader, mediax::rtp::jpeg::gst::RtpJpegGstPayloader, mediax::rtp::jpeg::gst::vaapi::RtpJpegGstVaapiPayloader, and mediax::rtp::uncompressed::RtpUncompressedPayloader.

---

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

• src/rtp/rtp_payloader.h
• src/rtp/rtp_payloader.cc