IPLS
extends Frame
in package
IPLS frame - Involved people list.
The 'Involved people list' frame is intended to store the names of those involved in the creation of the audio file, and their involvement. The frame consists of pairs of names and involvements, separated by null bytes.
Table of Contents
Properties
Methods
- __construct() : mixed
- Constructs the IPLS frame with given parameters.
- addPerson() : self
- Adds a person to the involved people list.
- getEncoding() : int
- Returns the text encoding.
- getPeople() : array<string|int, mixed>
- Returns the involved people list.
- parse() : self
- Parses the frame data.
- setEncoding() : self
- Sets the text encoding.
- setPeople() : self
- Sets the involved people list.
- toBytes() : string
- Converts the frame to binary data.
Properties
$encoding
protected
int
$encoding
= Encoding::UTF8
$frameId
protected
string
$frameId
Hooks
protected
string
get
$people
protected
array<string|int, mixed>
$people
= []
Methods
__construct()
Constructs the IPLS frame with given parameters.
public
__construct([array<string|int, mixed> $people = [] ][, int $encoding = Encoding::UTF8 ]) : mixed
Parameters
- $people : array<string|int, mixed> = []
- $encoding : int = Encoding::UTF8
addPerson()
Adds a person to the involved people list.
public
addPerson(string $name, string $involvement) : self
Parameters
- $name : string
- $involvement : string
Return values
selfgetEncoding()
Returns the text encoding.
public
getEncoding() : int
Return values
intgetPeople()
Returns the involved people list.
public
getPeople() : array<string|int, mixed>
Return values
array<string|int, mixed>parse()
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
selfsetPeople()
Sets the involved people list.
public
setPeople(array<string|int, mixed> $people) : self
Parameters
- $people : array<string|int, mixed>
Return values
selftoBytes()
Converts the frame to binary data.
public
toBytes() : string