audio_samples_qoe

User Guide

  • Installation
    • Requirements
    • Install from PyPI
    • Build from Source
  • Quickstart
    • Scoring Two Files
    • Scoring In-Memory Signals
    • Mixing Paths and In-Memory Signals
    • Selecting a Mode
    • Parallel Scoring
  • Input Types
    • File Paths
    • AudioSamples
    • Sample Rates
    • Channel Count
    • What Is Not Accepted
  • Scoring Modes
    • Audio Mode
    • Speech Mode
    • Choosing a Mode
    • Conformance
  • SCOREQ
    • Construction
    • No-Reference Mode
    • Reference Mode
    • Sample Rate
    • Threading
    • ViSQOL or SCOREQ?
  • Error Handling
    • TypeError: wrong argument type
    • ValueError: invalid mode
    • OSError: file not found or decode error
    • VisqolError: pipeline failure
    • ScoreqError: pipeline failure or wrong mode
    • Defensive Pattern

API Reference

  • API Reference
    • Functions
      • visqol()
      • Type Aliases
        • AudioInput
        • VisqolMode
    • Classes
      • Scoreq
        • Scoreq.domain
        • Scoreq.mode
        • Scoreq.predict()
        • Scoreq.predict_ref()
      • Type Aliases
        • ScoreqDomain
        • ScoreqMode
    • Exceptions
      • VisqolError
      • ScoreqError
audio_samples_qoe
  • API Reference
  • View page source

API Reference

The public API is audio_samples_qoe.visqol() and audio_samples_qoe.Scoreq, plus the audio_samples_qoe.VisqolError and audio_samples_qoe.ScoreqError exceptions they can raise.

  • Functions
    • visqol()
    • Type Aliases
  • Classes
    • Scoreq
    • Type Aliases
  • Exceptions
    • VisqolError
    • ScoreqError
Previous Next

© Copyright 2026, Jack Geraghty.

Built with Sphinx using a theme provided by Read the Docs.