Variable ClusterInstanceConst

Type declaration

• Readonlyattributes: {
      currentChannel: OptionalAttribute<null | TypeFromFields<{
          affiliateCallSign: OptionalFieldType<string>;
          callSign: OptionalFieldType<string>;
          identifier: OptionalFieldType<string>;
          majorNumber: FieldType<number>;
          minorNumber: FieldType<number>;
          name: OptionalFieldType<string>;
          type: OptionalFieldType<Channel.ChannelType>;
      }>, any>;
  }

  • ReadonlycurrentChannel: OptionalAttribute<null | TypeFromFields<{
        affiliateCallSign: OptionalFieldType<string>;
        callSign: OptionalFieldType<string>;
        identifier: OptionalFieldType<string>;
        majorNumber: FieldType<number>;
        minorNumber: FieldType<number>;
        name: OptionalFieldType<string>;
        type: OptionalFieldType<Channel.ChannelType>;
    }>, any>

    This attribute shall contain the current channel. When supported but a channel is not currently tuned to (if a content application is in foreground), the value of the field shall be null.

    See

    MatterSpecification.v13.Cluster § 6.6.6.3

• Readonlycommands: {
      changeChannelByNumber: Command<TypeFromFields<{
          majorNumber: FieldType<number>;
          minorNumber: FieldType<number>;
      }>, void, any>;
      skipChannel: Command<TypeFromFields<{
          count: FieldType<number>;
      }>, void, any>;
  }

  • ReadonlychangeChannelByNumber: Command<TypeFromFields<{
        majorNumber: FieldType<number>;
        minorNumber: FieldType<number>;
    }>, void, any>

    Change the channel to the channel with the given Number in the ChannelList attribute.

    See

    MatterSpecification.v13.Cluster § 6.6.7.3

  • ReadonlyskipChannel: Command<TypeFromFields<{
        count: FieldType<number>;
    }>, void, any>

    This command provides channel up and channel down functionality, but allows channel index jumps of size Count.

    When the value of the increase or decrease is larger than the number of channels remaining in the given direction, then the behavior shall be to return to the beginning (or end) of the channel list and continue. For example, if the current channel is at index 0 and count value of -1 is given, then the current channel should change to the last channel.

    See

    MatterSpecification.v13.Cluster § 6.6.7.4

• Readonlyextensions: readonly [{
      component: {
          attributes: {
              channelList: Attribute<TypeFromFields<{
                  affiliateCallSign: OptionalFieldType<(...)>;
                  callSign: OptionalFieldType<(...)>;
                  identifier: OptionalFieldType<(...)>;
                  majorNumber: FieldType<(...)>;
                  minorNumber: FieldType<(...)>;
                  name: OptionalFieldType<(...)>;
                  type: OptionalFieldType<(...)>;
              }>[], any>;
          };
      };
      flags: {
          channelList: true;
      };
  }, {
      component: {
          attributes: {
              lineup: Attribute<null | TypeFromFields<{
                  lineupInfoType: FieldType<(...)>;
                  lineupName: OptionalFieldType<(...)>;
                  operatorName: FieldType<(...)>;
                  postalCode: OptionalFieldType<(...)>;
              }>, any>;
          };
      };
      flags: {
          lineupInfo: true;
      };
  }, {
      component: {
          commands: {
              changeChannel: Command<TypeFromFields<{
                  match: FieldType<string>;
              }>, TypeFromFields<{
                  data: OptionalFieldType<string>;
                  status: FieldType<Channel.Status>;
              }>, any>;
          };
      };
      flags: {
          channelList: true;
      };
  }, {
      component: {
          commands: {
              changeChannel: Command<TypeFromFields<{
                  match: FieldType<string>;
              }>, TypeFromFields<{
                  data: OptionalFieldType<string>;
                  status: FieldType<Channel.Status>;
              }>, any>;
          };
      };
      flags: {
          lineupInfo: true;
      };
  }, {
      component: {
          commands: {
              getProgramGuide: Command<TypeFromFields<{
                  channelList: OptionalFieldType<(...)[]>;
                  data: OptionalFieldType<Uint8Array>;
                  endTime: FieldType<number>;
                  externalIdList: OptionalFieldType<(...)[]>;
                  pageToken: OptionalFieldType<(...) | (...)>;
                  recordingFlag: OptionalFieldType<(...) | (...)>;
                  startTime: FieldType<number>;
              }>, TypeFromFields<{
                  paging: FieldType<TypeFromFields<(...)>>;
                  programList: FieldType<(...)[]>;
              }>, any>;
          };
      };
      flags: {
          electronicGuide: true;
      };
  }, {
      component: {
          commands: {
              cancelRecordProgram: Command<TypeFromFields<{
                  data: OptionalFieldType<Uint8Array>;
                  externalIdList: OptionalFieldType<(...)[]>;
                  programIdentifier: FieldType<string>;
                  shouldRecordSeries: FieldType<boolean>;
              }>, void, any>;
              recordProgram: Command<TypeFromFields<{
                  data: OptionalFieldType<Uint8Array>;
                  externalIdList: OptionalFieldType<(...)[]>;
                  programIdentifier: FieldType<string>;
                  shouldRecordSeries: FieldType<boolean>;
              }>, void, any>;
          };
      };
      flags: {
          electronicGuide: true;
          recordProgram: true;
      };
  }]

  This metadata controls which ChannelCluster elements matter.js activates for specific feature combinations.

• Readonlyfeatures: {
      channelList: BitFlag;
      electronicGuide: BitFlag;
      lineupInfo: BitFlag;
      recordProgram: BitFlag;
  }

  • ReadonlychannelList: BitFlag

    ChannelList

    Provides list of available channels.

  • ReadonlyelectronicGuide: BitFlag

    ElectronicGuide

    Provides electronic program guide information.

  • ReadonlylineupInfo: BitFlag

    LineupInfo

    Provides lineup info, which is a reference to an external source of lineup information.

  • ReadonlyrecordProgram: BitFlag

    RecordProgram

    Provides ability to record program.

• Readonlyid: 1284

• Readonlyname: "Channel"

• Readonlyrevision: 2