arduino-audio-tools
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
RTSPFormatGSM Class Reference

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

#include <RTSPFormat.h>

Inheritance diagram for RTSPFormatGSM:
RTSPFormat

Public Member Functions

 RTSPFormatGSM ()
 
virtual AudioInfo audioInfo ()
 
virtual void begin (AudioInfo info)
 
virtual int convert (void *data, int sampleCount)
 
AudioInfo defaultConfig ()
 
const charformat (char *buffer, int len) override
 Provides the GSM format information.
 
virtual int fragmentSize ()
 Fragment (=write) size in bytes.
 
virtual const charname ()
 
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.
 
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.
 
virtual bool useRfc2250Header () const
 

Protected Attributes

AudioInfo cfg {16000, 1, 16}
 
int fragment_size = 640
 
const charname_str = "RTSPAudioTools"
 
const charSTD_URL_PRE_SUFFIX = "trackID"
 
int timer_period_us = 10000
 

Detailed Description

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

Author
Phil Schatzmann

Constructor & Destructor Documentation

◆ RTSPFormatGSM()

RTSPFormatGSM ( )
inline

Member Function Documentation

◆ audioInfo()

virtual AudioInfo audioInfo ( )
inlinevirtualinherited

◆ begin()

virtual void begin ( AudioInfo  info)
inlinevirtualinherited

◆ convert()

virtual int convert ( void data,
int  sampleCount 
)
inlinevirtualinherited

Reimplemented in RTSPFormatPCM.

◆ defaultConfig()

AudioInfo defaultConfig ( )
inlinevirtual

Implements RTSPFormat.

◆ format()

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

Provides the GSM format information.

Implements RTSPFormat.

◆ fragmentSize()

virtual int fragmentSize ( )
inlinevirtualinherited

Fragment (=write) size in bytes.

◆ 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, and RTSPFormatMP3.

◆ 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.

◆ 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 >, and RTSPFormatMP3.

◆ timestampIncrement()

virtual int timestampIncrement ( )
inlinevirtualinherited

Fragment size in samples.

Reimplemented in RTSPFormatMP3.

◆ useRfc2250Header()

virtual bool useRfc2250Header ( ) const
inlinevirtualinherited

Reimplemented in RTSPFormatMP3.

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

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