LINK
extends Frame
in package
LINK frame - Linked information.
The 'Linked information' frame is used to link information from another ID3v2 tag that might be present in another audio file or alone in a binary file. It consists of a frame identifier, URL, and additional data.
Table of Contents
Properties
- $additionalData : string
- $encoding : int
- $frameId : string
- $frameIdentifier : string
- $url : string
Methods
- __construct() : mixed
- Constructs the LINK frame with given parameters.
- getAdditionalData() : string
- Returns the additional data.
- getEncoding() : int
- Returns the text encoding.
- getFrameIdentifier() : string
- Returns the frame identifier.
- getUrl() : string
- Returns the URL.
- parse() : self
- Parses the frame data.
- setAdditionalData() : self
- Sets the additional data.
- setEncoding() : self
- Sets the text encoding.
- setFrameIdentifier() : self
- Sets the frame identifier.
- setUrl() : self
- Sets the URL.
- toBytes() : string
- Converts the frame to binary data.
Properties
$additionalData
protected
string
$additionalData
= ''
$encoding
protected
int
$encoding
= Encoding::UTF8
$frameId
protected
string
$frameId
Hooks
protected
string
get
$frameIdentifier
protected
string
$frameIdentifier
= ''
$url
protected
string
$url
= ''
Methods
__construct()
Constructs the LINK frame with given parameters.
public
__construct([string $frameIdentifier = '' ][, string $url = '' ][, string $additionalData = '' ]) : mixed
Parameters
- $frameIdentifier : string = ''
- $url : string = ''
- $additionalData : string = ''
getAdditionalData()
Returns the additional data.
public
getAdditionalData() : string
Return values
stringgetEncoding()
Returns the text encoding.
public
getEncoding() : int
Return values
intgetFrameIdentifier()
Returns the frame identifier.
public
getFrameIdentifier() : string
Return values
stringgetUrl()
Returns the URL.
public
getUrl() : string
Return values
stringparse()
Parses the frame data.
public
parse(string $frameData) : self
Parameters
- $frameData : string
Return values
selfsetAdditionalData()
Sets the additional data.
public
setAdditionalData(string $additionalData) : self
Parameters
- $additionalData : string
Return values
selfsetEncoding()
Sets the text encoding.
public
setEncoding(int $encoding) : self
Parameters
- $encoding : int
Return values
selfsetFrameIdentifier()
Sets the frame identifier.
public
setFrameIdentifier(string $frameIdentifier) : self
Parameters
- $frameIdentifier : string
Return values
selfsetUrl()
Sets the URL.
public
setUrl(string $url) : self
Parameters
- $url : string
Return values
selftoBytes()
Converts the frame to binary data.
public
toBytes() : string