TPE1
extends TextFrame
in package
TPE1 frame - Lead performer(s)/Soloist(s).
The 'Lead performer(s)/Soloist(s)' frame is used for the main artist(s). They are separated with the "/" character.
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructs the TPE1 frame with given parameters.
- getArtist() : string
- Returns the artist.
- getArtists() : array<string|int, string>
- Returns the artists as an array.
- getEncoding() : int
- Returns the text encoding.
- getText() : string
- Returns the text content.
- parse() : self
- Parses the frame data.
- setArtist() : self
- Sets the artist.
- setArtists() : self
- Sets the artists from an array.
- setEncoding() : self
- Sets the text encoding.
- 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 TPE1 frame with given parameters.
public
__construct([string $artist = '' ][, int $encoding = Encoding::UTF8 ]) : mixed
Parameters
- $artist : string = ''
-
The artist
- $encoding : int = Encoding::UTF8
-
The text encoding
getArtist()
Returns the artist.
public
getArtist() : string
Return values
stringgetArtists()
Returns the artists as an array.
public
getArtists() : array<string|int, string>
Return values
array<string|int, string>getEncoding()
Returns the text encoding.
public
getEncoding() : int
Return values
intgetText()
Returns the text content.
public
getText() : string
Return values
stringparse()
Parses the frame data.
public
parse(string $frameData) : self
Parameters
- $frameData : string
Return values
selfsetArtist()
Sets the artist.
public
setArtist(string $artist) : self
Parameters
- $artist : string
-
The artist
Return values
selfsetArtists()
Sets the artists from an array.
public
setArtists(array<string|int, string> $artists) : self
Parameters
- $artists : array<string|int, string>
-
The artists
Return values
selfsetEncoding()
Sets the text encoding.
public
setEncoding(int $encoding) : self
Parameters
- $encoding : int
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