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 void | begin (RTSPVideoInfo info) |
| virtual int | convert (void *data, int sampleCount) |
| virtual AudioInfo | defaultConfig ()=0 |
| virtual RTSPVideoInfo | defaultVideoConfig () |
| virtual const char * | format (char *buffer, int len)=0 |
| 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
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
Member Function Documentation
◆ audioInfo()
|
inlinevirtual |
Reimplemented in RTSPFormatMP3, and RTSPFormatADPCM< AudioEncoder >.
◆ begin() [1/2]
|
inlinevirtual |
Reimplemented in RTSPFormatPCM, RTSPFormatOpus, RTSPFormatAbtX, RTSPFormatPCM8, RTSPFormatADPCM< AudioEncoder >, RTSPFormatMP3, and RTSPFormatAAC.
◆ begin() [2/2]
|
inlinevirtual |
◆ convert()
|
inlinevirtual |
Reimplemented in RTSPFormatPCM.
◆ defaultConfig()
|
pure virtual |
◆ defaultVideoConfig()
|
inlinevirtual |
Reimplemented in RTSPFormatMJPEG, and RTSPFormatH264.
◆ format()
|
pure virtual |
◆ fragmentSize()
|
inlinevirtual |
Fragment (=write) size in bytes.
Reimplemented in RTSPFormatMP3.
◆ mediaType()
|
inlinevirtual |
Reimplemented in RTSPFormatMJPEG, RTSPFormatH264, and RTSPFormatMTS.
◆ name()
|
inlinevirtual |
◆ readHeader()
|
inlinevirtual |
Optional header: e.g. rfc2250.
◆ rtpPayloadType()
|
inlinevirtual |
default dynamic
Reimplemented in RTSPFormatPCM, RTSPFormatMP3, RTSPFormatMJPEG, RTSPFormatH264, and RTSPFormatMTS.
◆ setFragmentSize()
|
inline |
Defines the fragment size in bytes.
◆ setName()
|
inline |
Defines the name of the stream.
◆ setProfileLevelId()
|
inlinevirtual |
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()
|
inlinevirtual |
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()
|
inline |
Defines the timer period in microseconds.
◆ setUseRfc2250Header()
|
inlinevirtual |
Optional: Configure RFC2250 header usage (default: no-op)
Reimplemented in RTSPFormatMP3.
◆ timerPeriodUs()
|
inlinevirtual |
Timer period in microseconds.
Reimplemented in RTSPFormatADPCM< AudioEncoder >, RTSPFormatMP3, and RTSPFormatMTS.
◆ timestampIncrement()
|
inlinevirtual |
Fragment size in samples (for audio) or timestamp increment (for video)
Reimplemented in RTSPFormatMP3, RTSPFormatMJPEG, and RTSPFormatH264.
◆ useRfc2250Header()
|
inlinevirtual |
Reimplemented in RTSPFormatMP3.
◆ videoInfo()
|
inlinevirtual |
Member Data Documentation
◆ cfg
|
protected |
◆ fragment_size
|
protected |
◆ name_str
|
protected |
◆ STD_URL_PRE_SUFFIX
|
protected |
◆ timer_period_us
|
protected |
◆ video_cfg
|
protected |
The documentation for this class was generated from the following file:
- src/AudioTools/Communication/RTSP/RTSPFormat.h
