UI Accessibility Plugin  Version 1.1.1
Make your UI accessible for visually impaired users
Classes | Public Types | Public Member Functions | Public Attributes | List of all members
UAP_AudioQueue Class Reference
Inheritance diagram for UAP_AudioQueue:

Public Types

enum  EAudioType {
  None = 0, Pause = 1, Element_Text = 2, Element_Type = 4,
  Element_Hint = 8, App = 16, Container_Name = 32, Skippable = 64
}
 
enum  EInterrupt { None = 0, Elements = EAudioType.Pause | EAudioType.Element_Text | EAudioType.Element_Type | EAudioType.Element_Hint | EAudioType.Skippable, All = EAudioType.Pause | EAudioType.Element_Text | EAudioType.Element_Type | EAudioType.Element_Hint | EAudioType.Container_Name | EAudioType.App | EAudioType.Skippable }
 

Public Member Functions

delegate void UAP_GenericCallback ()
 
void QueueAudio (string textForTTS, EAudioType type, bool allowVoiceOver, UAP_GenericCallback callbackOnDone=null, EInterrupt interruptsAudioTypes=EInterrupt.None, bool isInterruptible=true)
 
void QueueAudio (AudioClip audioFile, EAudioType type, UAP_GenericCallback callbackOnDone=null, EInterrupt interruptsAudioTypes=EInterrupt.None, bool isInterruptible=true)
 
void QueuePause (float durationInSecs)
 
void Stop ()
 
void StopAllInterruptibles ()
 Stops and removes everything in the queue that is tagged as interruptible (that's almost everything) More...
 
void InterruptAppAnnouncement ()
 Interrupt currently playing app announcement made with ::Say(). Only executes if there is an app announcement currently playing and if it is interruptible. More...
 
void Initialize ()
 
bool IsPlaying ()
 Checks whether audio is actively playing, TTS or audio clips, but not counting pauses. More...
 
bool IsPlayingExceptAppOrSkippable ()
 Like IsPlaying(), but will return false if the audio playing is a skippable More...
 
bool IsCompletelyEmpty ()
 Checks if there is nothing currently playing or waiting to be played, including pauses. More...
 
int GetSpeechRate ()
 
int SetSpeechRate (int speechRate)
 

Public Attributes

int m_CurrentQueueLength = 0
 Read-only - for debugging purposes only. More...
 
float m_CurrentPauseDuration = 0.0f
 Read-only - for debugging purposes only. More...
 
string m_CurrentElement = "none"
 Read-only - for debugging purposes only. More...
 
bool m_IsSpeaking = false
 Read-only - for debugging purposes only. More...
 

Member Function Documentation

void UAP_AudioQueue.InterruptAppAnnouncement ( )

Interrupt currently playing app announcement made with ::Say(). Only executes if there is an app announcement currently playing and if it is interruptible.

bool UAP_AudioQueue.IsCompletelyEmpty ( )

Checks if there is nothing currently playing or waiting to be played, including pauses.

bool UAP_AudioQueue.IsPlaying ( )

Checks whether audio is actively playing, TTS or audio clips, but not counting pauses.

bool UAP_AudioQueue.IsPlayingExceptAppOrSkippable ( )

Like IsPlaying(), but will return false if the audio playing is a skippable

Returns
void UAP_AudioQueue.StopAllInterruptibles ( )

Stops and removes everything in the queue that is tagged as interruptible (that's almost everything)

Member Data Documentation

string UAP_AudioQueue.m_CurrentElement = "none"

Read-only - for debugging purposes only.

float UAP_AudioQueue.m_CurrentPauseDuration = 0.0f

Read-only - for debugging purposes only.

int UAP_AudioQueue.m_CurrentQueueLength = 0

Read-only - for debugging purposes only.

bool UAP_AudioQueue.m_IsSpeaking = false

Read-only - for debugging purposes only.

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