UserDataAudio

class UserDataAudio

Bases: MovieAudio

A UserDataAudio is a way for the user to manually supply raw audio samples. remove_after_read means the data will be removed if read once. Else data will be stored (enable looping and seeking). Expects data as 16 bit signed (word); Example for stereo: 1.word = 1.channel,2.word = 2.channel, 3.word = 1.channel,4.word = 2.channel, etc.

Inheritance diagram

Inheritance diagram of UserDataAudio

UserDataAudio(int rate, int channels, bool remove_after_read = true)
UserDataAudio(UserDataAudio const&) = default

This constructor returns a UserDataAudio — a means to supply raw audio samples manually.

void append(int16_t *data, int n)
void append(DatagramIterator *src, int len = 1073741824)
void append(std::string const &str)

Appends audio samples to the buffer.

Appends audio samples to the buffer from a datagram. This is intended to make it easy to send streaming raw audio over a network.

Appends audio samples to the buffer from a string. The samples must be stored little-endian in the string. This is not particularly efficient, but it may be convenient to deal with samples in python.

void done(void)

A promise not to write any more samples.

Promises not to append any more samples, ie, this marks the end of the audio stream.

static TypeHandle get_class_type(void)