Audio Format Definition - Base class for RTSP audio formats. More...
#include <RTSPFormat.h>
Public Member Functions | |
| virtual AudioInfo | audioInfo () |
| virtual void | begin (AudioInfo info) |
| virtual int | convert (void *data, int sampleCount) |
| virtual AudioInfo | defaultConfig ()=0 |
| virtual const char * | format (char *buffer, int len)=0 |
| virtual int | fragmentSize () |
| Fragment (=write) size in bytes. | |
| 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. | |
| 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 char * | name_str = "RTSPAudioTools" |
| const char * | STD_URL_PRE_SUFFIX = "trackID" |
| int | timer_period_us = 10000 |
Detailed Description
Audio Format Definition - Base class for RTSP audio formats.
The RTSPFormat class hierarchy defines audio format characteristics for RTSP streaming, including SDP generation and RTP packaging parameters. This base class provides the interface for:
- SDP (Session Description Protocol) generation for RTSP DESCRIBE responses
- Audio data conversion (endianness, format transformations)
- RTP packaging parameters (fragment size, timing)
- Sample rate and channel configuration
Supported Formats
- RTSPFormatPCM: Linear PCM audio (most common)
- Custom formats can be implemented by extending this class
SDP Format String
The format() method generates SDP media descriptions like:
- Note
- Implementations must provide format() method for SDP generation
- Version
- 0.1.1
Member Function Documentation
◆ audioInfo()
|
inlinevirtual |
Reimplemented in RTSPFormatMP3.
◆ convert()
|
inlinevirtual |
Reimplemented in RTSPFormatPCM.
◆ format()
|
pure virtual |
Implemented in RTSPFormatPCM, RTSPFormatGSM, and RTSPFormatG711.
◆ rtpPayloadType()
|
inlinevirtual |
default dynamic
Reimplemented in RTSPFormatPCM, and RTSPFormatMP3.
◆ setUseRfc2250Header()
|
inlinevirtual |
Optional: Configure RFC2250 header usage (default: no-op)
Reimplemented in RTSPFormatMP3.
◆ timerPeriodUs()
|
inlinevirtual |
Timer period in microseconds.
Reimplemented in RTSPFormatADPCM< AudioEncoder >, and RTSPFormatMP3.
◆ timestampIncrement()
|
inlinevirtual |
Fragment size in samples.
Reimplemented in RTSPFormatMP3.
The documentation for this class was generated from the following file:
- src/AudioTools/Communication/RTSP/RTSPFormat.h
