[ CallUrgency, ConversationHandle, ConvEventBody, EncryptionKey, EventSequence, IntervalSpec, IntervalSpecs, NB, newTune, nullConvHandle, nullHandle, PartyHandle, ProseSpec, ProseSpecs, Reason, ROPE, SHHH, SmartsHandle, StateInConv, ThHandle, Tune, VoiceInterval ],

nullConvHandle: Thrush.ConversationHandle = Thrush.nullConvHandle;

smartsID: Thrush.SmartsHandle←Thrush.nullHandle,

partyID: Thrush.PartyHandle ← Thrush.nullHandle,

shh: SHHH←NIL,

conversations: ConvDesc←NIL,

currentConvID: ConversationHandle ← nullConvHandle,

thProcess: PROCESS←NIL,

thAction: CONDITION,

apprise: BOOL←FALSE,

myName: ThSmartsRpcControl.InterfaceName ← [],

myRName: ROPE ← NIL,

myPassword: RPC.EncryptionKey ← NULL,

serverInstanceName: ROPE ← NIL,

serverInstance: ROPE←NIL,

namesGVInstanceName: ROPE←NIL,

namesGVInstance: ROPE←NIL,

sysNoises: RefTab.Ref ← NIL,

Call backs

ReportSystemState: PROC[ on: BOOL ],

ReportConversationState: PROC[ nb: NB, cDesc: ConvDesc, remark: ROPE←NIL ]

];

Switching data

cState: Thrush.ConvEventBody,  -- amalgam of useful info from reported events

desiredState: Thrush.StateInConv𡤊ny, -- what we're aiming for

desiredPartyID: PartyHandle←NULL,

desiredReason: Reason←wontSay,

desiredComment: ROPE←NIL,

requestedIntervals: Thrush.IntervalSpecs←NIL,

pendingIntervals: Thrush.IntervalSpecs←NIL, -- a tail of requestedIntervals, to be started

requestedProses: Thrush.ProseSpecs←NIL,

pendingProses: Thrush.ProseSpecs←NIL, -- a tail of requestedProses, to be started

newEvent, newSpec, newKeys, newAddress: BOOL ←FALSE,

descValid: BOOL←FALSE,

Client Data

clientData: REF ← NIL, -- only known use: FinchTool uses to store Viewer pointer

next, prev: ConvDesc←NIL,

otherPartyID: PartyHandle ← nullHandle,

otherPartyDesc: ROPE← NIL,

startTime: BasicTime.GMT←NULL,

originator: Orig ← unknown,

weOriginated: BOOL←FALSE, -- This Finch originated the call

bluejayConnection: BOOL←FALSE,

proseConnection: BOOL←FALSE,

conference: BOOL←FALSE,

completed: BOOL←FALSE,

failed: BOOL←FALSE

];

thrushInstance: Thrush.ROPE←NIL,

ReportSystemState: PROC[ on: BOOL ],

ReportConversationState: PROC[ nb: NB, cDesc: ConvDesc, remark: ROPE←NIL ]

];

Expect ReportSystemState, followed by some number of ReportConversationStates, soon.

No more than one client should call this procedure, at present.

convID: Thrush.ConversationHandle ← Thrush.nullConvHandle,

rName: ROPE←NIL,

number: ROPE←NIL,

urgency: Thrush.CallUrgency←normal,

useNumber: BOOL←FALSE];

Uses specified conversation, creates a new one or uses one that's in a sufficiently idle state.

Interpretation of rName and number -- evaluate until action can be taken:

convID: Thrush.ConversationHandle,

reason: Thrush.Reason←terminating,

comment: ROPE←NIL

];

RETURNS [ s: Thrush.EventSequence ];

ok: something was recorded

abandoned: user or client program asked to abandon the recording (supported?)

failed: something went wrong, but may not next time.

hopeless: will continue to fail until somebody does something creative.

convID: Thrush.ConversationHandle ← Thrush.nullConvHandle, --vestigial until I figger it out

useTune: Thrush.Tune←Thrush.newTune,

useInterval: Thrush.VoiceInterval←[],

queueIt: BOOL←FALSE

]

RETURNS[

reason: RecordReason, -- << wouldn't need if only "ok" and "failed/hopeless" are supported.>>

tune: Thrush.Tune,

interval: Thrush.VoiceInterval←NULL,

key: Thrush.EncryptionKey←NULL

];

This procedure waits until the recording is complete. While it is running, calls to the registered procedures may occur to inform the user of what's happening. Client is responsible for arranging process structures so that there is a process available to call StopTune while a call to RecordTune is still pending.

convID should be defaulted

convID: Thrush.ConversationHandle ← Thrush.nullConvHandle, --vestigial until I figger it out

reason: RecordReason←ok -- other valid value: abandon (recording only: supported?)

];

Terminates recording or playback of tune, if any. Causes any pending RecordTune to terminate and return.

convID: Thrush.ConversationHandle ← Thrush.nullConvHandle, --vestigial until I figger it out

tune: Thrush.Tune,

interval: Thrush.VoiceInterval←[],

key: Thrush.EncryptionKey,

queueIt: BOOL←FALSE,

failOK: BOOL←FALSE, -- playing is optional; leave connection open if tune doesn't exist.

wait: BOOL ← FALSE -- wait until things appear to be started properly, or have failed

] RETURNS [ started: BOOL←FALSE ];

convID: Thrush.ConversationHandle ← Thrush.nullConvHandle, --vestigial until I figger it out

noiseName: ATOM,

queueIt: BOOL←FALSE, -- Should be FALSE if timeout stuff is used!

serverInstance: ROPE←NIL, -- defaults to UserProfile.ThrushClientServerInstance; this is where the noise is stored.

failOK: BOOL←FALSE, -- playing is optional; leave connection open if tune doesn't exist.

wait: BOOL ← FALSE -- wait until things appear to be started properly, or have failed

] RETURNS [ started: BOOL ]; -- TRUE: things appear to be started properly

A translate proc is used to modify the text rope to make it more intelligible. Examples: 1) words that the Prose doesn't pronounce correctly could be respelled or given as phonemes, and 2) Prose commands to alter speech speed or pitch could be added.

Send rope to text-to—speech server. Called with rope = the current selection by FinchTool's SpeakText button. Input rope will be modified by the translate proc if (a) one is specified with this call or (b) one has previously been specified via RegisterTranslateProc[proc] below.

Register default translate procedure to be used by TextToSpeech to make the text rope more intelligible. Most useful as a way to modify the action of the FinchTool's SpeakText button.

Flushes text-to-speech server queues, halts current speech.

Flushes text-to-speech server queues, initiates Prose self-test, and resets all speech parameters. Intended as an escape hatch.

playbackTune: PlaybackTuneProc,

playNoise: PlayNoiseProc,

recordTune: RecordTuneProc,

stopTune: StopTuneProc,

textToSpeech: TextToSpeechProc,

registerTranslateProc: RegisterTranslateProcType,

stopSpeech: StopSpeechProc,

resetProse: StopSpeechProc,

finchIsRunning: PROC RETURNS [isRunning: BOOL]

];

Register a set of procedures to be invoked when the appropriate database changes occur. Return a registration that can be used to name the set

Get the current registered set, or NIL

a quick and safe way to find out if Finch has been loaded and if it is active or not