Interface LaunchAppRequest

Input to the ApplicationLauncher launchApp command

See

MatterSpecification.v13.Cluster § 6.4.7.1

interface LaunchAppRequest {
    application?: TypeFromFields<{
        applicationId: FieldType<string>;
        catalogVendorId: FieldType<number>;
    }>;
    data?: Uint8Array;
}

Hierarchy (view full)

Properties

application? data?

Properties

Optionalapplication

application?: TypeFromFields<{
    applicationId: FieldType<string>;
    catalogVendorId: FieldType<number>;
}>

This field shall specify the Application to launch.

Type declaration

  • applicationId: FieldType<string>

    This field shall indicate the application identifier, expressed as a string, such as "PruneVideo" or "Company X". This field shall be unique within a catalog.

    For the DIAL registry catalog, this value shall be the DIAL prefix (see [DIAL Registry]).

    See

    MatterSpecification.v13.Cluster § 6.4.5.2.2

  • catalogVendorId: FieldType<number>

    This field shall indicate the CSA-issued vendor ID for the catalog. The DIAL registry shall use value 0x0000.

    Content App Platform providers will have their own catalog vendor ID (set to their own Vendor ID) and will assign an ApplicationID to each Content App.

    See

    MatterSpecification.v13.Cluster § 6.4.5.2.1

See

MatterSpecification.v13.Cluster § 6.4.7.1.1

Optionaldata

data?: Uint8Array

This field shall specify optional app-specific data to be sent to the app.

NOTE

This format and meaning of this value is proprietary and outside the specification. It provides a transition path for device makers that use other protocols (like DIAL) which allow for proprietary data. Apps that are not yet Matter aware can be launched via Matter, while retaining the existing ability to launch with proprietary data.

See

MatterSpecification.v13.Cluster § 6.4.7.1.2

Settings

Member Visibility

On This Page

Properties