{"id":"audio--audioStreamFormat","name":"audioStreamFormat","owner":"yeho","package":"audio","kind":"thing","signature":"external thing audioStreamFormat","description":"A audio stream format record carrying sampleEncoding, sampleRate, channels, bitsPerSample, channelMask, and related state.","context":"Play and control audio through Yeho's bounded audio runtime.","parameters":[],"returns":"void","members":[{"name":"sampleEncoding","kind":"field","type":"text","description":"Stores sample encoding as text.","signature":"text sampleEncoding","tags":["thing","field","audio"],"updated":"2026-09-09"},{"name":"sampleRate","kind":"field","type":"int","description":"Stores sample rate as int.","signature":"int sampleRate","tags":["thing","field","audio"],"updated":"2026-09-09"},{"name":"channels","kind":"field","type":"int","description":"Stores channels as int.","signature":"int channels","tags":["thing","field","audio"],"updated":"2026-09-09"},{"name":"bitsPerSample","kind":"field","type":"int","description":"Stores bits per sample as int.","signature":"int bitsPerSample","tags":["thing","field","audio"],"updated":"2026-09-09"},{"name":"channelMask","kind":"field","type":"int","description":"Stores channel mask as int.","signature":"int channelMask","tags":["thing","field","audio"],"updated":"2026-09-09"},{"name":"interleaved","kind":"field","type":"bool","description":"Stores interleaved as bool.","signature":"bool interleaved","tags":["thing","field","audio"],"updated":"2026-09-09"},{"name":"audioStreamFormat","kind":"constructor","parameters":[{"name":"sampleEncoding","type":"text","description":"Sample encoding."},{"name":"sampleRate","type":"int","description":"Sample rate."},{"name":"channels","type":"int","description":"Channels."},{"name":"bitsPerSample","type":"int","description":"Bits per sample."},{"name":"channelMask","type":"int","description":"Channel mask."},{"name":"interleaved","type":"bool","description":"Interleaved."}],"returns":"void","signature":"audioStreamFormat(text sampleEncoding, int sampleRate, int channels, int bitsPerSample, int channelMask, bool interleaved)","description":"Audio stream format.","tags":["thing","constructor","audio"],"updated":"2026-09-09"},{"name":"Valid","kind":"method","parameters":[],"returns":"bool","signature":"Valid() returns bool","description":"Valid.","tags":["thing","method","audio"],"exampleId":"method-Valid-7","updated":"2026-09-09"}],"tags":["audio","cpu","method","source-example","thing","yeho"],"updated":"2026-09-09","source":{"repository":"yeho","path":"packages/audio/audio.yh","line":21,"sha256":"02666e1bb2673c40210d372d8775a26bc82643a3070205b14759fe98b97ff6cb"},"status":"source-declared","notes":["Package presence and a declaration do not establish support on every host. Host services need their platform and lifecycle setup."],"examples":[{"id":"usage","title":"Use audioStreamFormat","description":"A complete small caller. Values are illustrative; check the returned result and package requirements before connecting live resources.","code":"using audio\n\n// Play and control audio through Yeho's bounded audio runtime.\naudioStreamFormat sample = audioStreamFormat(\"sample Encoding\", 1, 1, 1, 1, true)\nConsole.Log(Text.From(sample.sampleEncoding))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.audio__audiostreamformat\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"audio\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/audio\"\n","tags":["cpu","source-example"],"verification":"type checked","run":"cpu-oracle","sha256":"2eaf287d5db2712c76381ffcb33486e369d9561241dcb7ac1e24e1bc314c06d2","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null},{"id":"method-Valid-7","title":"audioStreamFormat.Valid","description":"A complete caller for this public method. Sample inputs are illustrative; native resources require their owning lifecycle.","code":"using audio\n\n// Valid.\naudioStreamFormat instance = audioStreamFormat(\"sample Encoding\", 1, 1, 1, 1, true)\nbool result = instance.Valid()\nConsole.Log(Text.From(result))\n","manifest":"manifestVersion = \"2\"\npackage = \"api.example.audio__audiostreamformat\"\nversion = \"0.1.0\"\nlanguageEdition = \"yeho-core-2026.1\"\n\n[app]\nkind = \"headless\"\n\n[[dependencies]]\npackage = \"audio\"\nversion = \"0.1.0\"\npath = \"../../../yeho/packages/audio\"\n","tags":["cpu","method","source-example"],"run":"cpu-oracle","verification":"type checked","sha256":"d207a7d35dd54c1f4815c334c42677d786ec38bcb9cbbd20f1170d2fb8003e2a","checked":"2026-09-09","diagnostic":"","observedOutput":null,"checkedBackend":null}],"searchTerms":["sampleEncoding","sampleRate","channels","bitsPerSample","channelMask","interleaved","audioStreamFormat","Valid"],"url":"https://demonhunterlabs.com/academy/api?item=audio--audioStreamFormat","json":"https://demonhunterlabs.com/reference/items/audio--audioStreamFormat.json","markdown":"https://demonhunterlabs.com/reference/text/audio--audioStreamFormat.md"}