API (python)

Module Summary:

omni.audioplayer

This module contains bindings to the C++ omni::audio::IAudioPlayer interface.

Module Details::

omni.audioplayer:

This module contains bindings to the C++ omni::audio::IAudioPlayer interface. This provides functionality for playing sound assets. This is intended only as a basic audio player interface for previewing assets. This is not intended to play sounds in a USD stage or in the Kit UI. For sounds in the USD stage, the omni.usd.audio interface should be used instead. For UI sounds, the omni.kit.uiaudio interface should be used.

Sound files may be in RIFF/WAV, Ogg, or FLAC format. Data in the sound files may use 8, 16, 24, or 32 bit integer samples, or 32 bit floating point samples. Channel counts may be from 1 to 64 If more channels of data are provided than the audio device can play, some channels will be blended together automatically.