Skip to main content

QoE API

Handles Networking related operations.

qoe.measure​

Signatures​

measure(qoe_id, opts \ [], lua)

Description​

Measure the QoE of a video stream with the given QoE ID.

Positional Parameters​

  • qoe_id: The QoE ID corresponds to the QoE recording session.

Keyword Parameters​

  • timeout: The maximum time to wait for the QoE measuring task to finish.

  • threshold: The threshold for the distance between the feature vectors of the frames.

    Defaults to 4.

  • distance: The distance metric to use for comparing the feature vectors of the frames.

    The default distance metric is "euclidean".

  • maxConsecutiveMismatches: The maximum number of consecutive mismatches allowed.

    Defaults to 10.

Returns​

  • true: If any playback issues have been detected.
  • false: If no playback issues have been detected.

Raises​

  • Runtime exeception will be raised if the QoE ID cannot be found.

qoe.persist​

Signatures​

persist(qoe_id)

Description​

Persist the QoE data with the given QoE ID.

Positional Parameters​

  • qoe_id: The QoE ID corresponds to the QoE recording session.

qoe.record​

Signatures​

record(duration, opts \ [], lua)

Description​

Record a video stream for QoE analysis.

Parameters​

  • duration: The duration of the video stream to record, counting from the starting frame.

Options​

  • timeout: The maximum time to wait for the starting frame to appear in the video stream.

  • startingFrame: The starting frame of the video stream.

    The recording starts when it detects the same frame in the video stream.

  • threshold: The threshold for the distance between the feature vectors of the frames.

    Defaults to 4.

  • distance: The distance metric to use for comparing the feature vectors of the frames.

    The default distance metric is "euclidean".

Returns​

  • qoe_id: An QoE ID corresponds to this QoE recording session and can be used to measure the QoE.