A class to read every SDP attribute for a given session. More...

#include <PvSessionInfoSDP.h>

Public Member Functions
virtual	~PvSessionInfoSDP ()
	Virtual destructor.

PvSessionInfoSDP *	Copy () const
	Copies the PvSessionInfoSDP. More...

uint32_t	GetSessionID () const
	Gets the session identifier. More...

uint32_t	GetSessionVersion () const
	Gets the SDP version (starts at 0). More...

std::string	GetSessionName () const
	Gets the session name. More...

std::string	GetSessionInfo () const
	Gets all the information about the session. More...

PvString	GetConnectionIP () const
	Gets the IP to connect to the session. More...

PvString	GetMediaType () const
	Gets the media type (typically video). More...

uint16_t	GetMediaTransportPort () const
	Gets the port to which the media is sent. More...

PvString	GetMediaSampling () const
	Gets the sampling (e.g. RGB). More...

uint16_t	GetMediaDepth () const
	Gets the depth of each sample (e.g. 8 bits). More...

PvString	GetMediaColorimetry () const
	Gets the colorimetry. More...

uint32_t	GetMediaWidth () const
	Gets the width. More...

uint32_t	GetMediaHeight () const
	Gets the height. More...

uint32_t	GetMediaFramerate () const
	Gets the frame rate. More...

bool	GetMediaInterlaced () const
	Returns if the media is interlaced. More...

PvString	GetContent () const
	Gets the content of the session (e.g. h264) More...

PvString	GetLicenseMessage () const
	Gets a message about the license. More...

PvString	GetDisplayID () const
	Gets the display identifier. More...

PvString	GetUniqueID () const
	Gets the unique ID. More...

PvString	GetConnectionID () const
	Gets the connection ID. More...

bool	IsConfigurationValid () const
	Checks if the configuration is valid. More...

bool	IsLicenseValid () const
	Checks if the license is valid. More...

const PvInterface *	GetInterface () const
	Gets the PvInterface where this session is discovered. More...

Detailed Description

A class to read every SDP attribute for a given session.

Member Function Documentation

◆ Copy()

PvSessionInfoSDP* PvSessionInfoSDP::Copy ( ) const

Copies the PvSessionInfoSDP.

Returns: A copy of the PvSessionInfoSDP.

◆ GetConnectionID()

PvString PvSessionInfoSDP::GetConnectionID ( ) const

Gets the connection ID.

Returns: A string with the connection ID.

◆ GetConnectionIP()

PvString PvSessionInfoSDP::GetConnectionIP ( ) const

Gets the IP to connect to the session.

Returns: A string with the connection IP.

◆ GetContent()

PvString PvSessionInfoSDP::GetContent ( ) const

Gets the content of the session (e.g. h264)

Returns: A string with the session content.

◆ GetDisplayID()

PvString PvSessionInfoSDP::GetDisplayID ( ) const

Gets the display identifier.

Returns: A string with the display ID.

◆ GetInterface()

const PvInterface* PvSessionInfoSDP::GetInterface ( ) const

Gets the PvInterface where this session is discovered.

Returns: A PvInterface for this session.

◆ GetLicenseMessage()

PvString PvSessionInfoSDP::GetLicenseMessage ( ) const

Gets a message about the license.

Returns: A string with the license message.

◆ GetMediaColorimetry()

PvString PvSessionInfoSDP::GetMediaColorimetry ( ) const

Gets the colorimetry.

Returns: A string with the colorimetry.

◆ GetMediaDepth()

uint16_t PvSessionInfoSDP::GetMediaDepth ( ) const

Gets the depth of each sample (e.g. 8 bits).

Returns: A string with the depth.

◆ GetMediaFramerate()

uint32_t PvSessionInfoSDP::GetMediaFramerate ( ) const

Gets the frame rate.

Returns: A string with the frame rate.

◆ GetMediaHeight()

uint32_t PvSessionInfoSDP::GetMediaHeight ( ) const

Gets the height.

Returns: A string with the height.

◆ GetMediaInterlaced()

bool PvSessionInfoSDP::GetMediaInterlaced ( ) const

Returns if the media is interlaced.

Returns: A boolean (true if interlaced, false otherwise).

◆ GetMediaSampling()

PvString PvSessionInfoSDP::GetMediaSampling ( ) const

Gets the sampling (e.g. RGB).

Returns: A string with the sampling.

◆ GetMediaTransportPort()

uint16_t PvSessionInfoSDP::GetMediaTransportPort ( ) const

Gets the port to which the media is sent.

Returns: An integer representing the transport port.

◆ GetMediaType()

PvString PvSessionInfoSDP::GetMediaType ( ) const

Gets the media type (typically video).

Returns: A string with the media type.

◆ GetMediaWidth()

uint32_t PvSessionInfoSDP::GetMediaWidth ( ) const

Gets the width.

Returns: A string with the width.

◆ GetSessionID()

uint32_t PvSessionInfoSDP::GetSessionID ( ) const

Gets the session identifier.

Returns: An integer representing the session ID.

◆ GetSessionInfo()

std::string PvSessionInfoSDP::GetSessionInfo ( ) const

Gets all the information about the session.

Returns: A string with the complete session description.

◆ GetSessionName()

std::string PvSessionInfoSDP::GetSessionName ( ) const

Gets the session name.

Returns: A string with the name of the session.

◆ GetSessionVersion()

uint32_t PvSessionInfoSDP::GetSessionVersion ( ) const

Gets the SDP version (starts at 0).

Returns: An integer representing the session version.

◆ GetUniqueID()

PvString PvSessionInfoSDP::GetUniqueID ( ) const

Gets the unique ID.

Returns: A string with the unique ID.

◆ IsConfigurationValid()

bool PvSessionInfoSDP::IsConfigurationValid ( ) const

Checks if the configuration is valid.

Returns: A boolean representing the validity of the current configuration (true for valid, false for invalid).

◆ IsLicenseValid()

bool PvSessionInfoSDP::IsLicenseValid ( ) const

Checks if the license is valid.

Returns: A boolean representing the validity of the license (true for valid, false for invalid).

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

PvSessionInfoSDP.h

eBUS SDK v6.5.1.6797 API

Public Member Functions