Public Member Functions | Public Attributes | List of all members
mycroft.client.speech.mic.MutableStream Class Reference

Public Member Functions

def __init__ (self, wrapped_stream, format, muted=False)
 
def close (self)
 
def is_stopped (self)
 
def mute (self)
 
def read (self, size, of_exc=False)
 
def stop_stream (self)
 
def unmute (self)
 

Public Attributes

 muted
 
 muted_buffer
 
 SAMPLE_WIDTH
 
 wrapped_stream
 

Detailed Description

Definition at line 48 of file mic.py.

Constructor & Destructor Documentation

def mycroft.client.speech.mic.MutableStream.__init__ (   self,
  wrapped_stream,
  format,
  muted = False 
)

Definition at line 49 of file mic.py.

Member Function Documentation

def mycroft.client.speech.mic.MutableStream.close (   self)

Definition at line 105 of file mic.py.

def mycroft.client.speech.mic.MutableStream.is_stopped (   self)

Definition at line 109 of file mic.py.

def mycroft.client.speech.mic.MutableStream.mute (   self)
Stop the stream and set the muted flag 

Definition at line 60 of file mic.py.

def mycroft.client.speech.mic.MutableStream.read (   self,
  size,
  of_exc = False 
)
    Read data from stream.

    Arguments:
size (int): Number of bytes to read
of_exc (bool): flag determining if the audio producer thread
               should throw IOError at overflows.

    Returns:
Data read from device

Definition at line 70 of file mic.py.

def mycroft.client.speech.mic.MutableStream.stop_stream (   self)

Definition at line 112 of file mic.py.

def mycroft.client.speech.mic.MutableStream.unmute (   self)
Start the stream and clear the muted flag 

Definition at line 65 of file mic.py.

Member Data Documentation

mycroft.client.speech.mic.MutableStream.muted

Definition at line 53 of file mic.py.

mycroft.client.speech.mic.MutableStream.muted_buffer

Definition at line 58 of file mic.py.

mycroft.client.speech.mic.MutableStream.SAMPLE_WIDTH

Definition at line 57 of file mic.py.

mycroft.client.speech.mic.MutableStream.wrapped_stream

Definition at line 51 of file mic.py.


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


mycroft_ros
Author(s):
autogenerated on Mon Apr 26 2021 02:35:40