SdpSession Class Reference

SDP session description (RFC 4566). More...

#include <sdpsession.h>

Public Types
using	Ptr = SharedPtr< SdpSession >
	Shared pointer type.
using	List = promeki::List< SdpSession >
	List of SdpSession values.
using	PtrList = promeki::List< SdpSession::Ptr >
	List of shared SdpSession pointers.

Public Member Functions
	SdpSession ()=default
	Default constructor.
const String &	sessionName () const
	Returns the session name (s= line).
void	setSessionName (const String &name)
	Sets the session name.
const String &	originUsername () const
	Returns the originator username.
uint64_t	sessionId () const
	Returns the session ID.
uint64_t	sessionVersion () const
	Returns the session version.
void	setOrigin (const String &username, uint64_t sessionId, uint64_t sessionVersion, const String &netType="IN", const String &addrType="IP4", const String &address="0.0.0.0")
	Sets the origin (o= line) fields.
const String &	originNetType () const
	Returns the origin network type (e.g. "IN").
const String &	originAddrType () const
	Returns the origin address type (e.g. "IP4").
const String &	originAddress () const
	Returns the origin address.
const String &	connectionAddress () const
	Returns the session-level connection address (c= line).
void	setConnectionAddress (const String &address)
	Sets the session-level connection address.
const promeki::List< SdpMediaDescription > &	mediaDescriptions () const
	Returns the list of media descriptions.
void	addMediaDescription (const SdpMediaDescription &md)
	Adds a media description.
String	toString () const
	Generates the SDP text representation.

Static Public Member Functions
static Result< SdpSession >	fromString (const String &sdp)
	Parses an SDP text string into an SdpSession.

Detailed Description

SDP session description (RFC 4566).

SdpSession represents a complete SDP document. It can parse SDP text into structured data and generate SDP text from structured data. Used by ST 2110 and AES67 for stream advertisement.

Example

SdpSession sdp;
sdp.setSessionName("vidgen test stream");
sdp.setConnectionAddress("239.0.0.1");
 
SdpMediaDescription video;
video.setMediaType("video");
video.setPort(5004);
video.setProtocol("RTP/AVP");
video.addPayloadType(96);
video.setAttribute("rtpmap", "96 raw/90000");
sdp.addMediaDescription(video);
 
String sdpText = sdp.toString();

Member Function Documentation

fromString()

static Result< SdpSession > SdpSession::fromString ( const String &  sdp )

static

Parses an SDP text string into an SdpSession.

Parameters

sdp	The SDP text to parse.

Returns

A Result containing the parsed session and Error::Ok, or Error::Invalid on parse failure.

setOrigin()

void SdpSession::setOrigin	(	const String &	username,
		uint64_t	sessionId,
		uint64_t	sessionVersion,
		const String &	netType = "IN",
		const String &	addrType = "IP4",
		const String &	address = "0.0.0.0"
	)

Sets the origin (o= line) fields.

Parameters

username	The originator username.
sessionId	The session ID.
sessionVersion	The session version.
netType	Network type (default "IN").
addrType	Address type (default "IP4").
address	The originator's address.

toString()

String SdpSession::toString

(

)

const

Generates the SDP text representation.

Returns

The complete SDP document as a string.

---

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

• include/promeki/network/sdpsession.h