PHP Class Captioning\Format\WebvttFile

Inheritance: extends Captioning\File

Show file Open project: captioning/captioning Class Usage Examples

Protected Properties

Property	Type	Description
$fileDescription	string
$regions	Captioning\Format\WebvttRegion[]

Public Methods

Method	Description
addRegion ( Captioning\Format\WebvttRegion $_region )
buildPart ( integer $_from, integer $_to )
getFileDescription ( ) : string
getRegion ( $_index ) : Captioning\Format\WebvttRegion \| null
getRegions ( ) : Captioning\Format\WebvttRegion[]
parse ( )
setFileDescription ( string $fileDescription )

Private Methods

Method	Description
createCue ( string $start, string $stop, string $text, string $settings, string $id, string $note ) : Captioning\Format\WebvttCue

Method Details

addRegion() public method

public addRegion ( Captioning\Format\WebvttRegion $_region )
$_region	Captioning\Format\WebvttRegion

buildPart() public method

public buildPart ( integer $_from, integer $_to )
$_from	integer
$_to	integer

getFileDescription() public method

public getFileDescription ( ) : string
return	string

getRegion() public method

public getRegion ( $_index ) : Captioning\Format\WebvttRegion \| null
$_index
return	Captioning\Format\WebvttRegion \| null

getRegions() public method

public getRegions ( ) : Captioning\Format\WebvttRegion[]
return	Captioning\Format\WebvttRegion[]

parse() public method

public parse ( )

setFileDescription() public method

public setFileDescription ( string $fileDescription )
$fileDescription	string

Property Details

$fileDescription protected property

protected string $fileDescription
return	string

$regions protected property

protected WebvttRegion[],Captioning\Format $regions
return	Captioning\Format\WebvttRegion[]