EQUA
extends Frame
in package
EQUA frame - Equalization.
The 'Equalization' frame allows the user to adjust the audio to their taste by specifying frequency adjustments. It contains an adjustment bit and a list of frequency/adjustment pairs.
Table of Contents
Properties
- $adjustmentBit : bool
- $adjustments : array<string|int, mixed>
- $encoding : int
- $frameId : string
Methods
- __construct() : mixed
- Constructs the EQUA frame with given parameters.
- addAdjustment() : self
- Adds a frequency adjustment.
- getAdjustmentBit() : bool
- Returns the adjustment bit.
- getAdjustments() : array<string|int, mixed>
- Returns the frequency adjustments.
- getEncoding() : int
- Returns the text encoding.
- parse() : self
- Parses the frame data.
- setAdjustmentBit() : self
- Sets the adjustment bit.
- setAdjustments() : self
- Sets the frequency adjustments.
- setEncoding() : self
- Sets the text encoding.
- toBytes() : string
- Converts the frame to binary data.
Properties
$adjustmentBit
protected
bool
$adjustmentBit
= false
$adjustments
protected
array<string|int, mixed>
$adjustments
= []
$encoding
protected
int
$encoding
= Encoding::UTF8
$frameId
protected
string
$frameId
Hooks
protected
string
get
Methods
__construct()
Constructs the EQUA frame with given parameters.
public
__construct([bool $adjustmentBit = false ][, array<string|int, mixed> $adjustments = [] ]) : mixed
Parameters
- $adjustmentBit : bool = false
- $adjustments : array<string|int, mixed> = []
addAdjustment()
Adds a frequency adjustment.
public
addAdjustment(int $frequency, int $adjustment) : self
Parameters
- $frequency : int
- $adjustment : int
Return values
selfgetAdjustmentBit()
Returns the adjustment bit.
public
getAdjustmentBit() : bool
Return values
boolgetAdjustments()
Returns the frequency adjustments.
public
getAdjustments() : array<string|int, mixed>
Return values
array<string|int, mixed>getEncoding()
Returns the text encoding.
public
getEncoding() : int
Return values
intparse()
Parses the frame data.
public
parse(string $frameData) : self
Parameters
- $frameData : string
Return values
selfsetAdjustmentBit()
Sets the adjustment bit.
public
setAdjustmentBit(bool $adjustmentBit) : self
Parameters
- $adjustmentBit : bool
Return values
selfsetAdjustments()
Sets the frequency adjustments.
public
setAdjustments(array<string|int, mixed> $adjustments) : self
Parameters
- $adjustments : array<string|int, mixed>
Return values
selfsetEncoding()
Sets the text encoding.
public
setEncoding(int $encoding) : self
Parameters
- $encoding : int
Return values
selftoBytes()
Converts the frame to binary data.
public
toBytes() : string