DASHIF\ModuleCMAF Class Reference

Inheritance diagram for DASHIF\ModuleCMAF:

Public Member Functions
	handleArguments ()
	detectFromManifest ()
	hookBeforeRepresentation ()
	hookRepresentation ()
	hookBeforeAdaptationSet ()
	hookAdaptationSet ()
Public Member Functions inherited from DASHIF\ModuleInterface
	isEnabled ()
	setEnabled ($newVal)
	hookBeforeMPD ()
	Checks if pre-conditions for MPD Validation are met. More...
	hookMPD ()
	hookPeriod ()
	hookLiveMpd ($mpd, $nextMpd)

Protected Member Functions
	addCLIArguments ()
Protected Member Functions inherited from DASHIF\ModuleInterface
	message ($message)

Additional Inherited Members
Public Attributes inherited from DASHIF\ModuleInterface
	$name
	$detected
Protected Attributes inherited from DASHIF\ModuleInterface
	$enabled
	$messages
	$warnings
	$errors

Member Function Documentation

hookAdaptationSet()

DASHIF\ModuleCMAF::hookAdaptationSet

(

)

A hook that is run after running a crossRepresentationProcess. Return value is added to the same array as hookBeforeRepresentation. Return values are ignored.

Module Usage

• CMAF (!!hookAll!!)
  • Runs checks on the presentation
    • Selectionset
    • AlignedSwitchingSets
  • Returns an array of errors.
• CTAWAVE
  • Runs SelectionSet checks
  • Runs Presentation checks
  • No return value
• HBBTV_DVB
  • Creates a content protection report
  • Runs crossvalidation over the adaptation sets.
  • No return value
• IOP
  • Runs crossvalidation over the adaptation sets.
  • No return value
• LOW_LATENCY
  • Runs crossvalidation over the adaptation sets.
  • No return value

Reimplemented from DASHIF\ModuleInterface.

hookBeforeAdaptationSet()

DASHIF\ModuleCMAF::hookBeforeAdaptationSet

(

)

A hook that is run after running a crossRepresentationProcess. Return value is added to the same array as hookBeforeRepresentation.

Module Usage

• HBBTV_DVB
  • Calls a function that removes images from an html file, leaving the html crippled.
• CMAF (!!hookAdaptationSet!!)
  • Compares switching sets against eachother, writes report report to txt file
  • Returns an array of errors.

Reimplemented from DASHIF\ModuleInterface.

hookBeforeRepresentation()

DASHIF\ModuleCMAF::hookBeforeRepresentation

(

)

A hook that is run before downloading and validating the first segment of each period-adaptationset combination. Return value is ignored

Module Usage

• CMAF
  • Unconditionally appends to the $additional_flags global parameter
  • No return value
• CTAWAVE (!!hookTracks!!)
  • Unconditionally appends to the $additional_flags global parameter
  • No return value
• HBBTV_DVB
  • Conditionally appends to the $additional_flags global parameter
  • Returns whether the current representation is a subtitle.
    • Creates a folder for the subtitles if any subtitle representation is found.

Reimplemented from DASHIF\ModuleInterface.

hookRepresentation()

DASHIF\ModuleCMAF::hookRepresentation

(

)

A hook that is run after downloading and validating the first segment of each period-adaptationset combination. Return value is added to an unnamed aray and used for reporting.

Module Usage

• CMAF
  • Only if representation xml exists:
    • Creates a file for writing errors/logs for the current representation.
    • Runs various checks, and writes their output to the error/log file.
  • Returns an array with 1 element, either 'noerror' 'warning' or 'error' depending on the contents of the error/log file.
• HBBTV_DVB
  • Creates a file for writing errors/logs for the current representation.
  • Runs various checks, and writes their output to the error/log file.
  • Adds images to the global $string_info variable
    • Duplicated html ids when called on a stream with multiple representations
    • Remove option of add_remove_images is completely broken.
  • Returns an array with 1 element, either 'noerror' 'warning' or 'error' depending on the contents of the error/log file.
• IOP
  • Runs only if representation xml file exists
  • Runs checks, saves in internal buffer
  • Writes internal buffer to error/log file
  • Reads error/log file for returncode parsing
  • Returns an array with 1 element, either 'noerror' 'warning' or 'error' depending on the contents of the error/log file.

Reimplemented from DASHIF\ModuleInterface.

---

The documentation for this class was generated from the following file:

• CMAF/module.php