Interface ITTSMessageQueue

Inherited Members

IEnumerable<TTSMessage>.GetEnumerator()

Namespace: VivoxUnity

Assembly: VivoxUnity.dll

Syntax

public interface ITTSMessageQueue : IEnumerable<TTSMessage>, IEnumerable

Properties

Count

Get the number of elements contained in the collection.

Declaration

int Count { get; }

Property Value

Type	Description
int

Methods

Clear()

Remove all objects from the collection and cancel them.

Declaration

void Clear()

See Also

CancelAll()

Contains(TTSMessage)

Determine whether a TTSMessage is in the collection.

Declaration

bool Contains(TTSMessage message)

Parameters

Type	Name	Description
TTSMessage	message	The TTSMessage to locate in the collection.

Returns

Type	Description
bool

Dequeue()

Remove and return the oldest TTSMessage in the collection. This cancels the message.

Declaration

TTSMessage Dequeue()

Returns

Type	Description
TTSMessage

See Also

CancelMessage(TTSMessage)

Enqueue(TTSMessage)

Add a message and speak it as the user that the collection belongs to.

Declaration

void Enqueue(TTSMessage message)

Parameters

Type	Name	Description
TTSMessage	message	The TTSMessage to add and speak.

See Also

Speak(TTSMessage)

Peek()

Return the oldest TTSMessage in the collection without removing it.

Declaration

TTSMessage Peek()

Returns

Type	Description
TTSMessage

Remove(TTSMessage)

Remove a specific message from the collection. This cancels the message.

Declaration

bool Remove(TTSMessage message)

Parameters

Type	Name	Description
TTSMessage	message	The TTSMessage to remove and cancel.

Returns

Type	Description
bool

See Also

CancelMessage(TTSMessage)

Events

AfterMessageAdded

Raised when a TTSMessage is added to the text-to-speech subsystem.

Declaration

event EventHandler<ITTSMessageQueueEventArgs> AfterMessageAdded

Event Type

Type	Description
EventHandler<ITTSMessageQueueEventArgs>

AfterMessageUpdated

Raised when playback begins for a TTSMessage in the collection.

Declaration

event EventHandler<ITTSMessageQueueEventArgs> AfterMessageUpdated

Event Type

Type	Description
EventHandler<ITTSMessageQueueEventArgs>

BeforeMessageRemoved

Raised when a TTSMessage is removed from the text-to-speech subsystem.

Declaration

event EventHandler<ITTSMessageQueueEventArgs> BeforeMessageRemoved

Event Type

Type	Description
EventHandler<ITTSMessageQueueEventArgs>

Remarks

This can result from either cancellation or playback completion.