mediax Namespace Reference

The Astute Systems (MediaX) library for video streaming. More...

Namespaces
namespace	qt6
	The Qt wrappers namespace.
namespace	rtp
	The Real Time Protocol (RTP) namespace.
namespace	sap
	The Session Announcment Protocol (SAP)/ Session Description Protocol (SDP) namespace.
namespace	video
	The video functions namespace.

Data Structures
class	DisplayManagerBase
	The display manager class. More...
struct	Resolution
	The video resolution structure. More...
class	RtpSapRecieve
	A RTP SAP receiver helper class. More...
class	RtpSapTransmit
	A RTP SAP transmitter helper class. More...

Enumerations
enum class	Status { kSuccess = 0 , kFailure = 1 , kError = 2 , kTimeout = 3 }
	Enum of status.

Functions
void	InitRtp (int argc, char *argv[])
	Initialize the RTP library, mainly needed for GStreamer support.
bool	IsRtpInitialised ()
	Check if the RTP library has been initialized.
void	RtpCleanup ()
	Finalise the RTP library, mainly needed for GStreamer support.
std::string	ColourspaceTypeToString (rtp::ColourspaceType)
	Convert enum to string.
rtp::ColourspaceType	ColourspaceTypeFromString (std::string_view)
	Convert string to enum.
uint8_t	BitsPerPixel (rtp::ColourspaceType mode)
	Get the number of bits per pixel for a given colour space.
uint8_t	BytesPerPixel (rtp::ColourspaceType mode)
	Get the number of bytes per pixel for a given colour space.
std::string	GetVersion ()
	Get the MediaX version number.
int	GetVersionMajor ()
	Get the MediaX version major number.
int	GetVersionMinor ()
	Get the MediaX version minor number.
int	GetVersionPatch ()
	Get the MediaX version patch number.
std::string	GetDate ()
	Get the MediaX build date.

Variables
const uint16_t	kDefaultHeight = 480
	The default width of the display.
const uint16_t	kDefaultWidth = 640
	The default height of the display.
const uint16_t	kDefaultFramerate = 25
	The default framerate.
const char	kDefaultFont [] = "Courier"
	Default font.
const uint16_t	kDefaultFontSize = 24
	Default font size.

Detailed Description

The Astute Systems (MediaX) library for video streaming.

Function Documentation

BitsPerPixel()

uint8_t mediax::BitsPerPixel

(

rtp::ColourspaceType

mode

)

Get the number of bits per pixel for a given colour space.

Parameters

mode

Returns

uint8_t the bits per pixel

BytesPerPixel()

uint8_t mediax::BytesPerPixel

(

rtp::ColourspaceType

mode

)

Get the number of bytes per pixel for a given colour space.

Parameters

mode

Returns

uint8_t The bytes per pixel, this will be rounded up for odd values i.e. NV12 is 12 bits per pixel but 2 bytes

ColourspaceTypeFromString()

rtp::ColourspaceType mediax::ColourspaceTypeFromString

(

std::string_view

)

Convert string to enum.

Returns

rtp::ColourspaceType

ColourspaceTypeToString()

std::string mediax::ColourspaceTypeToString

(

rtp::ColourspaceType

)

Convert enum to string.

Returns

std::string

InitRtp()

void mediax::InitRtp	(	int	argc,
		char *	argv[]
	)

Initialize the RTP library, mainly needed for GStreamer support.

Parameters

argc	from main, used to initialize GStreamer
argv	from main, used to initialize GStreamer

IsRtpInitialised()

bool mediax::IsRtpInitialised

(

)

Check if the RTP library has been initialized.

Returns

true If already initialized

false If not initialized