DASHIF\ModuleDASHInteroperability Class Reference

Inheritance diagram for DASHIF\ModuleDASHInteroperability:

Public Member Functions
	handleArguments ()
	detectFromManifest ()
	hookMPD ()
	hookRepresentation ()
	hookAdaptationSet ()
Public Member Functions inherited from DASHIF\ModuleInterface
	isEnabled ()
	setEnabled ($newVal)
	hookBeforeMPD ()
	Checks if pre-conditions for MPD Validation are met. More...
	hookBeforeRepresentation ()
	hookBeforeAdaptationSet ()
	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\ModuleDASHInteroperability::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.

hookMPD()

DASHIF\ModuleDASHInteroperability::hookMPD

(

)

A hook that is run between validating the MPD DOM, and reporting on it. Validity check of MPD DOM is ignored when running these hooks. Result Values are used in reporting on the MPD.

Module Usage

• HBBTV_DVB
  • Attempts to open $mpd_log.txt, if unsuccessfull no check are done and returns 'undefined'
  • Runs common checks, saving to mpd_log
  • Runs conditional checks for dvb and hbbtv, saving to mpd_log
  • Reads contents of the entire mpd_log file, and retrurns based on its contents.
    • !!This ASSUMES no other modules use the same file and inserts checked sequences.!!
    • If '###' is found anywhere in the file, return "error"
    • Otherwise, if 'Warning' is found anywhere in the file, return "warning"
    • Return true otherwise.
  • Reads xml from mpd_xml_report, saves the return value, then writes it back in whole.
• IOP
  • Attempts to open $mpd_log.txt, if unsuccessfull no check are done and returns 'undefined'
  • Runs conditional conformance checks and saves them to mpd_log
  • Reads contents of the entire mpd_log file, and retrurns based on its contents.
    • !!This ASSUMES no other modules use the same file and inserts checked sequences.!!
    • If 'DASH-IF IOP 4.3 check violated' if found in the file, return "error"
      • This does not occur for messages generated by IOP_ValidateMPD_Common()
    • Return true otherwise
  • Reads xml from mpd_xml_report, saves the return value, then writes it back in whole.
• LOW_LATENCY
  • Attempts to open $mpd_log.txt, if unsuccessfull no check are done and returns 'undefined'
  • Runs conformance checks and saves them to mpd_log
  • Reads contents of the temporary internal buffer, and retrurns based on its contents.
    • If 'violated' is found in the internal buffer, return "error"
    • Else, if 'warning' is found in the internal buffer, return "warning"
    • Else return true
  • Reads xml from mpd_xml_report, saves the return value, then writes it back in whole.

Reimplemented from DASHIF\ModuleInterface.

hookRepresentation()

DASHIF\ModuleDASHInteroperability::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:

• DASH/IOP/module.php