TEXT
extends TextFrame
in package
TEXT frame - Lyricist/Text writer.
The 'Lyricist/Text writer' frame is intended for the writer of the text or lyrics in the recording.
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructs the TEXT frame with given parameters.
- getEncoding() : int
- Returns the text encoding.
- getLyricist() : string
- Returns the lyricist/text writer.
- getText() : string
- Returns the text content.
- parse() : self
- Parses the frame data.
- setEncoding() : self
- Sets the text encoding.
- setLyricist() : self
- Sets the lyricist/text writer.
- setText() : self
- Sets the text content.
- toBytes() : string
- Converts the frame to binary data.
Properties
$encoding
protected
int
$encoding
= Encoding::UTF8
$frameId
protected
string
$frameId
Hooks
protected
string
get
$text
protected
string
$text
= ''
Methods
__construct()
Constructs the TEXT frame with given parameters.
public
__construct([string $lyricist = '' ][, int $encoding = Encoding::UTF8 ]) : mixed
Parameters
- $lyricist : string = ''
- $encoding : int = Encoding::UTF8
getEncoding()
Returns the text encoding.
public
getEncoding() : int
Return values
intgetLyricist()
Returns the lyricist/text writer.
public
getLyricist() : string
Return values
stringgetText()
Returns the text content.
public
getText() : string
Return values
stringparse()
Parses the frame data.
public
parse(string $frameData) : self
Parameters
- $frameData : string
Return values
selfsetEncoding()
Sets the text encoding.
public
setEncoding(int $encoding) : self
Parameters
- $encoding : int
Return values
selfsetLyricist()
Sets the lyricist/text writer.
public
setLyricist(string $lyricist) : self
Parameters
- $lyricist : string
Return values
selfsetText()
Sets the text content.
public
setText(string $text) : self
Parameters
- $text : string
Return values
selftoBytes()
Converts the frame to binary data.
public
toBytes() : string