Bånder

Apic extends Frame
in package

The Attached picture frame contains a picture directly related to the audio file.

There may be several pictures attached to one file, each in their individual APIC frame, but only one with the same content descriptor. There may only be one picture with the same picture type.

Table of Contents

Properties

$types  : array<string|int, mixed>
The list of image types.
$description  : string
$encoding  : int
$frameId  : string
$imageData  : string
$imageSize  : int
$imageType  : int
$mimeType  : string

Methods

__construct()  : void
Constructs the Frame class with given parameters.
getDescription()  : string
Returns the description.
getEncoding()  : int
Returns the text encoding.
getImageData()  : string
Returns the image data.
getImageSize()  : int
Returns the image size.
getImageType()  : int
Returns the image type.
getMimeType()  : string
Returns the MIME type.
parse()  : self
Parses the frame data.
setDescription()  : self
Sets the description.
setEncoding()  : self
Sets the text encoding.
setImageData()  : self
Sets the image data.
setImageType()  : self
Sets the image type.
setMimeType()  : self
Sets the MIME type.
toBytes()  : string
Converts the frame to binary data.

Properties

$types

The list of image types.

public static array<string|int, mixed> $types = ['Other', '32x32 pixels file icon (PNG only)', 'Other file icon', 'Cover (front)', 'Cover (back)', 'Leaflet page', 'Media (e.g. label side of CD)', 'Lead artist/lead performer/soloist', 'Artist/performer', 'Conductor', 'Band/Orchestra', 'Composer', 'Lyricist/text writer', 'Recording Location', 'During recording', 'During performance', 'Movie/video screen capture', 'A bright coloured fish', 'Illustration', 'Band/artist logotype', 'Publisher/Studio logotype']

$description

protected string $description = ''

$encoding

protected int $encoding = Encoding::UTF8

$frameId

protected string $frameId
Hooks
protected string get

$imageData

protected string $imageData = ''

$imageSize

protected int $imageSize = 0

$imageType

protected int $imageType = 0

$mimeType

protected string $mimeType = 'image/unknown'

Methods

__construct()

Constructs the Frame class with given parameters.

public __construct([array<string|int, mixed>|null $data = null ][, int $encoding = Encoding::UTF8 ]) : void
Parameters
$data : array<string|int, mixed>|null = null

{ mimeType: string, The MIME type. imageType: int, The image type. description: string, The description. imageData: string The image data. }

$encoding : int = Encoding::UTF8

The encoding of the frame data.

getDescription()

Returns the description.

public getDescription() : string
Return values
string

getEncoding()

Returns the text encoding.

public getEncoding() : int
Return values
int

getImageData()

Returns the image data.

public getImageData() : string
Return values
string

getImageSize()

Returns the image size.

public getImageSize() : int
Return values
int

getImageType()

Returns the image type.

public getImageType() : int
Return values
int

getMimeType()

Returns the MIME type.

public getMimeType() : string
Return values
string

parse()

Parses the frame data.

public parse(string $frameData) : self
Parameters
$frameData : string
Return values
self

setDescription()

Sets the description.

public setDescription(string $description) : self
Parameters
$description : string
Return values
self

setEncoding()

Sets the text encoding.

public setEncoding(int $encoding) : self
Parameters
$encoding : int
Return values
self

setImageData()

Sets the image data.

public setImageData(string $imageData) : self
Parameters
$imageData : string
Return values
self

setImageType()

Sets the image type.

public setImageType(int $imageType) : self
Parameters
$imageType : int
Return values
self

setMimeType()

Sets the MIME type.

public setMimeType(string $mimeType) : self
Parameters
$mimeType : string
Return values
self

toBytes()

Converts the frame to binary data.

public toBytes() : string
Return values
string

        
On this page

Search results