Bånder

SYLT extends Frame
in package

SYLT frame - Synchronized lyric/text.

The 'Synchronized lyric/text' frame is another way of incorporating the lyrics in the audio file, but this time in sync with the audio. It might also be used to describe events occurring on a stage or on the screen in sync with the audio.

Table of Contents

Constants

FORMAT_MILLISECONDS  = 2
FORMAT_MPEG_FRAMES  = 1
Time format constants.
TYPE_CHORD  = 5
TYPE_EVENTS  = 4
TYPE_LYRICS  = 1
TYPE_MOVEMENT_PART_NAME  = 3
TYPE_OTHER  = 0
Content type constants.
TYPE_TEXT_TRANSCRIPTION  = 2
TYPE_TRIVIA  = 6
TYPE_URLS_TO_IMAGES  = 8
TYPE_URLS_TO_WEBPAGES  = 7

Properties

$description  : string
$encoding  : int
$events  : array<string|int, mixed>
$format  : int
$frameId  : string
$language  : string
$type  : int

Methods

__construct()  : mixed
Constructs the SYLT frame with given parameters.
getDescription()  : string
Returns the description.
getEncoding()  : int
Returns the text encoding.
getEvents()  : array<string|int, mixed>
Returns the events with their timestamps.
getFormat()  : int
Returns the time format.
getLanguage()  : string
Returns the language code.
getType()  : int
Returns the content type.
parse()  : self
Parses the frame data.
setDescription()  : self
Sets the description.
setEncoding()  : self
Sets the text encoding.
setEvents()  : self
Sets the events with their timestamps.
setFormat()  : self
Sets the time format.
setLanguage()  : self
Sets the language code.
setType()  : self
Sets the content type.
toBytes()  : string
Converts the frame to binary data.

Constants

FORMAT_MILLISECONDS

public mixed FORMAT_MILLISECONDS = 2

FORMAT_MPEG_FRAMES

Time format constants.

public mixed FORMAT_MPEG_FRAMES = 1

TYPE_CHORD

public mixed TYPE_CHORD = 5

TYPE_EVENTS

public mixed TYPE_EVENTS = 4

TYPE_LYRICS

public mixed TYPE_LYRICS = 1

TYPE_MOVEMENT_PART_NAME

public mixed TYPE_MOVEMENT_PART_NAME = 3

TYPE_OTHER

Content type constants.

public mixed TYPE_OTHER = 0

TYPE_TEXT_TRANSCRIPTION

public mixed TYPE_TEXT_TRANSCRIPTION = 2

TYPE_TRIVIA

public mixed TYPE_TRIVIA = 6

TYPE_URLS_TO_IMAGES

public mixed TYPE_URLS_TO_IMAGES = 8

TYPE_URLS_TO_WEBPAGES

public mixed TYPE_URLS_TO_WEBPAGES = 7

Properties

$description

protected string $description = ''

$encoding

protected int $encoding = Encoding::UTF8

$events

protected array<string|int, mixed> $events = []

$format

protected int $format = self::FORMAT_MILLISECONDS

$frameId

protected string $frameId
Hooks
protected string get

$language

protected string $language = 'eng'

$type

protected int $type = self::TYPE_LYRICS

Methods

__construct()

Constructs the SYLT frame with given parameters.

public __construct([array<string|int, mixed> $events = [] ][, string $description = '' ][, string $language = 'eng' ][, int $format = self::FORMAT_MILLISECONDS ][, int $type = self::TYPE_LYRICS ][, int $encoding = Encoding::UTF8 ]) : mixed
Parameters
$events : array<string|int, mixed> = []
$description : string = ''
$language : string = 'eng'
$format : int = self::FORMAT_MILLISECONDS
$type : int = self::TYPE_LYRICS
$encoding : int = Encoding::UTF8

getDescription()

Returns the description.

public getDescription() : string
Return values
string

getEncoding()

Returns the text encoding.

public getEncoding() : int
Return values
int

getEvents()

Returns the events with their timestamps.

public getEvents() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFormat()

Returns the time format.

public getFormat() : int
Return values
int

getLanguage()

Returns the language code.

public getLanguage() : string
Return values
string

getType()

Returns the content type.

public getType() : int
Return values
int

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

setEvents()

Sets the events with their timestamps.

public setEvents(array<string|int, mixed> $events) : self
Parameters
$events : array<string|int, mixed>
Return values
self

setFormat()

Sets the time format.

public setFormat(int $format) : self
Parameters
$format : int
Return values
self

setLanguage()

Sets the language code.

public setLanguage(string $language) : self
Parameters
$language : string
Return values
self

setType()

Sets the content type.

public setType(int $type) : self
Parameters
$type : int
Return values
self

toBytes()

Converts the frame to binary data.

public toBytes() : string
Return values
string

        
On this page

Search results