Class to parse RTTTL files RTTTL (RingTone Text Transfer Language) format.
More...
#include <RtttlParser.h>
Class to parse RTTTL files RTTTL (RingTone Text Transfer Language) format.
- See also
- See https://en.wikipedia.org/wiki/Ring_Tone_Transfer_Language
◆ begin()
Initialise the parser with the given stream.
◆ end()
void RingTone::RtttlParser::end |
( |
| ) |
|
Release the source stream.
◆ getCaption()
String RingTone::RtttlParser::getCaption |
( |
| ) |
|
|
inline |
Get a display caption for the current tune.
◆ getCount()
unsigned RingTone::RtttlParser::getCount |
( |
| ) |
|
Get the number of tunes in this file.
◆ getHeader()
const RtttlHeader& RingTone::RtttlParser::getHeader |
( |
| ) |
|
|
inline |
◆ getIndex()
unsigned RingTone::RtttlParser::getIndex |
( |
| ) |
|
|
inline |
Get the current tune index.
◆ getState()
◆ getTitle()
const String& RingTone::RtttlParser::getTitle |
( |
| ) |
|
|
inline |
Get the current tune title.
◆ nextTune()
bool RingTone::RtttlParser::nextTune |
( |
| ) |
|
Locate next tune and read header.
◆ readNextNote()
Fetch the next note for this tune.
- Parameters
-
- Return values
-
bool | true on success, false if no more notes available |
Implements RingTone::Parser.
◆ rewind()
bool RingTone::RtttlParser::rewind |
( |
| ) |
|
|
inline |
◆ seekTune()
bool RingTone::RtttlParser::seekTune |
( |
unsigned |
index | ) |
|
Find a tune by index, starting at #0.
◆ setState()
The documentation for this class was generated from the following file: