mediax::sap Namespace Reference

The Session Announcment Protocol (SAP)/ Session Description Protocol (SDP) namespace. More...

Data Structures
class	SapAnnouncer
	Class to announce the stream details using the SAP protocol. More...
struct	SapHeader
	Class to announce the stream details using the SAP protocol. More...
class	SapListener
	Class definition of the SAPListener. More...
struct	SdpMessage
	A simplified SDP message structure. More...

Typedefs
using	SapCallback = std::function< void(sap::SdpMessage *sdp, void *data)>
	The SAPListener class is a singleton that listens for SAP/SDP announcements on the network.

Enumerations
enum class	SdpTypeEnum {   kProtocolVersion , kOriginatorSessionIdentifier , kSessionName , kSessionInformation ,   kUriOfDescription , kEmailAddress , kPhoneNumber , kConnectionInformation ,   kBandwidthInformation , kSessionAttribute , kTimeSessionActive , kMediaNameAndTransportAddress ,   kMediaTitle , KConnectionInformation , kUnknown }

Functions
::mediax::rtp::StreamInformation	SapToStreamInformation (const SdpMessage &sdp_message)
	Convert the SDP message to a StreamInformation object.
mediax::rtp::ColourspaceType	SamplingToColourspaceType (std::string_view sampling, uint32_t bits_per_pixel)
	Convert a string to a ColourspaceType.
std::string	GetSdpColourspace (mediax::rtp::ColourspaceType colourspace)
	Get the Sdp Colourspace object.

Detailed Description

The Session Announcment Protocol (SAP)/ Session Description Protocol (SDP) namespace.

The Session Announcment Protocol / Session Description Protocol (SAP/SDP) namespace.

Enumeration Type Documentation

SdpTypeEnum

enum class mediax::sap::SdpTypeEnum

strong

The SDP type as per RFC8866: v= (protocol version) o= (originator and session identifier) s= (session name) i=* (session information) u=* (URI of description) e=* (email address) p=* (phone number) c=* (connection information – not required if included in all media descriptions) b=* (zero or more bandwidth information lines) One or more time descriptions: ("t=", "r=" and "z=" lines; see below) k=* (obsolete) a=* (zero or more session attribute lines) Zero or more media descriptions

Function Documentation

GetSdpColourspace()

std::string mediax::sap::GetSdpColourspace

(

mediax::rtp::ColourspaceType

colourspace

)

Get the Sdp Colourspace object.

Parameters

colourspace

The colourspace to get the SDP string for

Returns

std::string

SamplingToColourspaceType()

mediax::rtp::ColourspaceType mediax::sap::SamplingToColourspaceType	(	std::string_view	sampling,
		uint32_t	bits_per_pixel
	)

Convert a string to a ColourspaceType.

Parameters

sampling	The sampling string
bits_per_pixel	The number of bits per pixel

Returns

ColourspaceType

SapToStreamInformation()

mediax::rtp::StreamInformation mediax::sap::SapToStreamInformation

(

const SdpMessage &

sdp_message

)

Convert the SDP message to a StreamInformation object.

Parameters

sdp_message

Returns

mediax::rtp::StreamInformation