Variable ScreenTimeComponentConst

ScreenTimeComponent: {
    attributes: {
        remainingScreenTime: Attribute<number, any>;
        screenDailyTime: Attribute<number, any>;
    };
    commands: {
        addBonusTime: Command<TypeFromFields, void, any>;
        setScreenDailyTime: Command<TypeFromFields, void, any>;
    };
    events: {
        remainingScreenTimeExpired: Event<void, any>;
    };
}

A ContentControlCluster supports these elements if it supports feature ScreenTime.

Type declaration

  • Readonlyattributes: {
        remainingScreenTime: Attribute<number, any>;
        screenDailyTime: Attribute<number, any>;
    }
    • ReadonlyremainingScreenTime: Attribute<number, any>

      Indicates the remaining screen time (in seconds) which the User is allowed to spend watching TV for the current day when the Content Control feature is activated. When this value equals 0, the media device shall terminate the playback of content.

      This attribute shall be updated when the AddBonusTime command is received and processed successfully (with the correct PIN).

      See

      MatterSpecification.v13.Cluster § 6.13.7.7

    • ReadonlyscreenDailyTime: Attribute<number, any>

      Indicates the amount of time (in seconds) which the User is allowed to spend watching TV within one day when the Content Control feature is activated.

      See

      MatterSpecification.v13.Cluster § 6.13.7.6

  • Readonlycommands: {
        addBonusTime: Command<TypeFromFields, void, any>;
        setScreenDailyTime: Command<TypeFromFields, void, any>;
    }
    • ReadonlyaddBonusTime: Command<TypeFromFields, void, any>

      The purpose of this command is to add the extra screen time for the user.

      If a client with Operate privilege invokes this command, the media device shall check whether

      the PINCode passed in the command matches the current PINCode value. If these match, then the RemainingScreenTime attribute shall be increased by the specified BonusTime value.

      If the PINs do not match, then a response with InvalidPINCode error status shall be returned, and no changes shall be made to RemainingScreenTime.

      If a client with Manage privilege or greater invokes this command, the media device shall ignore the PINCode field and directly increase the RemainingScreenTime attribute by the specified BonusTime value.

      A server that does not support the PM feature shall respond with InvalidPINCode to clients that only have Operate privilege unless:

      • It has been provided with the PIN value to expect via an out of band mechanism, and

      • The client has provided a PINCode that matches the expected PIN value.

      See

      MatterSpecification.v13.Cluster § 6.13.8.6

    • ReadonlysetScreenDailyTime: Command<TypeFromFields, void, any>

      The purpose of this command is to set the ScreenDailyTime attribute.

      Upon receipt of the SetScreenDailyTime command, the media device shall set the ScreenDailyTime attribute to the ScreenTime value.

      See

      MatterSpecification.v13.Cluster § 6.13.8.7

  • Readonlyevents: {
        remainingScreenTimeExpired: Event<void, any>;
    }
    • ReadonlyremainingScreenTimeExpired: Event<void, any>

      This event shall be generated when the RemainingScreenTime equals 0.

      See

      MatterSpecification.v13.Cluster § 6.13.9.1

Settings

Member Visibility