Docs For Class SmpteOffsetEvent

Class SmpteOffsetEvent

Description

Class SmpteOffsetEvent

since: 1.0

Located in /Event/SmpteOffsetEvent.php (line 21)

MetaEvent
   |
   --SmpteOffsetEvent

Method Summary

static string getFrameRateDescription (int $frameRate)

SmpteOffsetEvent __construct (int $frameRate, int $hour, int $min, int $second, int $frame, int $subframe)

string getParamDescription ()

int getSubtype ()

Variables

Inherited Variables

Inherited from MetaEvent

MetaEvent::$data
MetaEvent::$length

Methods

static method getFrameRateDescription (line 66)

Gets the user-friendly description of the different frame rate types

since: 1.0
throws: InvalidArgumentException
access: public
usedby: SmpteOffsetEvent::getParamDescription()

static string getFrameRateDescription (int $frameRate)

int $frameRate: Valid values: 0-3

Constructor __construct (line 35)

Constructor

since: 1.0
access: public

SmpteOffsetEvent __construct (int $frameRate, int $hour, int $min, int $second, int $frame, int $subframe)

int $frameRate: Valid values: 0 (24fps), 1 (25fps), 2 (30fps drop frame), 3 (30fps)
int $hour: Valid values: 0-23
int $min: Valid values: 0-59
int $second: Valid values: 0-59
int $frame: Valid values: 0-59
int $subframe: Valid values: 0-99

Redefinition of:

MetaEvent::__construct(): Constructor

getParamDescription (line 45)

since: 1.0
access: public
uses: SmpteOffsetEvent::getFrameRateDescription()

string getParamDescription ()

getSubtype (line 87)

since: 1.0
access: public
uses: MetaEventType::SMPTE_OFFSET

int getSubtype ()

Redefinition of:

MetaEvent::getSubtype(): Gets the meta event subtype for this event

Inherited Methods

Inherited From MetaEvent

MetaEvent::__construct()
MetaEvent::getData()
MetaEvent::getLength()
MetaEvent::getSubtype()
MetaEvent::getType()
MetaEvent::toBinary()
MetaEvent::__toString()

Documentation generated on Sun, 25 Oct 2009 22:38:20 -0700 by phpDocumentor 1.4.3