Interface Cluster

This cluster provides information about a Content App running on a Video Player device which is represented as an endpoint (see Device Type Library document).

The cluster server for this cluster should be supported on each endpoint that represents a Content App on a Video Player device. This cluster provides identification information about the Content App such as vendor and product.

See

MatterSpecification.v13.Cluster § 6.3

interface Cluster {
    attributes: Merge<{
        allowedVendorList: FixedAttribute<VendorId[], any>;
        application: FixedAttribute<TypeFromFields<{
            applicationId: FieldType<string>;
            catalogVendorId: FieldType<number>;
        }>, any>;
        applicationName: FixedAttribute<string, any>;
        applicationVersion: FixedAttribute<string, any>;
        productId: OptionalFixedAttribute<number, any>;
        status: Attribute<ApplicationBasic.ApplicationStatus, any>;
        vendorId: OptionalFixedAttribute<VendorId, any>;
        vendorName: OptionalFixedAttribute<string, any>;
    }, GlobalAttributes<{}>>;
    base: undefined;
    commands: {};
    events: {};
    extensions: undefined;
    features: {};
    id: Branded<1293, "ClusterId">;
    name: "ApplicationBasic";
    revision: 1;
    supportedFeatures: {};
    unknown: false;
    alter<const AlterationsT>(alterations: AlterationsT): WithAlterations<Of<{
        attributes: {
            allowedVendorList: FixedAttribute<VendorId[], any>;
            application: FixedAttribute<TypeFromFields<{
                applicationId: FieldType<string>;
                catalogVendorId: FieldType<number>;
            }>, any>;
            applicationName: FixedAttribute<string, any>;
            applicationVersion: FixedAttribute<string, any>;
            productId: OptionalFixedAttribute<number, any>;
            status: Attribute<ApplicationBasic.ApplicationStatus, any>;
            vendorId: OptionalFixedAttribute<VendorId, any>;
            vendorName: OptionalFixedAttribute<string, any>;
        };
        id: 1293;
        name: "ApplicationBasic";
        revision: 1;
    }>, AlterationsT>;
    enable<const FlagsT>(flags: FlagsT): WithFlags<Of<{
        attributes: {
            allowedVendorList: FixedAttribute<VendorId[], any>;
            application: FixedAttribute<TypeFromFields<{
                applicationId: FieldType<string>;
                catalogVendorId: FieldType<number>;
            }>, any>;
            applicationName: FixedAttribute<string, any>;
            applicationVersion: FixedAttribute<string, any>;
            productId: OptionalFixedAttribute<number, any>;
            status: Attribute<ApplicationBasic.ApplicationStatus, any>;
            vendorId: OptionalFixedAttribute<VendorId, any>;
            vendorName: OptionalFixedAttribute<string, any>;
        };
        id: 1293;
        name: "ApplicationBasic";
        revision: 1;
    }>, FlagsT>;
    set<const ValuesT>(values: ValuesT): WithValues<Of<{
        attributes: {
            allowedVendorList: FixedAttribute<VendorId[], any>;
            application: FixedAttribute<TypeFromFields<{
                applicationId: FieldType<string>;
                catalogVendorId: FieldType<number>;
            }>, any>;
            applicationName: FixedAttribute<string, any>;
            applicationVersion: FixedAttribute<string, any>;
            productId: OptionalFixedAttribute<number, any>;
            status: Attribute<ApplicationBasic.ApplicationStatus, any>;
            vendorId: OptionalFixedAttribute<VendorId, any>;
            vendorName: OptionalFixedAttribute<string, any>;
        };
        id: 1293;
        name: "ApplicationBasic";
        revision: 1;
    }>, ValuesT>;
    with<const SelectionT>(...selection: SelectionT): Of<Of<{
        attributes: {
            allowedVendorList: FixedAttribute<VendorId[], any>;
            application: FixedAttribute<TypeFromFields<{
                applicationId: FieldType<string>;
                catalogVendorId: FieldType<number>;
            }>, any>;
            applicationName: FixedAttribute<string, any>;
            applicationVersion: FixedAttribute<string, any>;
            productId: OptionalFixedAttribute<number, any>;
            status: Attribute<ApplicationBasic.ApplicationStatus, any>;
            vendorId: OptionalFixedAttribute<VendorId, any>;
            vendorName: OptionalFixedAttribute<string, any>;
        };
        id: 1293;
        name: "ApplicationBasic";
        revision: 1;
    }>, SelectionT>;
}

Hierarchy (view full)

Properties

attributes base commands events extensions features id name revision supportedFeatures unknown

Methods

alter enable set with

Properties

attributes

attributes: Merge<{
    allowedVendorList: FixedAttribute<VendorId[], any>;
    application: FixedAttribute<TypeFromFields<{
        applicationId: FieldType<string>;
        catalogVendorId: FieldType<number>;
    }>, any>;
    applicationName: FixedAttribute<string, any>;
    applicationVersion: FixedAttribute<string, any>;
    productId: OptionalFixedAttribute<number, any>;
    status: Attribute<ApplicationBasic.ApplicationStatus, any>;
    vendorId: OptionalFixedAttribute<VendorId, any>;
    vendorName: OptionalFixedAttribute<string, any>;
}, GlobalAttributes<{}>>

Type declaration

  • ReadonlyallowedVendorList: FixedAttribute<VendorId[], any>

    This attribute is a list of vendor IDs. Each entry is a vendor-id.

    See

    MatterSpecification.v13.Cluster § 6.3.5.8

  • Readonlyapplication: FixedAttribute<TypeFromFields<{
        applicationId: FieldType<string>;
        catalogVendorId: FieldType<number>;
    }>, any>

    This attribute shall specify a Content App which consists of an Application ID using a specified catalog.

    See

    MatterSpecification.v13.Cluster § 6.3.5.5

  • ReadonlyapplicationName: FixedAttribute<string, any>

    This attribute shall specify a human readable (displayable) name of the Content App assigned by the vendor. For example, "NPR On Demand". The maximum length of the ApplicationName attribute is 256 bytes of UTF-8 characters.

    See

    MatterSpecification.v13.Cluster § 6.3.5.3

  • ReadonlyapplicationVersion: FixedAttribute<string, any>

    This attribute shall specify a human readable (displayable) version of the Content App assigned by the vendor. The maximum length of the ApplicationVersion attribute is 32 bytes of UTF-8 characters.

    See

    MatterSpecification.v13.Cluster § 6.3.5.7

  • ReadonlyproductId: OptionalFixedAttribute<number, any>

    This attribute, if present, shall specify a numeric ID assigned by the vendor to identify a specific Content App made by them. If the Content App is certified by the Connectivity Standards Alliance, then this would be the Product ID as specified by the vendor for the certification.

    See

    MatterSpecification.v13.Cluster § 6.3.5.4

  • Readonlystatus: Attribute<ApplicationBasic.ApplicationStatus, any>

    This attribute shall specify the current running status of the application.

    See

    MatterSpecification.v13.Cluster § 6.3.5.6

  • ReadonlyvendorId: OptionalFixedAttribute<VendorId, any>

    This attribute, if present, shall specify the Connectivity Standards Alliance assigned Vendor ID for the Content App.

    See

    MatterSpecification.v13.Cluster § 6.3.5.2

  • ReadonlyvendorName: OptionalFixedAttribute<string, any>

    This attribute shall specify a human readable (displayable) name of the vendor for the Content App.

    See

    MatterSpecification.v13.Cluster § 6.3.5.1

base

base: undefined

commands

commands: {}

events

events: {}

extensions

extensions: undefined

features

features: {}

id

id: Branded<1293, "ClusterId">

name

name

revision

revision

supportedFeatures

supportedFeatures: {}

unknown

unknown

Methods

alter

enable

set

with

Settings

Member Visibility

On This Page

Properties
Methods