wait: Wait for an event

Description Usage Arguments Details Value Examples

View source: R/api.R

Description

wait waits until an event occurs or times out

Usage

1
2
3
4
5
wait(x, ...)
## Default S3 method:
wait(x, timeout, ...)
## S3 method for class 'audioInstance'
wait(x, timeout=NA, ...)

Arguments

x

event to wait for

timeout

longest period to wait for (in seconds, real number). A value of 0 causes wait to just check for the event, values NA and less than zero mean to wait indefinitely until the even occurs.

...

optional arguments passed to the method specific to the object being monitored

Details

The default method allows x to specify the timeout, i.e., if timeout is not specified and x is numeric then the timeout is set to x.

Value

Returns the result.

Examples

1
2
3
4
# play a sound and wait until the playback is done
wait(play(sin(1:10000/20)))
# wait for 2.5 seconds unconditionally
wait(2.5)

audio documentation built on May 29, 2017, 11:25 p.m.

Search within the audio package
Search all R packages, documentation and source code