Google Git
Sign in
fuchsia / reference-docs / main / . / f10 / sdk / fidl / fuchsia.mediastreams / README.md
blob: a7f33f9d3849c47819e277b0eef85193aae1c7a4 [file] [log] [blame] [view]
<link rel="stylesheet" href="../style.css" />
[TOC]
# fuchsia.mediastreams
<div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 7</span></div>
## **STRUCTS**
### AudioFormat {#AudioFormat data-text="AudioFormat"}
*Defined in [fuchsia.mediastreams/audio_format.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/audio_format.fidl;l=9)*
<p>Describes a format used for audio elementary streams without
reference to compression. Where compression is supported, this
type should be combined with a <code>Compression</code> struct.</p>
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="AudioFormat.sample_format">
<td><code>sample_format</code></td>
<td>
<code><a class='link' href='#AudioSampleFormat'>AudioSampleFormat</a></code>
</td>
<td><p>The type of individual samples.</p>
</td>
<td>No default</td>
</tr>
<tr id="AudioFormat.channel_count">
<td><code>channel_count</code></td>
<td>
<code>uint32</code>
</td>
<td><p>The number of samples per frame.</p>
</td>
<td>No default</td>
</tr>
<tr id="AudioFormat.frames_per_second">
<td><code>frames_per_second</code></td>
<td>
<code>uint32</code>
</td>
<td><p>The number of frames per second.</p>
</td>
<td>No default</td>
</tr>
<tr id="AudioFormat.channel_layout">
<td><code>channel_layout</code></td>
<td>
<code><a class='link' href='#AudioChannelLayout'>AudioChannelLayout</a></code>
</td>
<td><p>The spatial assignment of each channel.</p>
</td>
<td>No default</td>
</tr>
</table>
### Encryption {#Encryption data-text="Encryption"}
*Defined in [fuchsia.mediastreams/encryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=34)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="Encryption.scheme">
<td><code>scheme</code></td>
<td>
<code><a class='link' href='#EncryptionScheme'>EncryptionScheme</a></code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="Encryption.default_key_id">
<td><code>default_key_id</code></td>
<td>
<code><a class='link' href='#EncryptionKeyId'>EncryptionKeyId</a></code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="Encryption.default_init_vector">
<td><code>default_init_vector</code></td>
<td>
<code><a class='link' href='#EncryptionInitVector'>EncryptionInitVector</a></code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="Encryption.default_pattern">
<td><code>default_pattern</code></td>
<td>
<code><a class='link' href='#EncryptionPattern'>EncryptionPattern</a>?</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### EncryptionPattern {#EncryptionPattern data-text="EncryptionPattern"}
*Defined in [fuchsia.mediastreams/encryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=29)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="EncryptionPattern.clear_blocks">
<td><code>clear_blocks</code></td>
<td>
<code>uint32</code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="EncryptionPattern.encrypted_blocks">
<td><code>encrypted_blocks</code></td>
<td>
<code>uint32</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
### EncryptionSubsampleEntry {#EncryptionSubsampleEntry data-text="EncryptionSubsampleEntry"}
*Defined in [fuchsia.mediastreams/encryption.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=24)*
<table>
<tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
<tr id="EncryptionSubsampleEntry.clear_bytes">
<td><code>clear_bytes</code></td>
<td>
<code>uint32</code>
</td>
<td></td>
<td>No default</td>
</tr>
<tr id="EncryptionSubsampleEntry.encrypted_bytes">
<td><code>encrypted_bytes</code></td>
<td>
<code>uint32</code>
</td>
<td></td>
<td>No default</td>
</tr>
</table>
## **ENUMS**
### AudioSampleFormat [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#AudioSampleFormat data-text="AudioSampleFormat"}
Type: <code>uint32</code>
*Defined in [fuchsia.mediastreams/audio_format.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/audio_format.fidl;l=27)*
<p>Expresses the format of individual audio samples.</p>
<table>
<tr><th>Name</th><th>Value</th><th>Description</th></tr>
<tr id="AudioSampleFormat.UNSIGNED_8">
<td><h3 id="AudioSampleFormat.UNSIGNED_8" class="add-link hide-from-toc">UNSIGNED_8</h3></td>
<td><code>1</code></td>
<td></td>
</tr>
<tr id="AudioSampleFormat.SIGNED_16">
<td><h3 id="AudioSampleFormat.SIGNED_16" class="add-link hide-from-toc">SIGNED_16</h3></td>
<td><code>2</code></td>
<td></td>
</tr>
<tr id="AudioSampleFormat.SIGNED_24_IN_32">
<td><h3 id="AudioSampleFormat.SIGNED_24_IN_32" class="add-link hide-from-toc">SIGNED_24_IN_32</h3></td>
<td><code>3</code></td>
<td></td>
</tr>
<tr id="AudioSampleFormat.SIGNED_32">
<td><h3 id="AudioSampleFormat.SIGNED_32" class="add-link hide-from-toc">SIGNED_32</h3></td>
<td><code>4</code></td>
<td></td>
</tr>
<tr id="AudioSampleFormat.FLOAT">
<td><h3 id="AudioSampleFormat.FLOAT" class="add-link hide-from-toc">FLOAT</h3></td>
<td><code>5</code></td>
<td></td>
</tr>
</table>
## **UNIONS**
### AudioChannelLayout [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#AudioChannelLayout data-text="AudioChannelLayout"}
*Defined in [fuchsia.mediastreams/audio_format.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/audio_format.fidl;l=35)*
<table>
<tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
<tr id="AudioChannelLayout.placeholder">
<td><h3 id="AudioChannelLayout.placeholder" class="add-link hide-from-toc">1</h3></td>
<td><code>placeholder</code></td>
<td>
<code>uint8</code>
</td>
<td></td>
</tr>
</table>
## **CONSTANTS**
<table>
<tr><th>Name</th><th>Value</th><th>Type</th><th>Description</th></tr>
<tr id="ENCRYPTION_SCHEME_CBC1">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=18">ENCRYPTION_SCHEME_CBC1</a></td>
<td><code>cbc1</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr id="ENCRYPTION_SCHEME_CBCS">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=20">ENCRYPTION_SCHEME_CBCS</a></td>
<td><code>cbcs</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr id="ENCRYPTION_SCHEME_CENC">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=17">ENCRYPTION_SCHEME_CENC</a></td>
<td><code>cenc</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr id="ENCRYPTION_SCHEME_CENS">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=19">ENCRYPTION_SCHEME_CENS</a></td>
<td><code>cens</code></td>
<td><code>String</code></td>
<td></td>
</tr>
<tr id="MAX_ENCRYPTION_SCHEME_SIZE">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=7">MAX_ENCRYPTION_SCHEME_SIZE</a></td>
<td>
<code>4</code>
</td>
<td><code>int64</code></td>
<td><p>The maximum size of an <code>EncryptionScheme</code> string.</p>
</td>
</tr>
<tr id="MAX_INIT_VECTOR_SIZE">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=13">MAX_INIT_VECTOR_SIZE</a></td>
<td>
<code>16</code>
</td>
<td><code>int64</code></td>
<td><p>The maximum size of a <code>EncryptionInitVector</code> blob.</p>
</td>
</tr>
<tr id="MAX_KEY_ID_SIZE">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=10">MAX_KEY_ID_SIZE</a></td>
<td>
<code>16</code>
</td>
<td><code>int64</code></td>
<td><p>The maximum size of a <code>EncryptionKeyId</code> blob.</p>
</td>
</tr>
</table>
## **ALIASES**
<table>
<tr><th>Name</th><th>Value</th><th>Description</th></tr>
<tr id="EncryptionInitVector">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=22">EncryptionInitVector</a></td>
<td>
<code>vector</code>[<code><a class='link' href='#MAX_INIT_VECTOR_SIZE'>MAX_INIT_VECTOR_SIZE</a></code>]</td>
<td></td>
</tr>
<tr id="EncryptionKeyId">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=21">EncryptionKeyId</a></td>
<td>
<code>vector</code>[<code><a class='link' href='#MAX_KEY_ID_SIZE'>MAX_KEY_ID_SIZE</a></code>]</td>
<td></td>
</tr>
<tr id="EncryptionScheme">
<td><a href="https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.mediastreams/encryption.fidl;l=16">EncryptionScheme</a></td>
<td>
<code>string</code>[<code><a class='link' href='#MAX_ENCRYPTION_SCHEME_SIZE'>MAX_ENCRYPTION_SCHEME_SIZE</a></code>]</td>
<td><p>Identifies an encryption scheme.</p>
</td>
</tr>
</table>