audio · thing ·

audioStreamFormat

A audio stream format record carrying sampleEncoding, sampleRate, channels, bitsPerSample, channelMask, and related state.

audiocpumethodsource-examplethingyeho

Play and control audio through Yeho's bounded audio runtime.

external thing audioStreamFormat

Status: source-declared

Fields and methods (8)
text sampleEncoding
Stores sample encoding as text.
int sampleRate
Stores sample rate as int.
int channels
Stores channels as int.
int bitsPerSample
Stores bits per sample as int.
int channelMask
Stores channel mask as int.
bool interleaved
Stores interleaved as bool.
audioStreamFormat(text sampleEncoding, int sampleRate, int channels, int bitsPerSample, int channelMask, bool interleaved)
Audio stream format.
Valid() returns bool
Valid. Complete example

Use audioStreamFormat

A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.

cpu · source-example · type checked

using audio

// Play and control audio through Yeho's bounded audio runtime.
audioStreamFormat sample = audioStreamFormat("sample Encoding", 1, 1, 1, 1, true)
Console.Log(Text.From(sample.sampleEncoding))
project.mech
manifestVersion = "2"
package = "api.example.audio__audiostreamformat"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "audio"
version = "0.1.0"
path = "../../../yeho/packages/audio"

audioStreamFormat.Valid

A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.

cpu · method · source-example · type checked

using audio

// Valid.
audioStreamFormat instance = audioStreamFormat("sample Encoding", 1, 1, 1, 1, true)
bool result = instance.Valid()
Console.Log(Text.From(result))
project.mech
manifestVersion = "2"
package = "api.example.audio__audiostreamformat"
version = "0.1.0"
languageEdition = "yeho-core-2026.1"

[app]
kind = "headless"

[[dependencies]]
package = "audio"
version = "0.1.0"
path = "../../../yeho/packages/audio"
Notes and source

Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup.

yeho/packages/audio/audio.yh:21