audio.engine vocabulary
Factor handbook » Vocabulary index

Documentation
Audio playback engine

Metadata

Parents:	audio
Authors:	Joe Groff

Words

Tuple classes

Class	Superclass	Slots
audio-clip	disposable	audio-engine source al-source
audio-context-not-available	tuple	device-name
audio-device-not-found	tuple	device-name
audio-engine	disposable	voice-count al-device al-context al-sources listener next-source clips update-timer
audio-listener	tuple	position gain velocity orientation
audio-orientation-state	tuple	forward up
audio-source	tuple	position gain velocity relative? distance rolloff
static-audio-clip	audio-clip	al-buffer
streaming-audio-clip	audio-clip	generator channels sample-bits sample-rate al-buffers done?

Generic words

Word	Stack effect
audio-distance	( source -- distance )
audio-gain	( source/listener -- gain )
audio-orientation	( listener -- orientation )
audio-position	( source/listener -- position )
audio-relative?	( source -- relative? )
audio-rolloff	( source -- rolloff )
audio-velocity	( source/listener -- velocity )
generate-audio	( generator -- c-ptr size )
generator-audio-format	( generator -- channels sample-bits sample-rate )

Ordinary words

Word	Stack effect
<audio-engine>	( device-name voice-count -- engine )
<audio-orientation-state>	( forward up -- audio-orientation-state )
<standard-audio-engine>	( -- engine )
<static-audio-clip>	( audio-engine source audio loop? -- audio-clip/f )
<streaming-audio-clip>	( audio-engine source generator buffer-count -- audio-clip/f )
audio-context-not-available	( device-name -- * )
audio-device-not-found	( device-name -- * )
orientation>float-array	( orientation -- float-array )
pause-clip	( audio-clip -- )
pause-clips	( audio-clips -- )
play-clip	( audio-clip -- )
play-clips	( audio-clips -- )
play-static-audio-clip	( audio-engine source audio loop? -- audio-clip/f )
play-streaming-audio-clip	( audio-engine source generator buffer-count -- audio-clip/f )
start-audio	( audio-engine -- )
start-audio*	( audio-engine -- )
stop-audio	( audio-engine -- )
stop-clip	( audio-clip -- )
stop-clips	( audio-clips -- )
update-audio	( audio-engine -- )

Class predicate words

Word	Stack effect
audio-clip?	( object -- ? )
audio-context-not-available?	( object -- ? )
audio-device-not-found?	( object -- ? )
audio-engine?	( object -- ? )
audio-listener?	( object -- ? )
audio-orientation-state?	( object -- ? )
audio-source?	( object -- ? )
static-audio-clip?	( object -- ? )
streaming-audio-clip?	( object -- ? )

Files

resource:extra/audio/engine/engine.factor
resource:extra/audio/engine/engine-docs.factor

Metadata files

resource:extra/audio/engine/authors.txt
resource:extra/audio/engine/summary.txt

Children from resource:extra

Vocabulary	Summary
audio.engine.test

Children

Vocabulary	Summary
audio.engine.private