SpeechChannel:
Filter:

SpeechChannel : Object

(Undocumented class)
Source: Speech.sc

Description

This class is missing documentation.

Class Methods

Inherited class methods

Undocumented class methods

SpeechChannel.new(chan)

Instance Methods

Inherited instance methods

Undocumented instance methods

.channel

.doneAction

.doneAction = action

.isActive

.pause(bool)

.paused

.pitch

.pitch = midinote

.pitchMod

.pitchMod = mod

.prIsActive(chan)

.prSpeak(channel, txt)

.rate

.rate = ratein

.speak(string, force: false)

.stop(when: 0)

.voice

.voice = num

.volume

.volume = amp

.wordDoneAction

.wordDoneAction = action

Help template

Copy and paste the text below and save to HelpSource/Classes/SpeechChannel.schelp

TITLE:: SpeechChannel
summary:: (put short description here)
categories:: Undocumented classes
related:: Classes/SomeRelatedClass, Reference/SomeRelatedStuff, etc.

DESCRIPTION::
(put long description here)


CLASSMETHODS::

METHOD:: new
(describe method here)

ARGUMENT:: chan
(describe argument here)

returns:: (describe returnvalue here)


INSTANCEMETHODS::

METHOD:: stop
(describe method here)

ARGUMENT:: when
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: channel
(describe method here)

returns:: (describe returnvalue here)

METHOD:: voice
(describe method here)

ARGUMENT:: num
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: rate
(describe method here)

ARGUMENT:: ratein
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: volume
(describe method here)

ARGUMENT:: amp
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: speak
(describe method here)

ARGUMENT:: string
(describe argument here)

ARGUMENT:: force
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: prSpeak
(describe method here)

ARGUMENT:: channel
(describe argument here)

ARGUMENT:: txt
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: doneAction
(describe method here)

ARGUMENT:: action
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: pause
(describe method here)

ARGUMENT:: bool
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: paused
(describe method here)

returns:: (describe returnvalue here)

METHOD:: pitch
(describe method here)

ARGUMENT:: midinote
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: pitchMod
(describe method here)

ARGUMENT:: mod
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: prIsActive
(describe method here)

ARGUMENT:: chan
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: wordDoneAction
(describe method here)

ARGUMENT:: action
(describe argument here)

returns:: (describe returnvalue here)

METHOD:: isActive
(describe method here)

returns:: (describe returnvalue here)


EXAMPLES::

code::
(some example code)
::