WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

AudioStream
✖
AudioStream

Unsupported in Cloud[Experimental]

✖
AudioStream[source]

creates a new AudioStream object from source.

✖

is an object that represents a unique audio stream.

Details and Options

  • AudioStream is a handle to an Audio object or a device to programmatically control playback or recording of audio signals.
  • The source can be either of the following:
  • audioa stream to play back a single audio signal
    {audio1,audio2,…}a stream to play back a list of audio signals
    funca stream generated from the function func
    deva stream recorded from the audio input device dev
  • The function func operates on a buffer of time values and for each time it should return a scalar or a vector of numeric values.
  • Use AudioPlay to start playing back the stream.
  • Use AudioRecord to start recording the stream.
  • Use AudioPause or AudioStop to pause or stop the playback or the recording.
  • The dev can be any available input audio device from $AudioInputDevices.
  • Use Audio[astream] to create an Audio object from a recorded stream.
  • The following options can be specified:
  • AudioChannelAssignment Inheritedhow to assign audio channels to outputs
    AudioOutputDevice Inheritedaudio output device to use for playback
    Looping Falsewhether to loop the playback
    SampleRate Automaticsampling rate
    SoundVolume Automaticsound volume
  • A property of an audio stream astream can be obtained using astream["prop"].
  • It is possible to set values of properties with astream["prop"]=val.
  • Some properties of the playback stream include:
  • "AudioChannelAssignment"how to assign audio channels to outputs
    "AudioOutputDevice"audio output device to use for playback
    "BufferSize"number of samples in each buffer
    "CurrentAudio"snippet of the current audio
    "ID"the stream ID
    "Looping"whether to loop the playback
    "Position"position of the playback given as a time Quantity
    "SampleRate"number of samples per second
    "SoundVolume"sound volume
    "Status"status of the stream
  • Possible settings for "Status" include "Playing", "Recording", "Paused" or "Stopped".
  • Additional properties for AudioStream[{audio1,audio2,…}]:
  • "CurrentTrack"index of the track being played
    "Ordering"ordering used to play back tracks
    "Duration"duration of the current tracks
    "Durations"durations of all tracks
    "TrackCount"number of tracks
  • Additional property for AudioStream[func]:
  • "Function"the generator function
  • Additional properties for AudioStream[dev]:
  • "AudioInputDevice"audio input device to use for recording
    "GeneratedAssetLocation"path to the file that will store the recorded audio
    "RecordedAudio"an Audio object containing the recording
  • Functions such as Join, Append, AppendTo and Drop can be used to modify an AudioStream object.

Examples

open allclose all

Basic Examples  (3)Summary of the most common use cases

Create an AudioStream object from an audio object:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-8sgxqm
Out[2]=2

Play the audio stream:

In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-e0cie8
Out[3]=3

Create an AudioStream object from an input device:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-3urexi
Out[1]=1

Record the stream:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-c9tl4s
Out[2]=2

Stop the recording:

In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-l4sgth

Create an AudioStream object from a function:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-8qtf8a
Out[1]=1

Play the AudioStream:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-jqnj5e
Out[2]=2

Stop the playback:

In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-xdndw5

Scope  (17)Survey of the scope of standard use cases

Basic Uses  (5)

Create two separate streams from an audio object:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-yj6vpv
Out[2]=2
Out[3]=3

The two streams are independent. Play one after 0.5 seconds from the beginning of the other one:

In[4]:=4
✖
https://wolfram.com/xid/0rs4qh5ye-2d9hmz

Check for available stream properties:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-mozlqk
Out[1]=1

Get the property values of an audio stream:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-k75xq8
Out[2]=2

Set the "Position" property:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-6igjw1
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-dvisd7
Out[2]=2

Play from the selected point:

In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-xdd85m
Out[3]=3

Modify properties while playing an audio stream:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-owmsd1
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-0v8vd0

The buffer size is inherited from the system option:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-5pr14b
Out[1]=1

Playback Streams  (7)

Inspect the properties of an AudioStream created from an Audio object:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-yfgc0m
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-x5l8nz
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0rs4qh5ye-zh9lue
Out[4]=4

Create an AudioStream from a list of Audio objects:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-76ne9r
Out[1]=1

Play the audio stream:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-3hv4gf
Out[2]=2

Inspect the properties of an AudioStream created from a list of Audio objects:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-mnvoho
Out[1]=1

Get the list of available properties:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-c31uuu
Out[2]=2

Get the values for all available properties:

In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-4rhzqa
Out[3]=3

Create an AudioStream from a list of Audio objects and specify an ordering:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-oues1
Out[1]=1

Change the ordering:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-p3ji3h
Out[2]=2

Play the stream with the specified ordering:

In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-8vy7kr
Out[3]=3

Create an AudioStream from a list of Audio objects and set some of the properties:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-zu7vt2
Out[1]=1

Change the "CurrentTrack" property and play the AudioStream:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-r7wrb4
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-jux061
Out[3]=3

Audio streams can be extended using Append. Generate an audio stream of two audio signals:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-nfljxx
Out[1]=1

Create another audio signal:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-3w8tuu

Append the new audio signal to the stream:

In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-ewj1n6
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0rs4qh5ye-s4cd93
Out[4]=4

Play back the resulting stream:

In[5]:=5
✖
https://wolfram.com/xid/0rs4qh5ye-pths14

Audio streams can be combined. Generate two audio streams:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-8mcp41
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-pawg3b
Out[2]=2

Join two audio streams:

In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-dlohpl
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0rs4qh5ye-q8rsfo
Out[4]=4

Play back the resulting stream:

In[5]:=5
✖
https://wolfram.com/xid/0rs4qh5ye-neckq1

Generator Streams  (4)

Inspect the properties of an AudioStream created from a function:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-f52a46
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-bsfjxu
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-8q0w9q
Out[3]=3

Create an AudioStream from a function and record the generated signal:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-1rq1ca
Out[1]=1

Stop the recording:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-udd92r

Retrieve the recorded signal:

In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-ibx4f4
Out[3]=3

With functions that return arrays of depth 2, the first dimension is interpreted as the number of channels:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-rxqgyg
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-u4yt6r

Create an AudioStream from a function:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-zrpaax
Out[1]=1

Change the function during playback:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-yp1vsl
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-g625us

Input Streams  (1)

Inspect the properties of an AudioStream created from an input device:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-opfye6
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-6yjt2u
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-ndx64e
Out[3]=3

Options  (6)Common values & functionality for each option

AudioChannelAssignment  (1)

By default, the AudioChannelAssignment is inherited from the corresponding Audio object:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-tauc01
In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-zlb8ul
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0rs4qh5ye-gt2m55
Out[4]=4

It is possible to set the AudioStream to a different channel assignment:

In[5]:=5
✖
https://wolfram.com/xid/0rs4qh5ye-4aumwk
In[6]:=6
✖
https://wolfram.com/xid/0rs4qh5ye-t453az
Out[6]=6

Note that the channel assignment of the original audio object stays the same:

In[7]:=7
✖
https://wolfram.com/xid/0rs4qh5ye-mo748c
Out[7]=7

AudioOutputDevice  (1)

By default, the AudioOutputDevice is inherited from the corresponding Audio object:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-b6b9sg
In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-rkxj5v
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0rs4qh5ye-grvkpt
Out[4]=4

It is possible to set the AudioStream to a different device using the AudioOutputDevice option:

In[11]:=11
✖
https://wolfram.com/xid/0rs4qh5ye-r01pyg
In[13]:=13
✖
https://wolfram.com/xid/0rs4qh5ye-zpxfv8
Out[13]=13
In[14]:=14
✖
https://wolfram.com/xid/0rs4qh5ye-zshk4q
Out[14]=14

Looping  (1)

By default, Looping is 1:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-1bgw5k
Out[3]=3

Play the stream twice:

In[4]:=4
✖
https://wolfram.com/xid/0rs4qh5ye-esv163
Out[5]=5

The value of the Looping option does not need to be an integer:

In[6]:=6
✖
https://wolfram.com/xid/0rs4qh5ye-8yg9wg
Out[7]=7

SampleRate  (2)

Use the SampleRate option to control the sample rate of a generator AudioStream:

In[4]:=4
✖
https://wolfram.com/xid/0rs4qh5ye-kaq7o5
Out[5]=5
In[6]:=6
✖
https://wolfram.com/xid/0rs4qh5ye-ukt73l

Use the SampleRate option to control the sample rate of an input AudioStream:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-8b92gs
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-vb3x0o
Out[2]=2

SoundVolume  (1)

By default, the SoundVolume is inherited from the corresponding Audio object:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-nn8hfa
In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-nkvhot
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0rs4qh5ye-bone32
Out[4]=4

It is possible to set the AudioStream to a different volume using the SoundVolume option:

In[5]:=5
✖
https://wolfram.com/xid/0rs4qh5ye-kp4cec
In[7]:=7
✖
https://wolfram.com/xid/0rs4qh5ye-qoa6gs
Out[7]=7
In[8]:=8
✖
https://wolfram.com/xid/0rs4qh5ye-loy9og
Out[8]=8

Applications  (4)Sample problems that can be solved with this function

Build a basic GUI:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-tdsf96
Out[1]=1

Display a gauge with the RMS amplitude of a signal while it is playing:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-vt6gt

Define a function to plot the loudness as a position on a horizontal gauge:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-g3ffj

Display the gauge dynamically:

In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-4ik0pb
Out[3]=3

Stop the stream:

In[4]:=4
✖
https://wolfram.com/xid/0rs4qh5ye-5vce5l

Display the power spectrum of a signal while it is playing:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-jjh0lt

Define a function for the display of the power spectrum:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-j9rbhw

Display the power spectrum dynamically:

In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-yooicl
Out[3]=3

Stop the stream:

In[4]:=4
✖
https://wolfram.com/xid/0rs4qh5ye-9eq6fz

Create an AudioStream from a function that uses only binary operations:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-b46nhv
Out[1]=1

Control some parameter dynamically using sliders:

In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-nqc94k
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-dkbhc

Properties & Relations  (2)Properties of the function, and connections to other functions

Use AudioPlay to create and start playing an audio stream:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-rrqgr
Out[2]=2

Use AudioRecord to create and start a recording audio stream:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-uj5qgo
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-ku4cs4

Possible Issues  (2)Common pitfalls and unexpected behavior

If the audio is choppy, try increasing the buffer size:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-jjyg9e
In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-8fr5up
In[3]:=3
✖
https://wolfram.com/xid/0rs4qh5ye-19krs7
Out[3]=3
In[4]:=4
✖
https://wolfram.com/xid/0rs4qh5ye-w1niu8
Out[4]=4
In[5]:=5
✖
https://wolfram.com/xid/0rs4qh5ye-wv4jv8
Out[5]=5
In[6]:=6
✖
https://wolfram.com/xid/0rs4qh5ye-66ywu2
Out[6]=6

It is not possible to set the "Position" property in the case of an input stream:

In[1]:=1
✖
https://wolfram.com/xid/0rs4qh5ye-o6mbe8
In[2]:=2
✖
https://wolfram.com/xid/0rs4qh5ye-bvekgc
Out[2]=2
Wolfram Research (2017), AudioStream, Wolfram Language function, https://reference.wolfram.com/language/ref/AudioStream.html (updated 2021).
✖
Wolfram Research (2017), AudioStream, Wolfram Language function, https://reference.wolfram.com/language/ref/AudioStream.html (updated 2021).

Text

Wolfram Research (2017), AudioStream, Wolfram Language function, https://reference.wolfram.com/language/ref/AudioStream.html (updated 2021).

✖
Wolfram Research (2017), AudioStream, Wolfram Language function, https://reference.wolfram.com/language/ref/AudioStream.html (updated 2021).

CMS

Wolfram Language. 2017. "AudioStream." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2021. https://reference.wolfram.com/language/ref/AudioStream.html.

✖
Wolfram Language. 2017. "AudioStream." Wolfram Language & System Documentation Center. Wolfram Research. Last Modified 2021. https://reference.wolfram.com/language/ref/AudioStream.html.

APA

Wolfram Language. (2017). AudioStream. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/AudioStream.html

✖
Wolfram Language. (2017). AudioStream. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/AudioStream.html

BibTeX

@misc{reference.wolfram_2025_audiostream, author="Wolfram Research", title="{AudioStream}", year="2021", howpublished="\url{https://reference.wolfram.com/language/ref/AudioStream.html}", note=[Accessed: 29-March-2025 ]}

✖
@misc{reference.wolfram_2025_audiostream, author="Wolfram Research", title="{AudioStream}", year="2021", howpublished="\url{https://reference.wolfram.com/language/ref/AudioStream.html}", note=[Accessed: 29-March-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_audiostream, organization={Wolfram Research}, title={AudioStream}, year={2021}, url={https://reference.wolfram.com/language/ref/AudioStream.html}, note=[Accessed: 29-March-2025 ]}

✖
@online{reference.wolfram_2025_audiostream, organization={Wolfram Research}, title={AudioStream}, year={2021}, url={https://reference.wolfram.com/language/ref/AudioStream.html}, note=[Accessed: 29-March-2025 ]}