Miam-Player  0.8.0
A nice music player
TagLib::ID3v2::EventTimingCodesFrame Class Reference

ID3v2 event timing codes frame. More...

#include <eventtimingcodesframe.h>

Inheritance diagram for TagLib::ID3v2::EventTimingCodesFrame:
TagLib::ID3v2::Frame TagLib::ID3v2::Header

Classes

struct  SynchedEvent
 Single entry of time stamp and event. More...
 

Public Types

enum  TimestampFormat { Unknown = 0x00, AbsoluteMpegFrames = 0x01, AbsoluteMilliseconds = 0x02 }
 Specifies the timestamp format used. More...
 
enum  EventType {
  Padding = 0x00, EndOfInitialSilence = 0x01, IntroStart = 0x02, MainPartStart = 0x03,
  OutroStart = 0x04, OutroEnd = 0x05, VerseStart = 0x06, RefrainStart = 0x07,
  InterludeStart = 0x08, ThemeStart = 0x09, VariationStart = 0x0a, KeyChange = 0x0b,
  TimeChange = 0x0c, MomentaryUnwantedNoise = 0x0d, SustainedNoise = 0x0e, SustainedNoiseEnd = 0x0f,
  IntroEnd = 0x10, MainPartEnd = 0x11, VerseEnd = 0x12, RefrainEnd = 0x13,
  ThemeEnd = 0x14, Profanity = 0x15, ProfanityEnd = 0x16, NotPredefinedSynch0 = 0xe0,
  NotPredefinedSynch1 = 0xe1, NotPredefinedSynch2 = 0xe2, NotPredefinedSynch3 = 0xe3, NotPredefinedSynch4 = 0xe4,
  NotPredefinedSynch5 = 0xe5, NotPredefinedSynch6 = 0xe6, NotPredefinedSynch7 = 0xe7, NotPredefinedSynch8 = 0xe8,
  NotPredefinedSynch9 = 0xe9, NotPredefinedSynchA = 0xea, NotPredefinedSynchB = 0xeb, NotPredefinedSynchC = 0xec,
  NotPredefinedSynchD = 0xed, NotPredefinedSynchE = 0xee, NotPredefinedSynchF = 0xef, AudioEnd = 0xfd,
  AudioFileEnds = 0xfe
}
 Event types defined in id3v2.4.0-frames.txt 4.5. More...
 
typedef TagLib::List< SynchedEventSynchedEventList
 List of synchronized events. More...
 

Public Member Functions

 EventTimingCodesFrame ()
 Construct an empty event timing codes frame. More...
 
 EventTimingCodesFrame (const ByteVector &data)
 Construct a event timing codes frame based on the data in data. More...
 
virtual ~EventTimingCodesFrame ()
 Destroys this EventTimingCodesFrame instance. More...
 
virtual String toString () const
 Returns a null string. More...
 
TimestampFormat timestampFormat () const
 Returns the timestamp format. More...
 
SynchedEventList synchedEvents () const
 Returns the events with the time stamps. More...
 
void setTimestampFormat (TimestampFormat f)
 Set the timestamp format. More...
 
void setSynchedEvents (const SynchedEventList &e)
 Sets the text with the time stamps. More...
 
- Public Member Functions inherited from TagLib::ID3v2::Frame
virtual ~Frame ()
 Destroys this Frame instance. More...
 
ByteVector frameID () const
 Returns the Frame ID (Structure, 4) (Frames, 4) More...
 
unsigned int size () const
 Returns the size of the frame. More...
 
void setData (const ByteVector &data)
 Sets the data that will be used as the frame. More...
 
virtual void setText (const String &text)
 Set the text of frame in the sanest way possible. More...
 
ByteVector render () const
 Render the frame back to its binary format in a ByteVector. More...
 
 Header (const ByteVector &data, bool synchSafeInts)
 Construct a Frame Header based on data. More...
 
 Header (const ByteVector &data, unsigned int version=4)
 Construct a Frame Header based on data. More...
 
virtual ~Header ()
 Destroys this Header instance. More...
 
void setData (const ByteVector &data, bool synchSafeInts)
 Sets the data for the Header. More...
 
void setData (const ByteVector &data, unsigned int version=4)
 Sets the data for the Header. More...
 
ByteVector frameID () const
 Returns the Frame ID (Structure, 4) (Frames, 4) More...
 
void setFrameID (const ByteVector &id)
 Sets the frame's ID to id. More...
 
unsigned int frameSize () const
 Returns the size of the frame data portion, as set when setData() was called or set explicitly via setFrameSize(). More...
 
void setFrameSize (unsigned int size)
 Sets the size of the frame data portion. More...
 
unsigned int version () const
 Returns the ID3v2 version of the header, as passed in from the construction of the header or set via setVersion(). More...
 
void setVersion (unsigned int version)
 Sets the ID3v2 version of the header, changing has impact on the correct parsing/rendering of frame data. More...
 
bool tagAlterPreservation () const
 Returns true if the flag for tag alter preservation is set. More...
 
void setTagAlterPreservation (bool discard)
 Sets the flag for preservation of this frame if the tag is set. More...
 
bool fileAlterPreservation () const
 Returns true if the flag for file alter preservation is set. More...
 
bool readOnly () const
 Returns true if the frame is meant to be read only. More...
 
bool groupingIdentity () const
 Returns true if the flag for the grouping identity is set. More...
 
bool compression () const
 Returns true if compression is enabled for this frame. More...
 
bool encryption () const
 Returns true if encryption is enabled for this frame. More...
 
bool unsycronisation () const
 
bool unsynchronisation () const
 Returns true if unsynchronisation is enabled for this frame. More...
 
bool dataLengthIndicator () const
 Returns true if the flag for a data length indicator is set. More...
 
ByteVector render () const
 Render the Header back to binary format in a ByteVector. More...
 
bool frameAlterPreservation () const
 

Protected Member Functions

virtual void parseFields (const ByteVector &data)
 Called by parse() to parse the field data. More...
 
virtual ByteVector renderFields () const
 Render the field data back to a binary format in a ByteVector. More...
 
- Protected Member Functions inherited from TagLib::ID3v2::Frame
 Frame (const ByteVector &data)
 Constructs an ID3v2 frame using data to read the header information. More...
 
 Frame (Header *h)
 This creates an Frame using the header h. More...
 
Headerheader () const
 Returns a pointer to the frame header. More...
 
void setHeader (Header *h, bool deleteCurrent=true)
 Sets the header to h. More...
 
void parse (const ByteVector &data)
 Called by setData() to parse the frame data. More...
 
ByteVector fieldData (const ByteVector &frameData) const
 Returns a ByteVector containing the field data given the frame data. More...
 
String readStringField (const ByteVector &data, String::Type encoding, int *positon=0)
 Reads a String of type encoding from the ByteVector data. More...
 
String::Type checkTextEncoding (const StringList &fields, String::Type encoding) const
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
PropertyMap asProperties () const
 Parses the contents of this frame as PropertyMap. More...
 

Friends

class FrameFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from TagLib::ID3v2::Frame
static FramecreateTextualFrame (const String &key, const StringList &values)
 Creates a textual frame which corresponds to a single key in the PropertyMap interface. More...
 
static unsigned int headerSize ()
 Returns the size of the frame header. More...
 
static unsigned int headerSize (unsigned int version)
 Returns the size of the frame header for the given ID3v2 version. More...
 
static ByteVector textDelimiter (String::Type t)
 Returns the text delimiter that is used between fields for the string type t. More...
 
static unsigned int size ()
 Returns the size of the frame header in bytes. More...
 
static unsigned int size (unsigned int version)
 Returns the size of the frame header in bytes for the ID3v2 version that's given. More...
 
- Static Public Attributes inherited from TagLib::ID3v2::Frame
static const String instrumentPrefix
 The string with which an instrument name is prefixed to build a key in a PropertyMap; used to translate PropertyMaps to TMCL frames. More...
 
static const String commentPrefix
 The PropertyMap key prefix which triggers the use of a COMM frame instead of a TXXX frame for a non-standard key. More...
 
static const String lyricsPrefix
 The PropertyMap key prefix which triggers the use of a USLT frame instead of a TXXX frame for a non-standard key. More...
 
static const String urlPrefix
 The PropertyMap key prefix which triggers the use of a WXXX frame instead of a TXX frame for a non-standard key. More...
 
- Static Protected Member Functions inherited from TagLib::ID3v2::Frame
static String::Type checkEncoding (const StringList &fields, String::Type encoding)
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
static String::Type checkEncoding (const StringList &fields, String::Type encoding, unsigned int version)
 Checks a the list of string values to see if they can be used with the specified encoding and returns the recommended encoding. More...
 
static ByteVector keyToFrameID (const String &)
 Returns an appropriate ID3 frame ID for the given free-form tag key. More...
 
static String frameIDToKey (const ByteVector &)
 Returns a free-form tag name for the given ID3 frame ID. More...
 
static String keyToTXXX (const String &)
 Returns an appropriate TXXX frame description for the given free-form tag key. More...
 
static String txxxToKey (const String &)
 Returns a free-form tag name for the given ID3 frame description. More...
 
static void splitProperties (const PropertyMap &original, PropertyMap &singleFrameProperties, PropertyMap &tiplProperties, PropertyMap &tmclProperties)
 This helper function splits the PropertyMap original into three ProperytMaps singleFrameProperties, tiplProperties, and tmclProperties, such that: More...
 

Detailed Description

ID3v2 event timing codes frame.

An implementation of ID3v2 event timing codes.

Member Typedef Documentation

◆ SynchedEventList

Member Enumeration Documentation

◆ EventType

Event types defined in id3v2.4.0-frames.txt 4.5.

Event timing codes.

Enumerator
Padding 
EndOfInitialSilence 
IntroStart 
MainPartStart 
OutroStart 
OutroEnd 
VerseStart 
RefrainStart 
InterludeStart 
ThemeStart 
VariationStart 
KeyChange 
TimeChange 
MomentaryUnwantedNoise 
SustainedNoise 
SustainedNoiseEnd 
IntroEnd 
MainPartEnd 
VerseEnd 
RefrainEnd 
ThemeEnd 
Profanity 
ProfanityEnd 
NotPredefinedSynch0 
NotPredefinedSynch1 
NotPredefinedSynch2 
NotPredefinedSynch3 
NotPredefinedSynch4 
NotPredefinedSynch5 
NotPredefinedSynch6 
NotPredefinedSynch7 
NotPredefinedSynch8 
NotPredefinedSynch9 
NotPredefinedSynchA 
NotPredefinedSynchB 
NotPredefinedSynchC 
NotPredefinedSynchD 
NotPredefinedSynchE 
NotPredefinedSynchF 
AudioEnd 
AudioFileEnds 

◆ TimestampFormat

Specifies the timestamp format used.

Enumerator
Unknown 

The timestamp is of unknown format.

AbsoluteMpegFrames 

The timestamp represents the number of MPEG frames since the beginning of the audio stream.

AbsoluteMilliseconds 

The timestamp represents the number of milliseconds since the beginning of the audio stream.

Constructor & Destructor Documentation

◆ EventTimingCodesFrame() [1/2]

TagLib::ID3v2::EventTimingCodesFrame::EventTimingCodesFrame ( )
explicit

Construct an empty event timing codes frame.

◆ EventTimingCodesFrame() [2/2]

TagLib::ID3v2::EventTimingCodesFrame::EventTimingCodesFrame ( const ByteVector data)
explicit

Construct a event timing codes frame based on the data in data.

◆ ~EventTimingCodesFrame()

virtual TagLib::ID3v2::EventTimingCodesFrame::~EventTimingCodesFrame ( )
virtual

Destroys this EventTimingCodesFrame instance.

Member Function Documentation

◆ parseFields()

virtual void TagLib::ID3v2::EventTimingCodesFrame::parseFields ( const ByteVector data)
protectedvirtual

Called by parse() to parse the field data.

It makes this information available through the public API. This must be overridden by the subclasses.

Implements TagLib::ID3v2::Frame.

◆ renderFields()

virtual ByteVector TagLib::ID3v2::EventTimingCodesFrame::renderFields ( ) const
protectedvirtual

Render the field data back to a binary format in a ByteVector.

This must be overridden by subclasses.

Implements TagLib::ID3v2::Frame.

◆ setSynchedEvents()

void TagLib::ID3v2::EventTimingCodesFrame::setSynchedEvents ( const SynchedEventList e)

Sets the text with the time stamps.

See also
text()

◆ setTimestampFormat()

void TagLib::ID3v2::EventTimingCodesFrame::setTimestampFormat ( TimestampFormat  f)

Set the timestamp format.

See also
timestampFormat()

◆ synchedEvents()

SynchedEventList TagLib::ID3v2::EventTimingCodesFrame::synchedEvents ( ) const

Returns the events with the time stamps.

◆ timestampFormat()

TimestampFormat TagLib::ID3v2::EventTimingCodesFrame::timestampFormat ( ) const

Returns the timestamp format.

◆ toString()

virtual String TagLib::ID3v2::EventTimingCodesFrame::toString ( ) const
virtual

Returns a null string.

Implements TagLib::ID3v2::Frame.

Friends And Related Function Documentation

◆ FrameFactory

friend class FrameFactory
friend

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