TLAN
extends TextFrame
in package
TLAN frame - Language(s).
The 'Language(s)' frame should contain the languages of the text or lyrics spoken or sung in the audio. The language is represented with three characters according to ISO-639-2. If more than one language is used in the text, their language codes should follow according to the amount of their usage.
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructs the TLAN frame with given parameters.
- getEncoding() : int
- Returns the text encoding.
- getLanguage() : string
- Returns the language(s).
- getText() : string
- Returns the text content.
- parse() : self
- Parses the frame data.
- setEncoding() : self
- Sets the text encoding.
- setLanguage() : self
- Sets the language(s).
- 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 TLAN frame with given parameters.
public
__construct([string $language = '' ][, int $encoding = Encoding::UTF8 ]) : mixed
Parameters
- $language : string = ''
- $encoding : int = Encoding::UTF8
getEncoding()
Returns the text encoding.
public
getEncoding() : int
Return values
intgetLanguage()
Returns the language(s).
public
getLanguage() : 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
selfsetLanguage()
Sets the language(s).
public
setLanguage(string $language) : self
Parameters
- $language : 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