Panda3D
Public Member Functions | Static Public Member Functions | List of all members
UserDataAudio Class Reference

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. More...

Inheritance diagram for UserDataAudio:
MovieAudio TypedWritableReferenceCount Namable TypedWritable ReferenceCount MemoryBase TypedObject MemoryBase MemoryBase

Public Member Functions

 __init__ (int rate, int channels, bool remove_after_read)
 This constructor returns a UserDataAudio — a means to supply raw audio samples manually. More...
 
 append (DatagramIterator src, int len)
 Appends audio samples to the buffer from a datagram. This is intended to make it easy to send streaming raw audio over a network. More...
 
 append (str str)
 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. More...
 
 done ()
 Promises not to append any more samples, ie, this marks the end of the audio stream. More...
 
MovieAudioCursor open ()
 Open this audio, returning a UserDataAudioCursor. A UserDataAudio can only be opened by one consumer at a time. More...
 
- Public Member Functions inherited from MovieAudio
 __init__ (str name)
 This constructor returns a null audio stream — a stream of total silence, at 8000 samples per second. To get more interesting audio, you need to construct a subclass of this class. More...
 
const Filename getFilename ()
 Returns the movie's filename. A movie is not guaranteed to have a filename, if not, then this function returns a null filename. More...
 
MovieAudioCursor open ()
 Open this audio, returning a MovieAudioCursor. More...
 
- Public Member Functions inherited from TypedWritable
object __reduce__ ()
 
object __reduce_persist__ (object pickler)
 
str encodeToBamStream ()
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a string string. Returns empty string on failure. More...
 
bool encodeToBamStream (String data, BamWriter writer)
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. Returns true on success, false on failure. More...
 
UpdateSeq getBamModified ()
 Returns the current bam_modified counter. This counter is normally incremented automatically whenever the object is modified. More...
 
 markBamModified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. This should normally not need to be called by user code; it should be called internally when the object has been changed in a way that legitimately requires its retransmission to any connected clients. More...
 
- Public Member Functions inherited from TypedObject
TypeHandle getType ()
 Derived classes should override this function to return get_class_type(). More...
 
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. This is equivalent to get_type().get_index(). More...
 
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly. More...
 
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type. More...
 
- Public Member Functions inherited from ReferenceCount
int getRefCount ()
 Returns the current reference count. More...
 
 ref ()
 Explicitly increments the reference count. User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically. More...
 
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise. More...
 
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise. More...
 
bool unref ()
 Explicitly decrements the reference count. Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete(). More...
 
- Public Member Functions inherited from Namable
 __init__ (const Namable copy)
 
 __init__ (str initial_name)
 
 clearName ()
 Resets the Namable's name to empty. More...
 
str getName ()
 
bool hasName ()
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
Namable operator= (const Namable other)
 
 output (Ostream out)
 Outputs the Namable. This function simply writes the name to the output stream; most Namable derivatives will probably redefine this. More...
 
 setName (str name)
 

Static Public Member Functions

static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from MovieAudio
static MovieAudio get (const Filename name)
 Obtains a MovieAudio that references a file. Just calls MovieTypeRegistry::make_audio(). More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypedWritableReferenceCount decodeFromBamStream (str data, BamReader reader)
 Reads the string created by a previous call to encode_to_bam_stream(), and extracts and returns the single object on that string. Returns NULL on error. More...
 
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedWritable
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle getClassType ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle getClassType ()
 

Detailed Description

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.

Member Function Documentation

◆ __init__()

__init__ ( int  rate,
int  channels,
bool  remove_after_read 
)

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

◆ append() [1/2]

append ( DatagramIterator  src,
int  len 
)

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

◆ append() [2/2]

append ( str  str)

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.

◆ done()

done ( )

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

◆ getClassType()

static TypeHandle getClassType ( )
static

◆ open()

MovieAudioCursor open ( )

Open this audio, returning a UserDataAudioCursor. A UserDataAudio can only be opened by one consumer at a time.