Rebel Fork Framework
Urho3D::Microphone Class Reference

Microphone audio input device. Uses are for speech recognition or network speech, not intended for high quality recording usage. More...

#include <Urho3D/Audio/Microphone.h>

Inheritance diagram for Urho3D::Microphone:
Urho3D::Object Urho3D::RefCounted

Public Member Functions

 Microphone (Context *)
 Construct.
 
virtual ~Microphone ()
 Destruct.
 
ea::vector< int16_t > & GetData ()
 Gets direct access to the data.
 
const ea::vector< int16_t > & GetData () const
 Gets direct access to the data.
 
void CopyData (ea::vector< int16_t > &dest) const
 Copies the current data into the destination array.
 
void ClearData ()
 Wipes the buffer clean.
 
void Update (unsigned char *rawData, int rawDataLen)
 Appends data to the internal buffer.
 
unsigned GetFrequency () const
 
ea::string GetName () const
 
bool IsEnabled () const
 
void SetEnabled (bool state)
 
unsigned GetWakeThreshold () const
 
void SetWakeThreshold (unsigned value)
 
bool IsSleeping () const
 
SharedPtr< BufferedSoundStreamGetLinked () const
 Gets the linked stream target if any.
 
void Link (SharedPtr< BufferedSoundStream >)
 Links the given stream object to automatically fill with microphone data.
 
void Unlink ()
 Unlinks the stream object, typically do this in E_RECORDINGENDED.
 
- Public Member Functions inherited from Urho3D::Object
 Object (Context *context)
 Construct.
 
 ~Object () override
 Destruct. Clean up self from event sender & receiver structures.
 
virtual StringHash GetType () const =0
 
virtual const ea::string & GetTypeName () const =0
 
virtual const TypeInfoGetTypeInfo () const =0
 Return type info.
 
virtual void OnEvent (Object *sender, StringHash eventType, VariantMap &eventData)
 Handle event.
 
virtual void SerializeInBlock (Archive &archive)
 Serialize content from/to archive. May throw ArchiveException.
 
bool IsInstanceOf (StringHash type) const
 Check current instance is type of specified type.
 
bool IsInstanceOf (const TypeInfo *typeInfo) const
 Check current instance is type of specified type.
 
template<typename T >
bool IsInstanceOf () const
 Check current instance is type of specified class.
 
template<typename T >
T * Cast ()
 Cast the object to specified most derived class.
 
template<typename T >
const T * Cast () const
 Cast the object to specified most derived class.
 
void SubscribeToEventManual (StringHash eventType, EventHandler *handler)
 Subscribe to an event that can be sent by any sender.
 
void SubscribeToEventManual (Object *sender, StringHash eventType, EventHandler *handler)
 Subscribe to a specific sender's event.
 
template<class T >
void SubscribeToEvent (StringHash eventType, T handler)
 Subscribe to an event that can be sent by any sender.
 
template<class T >
void SubscribeToEvent (Object *sender, StringHash eventType, T handler)
 Subscribe to a specific sender's event.
 
void UnsubscribeFromEvent (StringHash eventType)
 Unsubscribe from an event.
 
void UnsubscribeFromEvent (Object *sender, StringHash eventType)
 Unsubscribe from a specific sender's event.
 
void UnsubscribeFromEvents (Object *sender)
 Unsubscribe from a specific sender's events.
 
void UnsubscribeFromAllEvents ()
 Unsubscribe from all events.
 
void UnsubscribeFromAllEventsExcept (const ea::vector< StringHash > &exceptions)
 Unsubscribe from all events except those listed.
 
void UnsubscribeFromAllEventsExcept (const ea::vector< Object * > &exceptions)
 Unsubscribe from all events except those with listed senders.
 
void SendEvent (StringHash eventType)
 Send event to all subscribers.
 
void SendEvent (StringHash eventType, VariantMap &eventData)
 Send event with parameters to all subscribers.
 
VariantMapGetEventDataMap () const
 Return a preallocated map for event data. Used for optimization to avoid constant re-allocation of event data maps.
 
template<typename... Args>
void SendEvent (StringHash eventType, const Args &... args)
 Send event with variadic parameter pairs to all subscribers. The parameters are (paramID, paramValue) pairs.
 
ContextGetContext () const
 Return execution context.
 
const VariantGetGlobalVar (StringHash key) const
 
const VariantMapGetGlobalVars () const
 
void SetGlobalVar (StringHash key, const Variant &value)
 
ObjectGetSubsystem (StringHash type) const
 Return subsystem by type.
 
ObjectGetEventSender () const
 Return active event sender. Null outside event handling.
 
EventHandlerGetEventHandler () const
 Return active event handler. Null outside event handling.
 
bool HasSubscribedToEvent (StringHash eventType) const
 Return whether has subscribed to an event without specific sender.
 
bool HasSubscribedToEvent (Object *sender, StringHash eventType) const
 Return whether has subscribed to a specific sender's event.
 
bool HasEventHandlers () const
 Return whether has subscribed to any event.
 
template<class T >
T * GetSubsystem () const
 Template version of returning a subsystem.
 
const ea::string & GetCategory () const
 
void SendEvent (StringHash eventType, const VariantMap &eventData)
 Send event with parameters to all subscribers.
 
void SetBlockEvents (bool block)
 Block object from sending and receiving events.
 
bool GetBlockEvents () const
 Return sending and receiving events blocking status.
 
- Public Member Functions inherited from Urho3D::RefCounted
 RefCounted ()
 Construct. Allocate the reference count structure and set an initial self weak reference.
 
virtual ~RefCounted ()
 Destruct. Mark as expired and also delete the reference count structure if no outside weak references exist.
 
 RefCounted (const RefCounted &rhs)=delete
 Prevent copy construction.
 
RefCountedoperator= (const RefCounted &rhs)=delete
 Prevent assignment.
 
int AddRef ()
 
int ReleaseRef ()
 
int Refs () const
 
int WeakRefs () const
 
RefCountRefCountPtr () const
 Return pointer to the reference count structure.
 
bool HasScriptObject () const
 Return true if script runtime object wrapping this native object exists.
 
bool IsScriptStrongRef () const
 Return true if script reference is strong.
 

Static Public Member Functions

static void RegisterObject (Context *)
 Register factory.
 
- Static Public Member Functions inherited from Urho3D::Object
static const TypeInfoGetTypeInfoStatic ()
 Return type info static.
 

Private Member Functions

 URHO3D_OBJECT (Microphone, Object)
 
void Init (const ea::string &name, SDL_AudioDeviceID id, int bufferSize, unsigned frequency, unsigned which)
 Initializes the SDL audio device.
 
void CheckDirtiness ()
 Audio calls this to check if the SDL thread has appended data to us.
 

Private Attributes

SharedPtr< BufferedSoundStreamlinkedStream_
 Target to auto-copy data into.
 
ea::string name_
 Named identifier of the microphone.
 
ea::vector< int16_t > buffer_
 Stored copy of data contained.
 
SDL_AudioDeviceID micID_
 SDL identifier for the mic.
 
unsigned which_
 Last seen index by SDL.
 
Mutex lock_
 Lock object for thread safety, most operations on speech are going to want to be threaded.
 
unsigned frequency_
 HZ freq of the mic.
 
unsigned wakeThreshold_ = UINT_MAX
 Signal threshold above which to "wake" the microphone. Not very effective.
 
bool enabled_
 Whether to active capture data or not (data still comes in, but is ignored not copied).
 
bool isSleeping_ = false
 Whether the microphone has failed to meet wake thresholds.
 
bool isDirty_ = false
 Cleanliness state of the data.
 

Friends

class Audio
 

Additional Inherited Members

- Protected Attributes inherited from Urho3D::Object
WeakPtr< Contextcontext_
 Execution context.
 

Detailed Description

Microphone audio input device. Uses are for speech recognition or network speech, not intended for high quality recording usage.

Member Function Documentation

◆ GetFrequency()

unsigned Urho3D::Microphone::GetFrequency ( ) const
inline

Returns the frequency of the microphone's recording.

◆ GetName()

ea::string Urho3D::Microphone::GetName ( ) const
inline

Returns the user friendly name of this microphone.

◆ GetWakeThreshold()

unsigned Urho3D::Microphone::GetWakeThreshold ( ) const
inline

Returns the minimum volume to wake the device (absolute value)

◆ IsEnabled()

bool Urho3D::Microphone::IsEnabled ( ) const
inline

Returns true if the device is actively recording.

◆ IsSleeping()

bool Urho3D::Microphone::IsSleeping ( ) const
inline

Returns true if this device is in sleep state.

◆ SetEnabled()

void Urho3D::Microphone::SetEnabled ( bool  state)

Starts or stops recording.

◆ SetWakeThreshold()

void Urho3D::Microphone::SetWakeThreshold ( unsigned  value)
inline

Minimum volume to wake this device.


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