UserDataAudio

Inheritance:

Methods of UserDataAudio:

Methods of MovieAudio:

Methods of TypedWritableReferenceCount:

Methods of TypedWritable:

Methods of TypedObject:

Methods of ReferenceCount:

Methods of Namable:

UserDataAudio
UserDataAudio::UserDataAudio(int rate, int channels);

Description: This constructor returns a UserDataAudio --- a means to supply raw audio samples manually.

append
void UserDataAudio::append(short int *data, int n);

Description: Appends audio samples to the buffer.
Description: Appends audio samples to the buffer from a datagram. This is intended to make it easy to send streaming raw audio over a network.
Description: 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
void UserDataAudio::done(void);

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

getClassType
static TypeHandle UserDataAudio::get_class_type(void);

Undocumented function.

open
virtual PointerTo< MovieAudioCursor > UserDataAudio::open(void);

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

MovieAudio
MovieAudio::MovieAudio(string const &name = ("Blank Audio"));

Description: 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.

get
static PointerTo< MovieAudio > MovieAudio::get(Filename const &name);

Description: Obtains a MovieAudio that references a file.

getClassType
static TypeHandle MovieAudio::get_class_type(void);

Undocumented function.

getFilename
Filename const &MovieAudio::get_filename(void) const;

Filename: movieAudio.I Created by: jyelon (02Jul07)
PANDA 3D SOFTWARE Copyright (c) Carnegie Mellon University. All rights reserved.
All use of this software is subject to the terms of the revised BSD license. You should have received a copy of this license along with this source code in a file named "LICENSE."
Description: Returns the movie's filename. A movie is not guaranteed to have a filename, if not, then this function returns a null filename.

open
virtual PointerTo< MovieAudioCursor > MovieAudio::open(void);

Description: Open this audio, returning a MovieAudioCursor

getClassType
static TypeHandle TypedWritableReferenceCount::get_class_type(void);

Undocumented function.

getClassType
static TypeHandle TypedWritable::get_class_type(void);

Undocumented function.

getClassType
static TypeHandle TypedObject::get_class_type(void);

Undocumented function.

getType
virtual TypeHandle TypedObject::get_type(void) const = 0;

Derived classes should override this function to return get_class_type().

getTypeIndex
int TypedObject::get_type_index(void) const;

Description: 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().

isExactType
bool TypedObject::is_exact_type(TypeHandle handle) const;

Description: Returns true if the current object is the indicated type exactly.

isOfType
bool TypedObject::is_of_type(TypeHandle handle) const;

Description: Returns true if the current object is or derives from the indicated type.

getClassType
static TypeHandle ReferenceCount::get_class_type(void);

Undocumented function.

getRefCount
int ReferenceCount::get_ref_count(void) const;

Description: Returns the current reference count.

ref
void ReferenceCount::ref(void) const;

Description: 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.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

testRefCountIntegrity
bool ReferenceCount::test_ref_count_integrity(void) const;

Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero
bool ReferenceCount::test_ref_count_nonzero(void) const;

Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref
bool ReferenceCount::unref(void) const;

Description: 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; plus, we don't have a virtual destructor anyway.) However, see the helper function unref_delete().
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.
This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.
The return value is true if the new reference count is nonzero, false if it is zero.

Namable
Namable::Namable(string const &initial_name = (""));

Description:

clearName
void Namable::clear_name(void);

Description: Resets the Namable's name to empty.

getClassType
static TypeHandle Namable::get_class_type(void);

Undocumented function.

getName
string const &Namable::get_name(void) const;

Description:

hasName
bool Namable::has_name(void) const;

Description: Returns true if the Namable has a nonempty name set, false if the name is empty.

operator =
Namable &Namable::operator =(Namable const &other);

Description:

output
void Namable::output(ostream &out) const;

In the absence of any definition to the contrary, outputting a Namable will write out its name.
Description: Outputs the Namable. This function simply writes the name to the output stream; most Namable derivatives will probably redefine this.

setName
void Namable::set_name(string const &name);

Description: