RTSPFormatPCM8 Class Reference

L8 format for RTSP https://en.wikipedia.org/wiki/RTP_payload_formats. More...

#include <RTSPFormat.h>

Inheritance diagram for RTSPFormatPCM8:

Public Member Functions
	RTSPFormatPCM8 ()
virtual AudioInfo	audioInfo ()
void	begin (AudioInfo info) override
virtual void	begin (RTSPVideoInfo info)
virtual int	convert (void *data, int sampleCount)
AudioInfo	defaultConfig ()
virtual RTSPVideoInfo	defaultVideoConfig ()
const char *	format (char *buffer, int len) override
virtual int	fragmentSize ()
	Fragment (=write) size in bytes.
virtual MediaType	mediaType ()
virtual const char *	name ()
virtual int	readHeader (uint8_t *data)
	Optional header: e.g. rfc2250.
virtual int	rtpPayloadType ()
	default dynamic
void	setFragmentSize (int fragmentSize)
	Defines the fragment size in bytes.
void	setName (const char *name)
	Defines the name of the stream.
virtual void	setProfileLevelId (const char *)
virtual void	setSpropParameterSets (const char *, const char *)
void	setTimerPeriodUs (int period)
	Defines the timer period in microseconds.
virtual void	setUseRfc2250Header (bool)
	Optional: Configure RFC2250 header usage (default: no-op)
virtual int	timerPeriodUs ()
	Timer period in microseconds.
virtual int	timestampIncrement ()
	Fragment size in samples (for audio) or timestamp increment (for video)
virtual bool	useRfc2250Header () const
virtual RTSPVideoInfo	videoInfo ()

Protected Attributes
AudioInfo	cfg {16000, 1, 16}
int	fragment_size = 640
const char *	name_str = "RTSPAudioTools"
const char *	STD_URL_PRE_SUFFIX = "trackID"
int	timer_period_us = 10000
RTSPVideoInfo	video_cfg {640, 480, 30.0f, RTSPVideoFormat::MJPEG, 24}

Detailed Description

L8 format for RTSP https://en.wikipedia.org/wiki/RTP_payload_formats.

Author

Phil Schatzmann

Constructor & Destructor Documentation

RTSPFormatPCM8()

RTSPFormatPCM8 ( )

inline

Member Function Documentation

audioInfo()

virtual AudioInfo audioInfo ( )

inlinevirtualinherited

Reimplemented in RTSPFormatMP3, and RTSPFormatADPCM< AudioEncoder >.

begin() [1/2]

void begin ( AudioInfo  info )

inlineoverridevirtual

Reimplemented from RTSPFormat.

begin() [2/2]

virtual void begin ( RTSPVideoInfo  info )

inlinevirtualinherited

convert()

virtual int convert ( void *  data, int  sampleCount  )

inlinevirtualinherited

Reimplemented in RTSPFormatPCM.

defaultConfig()

AudioInfo defaultConfig ( )

inlinevirtual

Implements RTSPFormat.

defaultVideoConfig()

virtual RTSPVideoInfo defaultVideoConfig ( )

inlinevirtualinherited

Reimplemented in RTSPFormatMJPEG, and RTSPFormatH264.

format()

const char * format ( char *  buffer, int  len  )

inlineoverridevirtual

Implements RTSPFormat.

fragmentSize()

virtual int fragmentSize ( )

inlinevirtualinherited

Fragment (=write) size in bytes.

Reimplemented in RTSPFormatMP3.

mediaType()

virtual MediaType mediaType ( )

inlinevirtualinherited

Reimplemented in RTSPFormatMJPEG, RTSPFormatH264, and RTSPFormatMTS.

name()

virtual const char * name ( )

inlinevirtualinherited

readHeader()

virtual int readHeader ( uint8_t *  data )

inlinevirtualinherited

Optional header: e.g. rfc2250.

rtpPayloadType()

virtual int rtpPayloadType ( )

inlinevirtualinherited

default dynamic

Reimplemented in RTSPFormatPCM, RTSPFormatMP3, RTSPFormatMJPEG, RTSPFormatH264, and RTSPFormatMTS.

setFragmentSize()

void setFragmentSize ( int  fragmentSize )

inlineinherited

Defines the fragment size in bytes.

setName()

void setName ( const char *  name )

inlineinherited

Defines the name of the stream.

setProfileLevelId()

virtual void setProfileLevelId ( const char *  )

inlinevirtualinherited

Optional: receives the 3-byte profile-level-id (as 6 hex digits) once an encoder has parsed it from the SPS. Default no-op; only RTSPFormatH264 acts on it.

Reimplemented in RTSPFormatH264.

setSpropParameterSets()

virtual void setSpropParameterSets ( const char *  , const char *    )

inlinevirtualinherited

Optional: receives base64-encoded SPS/PPS once an encoder has learned them (H.264 sprop-parameter-sets). Default no-op; only RTSPFormatH264 acts on it. Declared here (rather than only on RTSPFormatH264) so video encoders (see RTSPVideoEncoder) can push this through a generic RTSPFormat* without needing to know the concrete format type.

Reimplemented in RTSPFormatH264.

setTimerPeriodUs()

void setTimerPeriodUs ( int  period )

inlineinherited

Defines the timer period in microseconds.

setUseRfc2250Header()

virtual void setUseRfc2250Header ( bool  )

inlinevirtualinherited

Optional: Configure RFC2250 header usage (default: no-op)

Reimplemented in RTSPFormatMP3.

timerPeriodUs()

virtual int timerPeriodUs ( )

inlinevirtualinherited

Timer period in microseconds.

Reimplemented in RTSPFormatADPCM< AudioEncoder >, RTSPFormatMP3, and RTSPFormatMTS.

timestampIncrement()

virtual int timestampIncrement ( )

inlinevirtualinherited

Fragment size in samples (for audio) or timestamp increment (for video)

Reimplemented in RTSPFormatMP3, RTSPFormatMJPEG, and RTSPFormatH264.

useRfc2250Header()

virtual bool useRfc2250Header ( ) const

inlinevirtualinherited

Reimplemented in RTSPFormatMP3.

videoInfo()

virtual RTSPVideoInfo videoInfo ( )

inlinevirtualinherited

Member Data Documentation

cfg

AudioInfo cfg {16000, 1, 16}

protectedinherited

fragment_size

int fragment_size = 640

protectedinherited

name_str

const char* name_str = "RTSPAudioTools"

protectedinherited

STD_URL_PRE_SUFFIX

const char* STD_URL_PRE_SUFFIX = "trackID"

protectedinherited

timer_period_us

int timer_period_us = 10000

protectedinherited

video_cfg

RTSPVideoInfo video_cfg {640, 480, 30.0f, RTSPVideoFormat::MJPEG, 24}

protectedinherited

---

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

• src/AudioTools/Communication/RTSP/RTSPFormat.h