s&
About
The Project
infoAbout s&box mapRoadmap monitoringMetricsEngine startup and usage numbers
Updates
newspaperLatest News published_with_changesChangesRelease-by-release changelog
Games
Browse Games Discover Games
gamejamsvoting

Game Jam III

Ends Fri 25 Sep
ThemeOne More Round

Voting is open. Play the entries and pick the winner.

£50,000
prizepool
View the jam
Workshop
Playable
sports_esportsGamesStandalone games and gamemodes
Assets
landscapeMaps view_in_arModels textureMaterials apparelClothing
appsEverythingEvery asset type in one list
Forum
Learn
Documentation
rocket_launchGetting Started docsDocumentation apiAPI Reference
Resources
schoolTutorials manage_searchCode Search
Get s&box
Sign in with Steam
Api
Audio
SoundStream
chevron_left Audio
class
SoundStream

Constructors

functionsSoundStream

Properties

data_objectChannelsdata_objectLatencySamplesCountdata_objectMaxWriteSampleCountdata_objectQueuedSampleCountdata_objectSampleRate

Methods

functionsClosefunctionsDisposefunctionsPlayfunctionsWriteDatafunctionsWriteVoiceData
SoundStream
class Sandbox .
sealedSandbox.Engine

build Constructors 1

SoundStream (sampleRate, channels)

data_object Properties 5

Channels
int
Number of audio channels, as set during its creation.
LatencySamplesCount
int
MaxWriteSampleCount
int
QueuedSampleCount
int
SampleRate
int
Number of samples per second, as set during its creation.

functions Methods 5

Close ()
Close the stream: signals that no more data will be written. Once the internal buffer drains, Sandbox.SoundHandle.IsPlaying will become false.
Dispose ()
Play (volume, pitch)
SoundHandle
Play sound of the stream.
WriteData (data)
WriteVoiceData (data)
int
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.
Facepunch
  • News
  • Docs
  • Metrics
  • FAQ
  • Forum
  • Discord
  • Twitter