Panda3D
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
MicrophoneAudio Class Referenceabstract

Class MicrophoneAudio provides the means to read raw audio samples from a microphone. More...

#include "microphoneAudio.h"

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

Public Member Functions

virtual TypeHandle force_init_type ()
 
int get_channels () const
 
int get_rate () const
 
virtual TypeHandle get_type () const
 
virtual PT (MovieAudioCursor) open()=0
 
- Public Member Functions inherited from MovieAudio
 MovieAudio (const std::string &name="Blank Audio")
 This constructor returns a null audio stream — a stream of total silence, at 8000 samples per second. More...
 
const Filenameget_filename () const
 
- Public Member Functions inherited from TypedWritableReferenceCount
 TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
 
virtual ReferenceCountas_reference_count ()
 Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type. More...
 
void operator= (const TypedWritableReferenceCount &copy)
 
- Public Member Functions inherited from TypedWritable
 TypedWritable (const TypedWritable &copy)
 
virtual int complete_pointers (TypedWritable **p_list, BamReader *manager)
 Receives an array of pointers, one for each time manager->read_pointer() was called in fillin(). More...
 
vector_uchar encode_to_bam_stream () const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object. More...
 
bool encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
 Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string. More...
 
virtual void fillin (DatagramIterator &scan, BamReader *manager)
 This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object. More...
 
virtual void finalize (BamReader *manager)
 Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed. More...
 
UpdateSeq get_bam_modified () const
 Returns the current bam_modified counter. More...
 
void mark_bam_modified ()
 Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams. More...
 
void operator= (const TypedWritable &copy)
 
virtual bool require_fully_complete () const
 Some objects require all of their nested pointers to have been completed before the objects themselves can be completed. More...
 
virtual void update_bam_nested (BamWriter *manager)
 Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates. More...
 
virtual void write_datagram (BamWriter *manager, Datagram &dg)
 Writes the contents of this object to the datagram for shipping out to a Bam file. More...
 
- Public Member Functions inherited from TypedObject
 TypedObject (const TypedObject &copy)=default
 
TypedObjectas_typed_object ()
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
const TypedObjectas_typed_object () const
 Returns the object, upcast (if necessary) to a TypedObject pointer. More...
 
int get_best_parent_from_Set (const std::set< int > &) const
 
int get_type_index () const
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type. More...
 
bool is_exact_type (TypeHandle handle) const
 Returns true if the current object is the indicated type exactly. More...
 
bool is_of_type (TypeHandle handle) const
 Returns true if the current object is or derives from the indicated type. More...
 
TypedObjectoperator= (const TypedObject &copy)=default
 
- Public Member Functions inherited from ReferenceCount
int get_ref_count () const
 
WeakReferenceListget_weak_list () const
 Returns the WeakReferenceList associated with this ReferenceCount object. More...
 
bool has_weak_list () const
 Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...
 
void local_object ()
 This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...
 
void ref () const
 Explicitly increments the reference count. More...
 
bool ref_if_nonzero () const
 Atomically increases the reference count of this object if it is not zero. More...
 
bool test_ref_count_integrity () const
 Does some easy checks to make sure that the reference count isn't completely bogus. More...
 
bool test_ref_count_nonzero () const
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...
 
virtual bool unref () const
 Explicitly decrements the reference count. More...
 
WeakReferenceListweak_ref ()
 Adds the indicated PointerToVoid as a weak reference to this object. More...
 
void weak_unref ()
 Removes the indicated PointerToVoid as a weak reference to this object. More...
 
- Public Member Functions inherited from Namable
 Namable (const std::string &initial_name="")
 
void clear_name ()
 Resets the Namable's name to empty. More...
 
const std::string & get_name () const
 
bool has_name () const
 Returns true if the Namable has a nonempty name set, false if the name is empty. More...
 
void output (std::ostream &out) const
 Outputs the Namable. More...
 
void set_name (const std::string &name)
 

Static Public Member Functions

static void find_all_microphones ()
 Scans the hardware for microphones, and pushes them onto the global list of all microphones. More...
 
static TypeHandle get_class_type ()
 
static int get_num_options ()
 
static void init_type ()
 
static PT (MicrophoneAudio) get_option(int n)
 
- Static Public Member Functions inherited from MovieAudio
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (MovieAudio) get(const Filename &name)
 
- Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
static PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data
 
- Static Public Member Functions inherited from TypedWritable
static bool decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr)
 Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes. More...
 
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from TypedObject
static TypeHandle get_class_type ()
 
static void init_type ()
 This function is declared non-inline to work around a compiler bug in g++ 2.96. More...
 
- Static Public Member Functions inherited from ReferenceCount
static TypeHandle get_class_type ()
 
static void init_type ()
 
- Static Public Member Functions inherited from Namable
static TypeHandle get_class_type ()
 
static void init_type ()
 

Public Attributes

 get_channels
 Returns the number of channels. More...
 
 get_num_options
 Returns the number of microphone options. More...
 
 get_option
 
 get_rate
 Returns the sample rate. More...
 
- Public Attributes inherited from MovieAudio
 get_filename
 Returns the movie's filename. More...
 
- Public Attributes inherited from TypedWritableReferenceCount
static BamReaderreader = nullptr)
 
- Public Attributes inherited from TypedObject
 get_type
 
- Public Attributes inherited from ReferenceCount
 get_ref_count
 Returns the current reference count. More...
 
- Public Attributes inherited from Namable
 get_name
 
 set_name
 

Additional Inherited Members

- Static Public Attributes inherited from TypedWritable
static TypedWritable *const Null = nullptr
 

Detailed Description

Class MicrophoneAudio provides the means to read raw audio samples from a microphone.

Definition at line 25 of file microphoneAudio.h.

Member Function Documentation

◆ find_all_microphones()

void MicrophoneAudio::find_all_microphones ( )
static

Scans the hardware for microphones, and pushes them onto the global list of all microphones.

There are several implementations of MicrophoneAudio, including one based on DirectShow, one based on Linux ALSA, and so forth. These implementations are contained in one C++ file each, and they export nothing at all except a single "find_all" function. Otherwise, they can only be accessed through the virtual methods of the MicrophoneAudio objects they create.

Definition at line 39 of file microphoneAudio.cxx.

Referenced by PT().

Member Data Documentation

◆ get_channels

int MicrophoneAudio::get_channels
inline

Returns the number of channels.

Definition at line 38 of file microphoneAudio.h.

◆ get_num_options

int MicrophoneAudio::get_num_options

Returns the number of microphone options.

An "option" consists of a device plus a set of configuration parameters. For example, "Soundblaster Audigy Line in at 44,100 samples/sec" would be an option.

Definition at line 32 of file microphoneAudio.h.

◆ get_rate

int MicrophoneAudio::get_rate
inline

Returns the sample rate.

Definition at line 39 of file microphoneAudio.h.


The documentation for this class was generated from the following files: