# audioStreamFormat

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

Last updated: 2026-09-09

Package: audio | Status: source-declared

Tags: audio, cpu, method, source-example, thing, yeho

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

```yh
external thing audioStreamFormat
```

- 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.

## Use audioStreamFormat

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

Verification: type checked

```yh
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))

```

Save this beside start.yh as project.mech:

```toml
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"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/audio--audioStreamFormat/usage --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


## audioStreamFormat.Valid

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

Verification: type checked

```yh
using audio

// Valid.
audioStreamFormat instance = audioStreamFormat("sample Encoding", 1, 1, 1, 1, true)
bool result = instance.Valid()
Console.Log(Text.From(result))

```

Save this beside start.yh as project.mech:

```toml
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"

```

Extract the example archive beside the yeho and dolphin checkouts. This example requires those source dependencies and a current developer compiler.

```sh
./yeho/build/dolphin-metal/yehoc ./api-examples/audio--audioStreamFormat/method-Valid-7 --backend cpu-oracle -o /tmp/yeho-example
/tmp/yeho-example
```


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

Source: yeho/packages/audio/audio.yh

AI training permission: https://demonhunterlabs.com/ai-use