f11/sdk/fidl/fuchsia.castsysteminfo/README.md

<link rel="stylesheet" href="../style.css" />

[TOC]
# fuchsia.castsysteminfo

<div class="fidl-version-div"><span class="fidl-attribute fidl-version">Added: 7</span></div>


## **PROTOCOLS**

## Provider {#Provider}
*Defined in [fuchsia.castsysteminfo/cast_system_info.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.castsysteminfo/cast_system_info.fidl;l=32)*
<p>Exposes Cast system info, as modeled in the SystemInfo table.</p>


### GetSystemInfo {#Provider.GetSystemInfo}

<p>Retrieves the SystemInfo fields that are generated at first boot and are
available at startup.</p>



#### Request {#Provider.GetSystemInfo_Request}

&lt;EMPTY&gt;


#### Response {#Provider.GetSystemInfo_Response}

<table>
    <tr><th>Name</th><th>Type</th></tr>
        <tr>
            <td><code>result</code></td>
            <td>
                <code><a class='link' href='#Provider_GetSystemInfo_Result'>Provider_GetSystemInfo_Result</a></code>
            </td>
        </tr>
</table>


## **STRUCTS**

### Provider_GetSystemInfo_Response  {#Provider_GetSystemInfo_Response data-text="Provider_GetSystemInfo_Response"}
*Defined in [fuchsia.castsysteminfo/cast_system_info.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.castsysteminfo/cast_system_info.fidl;l=35)*

<table>
    <tr><th>Field</th><th>Type</th><th>Description</th><th>Default</th></tr>
        <tr id="Provider_GetSystemInfo_Response.systemInfo">
            <td><code>systemInfo</code></td>
            <td>
                <code><a class='link' href='#SystemInfo'>SystemInfo</a></code>
            </td>
            <td></td>
            <td>No default</td>
        </tr>
</table>


## **ENUMS**

### ErrorCode [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute} {#ErrorCode data-text="ErrorCode"}
Type: <code>uint32</code>

*Defined in [fuchsia.castsysteminfo/cast_system_info.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.castsysteminfo/cast_system_info.fidl;l=8)*
<p>Error codes for the GetSystemInfo operation.</p>

<table>
    <tr><th>Name</th><th>Value</th><th>Description</th></tr>
        <tr id="ErrorCode.ERR_NO_SYSTEM_INFO">
<td><h3 id="ErrorCode.ERR_NO_SYSTEM_INFO" class="add-link hide-from-toc">ERR_NO_SYSTEM_INFO</h3></td>
            <td><code>1</code></td>
            <td><p>Error when there is no system info available.</p>
</td>
        </tr>
        <tr id="ErrorCode.ERR_INTERNAL">
<td><h3 id="ErrorCode.ERR_INTERNAL" class="add-link hide-from-toc">ERR_INTERNAL</h3></td>
            <td><code>2</code></td>
            <td><p>Generic error.</p>
</td>
        </tr>
</table>


## **TABLES**

### SystemInfo  {#SystemInfo data-text="SystemInfo"}


*Defined in [fuchsia.castsysteminfo/cast_system_info.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.castsysteminfo/cast_system_info.fidl;l=20)*
<p>Cast-related device settings</p>
<p>This table may be extended to include additional cast-specific information.
The values requested here are generated on first boot of the device and
don't change unless there is a factory reset.</p>

<table>
    <tr><th>Ordinal</th><th>Field</th><th>Type</th><th>Description</th></tr>
        <tr id="SystemInfo.local_device_id">
<td><h3 id="SystemInfo.local_device_id" class="add-link hide-from-toc">1</h3></td>
            <td><code>local_device_id</code></td>
            <td>
                <code>string</code>
            </td>
            <td><p>Local (CastV2) device ID. Identifies the device on a local network.
Used by the Home app as the device identifier and for MDNS record matching.</p>
</td>
        </tr>
        <tr id="SystemInfo.cloud_device_id">
<td><h3 id="SystemInfo.cloud_device_id" class="add-link hide-from-toc">2</h3></td>
            <td><code>cloud_device_id</code></td>
            <td>
                <code>string</code>
            </td>
            <td><p>The device will use this identifier to send/receive CloudCast commands.
Sending a CloudCast command to the receiver with this ID will ensure that
the command is accepted and consumed by the device.</p>
</td>
        </tr>
</table>


## **UNIONS**

### Provider_GetSystemInfo_Result [strict](/fuchsia-src/reference/fidl/language/language.md#strict-vs-flexible){:.fidl-attribute}  {#Provider_GetSystemInfo_Result data-text="Provider_GetSystemInfo_Result"}
*Defined in [fuchsia.castsysteminfo/cast_system_info.fidl](https://cs.opensource.google/fuchsia/fuchsia/+/main:sdk/fidl/fuchsia.castsysteminfo/cast_system_info.fidl;l=35)*
<table>
    <tr><th>Ordinal</th><th>Variant</th><th>Type</th><th>Description</th></tr>
        <tr id="Provider_GetSystemInfo_Result.response">
<td><h3 id="Provider_GetSystemInfo_Result.response" class="add-link hide-from-toc">1</h3></td>
            <td><code>response</code></td>
            <td>
                <code><a class='link' href='#Provider_GetSystemInfo_Response'>Provider_GetSystemInfo_Response</a></code>
            </td>
            <td></td>
        </tr>
        <tr id="Provider_GetSystemInfo_Result.err">
<td><h3 id="Provider_GetSystemInfo_Result.err" class="add-link hide-from-toc">2</h3></td>
            <td><code>err</code></td>
            <td>
                <code><a class='link' href='#ErrorCode'>ErrorCode</a></code>
            </td>
            <td></td>
        </tr>
</table>