Skip to main content

%Ogre Video and Audio Plugins {#mainpage}

This is the API reference for the Ogre Video and Audio plugins; contained within are the specifications for each class and the methods on those classes which you can refer to when using the library in your code.

Building

The audio plugin builds against the bundled mojoAL OpenAL 1.1 implementation by default, which requires SDL2:

cmake -B build .
cmake --build build

Pass -DOGGSOUND_USE_MOJOAL=OFF to link against a system OpenAL implementation instead. mojoAL does not support EFX or multichannel (4/5.1/6.1/7.1) buffer formats.

Standalone Ogg Vorbis playback is decoded with the bundled stb_vorbis. stb_vorbis has no streaming IO callbacks, so streamed .ogg sounds keep the compressed file in memory. The Theora video plugin still uses libogg/libvorbis for audio multiplexed into video files.

Licensing

The default audio build is entirely permissively licensed: OgreOggSound is BSD-3-Clause, the bundled mojoAL OpenAL implementation is zlib, stb_vorbis is public domain/MIT, and SDL2 is zlib. This allows static linking into closed-source applications without LGPL obligations.

Building with -DOGGSOUND_USE_MOJOAL=OFF links against OpenAL Soft instead, which is LGPL-2.1-or-later and must be redistributed according to its license.

OggSound

The %OgreOggSound library is designed to provide a simple, quick and easy method of adding audio to an OGRE based application. Its primarily a wrapper around the OpenAL audio library, but its design focus is seamless integration with OGRE based applications.

It hides all the mundane setup and updating procedures needed by OpenAL, and condenses the functionality down to a clean and simple OGRE-fied interface.

Features

  • .ogg file format support
  • uncompressed .wav file support
  • In memory and streaming support
    • Load whole sound into memory
    • Stream sound from a file
  • Optional multithreaded streaming
  • Multichannel audio support
  • Full 2D/3D audio support
    • spatialized sound support using mono sound files
    • 2D/multichannel support
  • Full control over 3D parameters
    • All 3D properties exposed for customisation
    • Global attenuation model configurable
    • Global sound speed configurable
    • Global doppler effect configurable
  • Playback seeking
  • Cue points - Set 'jump-to' points within sounds
  • Configurable loop points
    • By default a sound would loop from start to end, however a user can customise this by offsetting the start point of the loop per sound.
  • Temporary sounds
    • Allows creation and automatic destruction of single-play/infrequent sounds.
  • Source management
    • Sources are pooled
    • Sources are automatically re-used when a sound requests to play
    • Sounds are re-activated if temporarily stopped.
  • OGRE integration support
    • Sound objects are derived from MovableObject
    • can be attached directly into scene graph via SceneNodes
    • Automatically updates transformations
  • Audio capturing support to WAV file.
  • XRAM hardware buffer support
    • Currently experimental
  • EFX effect support
    • Support for attaching EFX filters/effects to sounds if hardware supported
    • Support for EAX room reverb presets
  • Volume control
  • Pitch control
  • Loop control
  • Fully Documented

Theora Video Plugin

The Theora Video plugin allows referencing theora streams as @ref External-Texture-Sources.

Features

  • Integrates into Ogre3D as a FrameListener
  • Supports loading videos from material files
  • optional yuv->rgb conversion via shader

Metadata

Release files for ogre-oggsound 14.6.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distributions (wheels)

Table of built distributions (wheels) for ogre-oggsound 14.6.2
File Actions
ogre_oggsound-14.6.2-cp314-cp314-win_amd64.whl CPython 3.14 CPython 3.14 Windows x86-64 Details for ogre_oggsound-14.6.2-cp314-cp314-win_amd64.whl
ogre_oggsound-14.6.2-cp314-cp314-manylinux_2_28_x86_64.whl CPython 3.14 CPython 3.14 Linux glibc 2.28+ x86-64 Details for ogre_oggsound-14.6.2-cp314-cp314-manylinux_2_28_x86_64.whl
ogre_oggsound-14.6.2-cp314-cp314-macosx_14_0_arm64.whl CPython 3.14 CPython 3.14 macOS 14.0+ ARM64 Details for ogre_oggsound-14.6.2-cp314-cp314-macosx_14_0_arm64.whl
ogre_oggsound-14.6.2-cp312-cp312-win_amd64.whl CPython 3.12 CPython 3.12 Windows x86-64 Details for ogre_oggsound-14.6.2-cp312-cp312-win_amd64.whl
ogre_oggsound-14.6.2-cp312-cp312-manylinux_2_28_x86_64.whl CPython 3.12 CPython 3.12 Linux glibc 2.28+ x86-64 Details for ogre_oggsound-14.6.2-cp312-cp312-manylinux_2_28_x86_64.whl
ogre_oggsound-14.6.2-cp312-cp312-macosx_14_0_arm64.whl CPython 3.12 CPython 3.12 macOS 14.0+ ARM64 Details for ogre_oggsound-14.6.2-cp312-cp312-macosx_14_0_arm64.whl

Total release size: 1.2 MB

Release files / ogre_oggsound-14.6.2-cp314-cp314-win_amd64.whl

Download URL ogre_oggsound-14.6.2-cp314-cp314-win_amd64.whl
Size 184.3 kB
Tags CPython 3.14 Windows x86-64
SHA-256 checksum
How to use checksums
d2427044dce55bc6b59b53902ca8cfcd2cf21d0e167ca85f99cb728170386fde
BLAKE2b-256 checksum
How to use checksums
26a7507ffd9984a81fbdc429689c6167db96ef879dc99f2f98dd1f3bd80aca55
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.14.9

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Release files / ogre_oggsound-14.6.2-cp314-cp314-manylinux_2_28_x86_64.whl

Download URL ogre_oggsound-14.6.2-cp314-cp314-manylinux_2_28_x86_64.whl
Size 249.2 kB
Tags CPython 3.14 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
d7f448662c43d4e90c3848a3754f519dd49a6007296469325ebafc088cb75fd1
BLAKE2b-256 checksum
How to use checksums
506c5ed9950696b4266c52b396ec5480820f6700321dadb7daaf1c386cced461
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.10.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Release files / ogre_oggsound-14.6.2-cp314-cp314-macosx_14_0_arm64.whl

Download URL ogre_oggsound-14.6.2-cp314-cp314-macosx_14_0_arm64.whl
Size 181.6 kB
Tags CPython 3.14 macOS 14.0+ ARM64
SHA-256 checksum
How to use checksums
b3086ed0bd462cd4dfce0f9215bcbcdca5b2ae4991ae7de9943d11223856c159
BLAKE2b-256 checksum
How to use checksums
6388bff764233efb6f892059c5adc571dd78ee5914bef53122addd1213b8afc6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.14.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Release files / ogre_oggsound-14.6.2-cp312-cp312-win_amd64.whl

Download URL ogre_oggsound-14.6.2-cp312-cp312-win_amd64.whl
Size 179.0 kB
Tags CPython 3.12 Windows x86-64
SHA-256 checksum
How to use checksums
a7b5a180f30421a7c56f199558de3b8b450568c63c67d2445b491b3ccf50a55e
BLAKE2b-256 checksum
How to use checksums
77dc4b7c232a0c67b5408463d8d31f6d02a8832e2c40665b29eae80bc639f6cc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.12.10

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Release files / ogre_oggsound-14.6.2-cp312-cp312-manylinux_2_28_x86_64.whl

Download URL ogre_oggsound-14.6.2-cp312-cp312-manylinux_2_28_x86_64.whl
Size 249.3 kB
Tags CPython 3.12 Linux glibc 2.28+ x86-64
SHA-256 checksum
How to use checksums
7d3151b5c74c46ffefeaa3baecb8bbd2b57d4245cbbb50bde31075682f8be8ba
BLAKE2b-256 checksum
How to use checksums
4f8b3b758f5ee5acffd3f7515fcbcf934d6cb1ef9a5dd5fb3eda0f7c159dbd83
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.10.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Release files / ogre_oggsound-14.6.2-cp312-cp312-macosx_14_0_arm64.whl

Download URL ogre_oggsound-14.6.2-cp312-cp312-macosx_14_0_arm64.whl
Size 177.8 kB
Tags CPython 3.12 macOS 14.0+ ARM64
SHA-256 checksum
How to use checksums
221d12c54a8be7f616ea6d7763c90d1886e5da5f71caf683748a0a356a6157d6
BLAKE2b-256 checksum
How to use checksums
7b872826ca80b2b415a51f2cf02422d39f99dbb3b91051b02eb116abec13b30a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.12.10

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

Security for ogre-oggsound 14.6.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 6 files in this release have been uploaded with provenance metadata.

Select from 6 files

Attestation for ogre_oggsound-14.6.2-cp314-cp314-win_amd64.whl

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 26, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

14.6.2 This release

6 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page