@matter/types 0.14.0-alpha.0-20250531-7ed2d6da8 → 0.14.0-alpha.0-20250602-37f27bb02
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/clusters/access-control.d.ts +250 -250
- package/dist/cjs/clusters/access-control.js +39 -39
- package/dist/cjs/clusters/account-login.d.ts +29 -29
- package/dist/cjs/clusters/account-login.js +11 -11
- package/dist/cjs/clusters/actions.d.ts +108 -108
- package/dist/cjs/clusters/actions.js +39 -39
- package/dist/cjs/clusters/administrator-commissioning.d.ts +77 -51
- package/dist/cjs/clusters/administrator-commissioning.d.ts.map +1 -1
- package/dist/cjs/clusters/administrator-commissioning.js +32 -12
- package/dist/cjs/clusters/administrator-commissioning.js.map +1 -1
- package/dist/cjs/clusters/air-quality.d.ts +5 -5
- package/dist/cjs/clusters/air-quality.js +1 -1
- package/dist/cjs/clusters/alarm-base.d.ts +43 -43
- package/dist/cjs/clusters/alarm-base.js +14 -14
- package/dist/cjs/clusters/application-basic.d.ts +16 -16
- package/dist/cjs/clusters/application-basic.js +10 -10
- package/dist/cjs/clusters/application-launcher.d.ts +141 -99
- package/dist/cjs/clusters/application-launcher.d.ts.map +1 -1
- package/dist/cjs/clusters/application-launcher.js +45 -13
- package/dist/cjs/clusters/application-launcher.js.map +2 -2
- package/dist/cjs/clusters/audio-output.d.ts +37 -37
- package/dist/cjs/clusters/audio-output.js +8 -8
- package/dist/cjs/clusters/ballast-configuration.d.ts +23 -23
- package/dist/cjs/clusters/ballast-configuration.js +17 -17
- package/dist/cjs/clusters/basic-information.d.ts +54 -54
- package/dist/cjs/clusters/basic-information.js +34 -34
- package/dist/cjs/clusters/binding.d.ts +12 -12
- package/dist/cjs/clusters/binding.js +5 -5
- package/dist/cjs/clusters/boolean-state-configuration.d.ts +92 -92
- package/dist/cjs/clusters/boolean-state-configuration.js +18 -18
- package/dist/cjs/clusters/boolean-state.d.ts +7 -7
- package/dist/cjs/clusters/boolean-state.js +3 -3
- package/dist/cjs/clusters/bridged-device-basic-information.d.ts +102 -102
- package/dist/cjs/clusters/bridged-device-basic-information.js +28 -28
- package/dist/cjs/clusters/channel.d.ts +577 -559
- package/dist/cjs/clusters/channel.d.ts.map +1 -1
- package/dist/cjs/clusters/channel.js +87 -73
- package/dist/cjs/clusters/channel.js.map +2 -2
- package/dist/cjs/clusters/color-control.d.ts +658 -658
- package/dist/cjs/clusters/color-control.js +116 -116
- package/dist/cjs/clusters/commissioner-control.d.ts +16 -16
- package/dist/cjs/clusters/commissioner-control.js +5 -5
- package/dist/cjs/clusters/concentration-measurement.d.ts +26 -26
- package/dist/cjs/clusters/concentration-measurement.js +11 -11
- package/dist/cjs/clusters/content-app-observer.d.ts +27 -17
- package/dist/cjs/clusters/content-app-observer.d.ts.map +1 -1
- package/dist/cjs/clusters/content-app-observer.js +14 -6
- package/dist/cjs/clusters/content-app-observer.js.map +2 -2
- package/dist/cjs/clusters/content-control.d.ts +438 -356
- package/dist/cjs/clusters/content-control.d.ts.map +1 -1
- package/dist/cjs/clusters/content-control.js +120 -58
- package/dist/cjs/clusters/content-control.js.map +1 -1
- package/dist/cjs/clusters/content-launcher.d.ts +509 -475
- package/dist/cjs/clusters/content-launcher.d.ts.map +1 -1
- package/dist/cjs/clusters/content-launcher.js +65 -39
- package/dist/cjs/clusters/content-launcher.js.map +2 -2
- package/dist/cjs/clusters/descriptor.d.ts +28 -28
- package/dist/cjs/clusters/descriptor.js +8 -8
- package/dist/cjs/clusters/device-energy-management-mode.d.ts +43 -43
- package/dist/cjs/clusters/device-energy-management-mode.js +8 -8
- package/dist/cjs/clusters/device-energy-management.d.ts +544 -544
- package/dist/cjs/clusters/device-energy-management.js +87 -87
- package/dist/cjs/clusters/diagnostic-logs.d.ts +67 -33
- package/dist/cjs/clusters/diagnostic-logs.d.ts.map +1 -1
- package/dist/cjs/clusters/diagnostic-logs.js +34 -8
- package/dist/cjs/clusters/diagnostic-logs.js.map +2 -2
- package/dist/cjs/clusters/dishwasher-alarm.d.ts +57 -57
- package/dist/cjs/clusters/dishwasher-alarm.js +14 -14
- package/dist/cjs/clusters/dishwasher-mode.d.ts +42 -42
- package/dist/cjs/clusters/dishwasher-mode.js +8 -8
- package/dist/cjs/clusters/door-lock.d.ts +1367 -1350
- package/dist/cjs/clusters/door-lock.d.ts.map +1 -1
- package/dist/cjs/clusters/door-lock.js +242 -228
- package/dist/cjs/clusters/door-lock.js.map +1 -1
- package/dist/cjs/clusters/ecosystem-information.d.ts +27 -27
- package/dist/cjs/clusters/ecosystem-information.js +12 -12
- package/dist/cjs/clusters/electrical-energy-measurement.d.ts +275 -275
- package/dist/cjs/clusters/electrical-energy-measurement.js +25 -25
- package/dist/cjs/clusters/electrical-power-measurement.d.ts +199 -199
- package/dist/cjs/clusters/electrical-power-measurement.js +39 -39
- package/dist/cjs/clusters/energy-evse-mode.d.ts +43 -43
- package/dist/cjs/clusters/energy-evse-mode.js +8 -8
- package/dist/cjs/clusters/energy-evse.d.ts +323 -323
- package/dist/cjs/clusters/energy-evse.js +73 -73
- package/dist/cjs/clusters/energy-preference.d.ts +49 -49
- package/dist/cjs/clusters/energy-preference.js +9 -9
- package/dist/cjs/clusters/ethernet-network-diagnostics.d.ts +31 -31
- package/dist/cjs/clusters/ethernet-network-diagnostics.js +10 -10
- package/dist/cjs/clusters/fan-control.d.ts +67 -67
- package/dist/cjs/clusters/fan-control.js +17 -17
- package/dist/cjs/clusters/fixed-label.d.ts +2 -2
- package/dist/cjs/clusters/fixed-label.js +1 -1
- package/dist/cjs/clusters/flow-measurement.d.ts +5 -5
- package/dist/cjs/clusters/flow-measurement.js +4 -4
- package/dist/cjs/clusters/general-commissioning.d.ts +104 -104
- package/dist/cjs/clusters/general-commissioning.js +25 -25
- package/dist/cjs/clusters/general-diagnostics.d.ts +174 -174
- package/dist/cjs/clusters/general-diagnostics.js +40 -40
- package/dist/cjs/clusters/group-key-management.d.ts +119 -119
- package/dist/cjs/clusters/group-key-management.js +23 -23
- package/dist/cjs/clusters/groups.d.ts +78 -78
- package/dist/cjs/clusters/groups.js +21 -21
- package/dist/cjs/clusters/icd-management.d.ts +131 -131
- package/dist/cjs/clusters/icd-management.js +29 -29
- package/dist/cjs/clusters/identify.d.ts +16 -16
- package/dist/cjs/clusters/identify.js +6 -6
- package/dist/cjs/clusters/illuminance-measurement.d.ts +7 -7
- package/dist/cjs/clusters/illuminance-measurement.js +5 -5
- package/dist/cjs/clusters/joint-fabric-datastore.d.ts +175 -175
- package/dist/cjs/clusters/joint-fabric-datastore.js +62 -62
- package/dist/cjs/clusters/joint-fabric-pki.d.ts +14 -14
- package/dist/cjs/clusters/joint-fabric-pki.js +5 -5
- package/dist/cjs/clusters/keypad-input.d.ts +34 -16
- package/dist/cjs/clusters/keypad-input.d.ts.map +1 -1
- package/dist/cjs/clusters/keypad-input.js +17 -3
- package/dist/cjs/clusters/keypad-input.js.map +2 -2
- package/dist/cjs/clusters/label.d.ts +10 -10
- package/dist/cjs/clusters/label.js +3 -3
- package/dist/cjs/clusters/laundry-dryer-controls.d.ts +4 -4
- package/dist/cjs/clusters/laundry-dryer-controls.js +2 -2
- package/dist/cjs/clusters/laundry-washer-controls.d.ts +23 -23
- package/dist/cjs/clusters/laundry-washer-controls.js +6 -6
- package/dist/cjs/clusters/laundry-washer-mode.d.ts +34 -34
- package/dist/cjs/clusters/laundry-washer-mode.js +5 -5
- package/dist/cjs/clusters/level-control.d.ts +303 -303
- package/dist/cjs/clusters/level-control.js +32 -32
- package/dist/cjs/clusters/localization-configuration.d.ts +3 -3
- package/dist/cjs/clusters/localization-configuration.js +2 -2
- package/dist/cjs/clusters/low-power.d.ts +2 -2
- package/dist/cjs/clusters/low-power.js +1 -1
- package/dist/cjs/clusters/media-input.d.ts +47 -47
- package/dist/cjs/clusters/media-input.js +11 -11
- package/dist/cjs/clusters/media-playback.d.ts +427 -385
- package/dist/cjs/clusters/media-playback.d.ts.map +1 -1
- package/dist/cjs/clusters/media-playback.js +89 -57
- package/dist/cjs/clusters/media-playback.js.map +2 -2
- package/dist/cjs/clusters/messages.d.ts +154 -154
- package/dist/cjs/clusters/messages.js +38 -38
- package/dist/cjs/clusters/microwave-oven-control.d.ts +63 -63
- package/dist/cjs/clusters/microwave-oven-control.js +17 -17
- package/dist/cjs/clusters/microwave-oven-mode.d.ts +39 -39
- package/dist/cjs/clusters/microwave-oven-mode.js +7 -7
- package/dist/cjs/clusters/mode-base.d.ts +59 -59
- package/dist/cjs/clusters/mode-base.js +13 -13
- package/dist/cjs/clusters/mode-select.d.ts +51 -51
- package/dist/cjs/clusters/mode-select.js +13 -13
- package/dist/cjs/clusters/network-commissioning.d.ts +325 -325
- package/dist/cjs/clusters/network-commissioning.js +46 -46
- package/dist/cjs/clusters/occupancy-sensing.d.ts +78 -78
- package/dist/cjs/clusters/occupancy-sensing.js +20 -20
- package/dist/cjs/clusters/on-off.d.ts +103 -103
- package/dist/cjs/clusters/on-off.js +19 -19
- package/dist/cjs/clusters/operational-credentials.d.ts +94 -94
- package/dist/cjs/clusters/operational-credentials.js +34 -34
- package/dist/cjs/clusters/operational-state.d.ts +67 -67
- package/dist/cjs/clusters/operational-state.js +21 -21
- package/dist/cjs/clusters/ota-software-update-provider.d.ts +95 -61
- package/dist/cjs/clusters/ota-software-update-provider.d.ts.map +1 -1
- package/dist/cjs/clusters/ota-software-update-provider.js +51 -25
- package/dist/cjs/clusters/ota-software-update-provider.js.map +2 -2
- package/dist/cjs/clusters/ota-software-update-requestor.d.ts +72 -72
- package/dist/cjs/clusters/ota-software-update-requestor.js +25 -25
- package/dist/cjs/clusters/oven-cavity-operational-state.d.ts +16 -16
- package/dist/cjs/clusters/oven-cavity-operational-state.js +11 -11
- package/dist/cjs/clusters/oven-mode.d.ts +40 -40
- package/dist/cjs/clusters/oven-mode.js +5 -5
- package/dist/cjs/clusters/power-source-configuration.d.ts +2 -2
- package/dist/cjs/clusters/power-source-configuration.js +1 -1
- package/dist/cjs/clusters/power-source.d.ts +155 -155
- package/dist/cjs/clusters/power-source.js +41 -41
- package/dist/cjs/clusters/power-topology.d.ts +8 -8
- package/dist/cjs/clusters/power-topology.js +2 -2
- package/dist/cjs/clusters/pressure-measurement.d.ts +25 -25
- package/dist/cjs/clusters/pressure-measurement.js +9 -9
- package/dist/cjs/clusters/proxy-configuration.d.ts +8 -8
- package/dist/cjs/clusters/proxy-configuration.js +3 -3
- package/dist/cjs/clusters/proxy-discovery.d.ts +10 -10
- package/dist/cjs/clusters/proxy-discovery.js +4 -4
- package/dist/cjs/clusters/pump-configuration-and-control.d.ts +189 -189
- package/dist/cjs/clusters/pump-configuration-and-control.js +57 -57
- package/dist/cjs/clusters/refrigerator-alarm.d.ts +43 -43
- package/dist/cjs/clusters/refrigerator-alarm.js +11 -11
- package/dist/cjs/clusters/refrigerator-and-temperature-controlled-cabinet-mode.d.ts +41 -41
- package/dist/cjs/clusters/refrigerator-and-temperature-controlled-cabinet-mode.js +8 -8
- package/dist/cjs/clusters/relative-humidity-measurement.d.ts +5 -5
- package/dist/cjs/clusters/relative-humidity-measurement.js +4 -4
- package/dist/cjs/clusters/resource-monitoring.d.ts +20 -20
- package/dist/cjs/clusters/resource-monitoring.js +7 -7
- package/dist/cjs/clusters/rvc-clean-mode.d.ts +48 -48
- package/dist/cjs/clusters/rvc-clean-mode.js +9 -9
- package/dist/cjs/clusters/rvc-operational-state.d.ts +54 -54
- package/dist/cjs/clusters/rvc-operational-state.js +17 -17
- package/dist/cjs/clusters/rvc-run-mode.d.ts +55 -55
- package/dist/cjs/clusters/rvc-run-mode.js +9 -9
- package/dist/cjs/clusters/scenes-management.d.ts +246 -246
- package/dist/cjs/clusters/scenes-management.js +70 -70
- package/dist/cjs/clusters/service-area.d.ts +128 -128
- package/dist/cjs/clusters/service-area.js +26 -26
- package/dist/cjs/clusters/smoke-co-alarm.d.ts +137 -137
- package/dist/cjs/clusters/smoke-co-alarm.js +30 -30
- package/dist/cjs/clusters/software-diagnostics.d.ts +53 -53
- package/dist/cjs/clusters/software-diagnostics.js +14 -14
- package/dist/cjs/clusters/switch.d.ts +105 -105
- package/dist/cjs/clusters/switch.js +23 -23
- package/dist/cjs/clusters/target-navigator.d.ts +48 -30
- package/dist/cjs/clusters/target-navigator.d.ts.map +1 -1
- package/dist/cjs/clusters/target-navigator.js +24 -10
- package/dist/cjs/clusters/target-navigator.js.map +2 -2
- package/dist/cjs/clusters/temperature-control.d.ts +45 -45
- package/dist/cjs/clusters/temperature-control.js +12 -12
- package/dist/cjs/clusters/temperature-measurement.d.ts +5 -5
- package/dist/cjs/clusters/temperature-measurement.js +4 -4
- package/dist/cjs/clusters/thermostat-user-interface-configuration.d.ts +7 -7
- package/dist/cjs/clusters/thermostat-user-interface-configuration.js +3 -3
- package/dist/cjs/clusters/thermostat.d.ts +515 -515
- package/dist/cjs/clusters/thermostat.js +114 -114
- package/dist/cjs/clusters/thread-border-router-management.d.ts +58 -58
- package/dist/cjs/clusters/thread-border-router-management.js +14 -14
- package/dist/cjs/clusters/thread-network-diagnostics.d.ts +359 -359
- package/dist/cjs/clusters/thread-network-diagnostics.js +108 -108
- package/dist/cjs/clusters/thread-network-directory.d.ts +27 -27
- package/dist/cjs/clusters/thread-network-directory.js +11 -11
- package/dist/cjs/clusters/time-format-localization.d.ts +12 -12
- package/dist/cjs/clusters/time-format-localization.js +3 -3
- package/dist/cjs/clusters/time-synchronization.d.ts +255 -245
- package/dist/cjs/clusters/time-synchronization.d.ts.map +1 -1
- package/dist/cjs/clusters/time-synchronization.js +55 -47
- package/dist/cjs/clusters/time-synchronization.js.map +1 -1
- package/dist/cjs/clusters/unit-localization.d.ts +6 -6
- package/dist/cjs/clusters/unit-localization.js +1 -1
- package/dist/cjs/clusters/user-label.d.ts +2 -2
- package/dist/cjs/clusters/user-label.js +1 -1
- package/dist/cjs/clusters/valid-proxies.d.ts +7 -7
- package/dist/cjs/clusters/valid-proxies.js +2 -2
- package/dist/cjs/clusters/valve-configuration-and-control.d.ts +90 -80
- package/dist/cjs/clusters/valve-configuration-and-control.d.ts.map +1 -1
- package/dist/cjs/clusters/valve-configuration-and-control.js +30 -22
- package/dist/cjs/clusters/valve-configuration-and-control.js.map +1 -1
- package/dist/cjs/clusters/wake-on-lan.d.ts +3 -3
- package/dist/cjs/clusters/wake-on-lan.js +2 -2
- package/dist/cjs/clusters/water-heater-management.d.ts +91 -91
- package/dist/cjs/clusters/water-heater-management.js +16 -16
- package/dist/cjs/clusters/water-heater-mode.d.ts +42 -42
- package/dist/cjs/clusters/water-heater-mode.js +8 -8
- package/dist/cjs/clusters/wi-fi-network-diagnostics.d.ts +69 -69
- package/dist/cjs/clusters/wi-fi-network-diagnostics.js +20 -20
- package/dist/cjs/clusters/wi-fi-network-management.d.ts +6 -6
- package/dist/cjs/clusters/wi-fi-network-management.js +3 -3
- package/dist/cjs/clusters/window-covering.d.ts +183 -183
- package/dist/cjs/clusters/window-covering.js +49 -49
- package/dist/cjs/common/StatusCode.d.ts +2 -11
- package/dist/cjs/common/StatusCode.d.ts.map +1 -1
- package/dist/cjs/common/StatusCode.js +1 -17
- package/dist/cjs/common/StatusCode.js.map +1 -1
- package/dist/cjs/common/StatusResponseError.d.ts +21 -0
- package/dist/cjs/common/StatusResponseError.d.ts.map +1 -0
- package/dist/cjs/common/StatusResponseError.js +54 -0
- package/dist/cjs/common/StatusResponseError.js.map +6 -0
- package/dist/cjs/common/ValidationError.d.ts +1 -1
- package/dist/cjs/common/ValidationError.d.ts.map +1 -1
- package/dist/cjs/common/ValidationError.js +2 -1
- package/dist/cjs/common/ValidationError.js.map +1 -1
- package/dist/cjs/common/index.d.ts +1 -0
- package/dist/cjs/common/index.d.ts.map +1 -1
- package/dist/cjs/common/index.js +1 -0
- package/dist/cjs/common/index.js.map +1 -1
- package/dist/cjs/globals/AtomicAttributeStatus.d.ts +4 -4
- package/dist/cjs/globals/AtomicAttributeStatus.js +2 -2
- package/dist/cjs/globals/AtomicRequestType.d.ts +1 -1
- package/dist/cjs/globals/Locationdesc.d.ts +5 -5
- package/dist/cjs/globals/Locationdesc.js +3 -3
- package/dist/cjs/globals/MeasurementAccuracy.d.ts +5 -5
- package/dist/cjs/globals/MeasurementAccuracy.js +3 -3
- package/dist/cjs/globals/MeasurementAccuracyRange.d.ts +10 -10
- package/dist/cjs/globals/MeasurementAccuracyRange.js +8 -8
- package/dist/cjs/globals/MeasurementType.d.ts +1 -1
- package/dist/cjs/globals/Priority.d.ts +1 -1
- package/dist/cjs/globals/Semtag.d.ts +6 -6
- package/dist/cjs/globals/Semtag.js +4 -4
- package/dist/cjs/globals/SoftwareVersionCertificationStatus.d.ts +1 -1
- package/dist/cjs/globals/Status.d.ts +33 -33
- package/dist/cjs/globals/Tod.d.ts +2 -2
- package/dist/cjs/globals/WildcardPathFlags.d.ts +1 -1
- package/dist/esm/clusters/access-control.d.ts +250 -250
- package/dist/esm/clusters/access-control.js +39 -39
- package/dist/esm/clusters/account-login.d.ts +29 -29
- package/dist/esm/clusters/account-login.js +11 -11
- package/dist/esm/clusters/actions.d.ts +108 -108
- package/dist/esm/clusters/actions.js +39 -39
- package/dist/esm/clusters/administrator-commissioning.d.ts +77 -51
- package/dist/esm/clusters/administrator-commissioning.d.ts.map +1 -1
- package/dist/esm/clusters/administrator-commissioning.js +32 -12
- package/dist/esm/clusters/administrator-commissioning.js.map +1 -1
- package/dist/esm/clusters/air-quality.d.ts +5 -5
- package/dist/esm/clusters/air-quality.js +1 -1
- package/dist/esm/clusters/alarm-base.d.ts +43 -43
- package/dist/esm/clusters/alarm-base.js +14 -14
- package/dist/esm/clusters/application-basic.d.ts +16 -16
- package/dist/esm/clusters/application-basic.js +10 -10
- package/dist/esm/clusters/application-launcher.d.ts +141 -99
- package/dist/esm/clusters/application-launcher.d.ts.map +1 -1
- package/dist/esm/clusters/application-launcher.js +45 -13
- package/dist/esm/clusters/application-launcher.js.map +1 -1
- package/dist/esm/clusters/audio-output.d.ts +37 -37
- package/dist/esm/clusters/audio-output.js +8 -8
- package/dist/esm/clusters/ballast-configuration.d.ts +23 -23
- package/dist/esm/clusters/ballast-configuration.js +17 -17
- package/dist/esm/clusters/basic-information.d.ts +54 -54
- package/dist/esm/clusters/basic-information.js +34 -34
- package/dist/esm/clusters/binding.d.ts +12 -12
- package/dist/esm/clusters/binding.js +5 -5
- package/dist/esm/clusters/boolean-state-configuration.d.ts +92 -92
- package/dist/esm/clusters/boolean-state-configuration.js +18 -18
- package/dist/esm/clusters/boolean-state.d.ts +7 -7
- package/dist/esm/clusters/boolean-state.js +3 -3
- package/dist/esm/clusters/bridged-device-basic-information.d.ts +102 -102
- package/dist/esm/clusters/bridged-device-basic-information.js +28 -28
- package/dist/esm/clusters/channel.d.ts +577 -559
- package/dist/esm/clusters/channel.d.ts.map +1 -1
- package/dist/esm/clusters/channel.js +87 -73
- package/dist/esm/clusters/channel.js.map +1 -1
- package/dist/esm/clusters/color-control.d.ts +658 -658
- package/dist/esm/clusters/color-control.js +116 -116
- package/dist/esm/clusters/commissioner-control.d.ts +16 -16
- package/dist/esm/clusters/commissioner-control.js +5 -5
- package/dist/esm/clusters/concentration-measurement.d.ts +26 -26
- package/dist/esm/clusters/concentration-measurement.js +11 -11
- package/dist/esm/clusters/content-app-observer.d.ts +27 -17
- package/dist/esm/clusters/content-app-observer.d.ts.map +1 -1
- package/dist/esm/clusters/content-app-observer.js +14 -6
- package/dist/esm/clusters/content-app-observer.js.map +1 -1
- package/dist/esm/clusters/content-control.d.ts +438 -356
- package/dist/esm/clusters/content-control.d.ts.map +1 -1
- package/dist/esm/clusters/content-control.js +120 -58
- package/dist/esm/clusters/content-control.js.map +1 -1
- package/dist/esm/clusters/content-launcher.d.ts +509 -475
- package/dist/esm/clusters/content-launcher.d.ts.map +1 -1
- package/dist/esm/clusters/content-launcher.js +65 -39
- package/dist/esm/clusters/content-launcher.js.map +1 -1
- package/dist/esm/clusters/descriptor.d.ts +28 -28
- package/dist/esm/clusters/descriptor.js +8 -8
- package/dist/esm/clusters/device-energy-management-mode.d.ts +43 -43
- package/dist/esm/clusters/device-energy-management-mode.js +8 -8
- package/dist/esm/clusters/device-energy-management.d.ts +544 -544
- package/dist/esm/clusters/device-energy-management.js +87 -87
- package/dist/esm/clusters/diagnostic-logs.d.ts +67 -33
- package/dist/esm/clusters/diagnostic-logs.d.ts.map +1 -1
- package/dist/esm/clusters/diagnostic-logs.js +34 -8
- package/dist/esm/clusters/diagnostic-logs.js.map +1 -1
- package/dist/esm/clusters/dishwasher-alarm.d.ts +57 -57
- package/dist/esm/clusters/dishwasher-alarm.js +14 -14
- package/dist/esm/clusters/dishwasher-mode.d.ts +42 -42
- package/dist/esm/clusters/dishwasher-mode.js +8 -8
- package/dist/esm/clusters/door-lock.d.ts +1367 -1350
- package/dist/esm/clusters/door-lock.d.ts.map +1 -1
- package/dist/esm/clusters/door-lock.js +242 -228
- package/dist/esm/clusters/door-lock.js.map +1 -1
- package/dist/esm/clusters/ecosystem-information.d.ts +27 -27
- package/dist/esm/clusters/ecosystem-information.js +12 -12
- package/dist/esm/clusters/electrical-energy-measurement.d.ts +275 -275
- package/dist/esm/clusters/electrical-energy-measurement.js +25 -25
- package/dist/esm/clusters/electrical-power-measurement.d.ts +199 -199
- package/dist/esm/clusters/electrical-power-measurement.js +39 -39
- package/dist/esm/clusters/energy-evse-mode.d.ts +43 -43
- package/dist/esm/clusters/energy-evse-mode.js +8 -8
- package/dist/esm/clusters/energy-evse.d.ts +323 -323
- package/dist/esm/clusters/energy-evse.js +73 -73
- package/dist/esm/clusters/energy-preference.d.ts +49 -49
- package/dist/esm/clusters/energy-preference.js +9 -9
- package/dist/esm/clusters/ethernet-network-diagnostics.d.ts +31 -31
- package/dist/esm/clusters/ethernet-network-diagnostics.js +10 -10
- package/dist/esm/clusters/fan-control.d.ts +67 -67
- package/dist/esm/clusters/fan-control.js +17 -17
- package/dist/esm/clusters/fixed-label.d.ts +2 -2
- package/dist/esm/clusters/fixed-label.js +1 -1
- package/dist/esm/clusters/flow-measurement.d.ts +5 -5
- package/dist/esm/clusters/flow-measurement.js +4 -4
- package/dist/esm/clusters/general-commissioning.d.ts +104 -104
- package/dist/esm/clusters/general-commissioning.js +25 -25
- package/dist/esm/clusters/general-diagnostics.d.ts +174 -174
- package/dist/esm/clusters/general-diagnostics.js +40 -40
- package/dist/esm/clusters/group-key-management.d.ts +119 -119
- package/dist/esm/clusters/group-key-management.js +23 -23
- package/dist/esm/clusters/groups.d.ts +78 -78
- package/dist/esm/clusters/groups.js +21 -21
- package/dist/esm/clusters/icd-management.d.ts +131 -131
- package/dist/esm/clusters/icd-management.js +29 -29
- package/dist/esm/clusters/identify.d.ts +16 -16
- package/dist/esm/clusters/identify.js +6 -6
- package/dist/esm/clusters/illuminance-measurement.d.ts +7 -7
- package/dist/esm/clusters/illuminance-measurement.js +5 -5
- package/dist/esm/clusters/joint-fabric-datastore.d.ts +175 -175
- package/dist/esm/clusters/joint-fabric-datastore.js +62 -62
- package/dist/esm/clusters/joint-fabric-pki.d.ts +14 -14
- package/dist/esm/clusters/joint-fabric-pki.js +5 -5
- package/dist/esm/clusters/keypad-input.d.ts +34 -16
- package/dist/esm/clusters/keypad-input.d.ts.map +1 -1
- package/dist/esm/clusters/keypad-input.js +17 -3
- package/dist/esm/clusters/keypad-input.js.map +1 -1
- package/dist/esm/clusters/label.d.ts +10 -10
- package/dist/esm/clusters/label.js +3 -3
- package/dist/esm/clusters/laundry-dryer-controls.d.ts +4 -4
- package/dist/esm/clusters/laundry-dryer-controls.js +2 -2
- package/dist/esm/clusters/laundry-washer-controls.d.ts +23 -23
- package/dist/esm/clusters/laundry-washer-controls.js +6 -6
- package/dist/esm/clusters/laundry-washer-mode.d.ts +34 -34
- package/dist/esm/clusters/laundry-washer-mode.js +5 -5
- package/dist/esm/clusters/level-control.d.ts +303 -303
- package/dist/esm/clusters/level-control.js +32 -32
- package/dist/esm/clusters/localization-configuration.d.ts +3 -3
- package/dist/esm/clusters/localization-configuration.js +2 -2
- package/dist/esm/clusters/low-power.d.ts +2 -2
- package/dist/esm/clusters/low-power.js +1 -1
- package/dist/esm/clusters/media-input.d.ts +47 -47
- package/dist/esm/clusters/media-input.js +11 -11
- package/dist/esm/clusters/media-playback.d.ts +427 -385
- package/dist/esm/clusters/media-playback.d.ts.map +1 -1
- package/dist/esm/clusters/media-playback.js +89 -57
- package/dist/esm/clusters/media-playback.js.map +1 -1
- package/dist/esm/clusters/messages.d.ts +154 -154
- package/dist/esm/clusters/messages.js +38 -38
- package/dist/esm/clusters/microwave-oven-control.d.ts +63 -63
- package/dist/esm/clusters/microwave-oven-control.js +17 -17
- package/dist/esm/clusters/microwave-oven-mode.d.ts +39 -39
- package/dist/esm/clusters/microwave-oven-mode.js +7 -7
- package/dist/esm/clusters/mode-base.d.ts +59 -59
- package/dist/esm/clusters/mode-base.js +13 -13
- package/dist/esm/clusters/mode-select.d.ts +51 -51
- package/dist/esm/clusters/mode-select.js +13 -13
- package/dist/esm/clusters/network-commissioning.d.ts +325 -325
- package/dist/esm/clusters/network-commissioning.js +46 -46
- package/dist/esm/clusters/occupancy-sensing.d.ts +78 -78
- package/dist/esm/clusters/occupancy-sensing.js +20 -20
- package/dist/esm/clusters/on-off.d.ts +103 -103
- package/dist/esm/clusters/on-off.js +19 -19
- package/dist/esm/clusters/operational-credentials.d.ts +94 -94
- package/dist/esm/clusters/operational-credentials.js +34 -34
- package/dist/esm/clusters/operational-state.d.ts +67 -67
- package/dist/esm/clusters/operational-state.js +21 -21
- package/dist/esm/clusters/ota-software-update-provider.d.ts +95 -61
- package/dist/esm/clusters/ota-software-update-provider.d.ts.map +1 -1
- package/dist/esm/clusters/ota-software-update-provider.js +51 -25
- package/dist/esm/clusters/ota-software-update-provider.js.map +1 -1
- package/dist/esm/clusters/ota-software-update-requestor.d.ts +72 -72
- package/dist/esm/clusters/ota-software-update-requestor.js +25 -25
- package/dist/esm/clusters/oven-cavity-operational-state.d.ts +16 -16
- package/dist/esm/clusters/oven-cavity-operational-state.js +11 -11
- package/dist/esm/clusters/oven-mode.d.ts +40 -40
- package/dist/esm/clusters/oven-mode.js +5 -5
- package/dist/esm/clusters/power-source-configuration.d.ts +2 -2
- package/dist/esm/clusters/power-source-configuration.js +1 -1
- package/dist/esm/clusters/power-source.d.ts +155 -155
- package/dist/esm/clusters/power-source.js +41 -41
- package/dist/esm/clusters/power-topology.d.ts +8 -8
- package/dist/esm/clusters/power-topology.js +2 -2
- package/dist/esm/clusters/pressure-measurement.d.ts +25 -25
- package/dist/esm/clusters/pressure-measurement.js +9 -9
- package/dist/esm/clusters/proxy-configuration.d.ts +8 -8
- package/dist/esm/clusters/proxy-configuration.js +3 -3
- package/dist/esm/clusters/proxy-discovery.d.ts +10 -10
- package/dist/esm/clusters/proxy-discovery.js +4 -4
- package/dist/esm/clusters/pump-configuration-and-control.d.ts +189 -189
- package/dist/esm/clusters/pump-configuration-and-control.js +57 -57
- package/dist/esm/clusters/refrigerator-alarm.d.ts +43 -43
- package/dist/esm/clusters/refrigerator-alarm.js +11 -11
- package/dist/esm/clusters/refrigerator-and-temperature-controlled-cabinet-mode.d.ts +41 -41
- package/dist/esm/clusters/refrigerator-and-temperature-controlled-cabinet-mode.js +8 -8
- package/dist/esm/clusters/relative-humidity-measurement.d.ts +5 -5
- package/dist/esm/clusters/relative-humidity-measurement.js +4 -4
- package/dist/esm/clusters/resource-monitoring.d.ts +20 -20
- package/dist/esm/clusters/resource-monitoring.js +7 -7
- package/dist/esm/clusters/rvc-clean-mode.d.ts +48 -48
- package/dist/esm/clusters/rvc-clean-mode.js +9 -9
- package/dist/esm/clusters/rvc-operational-state.d.ts +54 -54
- package/dist/esm/clusters/rvc-operational-state.js +17 -17
- package/dist/esm/clusters/rvc-run-mode.d.ts +55 -55
- package/dist/esm/clusters/rvc-run-mode.js +9 -9
- package/dist/esm/clusters/scenes-management.d.ts +246 -246
- package/dist/esm/clusters/scenes-management.js +70 -70
- package/dist/esm/clusters/service-area.d.ts +128 -128
- package/dist/esm/clusters/service-area.js +26 -26
- package/dist/esm/clusters/smoke-co-alarm.d.ts +137 -137
- package/dist/esm/clusters/smoke-co-alarm.js +30 -30
- package/dist/esm/clusters/software-diagnostics.d.ts +53 -53
- package/dist/esm/clusters/software-diagnostics.js +14 -14
- package/dist/esm/clusters/switch.d.ts +105 -105
- package/dist/esm/clusters/switch.js +23 -23
- package/dist/esm/clusters/target-navigator.d.ts +48 -30
- package/dist/esm/clusters/target-navigator.d.ts.map +1 -1
- package/dist/esm/clusters/target-navigator.js +24 -10
- package/dist/esm/clusters/target-navigator.js.map +1 -1
- package/dist/esm/clusters/temperature-control.d.ts +45 -45
- package/dist/esm/clusters/temperature-control.js +12 -12
- package/dist/esm/clusters/temperature-measurement.d.ts +5 -5
- package/dist/esm/clusters/temperature-measurement.js +4 -4
- package/dist/esm/clusters/thermostat-user-interface-configuration.d.ts +7 -7
- package/dist/esm/clusters/thermostat-user-interface-configuration.js +3 -3
- package/dist/esm/clusters/thermostat.d.ts +515 -515
- package/dist/esm/clusters/thermostat.js +114 -114
- package/dist/esm/clusters/thread-border-router-management.d.ts +58 -58
- package/dist/esm/clusters/thread-border-router-management.js +14 -14
- package/dist/esm/clusters/thread-network-diagnostics.d.ts +359 -359
- package/dist/esm/clusters/thread-network-diagnostics.js +108 -108
- package/dist/esm/clusters/thread-network-directory.d.ts +27 -27
- package/dist/esm/clusters/thread-network-directory.js +11 -11
- package/dist/esm/clusters/time-format-localization.d.ts +12 -12
- package/dist/esm/clusters/time-format-localization.js +3 -3
- package/dist/esm/clusters/time-synchronization.d.ts +255 -245
- package/dist/esm/clusters/time-synchronization.d.ts.map +1 -1
- package/dist/esm/clusters/time-synchronization.js +55 -47
- package/dist/esm/clusters/time-synchronization.js.map +1 -1
- package/dist/esm/clusters/unit-localization.d.ts +6 -6
- package/dist/esm/clusters/unit-localization.js +1 -1
- package/dist/esm/clusters/user-label.d.ts +2 -2
- package/dist/esm/clusters/user-label.js +1 -1
- package/dist/esm/clusters/valid-proxies.d.ts +7 -7
- package/dist/esm/clusters/valid-proxies.js +2 -2
- package/dist/esm/clusters/valve-configuration-and-control.d.ts +90 -80
- package/dist/esm/clusters/valve-configuration-and-control.d.ts.map +1 -1
- package/dist/esm/clusters/valve-configuration-and-control.js +30 -22
- package/dist/esm/clusters/valve-configuration-and-control.js.map +1 -1
- package/dist/esm/clusters/wake-on-lan.d.ts +3 -3
- package/dist/esm/clusters/wake-on-lan.js +2 -2
- package/dist/esm/clusters/water-heater-management.d.ts +91 -91
- package/dist/esm/clusters/water-heater-management.js +16 -16
- package/dist/esm/clusters/water-heater-mode.d.ts +42 -42
- package/dist/esm/clusters/water-heater-mode.js +8 -8
- package/dist/esm/clusters/wi-fi-network-diagnostics.d.ts +69 -69
- package/dist/esm/clusters/wi-fi-network-diagnostics.js +20 -20
- package/dist/esm/clusters/wi-fi-network-management.d.ts +6 -6
- package/dist/esm/clusters/wi-fi-network-management.js +3 -3
- package/dist/esm/clusters/window-covering.d.ts +183 -183
- package/dist/esm/clusters/window-covering.js +49 -49
- package/dist/esm/common/StatusCode.d.ts +2 -11
- package/dist/esm/common/StatusCode.d.ts.map +1 -1
- package/dist/esm/common/StatusCode.js +1 -17
- package/dist/esm/common/StatusCode.js.map +1 -1
- package/dist/esm/common/StatusResponseError.d.ts +21 -0
- package/dist/esm/common/StatusResponseError.d.ts.map +1 -0
- package/dist/esm/common/StatusResponseError.js +34 -0
- package/dist/esm/common/StatusResponseError.js.map +6 -0
- package/dist/esm/common/ValidationError.d.ts +1 -1
- package/dist/esm/common/ValidationError.d.ts.map +1 -1
- package/dist/esm/common/ValidationError.js +2 -1
- package/dist/esm/common/ValidationError.js.map +1 -1
- package/dist/esm/common/index.d.ts +1 -0
- package/dist/esm/common/index.d.ts.map +1 -1
- package/dist/esm/common/index.js +1 -0
- package/dist/esm/common/index.js.map +1 -1
- package/dist/esm/globals/AtomicAttributeStatus.d.ts +4 -4
- package/dist/esm/globals/AtomicAttributeStatus.js +2 -2
- package/dist/esm/globals/AtomicRequestType.d.ts +1 -1
- package/dist/esm/globals/Locationdesc.d.ts +5 -5
- package/dist/esm/globals/Locationdesc.js +3 -3
- package/dist/esm/globals/MeasurementAccuracy.d.ts +5 -5
- package/dist/esm/globals/MeasurementAccuracy.js +3 -3
- package/dist/esm/globals/MeasurementAccuracyRange.d.ts +10 -10
- package/dist/esm/globals/MeasurementAccuracyRange.js +8 -8
- package/dist/esm/globals/MeasurementType.d.ts +1 -1
- package/dist/esm/globals/Priority.d.ts +1 -1
- package/dist/esm/globals/Semtag.d.ts +6 -6
- package/dist/esm/globals/Semtag.js +4 -4
- package/dist/esm/globals/SoftwareVersionCertificationStatus.d.ts +1 -1
- package/dist/esm/globals/Status.d.ts +33 -33
- package/dist/esm/globals/Tod.d.ts +2 -2
- package/dist/esm/globals/WildcardPathFlags.d.ts +1 -1
- package/package.json +5 -5
- package/src/clusters/access-control.ts +72 -72
- package/src/clusters/account-login.ts +22 -22
- package/src/clusters/actions.ts +86 -86
- package/src/clusters/administrator-commissioning.ts +67 -20
- package/src/clusters/air-quality.ts +4 -4
- package/src/clusters/alarm-base.ts +22 -22
- package/src/clusters/application-basic.ts +14 -14
- package/src/clusters/application-launcher.ts +105 -28
- package/src/clusters/audio-output.ts +17 -17
- package/src/clusters/ballast-configuration.ts +20 -20
- package/src/clusters/basic-information.ts +47 -47
- package/src/clusters/binding.ts +8 -8
- package/src/clusters/boolean-state-configuration.ts +31 -31
- package/src/clusters/boolean-state.ts +6 -6
- package/src/clusters/bridged-device-basic-information.ts +38 -38
- package/src/clusters/channel.ts +143 -111
- package/src/clusters/color-control.ts +168 -168
- package/src/clusters/commissioner-control.ts +15 -15
- package/src/clusters/concentration-measurement.ts +15 -15
- package/src/clusters/content-app-observer.ts +29 -12
- package/src/clusters/content-control.ts +248 -96
- package/src/clusters/content-launcher.ts +131 -69
- package/src/clusters/descriptor.ts +13 -13
- package/src/clusters/device-energy-management-mode.ts +28 -28
- package/src/clusters/device-energy-management.ts +136 -136
- package/src/clusters/diagnostic-logs.ts +88 -26
- package/src/clusters/dishwasher-alarm.ts +24 -24
- package/src/clusters/dishwasher-mode.ts +27 -27
- package/src/clusters/door-lock.ts +408 -377
- package/src/clusters/ecosystem-information.ts +17 -17
- package/src/clusters/electrical-energy-measurement.ts +39 -39
- package/src/clusters/electrical-power-measurement.ts +53 -53
- package/src/clusters/energy-evse-mode.ts +28 -28
- package/src/clusters/energy-evse.ts +109 -109
- package/src/clusters/energy-preference.ts +19 -19
- package/src/clusters/ethernet-network-diagnostics.ts +13 -13
- package/src/clusters/fan-control.ts +30 -30
- package/src/clusters/fixed-label.ts +2 -2
- package/src/clusters/flow-measurement.ts +5 -5
- package/src/clusters/general-commissioning.ts +45 -45
- package/src/clusters/general-diagnostics.ts +66 -66
- package/src/clusters/group-key-management.ts +45 -45
- package/src/clusters/groups.ts +44 -44
- package/src/clusters/icd-management.ts +50 -50
- package/src/clusters/identify.ts +14 -14
- package/src/clusters/illuminance-measurement.ts +7 -7
- package/src/clusters/joint-fabric-datastore.ts +82 -82
- package/src/clusters/joint-fabric-pki.ts +12 -12
- package/src/clusters/keypad-input.ts +43 -11
- package/src/clusters/label.ts +5 -5
- package/src/clusters/laundry-dryer-controls.ts +4 -4
- package/src/clusters/laundry-washer-controls.ts +11 -11
- package/src/clusters/laundry-washer-mode.ts +25 -25
- package/src/clusters/level-control.ts +49 -49
- package/src/clusters/localization-configuration.ts +3 -3
- package/src/clusters/low-power.ts +2 -2
- package/src/clusters/media-input.ts +20 -20
- package/src/clusters/media-playback.ts +168 -91
- package/src/clusters/messages.ts +61 -61
- package/src/clusters/microwave-oven-control.ts +23 -23
- package/src/clusters/microwave-oven-mode.ts +25 -25
- package/src/clusters/mode-base.ts +37 -37
- package/src/clusters/mode-select.ts +22 -22
- package/src/clusters/network-commissioning.ts +76 -76
- package/src/clusters/occupancy-sensing.ts +29 -29
- package/src/clusters/on-off.ts +33 -33
- package/src/clusters/operational-credentials.ts +65 -65
- package/src/clusters/operational-state.ts +34 -34
- package/src/clusters/ota-software-update-provider.ts +101 -39
- package/src/clusters/ota-software-update-requestor.ts +55 -55
- package/src/clusters/oven-cavity-operational-state.ts +14 -14
- package/src/clusters/oven-mode.ts +31 -31
- package/src/clusters/power-source-configuration.ts +2 -2
- package/src/clusters/power-source.ts +59 -59
- package/src/clusters/power-topology.ts +4 -4
- package/src/clusters/pressure-measurement.ts +11 -11
- package/src/clusters/proxy-configuration.ts +6 -6
- package/src/clusters/proxy-discovery.ts +7 -7
- package/src/clusters/pump-configuration-and-control.ts +69 -69
- package/src/clusters/refrigerator-alarm.ts +18 -18
- package/src/clusters/refrigerator-and-temperature-controlled-cabinet-mode.ts +26 -26
- package/src/clusters/relative-humidity-measurement.ts +5 -5
- package/src/clusters/resource-monitoring.ts +13 -13
- package/src/clusters/rvc-clean-mode.ts +31 -31
- package/src/clusters/rvc-operational-state.ts +28 -28
- package/src/clusters/rvc-run-mode.ts +38 -38
- package/src/clusters/scenes-management.ts +112 -112
- package/src/clusters/service-area.ts +50 -50
- package/src/clusters/smoke-co-alarm.ts +68 -68
- package/src/clusters/software-diagnostics.ts +20 -20
- package/src/clusters/switch.ts +45 -45
- package/src/clusters/target-navigator.ts +52 -20
- package/src/clusters/temperature-control.ts +19 -19
- package/src/clusters/temperature-measurement.ts +5 -5
- package/src/clusters/thermostat-user-interface-configuration.ts +7 -7
- package/src/clusters/thermostat.ts +172 -172
- package/src/clusters/thread-border-router-management.ts +23 -23
- package/src/clusters/thread-network-diagnostics.ts +125 -125
- package/src/clusters/thread-network-directory.ts +22 -22
- package/src/clusters/time-format-localization.ts +7 -7
- package/src/clusters/time-synchronization.ts +98 -81
- package/src/clusters/unit-localization.ts +4 -4
- package/src/clusters/user-label.ts +2 -2
- package/src/clusters/valid-proxies.ts +7 -7
- package/src/clusters/valve-configuration-and-control.ts +52 -35
- package/src/clusters/wake-on-lan.ts +3 -3
- package/src/clusters/water-heater-management.ts +26 -26
- package/src/clusters/water-heater-mode.ts +27 -27
- package/src/clusters/wi-fi-network-diagnostics.ts +32 -32
- package/src/clusters/wi-fi-network-management.ts +6 -6
- package/src/clusters/window-covering.ts +68 -68
- package/src/common/StatusCode.ts +3 -21
- package/src/common/StatusResponseError.ts +41 -0
- package/src/common/ValidationError.ts +2 -1
- package/src/common/index.ts +1 -0
- package/src/globals/AtomicAttributeStatus.ts +4 -4
- package/src/globals/AtomicRequestType.ts +1 -1
- package/src/globals/Locationdesc.ts +5 -5
- package/src/globals/MeasurementAccuracy.ts +5 -5
- package/src/globals/MeasurementAccuracyRange.ts +10 -10
- package/src/globals/MeasurementType.ts +1 -1
- package/src/globals/Priority.ts +1 -1
- package/src/globals/Semtag.ts +6 -6
- package/src/globals/SoftwareVersionCertificationStatus.ts +1 -1
- package/src/globals/Status.ts +33 -33
- package/src/globals/Tod.ts +2 -2
- package/src/globals/WildcardPathFlags.ts +1 -1
|
@@ -7,13 +7,15 @@
|
|
|
7
7
|
import { MutableCluster } from "../cluster/mutation/MutableCluster.js";
|
|
8
8
|
import { Attribute, Command, OptionalAttribute } from "../cluster/Cluster.js";
|
|
9
9
|
import { TypeFromSchema } from "../tlv/TlvSchema.js";
|
|
10
|
+
import { StatusResponseError } from "../common/StatusResponseError.js";
|
|
11
|
+
import { Status as GlobalStatus } from "../globals/Status.js";
|
|
10
12
|
import { BitFlag } from "../schema/BitmapSchema.js";
|
|
11
13
|
import { Identity } from "#general";
|
|
12
14
|
export declare namespace Channel {
|
|
13
15
|
/**
|
|
14
16
|
* These are optional features supported by ChannelCluster.
|
|
15
17
|
*
|
|
16
|
-
* @see {@link MatterSpecification.
|
|
18
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.4
|
|
17
19
|
*/
|
|
18
20
|
enum Feature {
|
|
19
21
|
/**
|
|
@@ -42,7 +44,7 @@ export declare namespace Channel {
|
|
|
42
44
|
RecordProgram = "RecordProgram"
|
|
43
45
|
}
|
|
44
46
|
/**
|
|
45
|
-
* @see {@link MatterSpecification.
|
|
47
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.4
|
|
46
48
|
*/
|
|
47
49
|
enum ChannelType {
|
|
48
50
|
/**
|
|
@@ -68,7 +70,7 @@ export declare namespace Channel {
|
|
|
68
70
|
* While the major and minor numbers in the ChannelInfoStruct support use of ATSC channel format, a lineup may use
|
|
69
71
|
* other formats which can map into these numeric values.
|
|
70
72
|
*
|
|
71
|
-
* @see {@link MatterSpecification.
|
|
73
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5
|
|
72
74
|
*/
|
|
73
75
|
const TlvChannelInfo: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
74
76
|
/**
|
|
@@ -77,7 +79,7 @@ export declare namespace Channel {
|
|
|
77
79
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
78
80
|
* represented by a major or minor number.
|
|
79
81
|
*
|
|
80
|
-
* @see {@link MatterSpecification.
|
|
82
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
81
83
|
*/
|
|
82
84
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
83
85
|
/**
|
|
@@ -86,42 +88,42 @@ export declare namespace Channel {
|
|
|
86
88
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
87
89
|
* represented by a major or minor number.
|
|
88
90
|
*
|
|
89
|
-
* @see {@link MatterSpecification.
|
|
91
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
90
92
|
*/
|
|
91
93
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
92
94
|
/**
|
|
93
95
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
94
96
|
* field is optional, but SHOULD be provided when known.
|
|
95
97
|
*
|
|
96
|
-
* @see {@link MatterSpecification.
|
|
98
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
97
99
|
*/
|
|
98
100
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
99
101
|
/**
|
|
100
102
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
101
103
|
* provided when known.
|
|
102
104
|
*
|
|
103
|
-
* @see {@link MatterSpecification.
|
|
105
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
104
106
|
*/
|
|
105
107
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
106
108
|
/**
|
|
107
109
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
108
110
|
* be provided when known.
|
|
109
111
|
*
|
|
110
|
-
* @see {@link MatterSpecification.
|
|
112
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
111
113
|
*/
|
|
112
114
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
113
115
|
/**
|
|
114
116
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
115
117
|
* provided when MajorNumber and MinorNumber are not available.
|
|
116
118
|
*
|
|
117
|
-
* @see {@link MatterSpecification.
|
|
119
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
118
120
|
*/
|
|
119
121
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
120
122
|
/**
|
|
121
123
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
122
124
|
* provided when known.
|
|
123
125
|
*
|
|
124
|
-
* @see {@link MatterSpecification.
|
|
126
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
125
127
|
*/
|
|
126
128
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
127
129
|
}>;
|
|
@@ -131,12 +133,12 @@ export declare namespace Channel {
|
|
|
131
133
|
* While the major and minor numbers in the ChannelInfoStruct support use of ATSC channel format, a lineup may use
|
|
132
134
|
* other formats which can map into these numeric values.
|
|
133
135
|
*
|
|
134
|
-
* @see {@link MatterSpecification.
|
|
136
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5
|
|
135
137
|
*/
|
|
136
138
|
interface ChannelInfo extends TypeFromSchema<typeof TlvChannelInfo> {
|
|
137
139
|
}
|
|
138
140
|
/**
|
|
139
|
-
* @see {@link MatterSpecification.
|
|
141
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.2
|
|
140
142
|
*/
|
|
141
143
|
enum LineupInfoType {
|
|
142
144
|
/**
|
|
@@ -148,33 +150,33 @@ export declare namespace Channel {
|
|
|
148
150
|
* The Lineup Info allows references to external lineup sources like Gracenote. The combination of OperatorName,
|
|
149
151
|
* LineupName, and PostalCode MUST uniquely identify a lineup.
|
|
150
152
|
*
|
|
151
|
-
* @see {@link MatterSpecification.
|
|
153
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6
|
|
152
154
|
*/
|
|
153
155
|
const TlvLineupInfo: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
154
156
|
/**
|
|
155
157
|
* This field shall indicate the name of the operator, for example “Comcast”.
|
|
156
158
|
*
|
|
157
|
-
* @see {@link MatterSpecification.
|
|
159
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.1
|
|
158
160
|
*/
|
|
159
161
|
operatorName: import("../tlv/TlvObject.js").FieldType<string>;
|
|
160
162
|
/**
|
|
161
163
|
* This field shall indicate the name of the provider lineup, for example "Comcast King County". This field is
|
|
162
164
|
* optional, but SHOULD be provided when known.
|
|
163
165
|
*
|
|
164
|
-
* @see {@link MatterSpecification.
|
|
166
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.2
|
|
165
167
|
*/
|
|
166
168
|
lineupName: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
167
169
|
/**
|
|
168
170
|
* This field shall indicate the postal code (zip code) for the location of the device, such as "98052". This
|
|
169
171
|
* field is optional, but SHOULD be provided when known.
|
|
170
172
|
*
|
|
171
|
-
* @see {@link MatterSpecification.
|
|
173
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.3
|
|
172
174
|
*/
|
|
173
175
|
postalCode: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
174
176
|
/**
|
|
175
177
|
* This field shall indicate the type of lineup. This field is optional, but SHOULD be provided when known.
|
|
176
178
|
*
|
|
177
|
-
* @see {@link MatterSpecification.
|
|
179
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.4
|
|
178
180
|
*/
|
|
179
181
|
lineupInfoType: import("../tlv/TlvObject.js").FieldType<LineupInfoType>;
|
|
180
182
|
}>;
|
|
@@ -182,32 +184,32 @@ export declare namespace Channel {
|
|
|
182
184
|
* The Lineup Info allows references to external lineup sources like Gracenote. The combination of OperatorName,
|
|
183
185
|
* LineupName, and PostalCode MUST uniquely identify a lineup.
|
|
184
186
|
*
|
|
185
|
-
* @see {@link MatterSpecification.
|
|
187
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6
|
|
186
188
|
*/
|
|
187
189
|
interface LineupInfo extends TypeFromSchema<typeof TlvLineupInfo> {
|
|
188
190
|
}
|
|
189
191
|
/**
|
|
190
192
|
* Input to the Channel changeChannel command
|
|
191
193
|
*
|
|
192
|
-
* @see {@link MatterSpecification.
|
|
194
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1
|
|
193
195
|
*/
|
|
194
196
|
const TlvChangeChannelRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
195
197
|
/**
|
|
196
198
|
* This field shall contain a user-input string to match in order to identify the target channel.
|
|
197
199
|
*
|
|
198
|
-
* @see {@link MatterSpecification.
|
|
200
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1.1
|
|
199
201
|
*/
|
|
200
202
|
match: import("../tlv/TlvObject.js").FieldType<string>;
|
|
201
203
|
}>;
|
|
202
204
|
/**
|
|
203
205
|
* Input to the Channel changeChannel command
|
|
204
206
|
*
|
|
205
|
-
* @see {@link MatterSpecification.
|
|
207
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1
|
|
206
208
|
*/
|
|
207
209
|
interface ChangeChannelRequest extends TypeFromSchema<typeof TlvChangeChannelRequest> {
|
|
208
210
|
}
|
|
209
211
|
/**
|
|
210
|
-
* @see {@link MatterSpecification.
|
|
212
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.3
|
|
211
213
|
*/
|
|
212
214
|
enum Status {
|
|
213
215
|
/**
|
|
@@ -223,43 +225,59 @@ export declare namespace Channel {
|
|
|
223
225
|
*/
|
|
224
226
|
NoMatches = 2
|
|
225
227
|
}
|
|
228
|
+
/**
|
|
229
|
+
* Thrown for cluster status code {@link Status.MultipleMatches}.
|
|
230
|
+
*
|
|
231
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.3
|
|
232
|
+
*/
|
|
233
|
+
class MultipleMatchesError extends StatusResponseError {
|
|
234
|
+
constructor(message?: string, code?: GlobalStatus, clusterCode?: Status);
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* Thrown for cluster status code {@link Status.NoMatches}.
|
|
238
|
+
*
|
|
239
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.3
|
|
240
|
+
*/
|
|
241
|
+
class NoMatchesError extends StatusResponseError {
|
|
242
|
+
constructor(message?: string, code?: GlobalStatus, clusterCode?: Status);
|
|
243
|
+
}
|
|
226
244
|
/**
|
|
227
245
|
* This command shall be generated in response to a ChangeChannel command.
|
|
228
246
|
*
|
|
229
|
-
* @see {@link MatterSpecification.
|
|
247
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2
|
|
230
248
|
*/
|
|
231
249
|
const TlvChangeChannelResponse: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
232
250
|
/**
|
|
233
251
|
* This field shall indicate the status of the command which resulted in this response.
|
|
234
252
|
*
|
|
235
|
-
* @see {@link MatterSpecification.
|
|
253
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.1
|
|
236
254
|
*/
|
|
237
255
|
status: import("../tlv/TlvObject.js").FieldType<Status>;
|
|
238
256
|
/**
|
|
239
257
|
* This field shall indicate Optional app-specific data.
|
|
240
258
|
*
|
|
241
|
-
* @see {@link MatterSpecification.
|
|
259
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.2
|
|
242
260
|
*/
|
|
243
261
|
data: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
244
262
|
}>;
|
|
245
263
|
/**
|
|
246
264
|
* This command shall be generated in response to a ChangeChannel command.
|
|
247
265
|
*
|
|
248
|
-
* @see {@link MatterSpecification.
|
|
266
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2
|
|
249
267
|
*/
|
|
250
268
|
interface ChangeChannelResponse extends TypeFromSchema<typeof TlvChangeChannelResponse> {
|
|
251
269
|
}
|
|
252
270
|
/**
|
|
253
271
|
* This object defines the pagination structure.
|
|
254
272
|
*
|
|
255
|
-
* @see {@link MatterSpecification.
|
|
273
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11
|
|
256
274
|
*/
|
|
257
275
|
const TlvPageToken: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
258
276
|
/**
|
|
259
277
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
260
278
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
261
279
|
*
|
|
262
|
-
* @see {@link MatterSpecification.
|
|
280
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
263
281
|
*/
|
|
264
282
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
265
283
|
/**
|
|
@@ -268,7 +286,7 @@ export declare namespace Channel {
|
|
|
268
286
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
269
287
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
270
288
|
*
|
|
271
|
-
* @see {@link MatterSpecification.
|
|
289
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
272
290
|
*/
|
|
273
291
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
274
292
|
/**
|
|
@@ -277,19 +295,19 @@ export declare namespace Channel {
|
|
|
277
295
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
278
296
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
279
297
|
*
|
|
280
|
-
* @see {@link MatterSpecification.
|
|
298
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
281
299
|
*/
|
|
282
300
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
283
301
|
}>;
|
|
284
302
|
/**
|
|
285
303
|
* This object defines the pagination structure.
|
|
286
304
|
*
|
|
287
|
-
* @see {@link MatterSpecification.
|
|
305
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11
|
|
288
306
|
*/
|
|
289
307
|
interface PageToken extends TypeFromSchema<typeof TlvPageToken> {
|
|
290
308
|
}
|
|
291
309
|
/**
|
|
292
|
-
* @see {@link MatterSpecification.
|
|
310
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.1
|
|
293
311
|
*/
|
|
294
312
|
const RecordingFlag: {
|
|
295
313
|
/**
|
|
@@ -308,14 +326,14 @@ export declare namespace Channel {
|
|
|
308
326
|
/**
|
|
309
327
|
* Input to the Channel getProgramGuide command
|
|
310
328
|
*
|
|
311
|
-
* @see {@link MatterSpecification.
|
|
329
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5
|
|
312
330
|
*/
|
|
313
331
|
const TlvGetProgramGuideRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
314
332
|
/**
|
|
315
333
|
* This field shall indicate the beginning of the time window for which program guide entries are to be
|
|
316
334
|
* retrieved, as a UTC time. Entries with a start time on or after this value will be included in the results.
|
|
317
335
|
*
|
|
318
|
-
* @see {@link MatterSpecification.
|
|
336
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.1
|
|
319
337
|
*/
|
|
320
338
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
321
339
|
/**
|
|
@@ -323,7 +341,7 @@ export declare namespace Channel {
|
|
|
323
341
|
* a UTC time. Entries with an end time on or before this value will be included in the results. This field can
|
|
324
342
|
* represent a past or future value but shall be greater than the StartTime.
|
|
325
343
|
*
|
|
326
|
-
* @see {@link MatterSpecification.
|
|
344
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.2
|
|
327
345
|
*/
|
|
328
346
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
329
347
|
/**
|
|
@@ -331,7 +349,7 @@ export declare namespace Channel {
|
|
|
331
349
|
* a list of channels in this field, the response will only include entries corresponding to the specified
|
|
332
350
|
* channels.
|
|
333
351
|
*
|
|
334
|
-
* @see {@link MatterSpecification.
|
|
352
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.3
|
|
335
353
|
*/
|
|
336
354
|
channelList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
337
355
|
/**
|
|
@@ -340,7 +358,7 @@ export declare namespace Channel {
|
|
|
340
358
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
341
359
|
* represented by a major or minor number.
|
|
342
360
|
*
|
|
343
|
-
* @see {@link MatterSpecification.
|
|
361
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
344
362
|
*/
|
|
345
363
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
346
364
|
/**
|
|
@@ -349,56 +367,56 @@ export declare namespace Channel {
|
|
|
349
367
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
350
368
|
* represented by a major or minor number.
|
|
351
369
|
*
|
|
352
|
-
* @see {@link MatterSpecification.
|
|
370
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
353
371
|
*/
|
|
354
372
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
355
373
|
/**
|
|
356
374
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
357
375
|
* field is optional, but SHOULD be provided when known.
|
|
358
376
|
*
|
|
359
|
-
* @see {@link MatterSpecification.
|
|
377
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
360
378
|
*/
|
|
361
379
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
362
380
|
/**
|
|
363
381
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
364
382
|
* provided when known.
|
|
365
383
|
*
|
|
366
|
-
* @see {@link MatterSpecification.
|
|
384
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
367
385
|
*/
|
|
368
386
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
369
387
|
/**
|
|
370
388
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
371
389
|
* be provided when known.
|
|
372
390
|
*
|
|
373
|
-
* @see {@link MatterSpecification.
|
|
391
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
374
392
|
*/
|
|
375
393
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
376
394
|
/**
|
|
377
395
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
378
396
|
* provided when MajorNumber and MinorNumber are not available.
|
|
379
397
|
*
|
|
380
|
-
* @see {@link MatterSpecification.
|
|
398
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
381
399
|
*/
|
|
382
400
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
383
401
|
/**
|
|
384
402
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
385
403
|
* provided when known.
|
|
386
404
|
*
|
|
387
|
-
* @see {@link MatterSpecification.
|
|
405
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
388
406
|
*/
|
|
389
407
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
390
408
|
}>[]>;
|
|
391
409
|
/**
|
|
392
410
|
* This field shall indicate the pagination token used for managing pagination progression.
|
|
393
411
|
*
|
|
394
|
-
* @see {@link MatterSpecification.
|
|
412
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.4
|
|
395
413
|
*/
|
|
396
414
|
pageToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
397
415
|
/**
|
|
398
416
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
399
417
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
400
418
|
*
|
|
401
|
-
* @see {@link MatterSpecification.
|
|
419
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
402
420
|
*/
|
|
403
421
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
404
422
|
/**
|
|
@@ -407,7 +425,7 @@ export declare namespace Channel {
|
|
|
407
425
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
408
426
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
409
427
|
*
|
|
410
|
-
* @see {@link MatterSpecification.
|
|
428
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
411
429
|
*/
|
|
412
430
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
413
431
|
/**
|
|
@@ -416,14 +434,14 @@ export declare namespace Channel {
|
|
|
416
434
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
417
435
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
418
436
|
*
|
|
419
|
-
* @see {@link MatterSpecification.
|
|
437
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
420
438
|
*/
|
|
421
439
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
422
440
|
}> | null>;
|
|
423
441
|
/**
|
|
424
442
|
* This field shall indicate the flags of the programs for which entries should be fetched.
|
|
425
443
|
*
|
|
426
|
-
* @see {@link MatterSpecification.
|
|
444
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.5
|
|
427
445
|
*/
|
|
428
446
|
recordingFlag: import("../tlv/TlvObject.js").OptionalFieldType<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
429
447
|
/**
|
|
@@ -442,7 +460,7 @@ export declare namespace Channel {
|
|
|
442
460
|
/**
|
|
443
461
|
* This field shall indicate the list of additional external content identifiers.
|
|
444
462
|
*
|
|
445
|
-
* @see {@link MatterSpecification.
|
|
463
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.6
|
|
446
464
|
*/
|
|
447
465
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
448
466
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -451,35 +469,35 @@ export declare namespace Channel {
|
|
|
451
469
|
/**
|
|
452
470
|
* This field shall indicate Optional app-specific data.
|
|
453
471
|
*
|
|
454
|
-
* @see {@link MatterSpecification.
|
|
472
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.7
|
|
455
473
|
*/
|
|
456
474
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
457
475
|
}>;
|
|
458
476
|
/**
|
|
459
477
|
* Input to the Channel getProgramGuide command
|
|
460
478
|
*
|
|
461
|
-
* @see {@link MatterSpecification.
|
|
479
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5
|
|
462
480
|
*/
|
|
463
481
|
interface GetProgramGuideRequest extends TypeFromSchema<typeof TlvGetProgramGuideRequest> {
|
|
464
482
|
}
|
|
465
483
|
/**
|
|
466
484
|
* This object defines the paging structure that includes the previous and next pagination tokens.
|
|
467
485
|
*
|
|
468
|
-
* @see {@link MatterSpecification.
|
|
486
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12
|
|
469
487
|
*/
|
|
470
488
|
const TlvChannelPaging: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
471
489
|
/**
|
|
472
490
|
* This field shall indicate the token to retrieve the preceding page. Absence of this field denotes the
|
|
473
491
|
* response as the initial page.
|
|
474
492
|
*
|
|
475
|
-
* @see {@link MatterSpecification.
|
|
493
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12.1
|
|
476
494
|
*/
|
|
477
495
|
previousToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
478
496
|
/**
|
|
479
497
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
480
498
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
481
499
|
*
|
|
482
|
-
* @see {@link MatterSpecification.
|
|
500
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
483
501
|
*/
|
|
484
502
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
485
503
|
/**
|
|
@@ -488,7 +506,7 @@ export declare namespace Channel {
|
|
|
488
506
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
489
507
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
490
508
|
*
|
|
491
|
-
* @see {@link MatterSpecification.
|
|
509
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
492
510
|
*/
|
|
493
511
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
494
512
|
/**
|
|
@@ -497,7 +515,7 @@ export declare namespace Channel {
|
|
|
497
515
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
498
516
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
499
517
|
*
|
|
500
|
-
* @see {@link MatterSpecification.
|
|
518
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
501
519
|
*/
|
|
502
520
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
503
521
|
}> | null>;
|
|
@@ -505,14 +523,14 @@ export declare namespace Channel {
|
|
|
505
523
|
* This field shall indicate the token to retrieve the next page. Absence of this field denotes the response as
|
|
506
524
|
* the last page.
|
|
507
525
|
*
|
|
508
|
-
* @see {@link MatterSpecification.
|
|
526
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12.2
|
|
509
527
|
*/
|
|
510
528
|
nextToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
511
529
|
/**
|
|
512
530
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
513
531
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
514
532
|
*
|
|
515
|
-
* @see {@link MatterSpecification.
|
|
533
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
516
534
|
*/
|
|
517
535
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
518
536
|
/**
|
|
@@ -521,7 +539,7 @@ export declare namespace Channel {
|
|
|
521
539
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
522
540
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
523
541
|
*
|
|
524
|
-
* @see {@link MatterSpecification.
|
|
542
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
525
543
|
*/
|
|
526
544
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
527
545
|
/**
|
|
@@ -530,7 +548,7 @@ export declare namespace Channel {
|
|
|
530
548
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
531
549
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
532
550
|
*
|
|
533
|
-
* @see {@link MatterSpecification.
|
|
551
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
534
552
|
*/
|
|
535
553
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
536
554
|
}> | null>;
|
|
@@ -538,105 +556,105 @@ export declare namespace Channel {
|
|
|
538
556
|
/**
|
|
539
557
|
* This object defines the paging structure that includes the previous and next pagination tokens.
|
|
540
558
|
*
|
|
541
|
-
* @see {@link MatterSpecification.
|
|
559
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12
|
|
542
560
|
*/
|
|
543
561
|
interface ChannelPaging extends TypeFromSchema<typeof TlvChannelPaging> {
|
|
544
562
|
}
|
|
545
563
|
/**
|
|
546
564
|
* This object provides the episode information related to a program.
|
|
547
565
|
*
|
|
548
|
-
* @see {@link MatterSpecification.
|
|
566
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9
|
|
549
567
|
*/
|
|
550
568
|
const TlvSeriesInfo: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
551
569
|
/**
|
|
552
570
|
* This field shall represent the season of the series associated to the program.
|
|
553
571
|
*
|
|
554
|
-
* @see {@link MatterSpecification.
|
|
572
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.1
|
|
555
573
|
*/
|
|
556
574
|
season: import("../tlv/TlvObject.js").FieldType<string>;
|
|
557
575
|
/**
|
|
558
576
|
* This field shall represent the episode of the program.
|
|
559
577
|
*
|
|
560
|
-
* @see {@link MatterSpecification.
|
|
578
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.2
|
|
561
579
|
*/
|
|
562
580
|
episode: import("../tlv/TlvObject.js").FieldType<string>;
|
|
563
581
|
}>;
|
|
564
582
|
/**
|
|
565
583
|
* This object provides the episode information related to a program.
|
|
566
584
|
*
|
|
567
|
-
* @see {@link MatterSpecification.
|
|
585
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9
|
|
568
586
|
*/
|
|
569
587
|
interface SeriesInfo extends TypeFromSchema<typeof TlvSeriesInfo> {
|
|
570
588
|
}
|
|
571
589
|
/**
|
|
572
590
|
* This object defines the category associated to a program.
|
|
573
591
|
*
|
|
574
|
-
* @see {@link MatterSpecification.
|
|
592
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8
|
|
575
593
|
*/
|
|
576
594
|
const TlvProgramCategory: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
577
595
|
/**
|
|
578
596
|
* This field shall represent the category or genre of the program. Ex. News.
|
|
579
597
|
*
|
|
580
|
-
* @see {@link MatterSpecification.
|
|
598
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.1
|
|
581
599
|
*/
|
|
582
600
|
category: import("../tlv/TlvObject.js").FieldType<string>;
|
|
583
601
|
/**
|
|
584
602
|
* This field shall represent the sub-category or sub-genre of the program. Ex. Local.
|
|
585
603
|
*
|
|
586
|
-
* @see {@link MatterSpecification.
|
|
604
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.2
|
|
587
605
|
*/
|
|
588
606
|
subCategory: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
589
607
|
}>;
|
|
590
608
|
/**
|
|
591
609
|
* This object defines the category associated to a program.
|
|
592
610
|
*
|
|
593
|
-
* @see {@link MatterSpecification.
|
|
611
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8
|
|
594
612
|
*/
|
|
595
613
|
interface ProgramCategory extends TypeFromSchema<typeof TlvProgramCategory> {
|
|
596
614
|
}
|
|
597
615
|
/**
|
|
598
616
|
* This object provides the cast information related to a program.
|
|
599
617
|
*
|
|
600
|
-
* @see {@link MatterSpecification.
|
|
618
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10
|
|
601
619
|
*/
|
|
602
620
|
const TlvProgramCast: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
603
621
|
/**
|
|
604
622
|
* This field shall represent the name of the cast member.
|
|
605
623
|
*
|
|
606
|
-
* @see {@link MatterSpecification.
|
|
624
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.1
|
|
607
625
|
*/
|
|
608
626
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
609
627
|
/**
|
|
610
628
|
* This field shall represent the role of the cast member. Ex. Actor, Director.
|
|
611
629
|
*
|
|
612
|
-
* @see {@link MatterSpecification.
|
|
630
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.2
|
|
613
631
|
*/
|
|
614
632
|
role: import("../tlv/TlvObject.js").FieldType<string>;
|
|
615
633
|
}>;
|
|
616
634
|
/**
|
|
617
635
|
* This object provides the cast information related to a program.
|
|
618
636
|
*
|
|
619
|
-
* @see {@link MatterSpecification.
|
|
637
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10
|
|
620
638
|
*/
|
|
621
639
|
interface ProgramCast extends TypeFromSchema<typeof TlvProgramCast> {
|
|
622
640
|
}
|
|
623
641
|
/**
|
|
624
642
|
* This indicates a program within an electronic program guide (EPG).
|
|
625
643
|
*
|
|
626
|
-
* @see {@link MatterSpecification.
|
|
644
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7
|
|
627
645
|
*/
|
|
628
646
|
const TlvProgram: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
629
647
|
/**
|
|
630
648
|
* This field shall indicate a unique identifier for a program within an electronic program guide list. The
|
|
631
649
|
* identifier shall be unique across multiple channels.
|
|
632
650
|
*
|
|
633
|
-
* @see {@link MatterSpecification.
|
|
651
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.1
|
|
634
652
|
*/
|
|
635
653
|
identifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
636
654
|
/**
|
|
637
655
|
* This field shall indicate the channel associated to the program.
|
|
638
656
|
*
|
|
639
|
-
* @see {@link MatterSpecification.
|
|
657
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.2
|
|
640
658
|
*/
|
|
641
659
|
channel: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
642
660
|
/**
|
|
@@ -645,7 +663,7 @@ export declare namespace Channel {
|
|
|
645
663
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
646
664
|
* represented by a major or minor number.
|
|
647
665
|
*
|
|
648
|
-
* @see {@link MatterSpecification.
|
|
666
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
649
667
|
*/
|
|
650
668
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
651
669
|
/**
|
|
@@ -654,42 +672,42 @@ export declare namespace Channel {
|
|
|
654
672
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
655
673
|
* represented by a major or minor number.
|
|
656
674
|
*
|
|
657
|
-
* @see {@link MatterSpecification.
|
|
675
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
658
676
|
*/
|
|
659
677
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
660
678
|
/**
|
|
661
679
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
662
680
|
* field is optional, but SHOULD be provided when known.
|
|
663
681
|
*
|
|
664
|
-
* @see {@link MatterSpecification.
|
|
682
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
665
683
|
*/
|
|
666
684
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
667
685
|
/**
|
|
668
686
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
669
687
|
* provided when known.
|
|
670
688
|
*
|
|
671
|
-
* @see {@link MatterSpecification.
|
|
689
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
672
690
|
*/
|
|
673
691
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
674
692
|
/**
|
|
675
693
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
676
694
|
* be provided when known.
|
|
677
695
|
*
|
|
678
|
-
* @see {@link MatterSpecification.
|
|
696
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
679
697
|
*/
|
|
680
698
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
681
699
|
/**
|
|
682
700
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
683
701
|
* provided when MajorNumber and MinorNumber are not available.
|
|
684
702
|
*
|
|
685
|
-
* @see {@link MatterSpecification.
|
|
703
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
686
704
|
*/
|
|
687
705
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
688
706
|
/**
|
|
689
707
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
690
708
|
* provided when known.
|
|
691
709
|
*
|
|
692
|
-
* @see {@link MatterSpecification.
|
|
710
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
693
711
|
*/
|
|
694
712
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
695
713
|
}>>;
|
|
@@ -697,34 +715,34 @@ export declare namespace Channel {
|
|
|
697
715
|
* This field shall indicate an epoch time in seconds indicating the start time of a program, as a UTC time.
|
|
698
716
|
* This field can represent a past or future value.
|
|
699
717
|
*
|
|
700
|
-
* @see {@link MatterSpecification.
|
|
718
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.3
|
|
701
719
|
*/
|
|
702
720
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
703
721
|
/**
|
|
704
722
|
* This field shall indicate an epoch time in seconds indicating the end time of a program, as a UTC time. This
|
|
705
723
|
* field can represent a past or future value but shall be greater than the StartTime.
|
|
706
724
|
*
|
|
707
|
-
* @see {@link MatterSpecification.
|
|
725
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.4
|
|
708
726
|
*/
|
|
709
727
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
710
728
|
/**
|
|
711
729
|
* This field shall indicate the title or name for the specific program. For example, “MCIS: Los Angeles”.
|
|
712
730
|
*
|
|
713
|
-
* @see {@link MatterSpecification.
|
|
731
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.5
|
|
714
732
|
*/
|
|
715
733
|
title: import("../tlv/TlvObject.js").FieldType<string>;
|
|
716
734
|
/**
|
|
717
735
|
* This field shall indicate the subtitle for the specific program. For example, “Maybe Today" which is an
|
|
718
736
|
* episode name for “MCIS: Los Angeles”. This field is optional but shall be provided if applicable and known.
|
|
719
737
|
*
|
|
720
|
-
* @see {@link MatterSpecification.
|
|
738
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.6
|
|
721
739
|
*/
|
|
722
740
|
subtitle: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
723
741
|
/**
|
|
724
742
|
* This field shall indicate the brief description for the specific program. For example, a description of an
|
|
725
743
|
* episode. This field is optional but shall be provided if known.
|
|
726
744
|
*
|
|
727
|
-
* @see {@link MatterSpecification.
|
|
745
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.7
|
|
728
746
|
*/
|
|
729
747
|
description: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
730
748
|
/**
|
|
@@ -732,7 +750,7 @@ export declare namespace Channel {
|
|
|
732
750
|
* of the standard Tags for Identifying Languages RFC 5646. This field is optional but shall be provided if
|
|
733
751
|
* known.
|
|
734
752
|
*
|
|
735
|
-
* @see {@link MatterSpecification.
|
|
753
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.8
|
|
736
754
|
*/
|
|
737
755
|
audioLanguages: import("../tlv/TlvObject.js").OptionalFieldType<string[]>;
|
|
738
756
|
/**
|
|
@@ -742,14 +760,14 @@ export declare namespace Channel {
|
|
|
742
760
|
* children but can be accepted in general for older children. This field is optional but shall be provided if
|
|
743
761
|
* known.
|
|
744
762
|
*
|
|
745
|
-
* @see {@link MatterSpecification.
|
|
763
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.9
|
|
746
764
|
*/
|
|
747
765
|
ratings: import("../tlv/TlvObject.js").OptionalFieldType<string[]>;
|
|
748
766
|
/**
|
|
749
767
|
* This field shall represent a URL of a thumbnail that clients can use to render an image for the program. The
|
|
750
768
|
* syntax of this field shall follow the syntax as specified in RFC 1738 and shall use the https scheme.
|
|
751
769
|
*
|
|
752
|
-
* @see {@link MatterSpecification.
|
|
770
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.10
|
|
753
771
|
*/
|
|
754
772
|
thumbnailUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
755
773
|
/**
|
|
@@ -757,35 +775,35 @@ export declare namespace Channel {
|
|
|
757
775
|
* detail view. The syntax of this field shall follow the syntax as specified in RFC 1738 and shall use the
|
|
758
776
|
* https scheme.
|
|
759
777
|
*
|
|
760
|
-
* @see {@link MatterSpecification.
|
|
778
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.11
|
|
761
779
|
*/
|
|
762
780
|
posterArtUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
763
781
|
/**
|
|
764
782
|
* This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
|
|
765
783
|
* syntax as specified in RFC 1738 and shall use the https scheme.
|
|
766
784
|
*
|
|
767
|
-
* @see {@link MatterSpecification.
|
|
785
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.12
|
|
768
786
|
*/
|
|
769
787
|
dvbiUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
770
788
|
/**
|
|
771
789
|
* This field shall be a string, in ISO 8601 format, representing the date on which the program was released.
|
|
772
790
|
* This field is optional but when provided, the year shall be provided as part of the string.
|
|
773
791
|
*
|
|
774
|
-
* @see {@link MatterSpecification.
|
|
792
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.13
|
|
775
793
|
*/
|
|
776
794
|
releaseDate: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
777
795
|
/**
|
|
778
796
|
* This field shall represent a string providing additional information on the parental guidance. This field is
|
|
779
797
|
* optional.
|
|
780
798
|
*
|
|
781
|
-
* @see {@link MatterSpecification.
|
|
799
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.14
|
|
782
800
|
*/
|
|
783
801
|
parentalGuidanceText: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
784
802
|
/**
|
|
785
803
|
* This field shall represent the recording status of the program. This field is required if the RecordProgram
|
|
786
804
|
* feature is set.
|
|
787
805
|
*
|
|
788
|
-
* @see {@link MatterSpecification.
|
|
806
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.15
|
|
789
807
|
*/
|
|
790
808
|
recordingFlag: import("../tlv/TlvObject.js").OptionalFieldType<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
791
809
|
/**
|
|
@@ -805,19 +823,19 @@ export declare namespace Channel {
|
|
|
805
823
|
* This field shall represent the information of a series such as season and episode number. This field is
|
|
806
824
|
* optional but SHOULD be provided if the program represents a series and this information is available.
|
|
807
825
|
*
|
|
808
|
-
* @see {@link MatterSpecification.
|
|
826
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.16
|
|
809
827
|
*/
|
|
810
828
|
seriesInfo: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
811
829
|
/**
|
|
812
830
|
* This field shall represent the season of the series associated to the program.
|
|
813
831
|
*
|
|
814
|
-
* @see {@link MatterSpecification.
|
|
832
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.1
|
|
815
833
|
*/
|
|
816
834
|
season: import("../tlv/TlvObject.js").FieldType<string>;
|
|
817
835
|
/**
|
|
818
836
|
* This field shall represent the episode of the program.
|
|
819
837
|
*
|
|
820
|
-
* @see {@link MatterSpecification.
|
|
838
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.2
|
|
821
839
|
*/
|
|
822
840
|
episode: import("../tlv/TlvObject.js").FieldType<string>;
|
|
823
841
|
}> | null>;
|
|
@@ -825,19 +843,19 @@ export declare namespace Channel {
|
|
|
825
843
|
* This field shall represent the category of a particular program. This field is optional but shall be provided
|
|
826
844
|
* if known.
|
|
827
845
|
*
|
|
828
|
-
* @see {@link MatterSpecification.
|
|
846
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.17
|
|
829
847
|
*/
|
|
830
848
|
categoryList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
831
849
|
/**
|
|
832
850
|
* This field shall represent the category or genre of the program. Ex. News.
|
|
833
851
|
*
|
|
834
|
-
* @see {@link MatterSpecification.
|
|
852
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.1
|
|
835
853
|
*/
|
|
836
854
|
category: import("../tlv/TlvObject.js").FieldType<string>;
|
|
837
855
|
/**
|
|
838
856
|
* This field shall represent the sub-category or sub-genre of the program. Ex. Local.
|
|
839
857
|
*
|
|
840
|
-
* @see {@link MatterSpecification.
|
|
858
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.2
|
|
841
859
|
*/
|
|
842
860
|
subCategory: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
843
861
|
}>[]>;
|
|
@@ -845,26 +863,26 @@ export declare namespace Channel {
|
|
|
845
863
|
* This field shall represent a list of the cast or the crew on the program. A single cast member may have more
|
|
846
864
|
* than one role. This field is optional but shall be provided if known.
|
|
847
865
|
*
|
|
848
|
-
* @see {@link MatterSpecification.
|
|
866
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.18
|
|
849
867
|
*/
|
|
850
868
|
castList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
851
869
|
/**
|
|
852
870
|
* This field shall represent the name of the cast member.
|
|
853
871
|
*
|
|
854
|
-
* @see {@link MatterSpecification.
|
|
872
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.1
|
|
855
873
|
*/
|
|
856
874
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
857
875
|
/**
|
|
858
876
|
* This field shall represent the role of the cast member. Ex. Actor, Director.
|
|
859
877
|
*
|
|
860
|
-
* @see {@link MatterSpecification.
|
|
878
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.2
|
|
861
879
|
*/
|
|
862
880
|
role: import("../tlv/TlvObject.js").FieldType<string>;
|
|
863
881
|
}>[]>;
|
|
864
882
|
/**
|
|
865
883
|
* This field shall indicate the list of additional external content identifiers.
|
|
866
884
|
*
|
|
867
|
-
* @see {@link MatterSpecification.
|
|
885
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.19
|
|
868
886
|
*/
|
|
869
887
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
870
888
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -874,35 +892,35 @@ export declare namespace Channel {
|
|
|
874
892
|
/**
|
|
875
893
|
* This indicates a program within an electronic program guide (EPG).
|
|
876
894
|
*
|
|
877
|
-
* @see {@link MatterSpecification.
|
|
895
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7
|
|
878
896
|
*/
|
|
879
897
|
interface Program extends TypeFromSchema<typeof TlvProgram> {
|
|
880
898
|
}
|
|
881
899
|
/**
|
|
882
900
|
* This command is a response to the GetProgramGuide command.
|
|
883
901
|
*
|
|
884
|
-
* @see {@link MatterSpecification.
|
|
902
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.6
|
|
885
903
|
*/
|
|
886
904
|
const TlvProgramGuideResponse: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
887
905
|
/**
|
|
888
906
|
* This field shall indicate the necessary pagination attributes that define information for both the succeeding
|
|
889
907
|
* and preceding data pages.
|
|
890
908
|
*
|
|
891
|
-
* @see {@link MatterSpecification.
|
|
909
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.6.1
|
|
892
910
|
*/
|
|
893
911
|
paging: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
894
912
|
/**
|
|
895
913
|
* This field shall indicate the token to retrieve the preceding page. Absence of this field denotes the
|
|
896
914
|
* response as the initial page.
|
|
897
915
|
*
|
|
898
|
-
* @see {@link MatterSpecification.
|
|
916
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12.1
|
|
899
917
|
*/
|
|
900
918
|
previousToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
901
919
|
/**
|
|
902
920
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
903
921
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
904
922
|
*
|
|
905
|
-
* @see {@link MatterSpecification.
|
|
923
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
906
924
|
*/
|
|
907
925
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
908
926
|
/**
|
|
@@ -911,7 +929,7 @@ export declare namespace Channel {
|
|
|
911
929
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
912
930
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
913
931
|
*
|
|
914
|
-
* @see {@link MatterSpecification.
|
|
932
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
915
933
|
*/
|
|
916
934
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
917
935
|
/**
|
|
@@ -920,7 +938,7 @@ export declare namespace Channel {
|
|
|
920
938
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
921
939
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
922
940
|
*
|
|
923
|
-
* @see {@link MatterSpecification.
|
|
941
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
924
942
|
*/
|
|
925
943
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
926
944
|
}> | null>;
|
|
@@ -928,14 +946,14 @@ export declare namespace Channel {
|
|
|
928
946
|
* This field shall indicate the token to retrieve the next page. Absence of this field denotes the response as
|
|
929
947
|
* the last page.
|
|
930
948
|
*
|
|
931
|
-
* @see {@link MatterSpecification.
|
|
949
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12.2
|
|
932
950
|
*/
|
|
933
951
|
nextToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
934
952
|
/**
|
|
935
953
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
936
954
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
937
955
|
*
|
|
938
|
-
* @see {@link MatterSpecification.
|
|
956
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
939
957
|
*/
|
|
940
958
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
941
959
|
/**
|
|
@@ -944,7 +962,7 @@ export declare namespace Channel {
|
|
|
944
962
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
945
963
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
946
964
|
*
|
|
947
|
-
* @see {@link MatterSpecification.
|
|
965
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
948
966
|
*/
|
|
949
967
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
950
968
|
/**
|
|
@@ -953,7 +971,7 @@ export declare namespace Channel {
|
|
|
953
971
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
954
972
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
955
973
|
*
|
|
956
|
-
* @see {@link MatterSpecification.
|
|
974
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
957
975
|
*/
|
|
958
976
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
959
977
|
}> | null>;
|
|
@@ -961,20 +979,20 @@ export declare namespace Channel {
|
|
|
961
979
|
/**
|
|
962
980
|
* This field shall indicate the list of programs.
|
|
963
981
|
*
|
|
964
|
-
* @see {@link MatterSpecification.
|
|
982
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.6.2
|
|
965
983
|
*/
|
|
966
984
|
programList: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
967
985
|
/**
|
|
968
986
|
* This field shall indicate a unique identifier for a program within an electronic program guide list. The
|
|
969
987
|
* identifier shall be unique across multiple channels.
|
|
970
988
|
*
|
|
971
|
-
* @see {@link MatterSpecification.
|
|
989
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.1
|
|
972
990
|
*/
|
|
973
991
|
identifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
974
992
|
/**
|
|
975
993
|
* This field shall indicate the channel associated to the program.
|
|
976
994
|
*
|
|
977
|
-
* @see {@link MatterSpecification.
|
|
995
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.2
|
|
978
996
|
*/
|
|
979
997
|
channel: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
980
998
|
/**
|
|
@@ -983,7 +1001,7 @@ export declare namespace Channel {
|
|
|
983
1001
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
984
1002
|
* represented by a major or minor number.
|
|
985
1003
|
*
|
|
986
|
-
* @see {@link MatterSpecification.
|
|
1004
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
987
1005
|
*/
|
|
988
1006
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
989
1007
|
/**
|
|
@@ -992,42 +1010,42 @@ export declare namespace Channel {
|
|
|
992
1010
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
993
1011
|
* represented by a major or minor number.
|
|
994
1012
|
*
|
|
995
|
-
* @see {@link MatterSpecification.
|
|
1013
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
996
1014
|
*/
|
|
997
1015
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
998
1016
|
/**
|
|
999
1017
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
1000
1018
|
* field is optional, but SHOULD be provided when known.
|
|
1001
1019
|
*
|
|
1002
|
-
* @see {@link MatterSpecification.
|
|
1020
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
1003
1021
|
*/
|
|
1004
1022
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1005
1023
|
/**
|
|
1006
1024
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
1007
1025
|
* provided when known.
|
|
1008
1026
|
*
|
|
1009
|
-
* @see {@link MatterSpecification.
|
|
1027
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
1010
1028
|
*/
|
|
1011
1029
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1012
1030
|
/**
|
|
1013
1031
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
1014
1032
|
* be provided when known.
|
|
1015
1033
|
*
|
|
1016
|
-
* @see {@link MatterSpecification.
|
|
1034
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
1017
1035
|
*/
|
|
1018
1036
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1019
1037
|
/**
|
|
1020
1038
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
1021
1039
|
* provided when MajorNumber and MinorNumber are not available.
|
|
1022
1040
|
*
|
|
1023
|
-
* @see {@link MatterSpecification.
|
|
1041
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
1024
1042
|
*/
|
|
1025
1043
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1026
1044
|
/**
|
|
1027
1045
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
1028
1046
|
* provided when known.
|
|
1029
1047
|
*
|
|
1030
|
-
* @see {@link MatterSpecification.
|
|
1048
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
1031
1049
|
*/
|
|
1032
1050
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
1033
1051
|
}>>;
|
|
@@ -1035,34 +1053,34 @@ export declare namespace Channel {
|
|
|
1035
1053
|
* This field shall indicate an epoch time in seconds indicating the start time of a program, as a UTC time.
|
|
1036
1054
|
* This field can represent a past or future value.
|
|
1037
1055
|
*
|
|
1038
|
-
* @see {@link MatterSpecification.
|
|
1056
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.3
|
|
1039
1057
|
*/
|
|
1040
1058
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1041
1059
|
/**
|
|
1042
1060
|
* This field shall indicate an epoch time in seconds indicating the end time of a program, as a UTC time. This
|
|
1043
1061
|
* field can represent a past or future value but shall be greater than the StartTime.
|
|
1044
1062
|
*
|
|
1045
|
-
* @see {@link MatterSpecification.
|
|
1063
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.4
|
|
1046
1064
|
*/
|
|
1047
1065
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1048
1066
|
/**
|
|
1049
1067
|
* This field shall indicate the title or name for the specific program. For example, “MCIS: Los Angeles”.
|
|
1050
1068
|
*
|
|
1051
|
-
* @see {@link MatterSpecification.
|
|
1069
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.5
|
|
1052
1070
|
*/
|
|
1053
1071
|
title: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1054
1072
|
/**
|
|
1055
1073
|
* This field shall indicate the subtitle for the specific program. For example, “Maybe Today" which is an
|
|
1056
1074
|
* episode name for “MCIS: Los Angeles”. This field is optional but shall be provided if applicable and known.
|
|
1057
1075
|
*
|
|
1058
|
-
* @see {@link MatterSpecification.
|
|
1076
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.6
|
|
1059
1077
|
*/
|
|
1060
1078
|
subtitle: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1061
1079
|
/**
|
|
1062
1080
|
* This field shall indicate the brief description for the specific program. For example, a description of an
|
|
1063
1081
|
* episode. This field is optional but shall be provided if known.
|
|
1064
1082
|
*
|
|
1065
|
-
* @see {@link MatterSpecification.
|
|
1083
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.7
|
|
1066
1084
|
*/
|
|
1067
1085
|
description: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1068
1086
|
/**
|
|
@@ -1070,7 +1088,7 @@ export declare namespace Channel {
|
|
|
1070
1088
|
* of the standard Tags for Identifying Languages RFC 5646. This field is optional but shall be provided if
|
|
1071
1089
|
* known.
|
|
1072
1090
|
*
|
|
1073
|
-
* @see {@link MatterSpecification.
|
|
1091
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.8
|
|
1074
1092
|
*/
|
|
1075
1093
|
audioLanguages: import("../tlv/TlvObject.js").OptionalFieldType<string[]>;
|
|
1076
1094
|
/**
|
|
@@ -1080,14 +1098,14 @@ export declare namespace Channel {
|
|
|
1080
1098
|
* children but can be accepted in general for older children. This field is optional but shall be provided if
|
|
1081
1099
|
* known.
|
|
1082
1100
|
*
|
|
1083
|
-
* @see {@link MatterSpecification.
|
|
1101
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.9
|
|
1084
1102
|
*/
|
|
1085
1103
|
ratings: import("../tlv/TlvObject.js").OptionalFieldType<string[]>;
|
|
1086
1104
|
/**
|
|
1087
1105
|
* This field shall represent a URL of a thumbnail that clients can use to render an image for the program. The
|
|
1088
1106
|
* syntax of this field shall follow the syntax as specified in RFC 1738 and shall use the https scheme.
|
|
1089
1107
|
*
|
|
1090
|
-
* @see {@link MatterSpecification.
|
|
1108
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.10
|
|
1091
1109
|
*/
|
|
1092
1110
|
thumbnailUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1093
1111
|
/**
|
|
@@ -1095,35 +1113,35 @@ export declare namespace Channel {
|
|
|
1095
1113
|
* detail view. The syntax of this field shall follow the syntax as specified in RFC 1738 and shall use the
|
|
1096
1114
|
* https scheme.
|
|
1097
1115
|
*
|
|
1098
|
-
* @see {@link MatterSpecification.
|
|
1116
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.11
|
|
1099
1117
|
*/
|
|
1100
1118
|
posterArtUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1101
1119
|
/**
|
|
1102
1120
|
* This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
|
|
1103
1121
|
* syntax as specified in RFC 1738 and shall use the https scheme.
|
|
1104
1122
|
*
|
|
1105
|
-
* @see {@link MatterSpecification.
|
|
1123
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.12
|
|
1106
1124
|
*/
|
|
1107
1125
|
dvbiUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1108
1126
|
/**
|
|
1109
1127
|
* This field shall be a string, in ISO 8601 format, representing the date on which the program was released.
|
|
1110
1128
|
* This field is optional but when provided, the year shall be provided as part of the string.
|
|
1111
1129
|
*
|
|
1112
|
-
* @see {@link MatterSpecification.
|
|
1130
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.13
|
|
1113
1131
|
*/
|
|
1114
1132
|
releaseDate: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1115
1133
|
/**
|
|
1116
1134
|
* This field shall represent a string providing additional information on the parental guidance. This field is
|
|
1117
1135
|
* optional.
|
|
1118
1136
|
*
|
|
1119
|
-
* @see {@link MatterSpecification.
|
|
1137
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.14
|
|
1120
1138
|
*/
|
|
1121
1139
|
parentalGuidanceText: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1122
1140
|
/**
|
|
1123
1141
|
* This field shall represent the recording status of the program. This field is required if the RecordProgram
|
|
1124
1142
|
* feature is set.
|
|
1125
1143
|
*
|
|
1126
|
-
* @see {@link MatterSpecification.
|
|
1144
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.15
|
|
1127
1145
|
*/
|
|
1128
1146
|
recordingFlag: import("../tlv/TlvObject.js").OptionalFieldType<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
1129
1147
|
/**
|
|
@@ -1143,19 +1161,19 @@ export declare namespace Channel {
|
|
|
1143
1161
|
* This field shall represent the information of a series such as season and episode number. This field is
|
|
1144
1162
|
* optional but SHOULD be provided if the program represents a series and this information is available.
|
|
1145
1163
|
*
|
|
1146
|
-
* @see {@link MatterSpecification.
|
|
1164
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.16
|
|
1147
1165
|
*/
|
|
1148
1166
|
seriesInfo: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1149
1167
|
/**
|
|
1150
1168
|
* This field shall represent the season of the series associated to the program.
|
|
1151
1169
|
*
|
|
1152
|
-
* @see {@link MatterSpecification.
|
|
1170
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.1
|
|
1153
1171
|
*/
|
|
1154
1172
|
season: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1155
1173
|
/**
|
|
1156
1174
|
* This field shall represent the episode of the program.
|
|
1157
1175
|
*
|
|
1158
|
-
* @see {@link MatterSpecification.
|
|
1176
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.2
|
|
1159
1177
|
*/
|
|
1160
1178
|
episode: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1161
1179
|
}> | null>;
|
|
@@ -1163,19 +1181,19 @@ export declare namespace Channel {
|
|
|
1163
1181
|
* This field shall represent the category of a particular program. This field is optional but shall be provided
|
|
1164
1182
|
* if known.
|
|
1165
1183
|
*
|
|
1166
|
-
* @see {@link MatterSpecification.
|
|
1184
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.17
|
|
1167
1185
|
*/
|
|
1168
1186
|
categoryList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1169
1187
|
/**
|
|
1170
1188
|
* This field shall represent the category or genre of the program. Ex. News.
|
|
1171
1189
|
*
|
|
1172
|
-
* @see {@link MatterSpecification.
|
|
1190
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.1
|
|
1173
1191
|
*/
|
|
1174
1192
|
category: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1175
1193
|
/**
|
|
1176
1194
|
* This field shall represent the sub-category or sub-genre of the program. Ex. Local.
|
|
1177
1195
|
*
|
|
1178
|
-
* @see {@link MatterSpecification.
|
|
1196
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.2
|
|
1179
1197
|
*/
|
|
1180
1198
|
subCategory: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1181
1199
|
}>[]>;
|
|
@@ -1183,26 +1201,26 @@ export declare namespace Channel {
|
|
|
1183
1201
|
* This field shall represent a list of the cast or the crew on the program. A single cast member may have more
|
|
1184
1202
|
* than one role. This field is optional but shall be provided if known.
|
|
1185
1203
|
*
|
|
1186
|
-
* @see {@link MatterSpecification.
|
|
1204
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.18
|
|
1187
1205
|
*/
|
|
1188
1206
|
castList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1189
1207
|
/**
|
|
1190
1208
|
* This field shall represent the name of the cast member.
|
|
1191
1209
|
*
|
|
1192
|
-
* @see {@link MatterSpecification.
|
|
1210
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.1
|
|
1193
1211
|
*/
|
|
1194
1212
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1195
1213
|
/**
|
|
1196
1214
|
* This field shall represent the role of the cast member. Ex. Actor, Director.
|
|
1197
1215
|
*
|
|
1198
|
-
* @see {@link MatterSpecification.
|
|
1216
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.2
|
|
1199
1217
|
*/
|
|
1200
1218
|
role: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1201
1219
|
}>[]>;
|
|
1202
1220
|
/**
|
|
1203
1221
|
* This field shall indicate the list of additional external content identifiers.
|
|
1204
1222
|
*
|
|
1205
|
-
* @see {@link MatterSpecification.
|
|
1223
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.19
|
|
1206
1224
|
*/
|
|
1207
1225
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1208
1226
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -1213,21 +1231,21 @@ export declare namespace Channel {
|
|
|
1213
1231
|
/**
|
|
1214
1232
|
* This command is a response to the GetProgramGuide command.
|
|
1215
1233
|
*
|
|
1216
|
-
* @see {@link MatterSpecification.
|
|
1234
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.6
|
|
1217
1235
|
*/
|
|
1218
1236
|
interface ProgramGuideResponse extends TypeFromSchema<typeof TlvProgramGuideResponse> {
|
|
1219
1237
|
}
|
|
1220
1238
|
/**
|
|
1221
1239
|
* Input to the Channel recordProgram command
|
|
1222
1240
|
*
|
|
1223
|
-
* @see {@link MatterSpecification.
|
|
1241
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7
|
|
1224
1242
|
*/
|
|
1225
1243
|
const TlvRecordProgramRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1226
1244
|
/**
|
|
1227
1245
|
* This field shall indicate the program identifier for the program that should be recorded. This value is
|
|
1228
1246
|
* provided by the identifier field in ProgramStruct.
|
|
1229
1247
|
*
|
|
1230
|
-
* @see {@link MatterSpecification.
|
|
1248
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.1
|
|
1231
1249
|
*/
|
|
1232
1250
|
programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1233
1251
|
/**
|
|
@@ -1235,13 +1253,13 @@ export declare namespace Channel {
|
|
|
1235
1253
|
* invoking record program on an episode with that flag set to true, the target should schedule record the whole
|
|
1236
1254
|
* series.
|
|
1237
1255
|
*
|
|
1238
|
-
* @see {@link MatterSpecification.
|
|
1256
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.2
|
|
1239
1257
|
*/
|
|
1240
1258
|
shouldRecordSeries: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
1241
1259
|
/**
|
|
1242
1260
|
* This field, if present, shall indicate the list of additional external content identifiers.
|
|
1243
1261
|
*
|
|
1244
|
-
* @see {@link MatterSpecification.
|
|
1262
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.3
|
|
1245
1263
|
*/
|
|
1246
1264
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1247
1265
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -1250,28 +1268,28 @@ export declare namespace Channel {
|
|
|
1250
1268
|
/**
|
|
1251
1269
|
* This field, if present, shall indicate app-specific data.
|
|
1252
1270
|
*
|
|
1253
|
-
* @see {@link MatterSpecification.
|
|
1271
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.4
|
|
1254
1272
|
*/
|
|
1255
1273
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
1256
1274
|
}>;
|
|
1257
1275
|
/**
|
|
1258
1276
|
* Input to the Channel recordProgram command
|
|
1259
1277
|
*
|
|
1260
|
-
* @see {@link MatterSpecification.
|
|
1278
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7
|
|
1261
1279
|
*/
|
|
1262
1280
|
interface RecordProgramRequest extends TypeFromSchema<typeof TlvRecordProgramRequest> {
|
|
1263
1281
|
}
|
|
1264
1282
|
/**
|
|
1265
1283
|
* Input to the Channel cancelRecordProgram command
|
|
1266
1284
|
*
|
|
1267
|
-
* @see {@link MatterSpecification.
|
|
1285
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8
|
|
1268
1286
|
*/
|
|
1269
1287
|
const TlvCancelRecordProgramRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1270
1288
|
/**
|
|
1271
1289
|
* This field shall indicate the program identifier for the program that should be cancelled from recording.
|
|
1272
1290
|
* This value is provided by the identifier field in ProgramStruct.
|
|
1273
1291
|
*
|
|
1274
|
-
* @see {@link MatterSpecification.
|
|
1292
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.1
|
|
1275
1293
|
*/
|
|
1276
1294
|
programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1277
1295
|
/**
|
|
@@ -1279,13 +1297,13 @@ export declare namespace Channel {
|
|
|
1279
1297
|
* recording. For example, invoking record program on an episode with that flag set to true, the target should
|
|
1280
1298
|
* schedule record the whole series.
|
|
1281
1299
|
*
|
|
1282
|
-
* @see {@link MatterSpecification.
|
|
1300
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.2
|
|
1283
1301
|
*/
|
|
1284
1302
|
shouldRecordSeries: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
1285
1303
|
/**
|
|
1286
1304
|
* This field, if present, shall indicate the list of additional external content identifiers.
|
|
1287
1305
|
*
|
|
1288
|
-
* @see {@link MatterSpecification.
|
|
1306
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.3
|
|
1289
1307
|
*/
|
|
1290
1308
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1291
1309
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -1294,61 +1312,61 @@ export declare namespace Channel {
|
|
|
1294
1312
|
/**
|
|
1295
1313
|
* This field, if present, shall indicate app-specific data.
|
|
1296
1314
|
*
|
|
1297
|
-
* @see {@link MatterSpecification.
|
|
1315
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.4
|
|
1298
1316
|
*/
|
|
1299
1317
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
1300
1318
|
}>;
|
|
1301
1319
|
/**
|
|
1302
1320
|
* Input to the Channel cancelRecordProgram command
|
|
1303
1321
|
*
|
|
1304
|
-
* @see {@link MatterSpecification.
|
|
1322
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8
|
|
1305
1323
|
*/
|
|
1306
1324
|
interface CancelRecordProgramRequest extends TypeFromSchema<typeof TlvCancelRecordProgramRequest> {
|
|
1307
1325
|
}
|
|
1308
1326
|
/**
|
|
1309
1327
|
* Input to the Channel changeChannelByNumber command
|
|
1310
1328
|
*
|
|
1311
|
-
* @see {@link MatterSpecification.
|
|
1329
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3
|
|
1312
1330
|
*/
|
|
1313
1331
|
const TlvChangeChannelByNumberRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1314
1332
|
/**
|
|
1315
1333
|
* This field shall indicate the channel major number value (ATSC format) to which the channel should change.
|
|
1316
1334
|
*
|
|
1317
|
-
* @see {@link MatterSpecification.
|
|
1335
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3.1
|
|
1318
1336
|
*/
|
|
1319
1337
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1320
1338
|
/**
|
|
1321
1339
|
* This field shall indicate the channel minor number value (ATSC format) to which the channel should change.
|
|
1322
1340
|
*
|
|
1323
|
-
* @see {@link MatterSpecification.
|
|
1341
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3.2
|
|
1324
1342
|
*/
|
|
1325
1343
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1326
1344
|
}>;
|
|
1327
1345
|
/**
|
|
1328
1346
|
* Input to the Channel changeChannelByNumber command
|
|
1329
1347
|
*
|
|
1330
|
-
* @see {@link MatterSpecification.
|
|
1348
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3
|
|
1331
1349
|
*/
|
|
1332
1350
|
interface ChangeChannelByNumberRequest extends TypeFromSchema<typeof TlvChangeChannelByNumberRequest> {
|
|
1333
1351
|
}
|
|
1334
1352
|
/**
|
|
1335
1353
|
* Input to the Channel skipChannel command
|
|
1336
1354
|
*
|
|
1337
|
-
* @see {@link MatterSpecification.
|
|
1355
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.4
|
|
1338
1356
|
*/
|
|
1339
1357
|
const TlvSkipChannelRequest: import("../tlv/TlvObject.js").ObjectSchema<{
|
|
1340
1358
|
/**
|
|
1341
1359
|
* This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is negative)
|
|
1342
1360
|
* the current channel.
|
|
1343
1361
|
*
|
|
1344
|
-
* @see {@link MatterSpecification.
|
|
1362
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.4.1
|
|
1345
1363
|
*/
|
|
1346
1364
|
count: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1347
1365
|
}>;
|
|
1348
1366
|
/**
|
|
1349
1367
|
* Input to the Channel skipChannel command
|
|
1350
1368
|
*
|
|
1351
|
-
* @see {@link MatterSpecification.
|
|
1369
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.4
|
|
1352
1370
|
*/
|
|
1353
1371
|
interface SkipChannelRequest extends TypeFromSchema<typeof TlvSkipChannelRequest> {
|
|
1354
1372
|
}
|
|
@@ -1360,7 +1378,7 @@ export declare namespace Channel {
|
|
|
1360
1378
|
/**
|
|
1361
1379
|
* This attribute shall provide the list of supported channels.
|
|
1362
1380
|
*
|
|
1363
|
-
* @see {@link MatterSpecification.
|
|
1381
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.6.1
|
|
1364
1382
|
*/
|
|
1365
1383
|
readonly channelList: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1366
1384
|
/**
|
|
@@ -1369,7 +1387,7 @@ export declare namespace Channel {
|
|
|
1369
1387
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
1370
1388
|
* represented by a major or minor number.
|
|
1371
1389
|
*
|
|
1372
|
-
* @see {@link MatterSpecification.
|
|
1390
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
1373
1391
|
*/
|
|
1374
1392
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1375
1393
|
/**
|
|
@@ -1378,42 +1396,42 @@ export declare namespace Channel {
|
|
|
1378
1396
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
1379
1397
|
* represented by a major or minor number.
|
|
1380
1398
|
*
|
|
1381
|
-
* @see {@link MatterSpecification.
|
|
1399
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
1382
1400
|
*/
|
|
1383
1401
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1384
1402
|
/**
|
|
1385
1403
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
1386
1404
|
* field is optional, but SHOULD be provided when known.
|
|
1387
1405
|
*
|
|
1388
|
-
* @see {@link MatterSpecification.
|
|
1406
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
1389
1407
|
*/
|
|
1390
1408
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1391
1409
|
/**
|
|
1392
1410
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
1393
1411
|
* provided when known.
|
|
1394
1412
|
*
|
|
1395
|
-
* @see {@link MatterSpecification.
|
|
1413
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
1396
1414
|
*/
|
|
1397
1415
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1398
1416
|
/**
|
|
1399
1417
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
1400
1418
|
* be provided when known.
|
|
1401
1419
|
*
|
|
1402
|
-
* @see {@link MatterSpecification.
|
|
1420
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
1403
1421
|
*/
|
|
1404
1422
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1405
1423
|
/**
|
|
1406
1424
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
1407
1425
|
* provided when MajorNumber and MinorNumber are not available.
|
|
1408
1426
|
*
|
|
1409
|
-
* @see {@link MatterSpecification.
|
|
1427
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
1410
1428
|
*/
|
|
1411
1429
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1412
1430
|
/**
|
|
1413
1431
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
1414
1432
|
* provided when known.
|
|
1415
1433
|
*
|
|
1416
|
-
* @see {@link MatterSpecification.
|
|
1434
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
1417
1435
|
*/
|
|
1418
1436
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
1419
1437
|
}>[], any>;
|
|
@@ -1427,33 +1445,33 @@ export declare namespace Channel {
|
|
|
1427
1445
|
/**
|
|
1428
1446
|
* This attribute shall identify the channel lineup using external data sources.
|
|
1429
1447
|
*
|
|
1430
|
-
* @see {@link MatterSpecification.
|
|
1448
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.6.2
|
|
1431
1449
|
*/
|
|
1432
1450
|
readonly lineup: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1433
1451
|
/**
|
|
1434
1452
|
* This field shall indicate the name of the operator, for example “Comcast”.
|
|
1435
1453
|
*
|
|
1436
|
-
* @see {@link MatterSpecification.
|
|
1454
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.1
|
|
1437
1455
|
*/
|
|
1438
1456
|
operatorName: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1439
1457
|
/**
|
|
1440
1458
|
* This field shall indicate the name of the provider lineup, for example "Comcast King County". This field is
|
|
1441
1459
|
* optional, but SHOULD be provided when known.
|
|
1442
1460
|
*
|
|
1443
|
-
* @see {@link MatterSpecification.
|
|
1461
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.2
|
|
1444
1462
|
*/
|
|
1445
1463
|
lineupName: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1446
1464
|
/**
|
|
1447
1465
|
* This field shall indicate the postal code (zip code) for the location of the device, such as "98052". This
|
|
1448
1466
|
* field is optional, but SHOULD be provided when known.
|
|
1449
1467
|
*
|
|
1450
|
-
* @see {@link MatterSpecification.
|
|
1468
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.3
|
|
1451
1469
|
*/
|
|
1452
1470
|
postalCode: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1453
1471
|
/**
|
|
1454
1472
|
* This field shall indicate the type of lineup. This field is optional, but SHOULD be provided when known.
|
|
1455
1473
|
*
|
|
1456
|
-
* @see {@link MatterSpecification.
|
|
1474
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.4
|
|
1457
1475
|
*/
|
|
1458
1476
|
lineupInfoType: import("../tlv/TlvObject.js").FieldType<LineupInfoType>;
|
|
1459
1477
|
}> | null, any>;
|
|
@@ -1474,26 +1492,26 @@ export declare namespace Channel {
|
|
|
1474
1492
|
*
|
|
1475
1493
|
* Upon success, the CurrentChannel attribute, if supported, shall be updated to reflect the change.
|
|
1476
1494
|
*
|
|
1477
|
-
* @see {@link MatterSpecification.
|
|
1495
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1
|
|
1478
1496
|
*/
|
|
1479
1497
|
readonly changeChannel: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1480
1498
|
/**
|
|
1481
1499
|
* This field shall contain a user-input string to match in order to identify the target channel.
|
|
1482
1500
|
*
|
|
1483
|
-
* @see {@link MatterSpecification.
|
|
1501
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1.1
|
|
1484
1502
|
*/
|
|
1485
1503
|
match: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1486
1504
|
}>, import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1487
1505
|
/**
|
|
1488
1506
|
* This field shall indicate the status of the command which resulted in this response.
|
|
1489
1507
|
*
|
|
1490
|
-
* @see {@link MatterSpecification.
|
|
1508
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.1
|
|
1491
1509
|
*/
|
|
1492
1510
|
status: import("../tlv/TlvObject.js").FieldType<Status>;
|
|
1493
1511
|
/**
|
|
1494
1512
|
* This field shall indicate Optional app-specific data.
|
|
1495
1513
|
*
|
|
1496
|
-
* @see {@link MatterSpecification.
|
|
1514
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.2
|
|
1497
1515
|
*/
|
|
1498
1516
|
data: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1499
1517
|
}>, any>;
|
|
@@ -1510,14 +1528,14 @@ export declare namespace Channel {
|
|
|
1510
1528
|
* ProgramGuideResponse. Standard error codes shall be used when arguments provided are not valid. For
|
|
1511
1529
|
* example, if StartTime is greater than EndTime, the status code INVALID_ACTION shall be returned.
|
|
1512
1530
|
*
|
|
1513
|
-
* @see {@link MatterSpecification.
|
|
1531
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5
|
|
1514
1532
|
*/
|
|
1515
1533
|
readonly getProgramGuide: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1516
1534
|
/**
|
|
1517
1535
|
* This field shall indicate the beginning of the time window for which program guide entries are to be
|
|
1518
1536
|
* retrieved, as a UTC time. Entries with a start time on or after this value will be included in the results.
|
|
1519
1537
|
*
|
|
1520
|
-
* @see {@link MatterSpecification.
|
|
1538
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.1
|
|
1521
1539
|
*/
|
|
1522
1540
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1523
1541
|
/**
|
|
@@ -1525,7 +1543,7 @@ export declare namespace Channel {
|
|
|
1525
1543
|
* a UTC time. Entries with an end time on or before this value will be included in the results. This field can
|
|
1526
1544
|
* represent a past or future value but shall be greater than the StartTime.
|
|
1527
1545
|
*
|
|
1528
|
-
* @see {@link MatterSpecification.
|
|
1546
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.2
|
|
1529
1547
|
*/
|
|
1530
1548
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1531
1549
|
/**
|
|
@@ -1533,7 +1551,7 @@ export declare namespace Channel {
|
|
|
1533
1551
|
* a list of channels in this field, the response will only include entries corresponding to the specified
|
|
1534
1552
|
* channels.
|
|
1535
1553
|
*
|
|
1536
|
-
* @see {@link MatterSpecification.
|
|
1554
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.3
|
|
1537
1555
|
*/
|
|
1538
1556
|
channelList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1539
1557
|
/**
|
|
@@ -1542,7 +1560,7 @@ export declare namespace Channel {
|
|
|
1542
1560
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
1543
1561
|
* represented by a major or minor number.
|
|
1544
1562
|
*
|
|
1545
|
-
* @see {@link MatterSpecification.
|
|
1563
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
1546
1564
|
*/
|
|
1547
1565
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1548
1566
|
/**
|
|
@@ -1551,56 +1569,56 @@ export declare namespace Channel {
|
|
|
1551
1569
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
1552
1570
|
* represented by a major or minor number.
|
|
1553
1571
|
*
|
|
1554
|
-
* @see {@link MatterSpecification.
|
|
1572
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
1555
1573
|
*/
|
|
1556
1574
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1557
1575
|
/**
|
|
1558
1576
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
1559
1577
|
* field is optional, but SHOULD be provided when known.
|
|
1560
1578
|
*
|
|
1561
|
-
* @see {@link MatterSpecification.
|
|
1579
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
1562
1580
|
*/
|
|
1563
1581
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1564
1582
|
/**
|
|
1565
1583
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
1566
1584
|
* provided when known.
|
|
1567
1585
|
*
|
|
1568
|
-
* @see {@link MatterSpecification.
|
|
1586
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
1569
1587
|
*/
|
|
1570
1588
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1571
1589
|
/**
|
|
1572
1590
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
1573
1591
|
* be provided when known.
|
|
1574
1592
|
*
|
|
1575
|
-
* @see {@link MatterSpecification.
|
|
1593
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
1576
1594
|
*/
|
|
1577
1595
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1578
1596
|
/**
|
|
1579
1597
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
1580
1598
|
* provided when MajorNumber and MinorNumber are not available.
|
|
1581
1599
|
*
|
|
1582
|
-
* @see {@link MatterSpecification.
|
|
1600
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
1583
1601
|
*/
|
|
1584
1602
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1585
1603
|
/**
|
|
1586
1604
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
1587
1605
|
* provided when known.
|
|
1588
1606
|
*
|
|
1589
|
-
* @see {@link MatterSpecification.
|
|
1607
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
1590
1608
|
*/
|
|
1591
1609
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
1592
1610
|
}>[]>;
|
|
1593
1611
|
/**
|
|
1594
1612
|
* This field shall indicate the pagination token used for managing pagination progression.
|
|
1595
1613
|
*
|
|
1596
|
-
* @see {@link MatterSpecification.
|
|
1614
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.4
|
|
1597
1615
|
*/
|
|
1598
1616
|
pageToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1599
1617
|
/**
|
|
1600
1618
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
1601
1619
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
1602
1620
|
*
|
|
1603
|
-
* @see {@link MatterSpecification.
|
|
1621
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
1604
1622
|
*/
|
|
1605
1623
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1606
1624
|
/**
|
|
@@ -1609,7 +1627,7 @@ export declare namespace Channel {
|
|
|
1609
1627
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
1610
1628
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
1611
1629
|
*
|
|
1612
|
-
* @see {@link MatterSpecification.
|
|
1630
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
1613
1631
|
*/
|
|
1614
1632
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1615
1633
|
/**
|
|
@@ -1618,14 +1636,14 @@ export declare namespace Channel {
|
|
|
1618
1636
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
1619
1637
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
1620
1638
|
*
|
|
1621
|
-
* @see {@link MatterSpecification.
|
|
1639
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
1622
1640
|
*/
|
|
1623
1641
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1624
1642
|
}> | null>;
|
|
1625
1643
|
/**
|
|
1626
1644
|
* This field shall indicate the flags of the programs for which entries should be fetched.
|
|
1627
1645
|
*
|
|
1628
|
-
* @see {@link MatterSpecification.
|
|
1646
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.5
|
|
1629
1647
|
*/
|
|
1630
1648
|
recordingFlag: import("../tlv/TlvObject.js").OptionalFieldType<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
1631
1649
|
/**
|
|
@@ -1644,7 +1662,7 @@ export declare namespace Channel {
|
|
|
1644
1662
|
/**
|
|
1645
1663
|
* This field shall indicate the list of additional external content identifiers.
|
|
1646
1664
|
*
|
|
1647
|
-
* @see {@link MatterSpecification.
|
|
1665
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.6
|
|
1648
1666
|
*/
|
|
1649
1667
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1650
1668
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -1653,7 +1671,7 @@ export declare namespace Channel {
|
|
|
1653
1671
|
/**
|
|
1654
1672
|
* This field shall indicate Optional app-specific data.
|
|
1655
1673
|
*
|
|
1656
|
-
* @see {@link MatterSpecification.
|
|
1674
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.7
|
|
1657
1675
|
*/
|
|
1658
1676
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
1659
1677
|
}>, import("../tlv/TlvObject.js").TypeFromFields<{
|
|
@@ -1661,21 +1679,21 @@ export declare namespace Channel {
|
|
|
1661
1679
|
* This field shall indicate the necessary pagination attributes that define information for both the succeeding
|
|
1662
1680
|
* and preceding data pages.
|
|
1663
1681
|
*
|
|
1664
|
-
* @see {@link MatterSpecification.
|
|
1682
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.6.1
|
|
1665
1683
|
*/
|
|
1666
1684
|
paging: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1667
1685
|
/**
|
|
1668
1686
|
* This field shall indicate the token to retrieve the preceding page. Absence of this field denotes the
|
|
1669
1687
|
* response as the initial page.
|
|
1670
1688
|
*
|
|
1671
|
-
* @see {@link MatterSpecification.
|
|
1689
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12.1
|
|
1672
1690
|
*/
|
|
1673
1691
|
previousToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1674
1692
|
/**
|
|
1675
1693
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
1676
1694
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
1677
1695
|
*
|
|
1678
|
-
* @see {@link MatterSpecification.
|
|
1696
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
1679
1697
|
*/
|
|
1680
1698
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1681
1699
|
/**
|
|
@@ -1684,7 +1702,7 @@ export declare namespace Channel {
|
|
|
1684
1702
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
1685
1703
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
1686
1704
|
*
|
|
1687
|
-
* @see {@link MatterSpecification.
|
|
1705
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
1688
1706
|
*/
|
|
1689
1707
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1690
1708
|
/**
|
|
@@ -1693,7 +1711,7 @@ export declare namespace Channel {
|
|
|
1693
1711
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
1694
1712
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
1695
1713
|
*
|
|
1696
|
-
* @see {@link MatterSpecification.
|
|
1714
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
1697
1715
|
*/
|
|
1698
1716
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1699
1717
|
}> | null>;
|
|
@@ -1701,14 +1719,14 @@ export declare namespace Channel {
|
|
|
1701
1719
|
* This field shall indicate the token to retrieve the next page. Absence of this field denotes the response as
|
|
1702
1720
|
* the last page.
|
|
1703
1721
|
*
|
|
1704
|
-
* @see {@link MatterSpecification.
|
|
1722
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12.2
|
|
1705
1723
|
*/
|
|
1706
1724
|
nextToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1707
1725
|
/**
|
|
1708
1726
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
1709
1727
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
1710
1728
|
*
|
|
1711
|
-
* @see {@link MatterSpecification.
|
|
1729
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
1712
1730
|
*/
|
|
1713
1731
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
1714
1732
|
/**
|
|
@@ -1717,7 +1735,7 @@ export declare namespace Channel {
|
|
|
1717
1735
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
1718
1736
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
1719
1737
|
*
|
|
1720
|
-
* @see {@link MatterSpecification.
|
|
1738
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
1721
1739
|
*/
|
|
1722
1740
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1723
1741
|
/**
|
|
@@ -1726,7 +1744,7 @@ export declare namespace Channel {
|
|
|
1726
1744
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
1727
1745
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
1728
1746
|
*
|
|
1729
|
-
* @see {@link MatterSpecification.
|
|
1747
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
1730
1748
|
*/
|
|
1731
1749
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1732
1750
|
}> | null>;
|
|
@@ -1734,20 +1752,20 @@ export declare namespace Channel {
|
|
|
1734
1752
|
/**
|
|
1735
1753
|
* This field shall indicate the list of programs.
|
|
1736
1754
|
*
|
|
1737
|
-
* @see {@link MatterSpecification.
|
|
1755
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.6.2
|
|
1738
1756
|
*/
|
|
1739
1757
|
programList: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1740
1758
|
/**
|
|
1741
1759
|
* This field shall indicate a unique identifier for a program within an electronic program guide list. The
|
|
1742
1760
|
* identifier shall be unique across multiple channels.
|
|
1743
1761
|
*
|
|
1744
|
-
* @see {@link MatterSpecification.
|
|
1762
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.1
|
|
1745
1763
|
*/
|
|
1746
1764
|
identifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1747
1765
|
/**
|
|
1748
1766
|
* This field shall indicate the channel associated to the program.
|
|
1749
1767
|
*
|
|
1750
|
-
* @see {@link MatterSpecification.
|
|
1768
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.2
|
|
1751
1769
|
*/
|
|
1752
1770
|
channel: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1753
1771
|
/**
|
|
@@ -1756,7 +1774,7 @@ export declare namespace Channel {
|
|
|
1756
1774
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
1757
1775
|
* represented by a major or minor number.
|
|
1758
1776
|
*
|
|
1759
|
-
* @see {@link MatterSpecification.
|
|
1777
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
1760
1778
|
*/
|
|
1761
1779
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1762
1780
|
/**
|
|
@@ -1765,42 +1783,42 @@ export declare namespace Channel {
|
|
|
1765
1783
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
1766
1784
|
* represented by a major or minor number.
|
|
1767
1785
|
*
|
|
1768
|
-
* @see {@link MatterSpecification.
|
|
1786
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
1769
1787
|
*/
|
|
1770
1788
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1771
1789
|
/**
|
|
1772
1790
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
1773
1791
|
* field is optional, but SHOULD be provided when known.
|
|
1774
1792
|
*
|
|
1775
|
-
* @see {@link MatterSpecification.
|
|
1793
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
1776
1794
|
*/
|
|
1777
1795
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1778
1796
|
/**
|
|
1779
1797
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
1780
1798
|
* provided when known.
|
|
1781
1799
|
*
|
|
1782
|
-
* @see {@link MatterSpecification.
|
|
1800
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
1783
1801
|
*/
|
|
1784
1802
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1785
1803
|
/**
|
|
1786
1804
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
1787
1805
|
* be provided when known.
|
|
1788
1806
|
*
|
|
1789
|
-
* @see {@link MatterSpecification.
|
|
1807
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
1790
1808
|
*/
|
|
1791
1809
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1792
1810
|
/**
|
|
1793
1811
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
1794
1812
|
* provided when MajorNumber and MinorNumber are not available.
|
|
1795
1813
|
*
|
|
1796
|
-
* @see {@link MatterSpecification.
|
|
1814
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
1797
1815
|
*/
|
|
1798
1816
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1799
1817
|
/**
|
|
1800
1818
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
1801
1819
|
* provided when known.
|
|
1802
1820
|
*
|
|
1803
|
-
* @see {@link MatterSpecification.
|
|
1821
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
1804
1822
|
*/
|
|
1805
1823
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
1806
1824
|
}>>;
|
|
@@ -1808,34 +1826,34 @@ export declare namespace Channel {
|
|
|
1808
1826
|
* This field shall indicate an epoch time in seconds indicating the start time of a program, as a UTC time.
|
|
1809
1827
|
* This field can represent a past or future value.
|
|
1810
1828
|
*
|
|
1811
|
-
* @see {@link MatterSpecification.
|
|
1829
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.3
|
|
1812
1830
|
*/
|
|
1813
1831
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1814
1832
|
/**
|
|
1815
1833
|
* This field shall indicate an epoch time in seconds indicating the end time of a program, as a UTC time. This
|
|
1816
1834
|
* field can represent a past or future value but shall be greater than the StartTime.
|
|
1817
1835
|
*
|
|
1818
|
-
* @see {@link MatterSpecification.
|
|
1836
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.4
|
|
1819
1837
|
*/
|
|
1820
1838
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
1821
1839
|
/**
|
|
1822
1840
|
* This field shall indicate the title or name for the specific program. For example, “MCIS: Los Angeles”.
|
|
1823
1841
|
*
|
|
1824
|
-
* @see {@link MatterSpecification.
|
|
1842
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.5
|
|
1825
1843
|
*/
|
|
1826
1844
|
title: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1827
1845
|
/**
|
|
1828
1846
|
* This field shall indicate the subtitle for the specific program. For example, “Maybe Today" which is an
|
|
1829
1847
|
* episode name for “MCIS: Los Angeles”. This field is optional but shall be provided if applicable and known.
|
|
1830
1848
|
*
|
|
1831
|
-
* @see {@link MatterSpecification.
|
|
1849
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.6
|
|
1832
1850
|
*/
|
|
1833
1851
|
subtitle: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1834
1852
|
/**
|
|
1835
1853
|
* This field shall indicate the brief description for the specific program. For example, a description of an
|
|
1836
1854
|
* episode. This field is optional but shall be provided if known.
|
|
1837
1855
|
*
|
|
1838
|
-
* @see {@link MatterSpecification.
|
|
1856
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.7
|
|
1839
1857
|
*/
|
|
1840
1858
|
description: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1841
1859
|
/**
|
|
@@ -1843,7 +1861,7 @@ export declare namespace Channel {
|
|
|
1843
1861
|
* of the standard Tags for Identifying Languages RFC 5646. This field is optional but shall be provided if
|
|
1844
1862
|
* known.
|
|
1845
1863
|
*
|
|
1846
|
-
* @see {@link MatterSpecification.
|
|
1864
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.8
|
|
1847
1865
|
*/
|
|
1848
1866
|
audioLanguages: import("../tlv/TlvObject.js").OptionalFieldType<string[]>;
|
|
1849
1867
|
/**
|
|
@@ -1853,14 +1871,14 @@ export declare namespace Channel {
|
|
|
1853
1871
|
* children but can be accepted in general for older children. This field is optional but shall be provided if
|
|
1854
1872
|
* known.
|
|
1855
1873
|
*
|
|
1856
|
-
* @see {@link MatterSpecification.
|
|
1874
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.9
|
|
1857
1875
|
*/
|
|
1858
1876
|
ratings: import("../tlv/TlvObject.js").OptionalFieldType<string[]>;
|
|
1859
1877
|
/**
|
|
1860
1878
|
* This field shall represent a URL of a thumbnail that clients can use to render an image for the program. The
|
|
1861
1879
|
* syntax of this field shall follow the syntax as specified in RFC 1738 and shall use the https scheme.
|
|
1862
1880
|
*
|
|
1863
|
-
* @see {@link MatterSpecification.
|
|
1881
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.10
|
|
1864
1882
|
*/
|
|
1865
1883
|
thumbnailUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1866
1884
|
/**
|
|
@@ -1868,35 +1886,35 @@ export declare namespace Channel {
|
|
|
1868
1886
|
* detail view. The syntax of this field shall follow the syntax as specified in RFC 1738 and shall use the
|
|
1869
1887
|
* https scheme.
|
|
1870
1888
|
*
|
|
1871
|
-
* @see {@link MatterSpecification.
|
|
1889
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.11
|
|
1872
1890
|
*/
|
|
1873
1891
|
posterArtUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1874
1892
|
/**
|
|
1875
1893
|
* This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
|
|
1876
1894
|
* syntax as specified in RFC 1738 and shall use the https scheme.
|
|
1877
1895
|
*
|
|
1878
|
-
* @see {@link MatterSpecification.
|
|
1896
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.12
|
|
1879
1897
|
*/
|
|
1880
1898
|
dvbiUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1881
1899
|
/**
|
|
1882
1900
|
* This field shall be a string, in ISO 8601 format, representing the date on which the program was released.
|
|
1883
1901
|
* This field is optional but when provided, the year shall be provided as part of the string.
|
|
1884
1902
|
*
|
|
1885
|
-
* @see {@link MatterSpecification.
|
|
1903
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.13
|
|
1886
1904
|
*/
|
|
1887
1905
|
releaseDate: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1888
1906
|
/**
|
|
1889
1907
|
* This field shall represent a string providing additional information on the parental guidance. This field is
|
|
1890
1908
|
* optional.
|
|
1891
1909
|
*
|
|
1892
|
-
* @see {@link MatterSpecification.
|
|
1910
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.14
|
|
1893
1911
|
*/
|
|
1894
1912
|
parentalGuidanceText: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1895
1913
|
/**
|
|
1896
1914
|
* This field shall represent the recording status of the program. This field is required if the RecordProgram
|
|
1897
1915
|
* feature is set.
|
|
1898
1916
|
*
|
|
1899
|
-
* @see {@link MatterSpecification.
|
|
1917
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.15
|
|
1900
1918
|
*/
|
|
1901
1919
|
recordingFlag: import("../tlv/TlvObject.js").OptionalFieldType<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
1902
1920
|
/**
|
|
@@ -1916,19 +1934,19 @@ export declare namespace Channel {
|
|
|
1916
1934
|
* This field shall represent the information of a series such as season and episode number. This field is
|
|
1917
1935
|
* optional but SHOULD be provided if the program represents a series and this information is available.
|
|
1918
1936
|
*
|
|
1919
|
-
* @see {@link MatterSpecification.
|
|
1937
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.16
|
|
1920
1938
|
*/
|
|
1921
1939
|
seriesInfo: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1922
1940
|
/**
|
|
1923
1941
|
* This field shall represent the season of the series associated to the program.
|
|
1924
1942
|
*
|
|
1925
|
-
* @see {@link MatterSpecification.
|
|
1943
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.1
|
|
1926
1944
|
*/
|
|
1927
1945
|
season: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1928
1946
|
/**
|
|
1929
1947
|
* This field shall represent the episode of the program.
|
|
1930
1948
|
*
|
|
1931
|
-
* @see {@link MatterSpecification.
|
|
1949
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.2
|
|
1932
1950
|
*/
|
|
1933
1951
|
episode: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1934
1952
|
}> | null>;
|
|
@@ -1936,19 +1954,19 @@ export declare namespace Channel {
|
|
|
1936
1954
|
* This field shall represent the category of a particular program. This field is optional but shall be provided
|
|
1937
1955
|
* if known.
|
|
1938
1956
|
*
|
|
1939
|
-
* @see {@link MatterSpecification.
|
|
1957
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.17
|
|
1940
1958
|
*/
|
|
1941
1959
|
categoryList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1942
1960
|
/**
|
|
1943
1961
|
* This field shall represent the category or genre of the program. Ex. News.
|
|
1944
1962
|
*
|
|
1945
|
-
* @see {@link MatterSpecification.
|
|
1963
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.1
|
|
1946
1964
|
*/
|
|
1947
1965
|
category: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1948
1966
|
/**
|
|
1949
1967
|
* This field shall represent the sub-category or sub-genre of the program. Ex. Local.
|
|
1950
1968
|
*
|
|
1951
|
-
* @see {@link MatterSpecification.
|
|
1969
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.2
|
|
1952
1970
|
*/
|
|
1953
1971
|
subCategory: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
1954
1972
|
}>[]>;
|
|
@@ -1956,26 +1974,26 @@ export declare namespace Channel {
|
|
|
1956
1974
|
* This field shall represent a list of the cast or the crew on the program. A single cast member may have more
|
|
1957
1975
|
* than one role. This field is optional but shall be provided if known.
|
|
1958
1976
|
*
|
|
1959
|
-
* @see {@link MatterSpecification.
|
|
1977
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.18
|
|
1960
1978
|
*/
|
|
1961
1979
|
castList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1962
1980
|
/**
|
|
1963
1981
|
* This field shall represent the name of the cast member.
|
|
1964
1982
|
*
|
|
1965
|
-
* @see {@link MatterSpecification.
|
|
1983
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.1
|
|
1966
1984
|
*/
|
|
1967
1985
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1968
1986
|
/**
|
|
1969
1987
|
* This field shall represent the role of the cast member. Ex. Actor, Director.
|
|
1970
1988
|
*
|
|
1971
|
-
* @see {@link MatterSpecification.
|
|
1989
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.2
|
|
1972
1990
|
*/
|
|
1973
1991
|
role: import("../tlv/TlvObject.js").FieldType<string>;
|
|
1974
1992
|
}>[]>;
|
|
1975
1993
|
/**
|
|
1976
1994
|
* This field shall indicate the list of additional external content identifiers.
|
|
1977
1995
|
*
|
|
1978
|
-
* @see {@link MatterSpecification.
|
|
1996
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.19
|
|
1979
1997
|
*/
|
|
1980
1998
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1981
1999
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -1993,14 +2011,14 @@ export declare namespace Channel {
|
|
|
1993
2011
|
/**
|
|
1994
2012
|
* Record a specific program or series when it goes live. This functionality enables DVR recording features.
|
|
1995
2013
|
*
|
|
1996
|
-
* @see {@link MatterSpecification.
|
|
2014
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7
|
|
1997
2015
|
*/
|
|
1998
2016
|
readonly recordProgram: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
1999
2017
|
/**
|
|
2000
2018
|
* This field shall indicate the program identifier for the program that should be recorded. This value is
|
|
2001
2019
|
* provided by the identifier field in ProgramStruct.
|
|
2002
2020
|
*
|
|
2003
|
-
* @see {@link MatterSpecification.
|
|
2021
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.1
|
|
2004
2022
|
*/
|
|
2005
2023
|
programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2006
2024
|
/**
|
|
@@ -2008,13 +2026,13 @@ export declare namespace Channel {
|
|
|
2008
2026
|
* invoking record program on an episode with that flag set to true, the target should schedule record the whole
|
|
2009
2027
|
* series.
|
|
2010
2028
|
*
|
|
2011
|
-
* @see {@link MatterSpecification.
|
|
2029
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.2
|
|
2012
2030
|
*/
|
|
2013
2031
|
shouldRecordSeries: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
2014
2032
|
/**
|
|
2015
2033
|
* This field, if present, shall indicate the list of additional external content identifiers.
|
|
2016
2034
|
*
|
|
2017
|
-
* @see {@link MatterSpecification.
|
|
2035
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.3
|
|
2018
2036
|
*/
|
|
2019
2037
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2020
2038
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -2023,21 +2041,21 @@ export declare namespace Channel {
|
|
|
2023
2041
|
/**
|
|
2024
2042
|
* This field, if present, shall indicate app-specific data.
|
|
2025
2043
|
*
|
|
2026
|
-
* @see {@link MatterSpecification.
|
|
2044
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.4
|
|
2027
2045
|
*/
|
|
2028
2046
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
2029
2047
|
}>, void, any>;
|
|
2030
2048
|
/**
|
|
2031
2049
|
* Cancel recording for a specific program or series.
|
|
2032
2050
|
*
|
|
2033
|
-
* @see {@link MatterSpecification.
|
|
2051
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8
|
|
2034
2052
|
*/
|
|
2035
2053
|
readonly cancelRecordProgram: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2036
2054
|
/**
|
|
2037
2055
|
* This field shall indicate the program identifier for the program that should be cancelled from recording.
|
|
2038
2056
|
* This value is provided by the identifier field in ProgramStruct.
|
|
2039
2057
|
*
|
|
2040
|
-
* @see {@link MatterSpecification.
|
|
2058
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.1
|
|
2041
2059
|
*/
|
|
2042
2060
|
programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2043
2061
|
/**
|
|
@@ -2045,13 +2063,13 @@ export declare namespace Channel {
|
|
|
2045
2063
|
* recording. For example, invoking record program on an episode with that flag set to true, the target should
|
|
2046
2064
|
* schedule record the whole series.
|
|
2047
2065
|
*
|
|
2048
|
-
* @see {@link MatterSpecification.
|
|
2066
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.2
|
|
2049
2067
|
*/
|
|
2050
2068
|
shouldRecordSeries: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
2051
2069
|
/**
|
|
2052
2070
|
* This field, if present, shall indicate the list of additional external content identifiers.
|
|
2053
2071
|
*
|
|
2054
|
-
* @see {@link MatterSpecification.
|
|
2072
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.3
|
|
2055
2073
|
*/
|
|
2056
2074
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2057
2075
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -2060,7 +2078,7 @@ export declare namespace Channel {
|
|
|
2060
2078
|
/**
|
|
2061
2079
|
* This field, if present, shall indicate app-specific data.
|
|
2062
2080
|
*
|
|
2063
|
-
* @see {@link MatterSpecification.
|
|
2081
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.4
|
|
2064
2082
|
*/
|
|
2065
2083
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
2066
2084
|
}>, void, any>;
|
|
@@ -2096,7 +2114,7 @@ export declare namespace Channel {
|
|
|
2096
2114
|
* This attribute shall contain the current channel. When supported but a channel is not currently tuned to
|
|
2097
2115
|
* (if a content application is in foreground), the value of the field shall be null.
|
|
2098
2116
|
*
|
|
2099
|
-
* @see {@link MatterSpecification.
|
|
2117
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.6.3
|
|
2100
2118
|
*/
|
|
2101
2119
|
readonly currentChannel: OptionalAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2102
2120
|
/**
|
|
@@ -2105,7 +2123,7 @@ export declare namespace Channel {
|
|
|
2105
2123
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
2106
2124
|
* represented by a major or minor number.
|
|
2107
2125
|
*
|
|
2108
|
-
* @see {@link MatterSpecification.
|
|
2126
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
2109
2127
|
*/
|
|
2110
2128
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2111
2129
|
/**
|
|
@@ -2114,42 +2132,42 @@ export declare namespace Channel {
|
|
|
2114
2132
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
2115
2133
|
* represented by a major or minor number.
|
|
2116
2134
|
*
|
|
2117
|
-
* @see {@link MatterSpecification.
|
|
2135
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
2118
2136
|
*/
|
|
2119
2137
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2120
2138
|
/**
|
|
2121
2139
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
2122
2140
|
* field is optional, but SHOULD be provided when known.
|
|
2123
2141
|
*
|
|
2124
|
-
* @see {@link MatterSpecification.
|
|
2142
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
2125
2143
|
*/
|
|
2126
2144
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2127
2145
|
/**
|
|
2128
2146
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
2129
2147
|
* provided when known.
|
|
2130
2148
|
*
|
|
2131
|
-
* @see {@link MatterSpecification.
|
|
2149
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
2132
2150
|
*/
|
|
2133
2151
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2134
2152
|
/**
|
|
2135
2153
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
2136
2154
|
* be provided when known.
|
|
2137
2155
|
*
|
|
2138
|
-
* @see {@link MatterSpecification.
|
|
2156
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
2139
2157
|
*/
|
|
2140
2158
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2141
2159
|
/**
|
|
2142
2160
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
2143
2161
|
* provided when MajorNumber and MinorNumber are not available.
|
|
2144
2162
|
*
|
|
2145
|
-
* @see {@link MatterSpecification.
|
|
2163
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
2146
2164
|
*/
|
|
2147
2165
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2148
2166
|
/**
|
|
2149
2167
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
2150
2168
|
* provided when known.
|
|
2151
2169
|
*
|
|
2152
|
-
* @see {@link MatterSpecification.
|
|
2170
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
2153
2171
|
*/
|
|
2154
2172
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
2155
2173
|
}> | null, any>;
|
|
@@ -2158,19 +2176,19 @@ export declare namespace Channel {
|
|
|
2158
2176
|
/**
|
|
2159
2177
|
* Change the channel to the channel with the given Number in the ChannelList attribute.
|
|
2160
2178
|
*
|
|
2161
|
-
* @see {@link MatterSpecification.
|
|
2179
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3
|
|
2162
2180
|
*/
|
|
2163
2181
|
readonly changeChannelByNumber: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2164
2182
|
/**
|
|
2165
2183
|
* This field shall indicate the channel major number value (ATSC format) to which the channel should change.
|
|
2166
2184
|
*
|
|
2167
|
-
* @see {@link MatterSpecification.
|
|
2185
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3.1
|
|
2168
2186
|
*/
|
|
2169
2187
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2170
2188
|
/**
|
|
2171
2189
|
* This field shall indicate the channel minor number value (ATSC format) to which the channel should change.
|
|
2172
2190
|
*
|
|
2173
|
-
* @see {@link MatterSpecification.
|
|
2191
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3.2
|
|
2174
2192
|
*/
|
|
2175
2193
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2176
2194
|
}>, void, any>;
|
|
@@ -2183,14 +2201,14 @@ export declare namespace Channel {
|
|
|
2183
2201
|
* continue. For example, if the current channel is at index 0 and count value of -1 is given, then the
|
|
2184
2202
|
* current channel should change to the last channel.
|
|
2185
2203
|
*
|
|
2186
|
-
* @see {@link MatterSpecification.
|
|
2204
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.4
|
|
2187
2205
|
*/
|
|
2188
2206
|
readonly skipChannel: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2189
2207
|
/**
|
|
2190
2208
|
* This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is negative)
|
|
2191
2209
|
* the current channel.
|
|
2192
2210
|
*
|
|
2193
|
-
* @see {@link MatterSpecification.
|
|
2211
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.4.1
|
|
2194
2212
|
*/
|
|
2195
2213
|
count: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2196
2214
|
}>, void, any>;
|
|
@@ -2207,7 +2225,7 @@ export declare namespace Channel {
|
|
|
2207
2225
|
/**
|
|
2208
2226
|
* This attribute shall provide the list of supported channels.
|
|
2209
2227
|
*
|
|
2210
|
-
* @see {@link MatterSpecification.
|
|
2228
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.6.1
|
|
2211
2229
|
*/
|
|
2212
2230
|
readonly channelList: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2213
2231
|
/**
|
|
@@ -2216,7 +2234,7 @@ export declare namespace Channel {
|
|
|
2216
2234
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
2217
2235
|
* represented by a major or minor number.
|
|
2218
2236
|
*
|
|
2219
|
-
* @see {@link MatterSpecification.
|
|
2237
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
2220
2238
|
*/
|
|
2221
2239
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2222
2240
|
/**
|
|
@@ -2225,42 +2243,42 @@ export declare namespace Channel {
|
|
|
2225
2243
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
2226
2244
|
* represented by a major or minor number.
|
|
2227
2245
|
*
|
|
2228
|
-
* @see {@link MatterSpecification.
|
|
2246
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
2229
2247
|
*/
|
|
2230
2248
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2231
2249
|
/**
|
|
2232
2250
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
2233
2251
|
* field is optional, but SHOULD be provided when known.
|
|
2234
2252
|
*
|
|
2235
|
-
* @see {@link MatterSpecification.
|
|
2253
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
2236
2254
|
*/
|
|
2237
2255
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2238
2256
|
/**
|
|
2239
2257
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
2240
2258
|
* provided when known.
|
|
2241
2259
|
*
|
|
2242
|
-
* @see {@link MatterSpecification.
|
|
2260
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
2243
2261
|
*/
|
|
2244
2262
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2245
2263
|
/**
|
|
2246
2264
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
2247
2265
|
* be provided when known.
|
|
2248
2266
|
*
|
|
2249
|
-
* @see {@link MatterSpecification.
|
|
2267
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
2250
2268
|
*/
|
|
2251
2269
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2252
2270
|
/**
|
|
2253
2271
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
2254
2272
|
* provided when MajorNumber and MinorNumber are not available.
|
|
2255
2273
|
*
|
|
2256
|
-
* @see {@link MatterSpecification.
|
|
2274
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
2257
2275
|
*/
|
|
2258
2276
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2259
2277
|
/**
|
|
2260
2278
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
2261
2279
|
* provided when known.
|
|
2262
2280
|
*
|
|
2263
|
-
* @see {@link MatterSpecification.
|
|
2281
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
2264
2282
|
*/
|
|
2265
2283
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
2266
2284
|
}>[], any>;
|
|
@@ -2275,33 +2293,33 @@ export declare namespace Channel {
|
|
|
2275
2293
|
/**
|
|
2276
2294
|
* This attribute shall identify the channel lineup using external data sources.
|
|
2277
2295
|
*
|
|
2278
|
-
* @see {@link MatterSpecification.
|
|
2296
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.6.2
|
|
2279
2297
|
*/
|
|
2280
2298
|
readonly lineup: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2281
2299
|
/**
|
|
2282
2300
|
* This field shall indicate the name of the operator, for example “Comcast”.
|
|
2283
2301
|
*
|
|
2284
|
-
* @see {@link MatterSpecification.
|
|
2302
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.1
|
|
2285
2303
|
*/
|
|
2286
2304
|
operatorName: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2287
2305
|
/**
|
|
2288
2306
|
* This field shall indicate the name of the provider lineup, for example "Comcast King County". This field is
|
|
2289
2307
|
* optional, but SHOULD be provided when known.
|
|
2290
2308
|
*
|
|
2291
|
-
* @see {@link MatterSpecification.
|
|
2309
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.2
|
|
2292
2310
|
*/
|
|
2293
2311
|
lineupName: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2294
2312
|
/**
|
|
2295
2313
|
* This field shall indicate the postal code (zip code) for the location of the device, such as "98052". This
|
|
2296
2314
|
* field is optional, but SHOULD be provided when known.
|
|
2297
2315
|
*
|
|
2298
|
-
* @see {@link MatterSpecification.
|
|
2316
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.3
|
|
2299
2317
|
*/
|
|
2300
2318
|
postalCode: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2301
2319
|
/**
|
|
2302
2320
|
* This field shall indicate the type of lineup. This field is optional, but SHOULD be provided when known.
|
|
2303
2321
|
*
|
|
2304
|
-
* @see {@link MatterSpecification.
|
|
2322
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.4
|
|
2305
2323
|
*/
|
|
2306
2324
|
lineupInfoType: import("../tlv/TlvObject.js").FieldType<LineupInfoType>;
|
|
2307
2325
|
}> | null, any>;
|
|
@@ -2323,26 +2341,26 @@ export declare namespace Channel {
|
|
|
2323
2341
|
*
|
|
2324
2342
|
* Upon success, the CurrentChannel attribute, if supported, shall be updated to reflect the change.
|
|
2325
2343
|
*
|
|
2326
|
-
* @see {@link MatterSpecification.
|
|
2344
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1
|
|
2327
2345
|
*/
|
|
2328
2346
|
readonly changeChannel: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2329
2347
|
/**
|
|
2330
2348
|
* This field shall contain a user-input string to match in order to identify the target channel.
|
|
2331
2349
|
*
|
|
2332
|
-
* @see {@link MatterSpecification.
|
|
2350
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1.1
|
|
2333
2351
|
*/
|
|
2334
2352
|
match: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2335
2353
|
}>, import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2336
2354
|
/**
|
|
2337
2355
|
* This field shall indicate the status of the command which resulted in this response.
|
|
2338
2356
|
*
|
|
2339
|
-
* @see {@link MatterSpecification.
|
|
2357
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.1
|
|
2340
2358
|
*/
|
|
2341
2359
|
status: import("../tlv/TlvObject.js").FieldType<Status>;
|
|
2342
2360
|
/**
|
|
2343
2361
|
* This field shall indicate Optional app-specific data.
|
|
2344
2362
|
*
|
|
2345
|
-
* @see {@link MatterSpecification.
|
|
2363
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.2
|
|
2346
2364
|
*/
|
|
2347
2365
|
data: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2348
2366
|
}>, any>;
|
|
@@ -2364,26 +2382,26 @@ export declare namespace Channel {
|
|
|
2364
2382
|
*
|
|
2365
2383
|
* Upon success, the CurrentChannel attribute, if supported, shall be updated to reflect the change.
|
|
2366
2384
|
*
|
|
2367
|
-
* @see {@link MatterSpecification.
|
|
2385
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1
|
|
2368
2386
|
*/
|
|
2369
2387
|
readonly changeChannel: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2370
2388
|
/**
|
|
2371
2389
|
* This field shall contain a user-input string to match in order to identify the target channel.
|
|
2372
2390
|
*
|
|
2373
|
-
* @see {@link MatterSpecification.
|
|
2391
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1.1
|
|
2374
2392
|
*/
|
|
2375
2393
|
match: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2376
2394
|
}>, import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2377
2395
|
/**
|
|
2378
2396
|
* This field shall indicate the status of the command which resulted in this response.
|
|
2379
2397
|
*
|
|
2380
|
-
* @see {@link MatterSpecification.
|
|
2398
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.1
|
|
2381
2399
|
*/
|
|
2382
2400
|
status: import("../tlv/TlvObject.js").FieldType<Status>;
|
|
2383
2401
|
/**
|
|
2384
2402
|
* This field shall indicate Optional app-specific data.
|
|
2385
2403
|
*
|
|
2386
|
-
* @see {@link MatterSpecification.
|
|
2404
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.2
|
|
2387
2405
|
*/
|
|
2388
2406
|
data: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2389
2407
|
}>, any>;
|
|
@@ -2401,14 +2419,14 @@ export declare namespace Channel {
|
|
|
2401
2419
|
* ProgramGuideResponse. Standard error codes shall be used when arguments provided are not valid. For
|
|
2402
2420
|
* example, if StartTime is greater than EndTime, the status code INVALID_ACTION shall be returned.
|
|
2403
2421
|
*
|
|
2404
|
-
* @see {@link MatterSpecification.
|
|
2422
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5
|
|
2405
2423
|
*/
|
|
2406
2424
|
readonly getProgramGuide: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2407
2425
|
/**
|
|
2408
2426
|
* This field shall indicate the beginning of the time window for which program guide entries are to be
|
|
2409
2427
|
* retrieved, as a UTC time. Entries with a start time on or after this value will be included in the results.
|
|
2410
2428
|
*
|
|
2411
|
-
* @see {@link MatterSpecification.
|
|
2429
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.1
|
|
2412
2430
|
*/
|
|
2413
2431
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2414
2432
|
/**
|
|
@@ -2416,7 +2434,7 @@ export declare namespace Channel {
|
|
|
2416
2434
|
* a UTC time. Entries with an end time on or before this value will be included in the results. This field can
|
|
2417
2435
|
* represent a past or future value but shall be greater than the StartTime.
|
|
2418
2436
|
*
|
|
2419
|
-
* @see {@link MatterSpecification.
|
|
2437
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.2
|
|
2420
2438
|
*/
|
|
2421
2439
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2422
2440
|
/**
|
|
@@ -2424,7 +2442,7 @@ export declare namespace Channel {
|
|
|
2424
2442
|
* a list of channels in this field, the response will only include entries corresponding to the specified
|
|
2425
2443
|
* channels.
|
|
2426
2444
|
*
|
|
2427
|
-
* @see {@link MatterSpecification.
|
|
2445
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.3
|
|
2428
2446
|
*/
|
|
2429
2447
|
channelList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2430
2448
|
/**
|
|
@@ -2433,7 +2451,7 @@ export declare namespace Channel {
|
|
|
2433
2451
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
2434
2452
|
* represented by a major or minor number.
|
|
2435
2453
|
*
|
|
2436
|
-
* @see {@link MatterSpecification.
|
|
2454
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
2437
2455
|
*/
|
|
2438
2456
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2439
2457
|
/**
|
|
@@ -2442,56 +2460,56 @@ export declare namespace Channel {
|
|
|
2442
2460
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
2443
2461
|
* represented by a major or minor number.
|
|
2444
2462
|
*
|
|
2445
|
-
* @see {@link MatterSpecification.
|
|
2463
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
2446
2464
|
*/
|
|
2447
2465
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2448
2466
|
/**
|
|
2449
2467
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
2450
2468
|
* field is optional, but SHOULD be provided when known.
|
|
2451
2469
|
*
|
|
2452
|
-
* @see {@link MatterSpecification.
|
|
2470
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
2453
2471
|
*/
|
|
2454
2472
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2455
2473
|
/**
|
|
2456
2474
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
2457
2475
|
* provided when known.
|
|
2458
2476
|
*
|
|
2459
|
-
* @see {@link MatterSpecification.
|
|
2477
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
2460
2478
|
*/
|
|
2461
2479
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2462
2480
|
/**
|
|
2463
2481
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
2464
2482
|
* be provided when known.
|
|
2465
2483
|
*
|
|
2466
|
-
* @see {@link MatterSpecification.
|
|
2484
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
2467
2485
|
*/
|
|
2468
2486
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2469
2487
|
/**
|
|
2470
2488
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
2471
2489
|
* provided when MajorNumber and MinorNumber are not available.
|
|
2472
2490
|
*
|
|
2473
|
-
* @see {@link MatterSpecification.
|
|
2491
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
2474
2492
|
*/
|
|
2475
2493
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2476
2494
|
/**
|
|
2477
2495
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
2478
2496
|
* provided when known.
|
|
2479
2497
|
*
|
|
2480
|
-
* @see {@link MatterSpecification.
|
|
2498
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
2481
2499
|
*/
|
|
2482
2500
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
2483
2501
|
}>[]>;
|
|
2484
2502
|
/**
|
|
2485
2503
|
* This field shall indicate the pagination token used for managing pagination progression.
|
|
2486
2504
|
*
|
|
2487
|
-
* @see {@link MatterSpecification.
|
|
2505
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.4
|
|
2488
2506
|
*/
|
|
2489
2507
|
pageToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2490
2508
|
/**
|
|
2491
2509
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
2492
2510
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
2493
2511
|
*
|
|
2494
|
-
* @see {@link MatterSpecification.
|
|
2512
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
2495
2513
|
*/
|
|
2496
2514
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
2497
2515
|
/**
|
|
@@ -2500,7 +2518,7 @@ export declare namespace Channel {
|
|
|
2500
2518
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
2501
2519
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
2502
2520
|
*
|
|
2503
|
-
* @see {@link MatterSpecification.
|
|
2521
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
2504
2522
|
*/
|
|
2505
2523
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2506
2524
|
/**
|
|
@@ -2509,14 +2527,14 @@ export declare namespace Channel {
|
|
|
2509
2527
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
2510
2528
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
2511
2529
|
*
|
|
2512
|
-
* @see {@link MatterSpecification.
|
|
2530
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
2513
2531
|
*/
|
|
2514
2532
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2515
2533
|
}> | null>;
|
|
2516
2534
|
/**
|
|
2517
2535
|
* This field shall indicate the flags of the programs for which entries should be fetched.
|
|
2518
2536
|
*
|
|
2519
|
-
* @see {@link MatterSpecification.
|
|
2537
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.5
|
|
2520
2538
|
*/
|
|
2521
2539
|
recordingFlag: import("../tlv/TlvObject.js").OptionalFieldType<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
2522
2540
|
/**
|
|
@@ -2535,7 +2553,7 @@ export declare namespace Channel {
|
|
|
2535
2553
|
/**
|
|
2536
2554
|
* This field shall indicate the list of additional external content identifiers.
|
|
2537
2555
|
*
|
|
2538
|
-
* @see {@link MatterSpecification.
|
|
2556
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.6
|
|
2539
2557
|
*/
|
|
2540
2558
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2541
2559
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -2544,7 +2562,7 @@ export declare namespace Channel {
|
|
|
2544
2562
|
/**
|
|
2545
2563
|
* This field shall indicate Optional app-specific data.
|
|
2546
2564
|
*
|
|
2547
|
-
* @see {@link MatterSpecification.
|
|
2565
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.7
|
|
2548
2566
|
*/
|
|
2549
2567
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
2550
2568
|
}>, import("../tlv/TlvObject.js").TypeFromFields<{
|
|
@@ -2552,21 +2570,21 @@ export declare namespace Channel {
|
|
|
2552
2570
|
* This field shall indicate the necessary pagination attributes that define information for both the succeeding
|
|
2553
2571
|
* and preceding data pages.
|
|
2554
2572
|
*
|
|
2555
|
-
* @see {@link MatterSpecification.
|
|
2573
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.6.1
|
|
2556
2574
|
*/
|
|
2557
2575
|
paging: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2558
2576
|
/**
|
|
2559
2577
|
* This field shall indicate the token to retrieve the preceding page. Absence of this field denotes the
|
|
2560
2578
|
* response as the initial page.
|
|
2561
2579
|
*
|
|
2562
|
-
* @see {@link MatterSpecification.
|
|
2580
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12.1
|
|
2563
2581
|
*/
|
|
2564
2582
|
previousToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2565
2583
|
/**
|
|
2566
2584
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
2567
2585
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
2568
2586
|
*
|
|
2569
|
-
* @see {@link MatterSpecification.
|
|
2587
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
2570
2588
|
*/
|
|
2571
2589
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
2572
2590
|
/**
|
|
@@ -2575,7 +2593,7 @@ export declare namespace Channel {
|
|
|
2575
2593
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
2576
2594
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
2577
2595
|
*
|
|
2578
|
-
* @see {@link MatterSpecification.
|
|
2596
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
2579
2597
|
*/
|
|
2580
2598
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2581
2599
|
/**
|
|
@@ -2584,7 +2602,7 @@ export declare namespace Channel {
|
|
|
2584
2602
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
2585
2603
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
2586
2604
|
*
|
|
2587
|
-
* @see {@link MatterSpecification.
|
|
2605
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
2588
2606
|
*/
|
|
2589
2607
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2590
2608
|
}> | null>;
|
|
@@ -2592,14 +2610,14 @@ export declare namespace Channel {
|
|
|
2592
2610
|
* This field shall indicate the token to retrieve the next page. Absence of this field denotes the response as
|
|
2593
2611
|
* the last page.
|
|
2594
2612
|
*
|
|
2595
|
-
* @see {@link MatterSpecification.
|
|
2613
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12.2
|
|
2596
2614
|
*/
|
|
2597
2615
|
nextToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2598
2616
|
/**
|
|
2599
2617
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
2600
2618
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
2601
2619
|
*
|
|
2602
|
-
* @see {@link MatterSpecification.
|
|
2620
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
2603
2621
|
*/
|
|
2604
2622
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
2605
2623
|
/**
|
|
@@ -2608,7 +2626,7 @@ export declare namespace Channel {
|
|
|
2608
2626
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
2609
2627
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
2610
2628
|
*
|
|
2611
|
-
* @see {@link MatterSpecification.
|
|
2629
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
2612
2630
|
*/
|
|
2613
2631
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2614
2632
|
/**
|
|
@@ -2617,7 +2635,7 @@ export declare namespace Channel {
|
|
|
2617
2635
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
2618
2636
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
2619
2637
|
*
|
|
2620
|
-
* @see {@link MatterSpecification.
|
|
2638
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
2621
2639
|
*/
|
|
2622
2640
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2623
2641
|
}> | null>;
|
|
@@ -2625,20 +2643,20 @@ export declare namespace Channel {
|
|
|
2625
2643
|
/**
|
|
2626
2644
|
* This field shall indicate the list of programs.
|
|
2627
2645
|
*
|
|
2628
|
-
* @see {@link MatterSpecification.
|
|
2646
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.6.2
|
|
2629
2647
|
*/
|
|
2630
2648
|
programList: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2631
2649
|
/**
|
|
2632
2650
|
* This field shall indicate a unique identifier for a program within an electronic program guide list. The
|
|
2633
2651
|
* identifier shall be unique across multiple channels.
|
|
2634
2652
|
*
|
|
2635
|
-
* @see {@link MatterSpecification.
|
|
2653
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.1
|
|
2636
2654
|
*/
|
|
2637
2655
|
identifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2638
2656
|
/**
|
|
2639
2657
|
* This field shall indicate the channel associated to the program.
|
|
2640
2658
|
*
|
|
2641
|
-
* @see {@link MatterSpecification.
|
|
2659
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.2
|
|
2642
2660
|
*/
|
|
2643
2661
|
channel: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2644
2662
|
/**
|
|
@@ -2647,7 +2665,7 @@ export declare namespace Channel {
|
|
|
2647
2665
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
2648
2666
|
* represented by a major or minor number.
|
|
2649
2667
|
*
|
|
2650
|
-
* @see {@link MatterSpecification.
|
|
2668
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
2651
2669
|
*/
|
|
2652
2670
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2653
2671
|
/**
|
|
@@ -2656,42 +2674,42 @@ export declare namespace Channel {
|
|
|
2656
2674
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
2657
2675
|
* represented by a major or minor number.
|
|
2658
2676
|
*
|
|
2659
|
-
* @see {@link MatterSpecification.
|
|
2677
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
2660
2678
|
*/
|
|
2661
2679
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2662
2680
|
/**
|
|
2663
2681
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
2664
2682
|
* field is optional, but SHOULD be provided when known.
|
|
2665
2683
|
*
|
|
2666
|
-
* @see {@link MatterSpecification.
|
|
2684
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
2667
2685
|
*/
|
|
2668
2686
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2669
2687
|
/**
|
|
2670
2688
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
2671
2689
|
* provided when known.
|
|
2672
2690
|
*
|
|
2673
|
-
* @see {@link MatterSpecification.
|
|
2691
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
2674
2692
|
*/
|
|
2675
2693
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2676
2694
|
/**
|
|
2677
2695
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
2678
2696
|
* be provided when known.
|
|
2679
2697
|
*
|
|
2680
|
-
* @see {@link MatterSpecification.
|
|
2698
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
2681
2699
|
*/
|
|
2682
2700
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2683
2701
|
/**
|
|
2684
2702
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
2685
2703
|
* provided when MajorNumber and MinorNumber are not available.
|
|
2686
2704
|
*
|
|
2687
|
-
* @see {@link MatterSpecification.
|
|
2705
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
2688
2706
|
*/
|
|
2689
2707
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2690
2708
|
/**
|
|
2691
2709
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
2692
2710
|
* provided when known.
|
|
2693
2711
|
*
|
|
2694
|
-
* @see {@link MatterSpecification.
|
|
2712
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
2695
2713
|
*/
|
|
2696
2714
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
2697
2715
|
}>>;
|
|
@@ -2699,34 +2717,34 @@ export declare namespace Channel {
|
|
|
2699
2717
|
* This field shall indicate an epoch time in seconds indicating the start time of a program, as a UTC time.
|
|
2700
2718
|
* This field can represent a past or future value.
|
|
2701
2719
|
*
|
|
2702
|
-
* @see {@link MatterSpecification.
|
|
2720
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.3
|
|
2703
2721
|
*/
|
|
2704
2722
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2705
2723
|
/**
|
|
2706
2724
|
* This field shall indicate an epoch time in seconds indicating the end time of a program, as a UTC time. This
|
|
2707
2725
|
* field can represent a past or future value but shall be greater than the StartTime.
|
|
2708
2726
|
*
|
|
2709
|
-
* @see {@link MatterSpecification.
|
|
2727
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.4
|
|
2710
2728
|
*/
|
|
2711
2729
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
2712
2730
|
/**
|
|
2713
2731
|
* This field shall indicate the title or name for the specific program. For example, “MCIS: Los Angeles”.
|
|
2714
2732
|
*
|
|
2715
|
-
* @see {@link MatterSpecification.
|
|
2733
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.5
|
|
2716
2734
|
*/
|
|
2717
2735
|
title: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2718
2736
|
/**
|
|
2719
2737
|
* This field shall indicate the subtitle for the specific program. For example, “Maybe Today" which is an
|
|
2720
2738
|
* episode name for “MCIS: Los Angeles”. This field is optional but shall be provided if applicable and known.
|
|
2721
2739
|
*
|
|
2722
|
-
* @see {@link MatterSpecification.
|
|
2740
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.6
|
|
2723
2741
|
*/
|
|
2724
2742
|
subtitle: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2725
2743
|
/**
|
|
2726
2744
|
* This field shall indicate the brief description for the specific program. For example, a description of an
|
|
2727
2745
|
* episode. This field is optional but shall be provided if known.
|
|
2728
2746
|
*
|
|
2729
|
-
* @see {@link MatterSpecification.
|
|
2747
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.7
|
|
2730
2748
|
*/
|
|
2731
2749
|
description: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2732
2750
|
/**
|
|
@@ -2734,7 +2752,7 @@ export declare namespace Channel {
|
|
|
2734
2752
|
* of the standard Tags for Identifying Languages RFC 5646. This field is optional but shall be provided if
|
|
2735
2753
|
* known.
|
|
2736
2754
|
*
|
|
2737
|
-
* @see {@link MatterSpecification.
|
|
2755
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.8
|
|
2738
2756
|
*/
|
|
2739
2757
|
audioLanguages: import("../tlv/TlvObject.js").OptionalFieldType<string[]>;
|
|
2740
2758
|
/**
|
|
@@ -2744,14 +2762,14 @@ export declare namespace Channel {
|
|
|
2744
2762
|
* children but can be accepted in general for older children. This field is optional but shall be provided if
|
|
2745
2763
|
* known.
|
|
2746
2764
|
*
|
|
2747
|
-
* @see {@link MatterSpecification.
|
|
2765
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.9
|
|
2748
2766
|
*/
|
|
2749
2767
|
ratings: import("../tlv/TlvObject.js").OptionalFieldType<string[]>;
|
|
2750
2768
|
/**
|
|
2751
2769
|
* This field shall represent a URL of a thumbnail that clients can use to render an image for the program. The
|
|
2752
2770
|
* syntax of this field shall follow the syntax as specified in RFC 1738 and shall use the https scheme.
|
|
2753
2771
|
*
|
|
2754
|
-
* @see {@link MatterSpecification.
|
|
2772
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.10
|
|
2755
2773
|
*/
|
|
2756
2774
|
thumbnailUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2757
2775
|
/**
|
|
@@ -2759,35 +2777,35 @@ export declare namespace Channel {
|
|
|
2759
2777
|
* detail view. The syntax of this field shall follow the syntax as specified in RFC 1738 and shall use the
|
|
2760
2778
|
* https scheme.
|
|
2761
2779
|
*
|
|
2762
|
-
* @see {@link MatterSpecification.
|
|
2780
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.11
|
|
2763
2781
|
*/
|
|
2764
2782
|
posterArtUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2765
2783
|
/**
|
|
2766
2784
|
* This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
|
|
2767
2785
|
* syntax as specified in RFC 1738 and shall use the https scheme.
|
|
2768
2786
|
*
|
|
2769
|
-
* @see {@link MatterSpecification.
|
|
2787
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.12
|
|
2770
2788
|
*/
|
|
2771
2789
|
dvbiUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2772
2790
|
/**
|
|
2773
2791
|
* This field shall be a string, in ISO 8601 format, representing the date on which the program was released.
|
|
2774
2792
|
* This field is optional but when provided, the year shall be provided as part of the string.
|
|
2775
2793
|
*
|
|
2776
|
-
* @see {@link MatterSpecification.
|
|
2794
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.13
|
|
2777
2795
|
*/
|
|
2778
2796
|
releaseDate: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2779
2797
|
/**
|
|
2780
2798
|
* This field shall represent a string providing additional information on the parental guidance. This field is
|
|
2781
2799
|
* optional.
|
|
2782
2800
|
*
|
|
2783
|
-
* @see {@link MatterSpecification.
|
|
2801
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.14
|
|
2784
2802
|
*/
|
|
2785
2803
|
parentalGuidanceText: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2786
2804
|
/**
|
|
2787
2805
|
* This field shall represent the recording status of the program. This field is required if the RecordProgram
|
|
2788
2806
|
* feature is set.
|
|
2789
2807
|
*
|
|
2790
|
-
* @see {@link MatterSpecification.
|
|
2808
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.15
|
|
2791
2809
|
*/
|
|
2792
2810
|
recordingFlag: import("../tlv/TlvObject.js").OptionalFieldType<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
2793
2811
|
/**
|
|
@@ -2807,19 +2825,19 @@ export declare namespace Channel {
|
|
|
2807
2825
|
* This field shall represent the information of a series such as season and episode number. This field is
|
|
2808
2826
|
* optional but SHOULD be provided if the program represents a series and this information is available.
|
|
2809
2827
|
*
|
|
2810
|
-
* @see {@link MatterSpecification.
|
|
2828
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.16
|
|
2811
2829
|
*/
|
|
2812
2830
|
seriesInfo: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2813
2831
|
/**
|
|
2814
2832
|
* This field shall represent the season of the series associated to the program.
|
|
2815
2833
|
*
|
|
2816
|
-
* @see {@link MatterSpecification.
|
|
2834
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.1
|
|
2817
2835
|
*/
|
|
2818
2836
|
season: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2819
2837
|
/**
|
|
2820
2838
|
* This field shall represent the episode of the program.
|
|
2821
2839
|
*
|
|
2822
|
-
* @see {@link MatterSpecification.
|
|
2840
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.2
|
|
2823
2841
|
*/
|
|
2824
2842
|
episode: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2825
2843
|
}> | null>;
|
|
@@ -2827,19 +2845,19 @@ export declare namespace Channel {
|
|
|
2827
2845
|
* This field shall represent the category of a particular program. This field is optional but shall be provided
|
|
2828
2846
|
* if known.
|
|
2829
2847
|
*
|
|
2830
|
-
* @see {@link MatterSpecification.
|
|
2848
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.17
|
|
2831
2849
|
*/
|
|
2832
2850
|
categoryList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2833
2851
|
/**
|
|
2834
2852
|
* This field shall represent the category or genre of the program. Ex. News.
|
|
2835
2853
|
*
|
|
2836
|
-
* @see {@link MatterSpecification.
|
|
2854
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.1
|
|
2837
2855
|
*/
|
|
2838
2856
|
category: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2839
2857
|
/**
|
|
2840
2858
|
* This field shall represent the sub-category or sub-genre of the program. Ex. Local.
|
|
2841
2859
|
*
|
|
2842
|
-
* @see {@link MatterSpecification.
|
|
2860
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.2
|
|
2843
2861
|
*/
|
|
2844
2862
|
subCategory: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
2845
2863
|
}>[]>;
|
|
@@ -2847,26 +2865,26 @@ export declare namespace Channel {
|
|
|
2847
2865
|
* This field shall represent a list of the cast or the crew on the program. A single cast member may have more
|
|
2848
2866
|
* than one role. This field is optional but shall be provided if known.
|
|
2849
2867
|
*
|
|
2850
|
-
* @see {@link MatterSpecification.
|
|
2868
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.18
|
|
2851
2869
|
*/
|
|
2852
2870
|
castList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2853
2871
|
/**
|
|
2854
2872
|
* This field shall represent the name of the cast member.
|
|
2855
2873
|
*
|
|
2856
|
-
* @see {@link MatterSpecification.
|
|
2874
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.1
|
|
2857
2875
|
*/
|
|
2858
2876
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2859
2877
|
/**
|
|
2860
2878
|
* This field shall represent the role of the cast member. Ex. Actor, Director.
|
|
2861
2879
|
*
|
|
2862
|
-
* @see {@link MatterSpecification.
|
|
2880
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.2
|
|
2863
2881
|
*/
|
|
2864
2882
|
role: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2865
2883
|
}>[]>;
|
|
2866
2884
|
/**
|
|
2867
2885
|
* This field shall indicate the list of additional external content identifiers.
|
|
2868
2886
|
*
|
|
2869
|
-
* @see {@link MatterSpecification.
|
|
2887
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.19
|
|
2870
2888
|
*/
|
|
2871
2889
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2872
2890
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -2886,14 +2904,14 @@ export declare namespace Channel {
|
|
|
2886
2904
|
/**
|
|
2887
2905
|
* Record a specific program or series when it goes live. This functionality enables DVR recording features.
|
|
2888
2906
|
*
|
|
2889
|
-
* @see {@link MatterSpecification.
|
|
2907
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7
|
|
2890
2908
|
*/
|
|
2891
2909
|
readonly recordProgram: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2892
2910
|
/**
|
|
2893
2911
|
* This field shall indicate the program identifier for the program that should be recorded. This value is
|
|
2894
2912
|
* provided by the identifier field in ProgramStruct.
|
|
2895
2913
|
*
|
|
2896
|
-
* @see {@link MatterSpecification.
|
|
2914
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.1
|
|
2897
2915
|
*/
|
|
2898
2916
|
programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2899
2917
|
/**
|
|
@@ -2901,13 +2919,13 @@ export declare namespace Channel {
|
|
|
2901
2919
|
* invoking record program on an episode with that flag set to true, the target should schedule record the whole
|
|
2902
2920
|
* series.
|
|
2903
2921
|
*
|
|
2904
|
-
* @see {@link MatterSpecification.
|
|
2922
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.2
|
|
2905
2923
|
*/
|
|
2906
2924
|
shouldRecordSeries: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
2907
2925
|
/**
|
|
2908
2926
|
* This field, if present, shall indicate the list of additional external content identifiers.
|
|
2909
2927
|
*
|
|
2910
|
-
* @see {@link MatterSpecification.
|
|
2928
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.3
|
|
2911
2929
|
*/
|
|
2912
2930
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2913
2931
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -2916,21 +2934,21 @@ export declare namespace Channel {
|
|
|
2916
2934
|
/**
|
|
2917
2935
|
* This field, if present, shall indicate app-specific data.
|
|
2918
2936
|
*
|
|
2919
|
-
* @see {@link MatterSpecification.
|
|
2937
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.4
|
|
2920
2938
|
*/
|
|
2921
2939
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
2922
2940
|
}>, void, any>;
|
|
2923
2941
|
/**
|
|
2924
2942
|
* Cancel recording for a specific program or series.
|
|
2925
2943
|
*
|
|
2926
|
-
* @see {@link MatterSpecification.
|
|
2944
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8
|
|
2927
2945
|
*/
|
|
2928
2946
|
readonly cancelRecordProgram: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2929
2947
|
/**
|
|
2930
2948
|
* This field shall indicate the program identifier for the program that should be cancelled from recording.
|
|
2931
2949
|
* This value is provided by the identifier field in ProgramStruct.
|
|
2932
2950
|
*
|
|
2933
|
-
* @see {@link MatterSpecification.
|
|
2951
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.1
|
|
2934
2952
|
*/
|
|
2935
2953
|
programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
2936
2954
|
/**
|
|
@@ -2938,13 +2956,13 @@ export declare namespace Channel {
|
|
|
2938
2956
|
* recording. For example, invoking record program on an episode with that flag set to true, the target should
|
|
2939
2957
|
* schedule record the whole series.
|
|
2940
2958
|
*
|
|
2941
|
-
* @see {@link MatterSpecification.
|
|
2959
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.2
|
|
2942
2960
|
*/
|
|
2943
2961
|
shouldRecordSeries: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
2944
2962
|
/**
|
|
2945
2963
|
* This field, if present, shall indicate the list of additional external content identifiers.
|
|
2946
2964
|
*
|
|
2947
|
-
* @see {@link MatterSpecification.
|
|
2965
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.3
|
|
2948
2966
|
*/
|
|
2949
2967
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2950
2968
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -2953,7 +2971,7 @@ export declare namespace Channel {
|
|
|
2953
2971
|
/**
|
|
2954
2972
|
* This field, if present, shall indicate app-specific data.
|
|
2955
2973
|
*
|
|
2956
|
-
* @see {@link MatterSpecification.
|
|
2974
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.4
|
|
2957
2975
|
*/
|
|
2958
2976
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
2959
2977
|
}>, void, any>;
|
|
@@ -2991,7 +3009,7 @@ export declare namespace Channel {
|
|
|
2991
3009
|
* This attribute shall contain the current channel. When supported but a channel is not currently tuned to
|
|
2992
3010
|
* (if a content application is in foreground), the value of the field shall be null.
|
|
2993
3011
|
*
|
|
2994
|
-
* @see {@link MatterSpecification.
|
|
3012
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.6.3
|
|
2995
3013
|
*/
|
|
2996
3014
|
readonly currentChannel: OptionalAttribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
2997
3015
|
/**
|
|
@@ -3000,7 +3018,7 @@ export declare namespace Channel {
|
|
|
3000
3018
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
3001
3019
|
* represented by a major or minor number.
|
|
3002
3020
|
*
|
|
3003
|
-
* @see {@link MatterSpecification.
|
|
3021
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
3004
3022
|
*/
|
|
3005
3023
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3006
3024
|
/**
|
|
@@ -3009,42 +3027,42 @@ export declare namespace Channel {
|
|
|
3009
3027
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
3010
3028
|
* represented by a major or minor number.
|
|
3011
3029
|
*
|
|
3012
|
-
* @see {@link MatterSpecification.
|
|
3030
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
3013
3031
|
*/
|
|
3014
3032
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3015
3033
|
/**
|
|
3016
3034
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
3017
3035
|
* field is optional, but SHOULD be provided when known.
|
|
3018
3036
|
*
|
|
3019
|
-
* @see {@link MatterSpecification.
|
|
3037
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
3020
3038
|
*/
|
|
3021
3039
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3022
3040
|
/**
|
|
3023
3041
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
3024
3042
|
* provided when known.
|
|
3025
3043
|
*
|
|
3026
|
-
* @see {@link MatterSpecification.
|
|
3044
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
3027
3045
|
*/
|
|
3028
3046
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3029
3047
|
/**
|
|
3030
3048
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
3031
3049
|
* be provided when known.
|
|
3032
3050
|
*
|
|
3033
|
-
* @see {@link MatterSpecification.
|
|
3051
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
3034
3052
|
*/
|
|
3035
3053
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3036
3054
|
/**
|
|
3037
3055
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
3038
3056
|
* provided when MajorNumber and MinorNumber are not available.
|
|
3039
3057
|
*
|
|
3040
|
-
* @see {@link MatterSpecification.
|
|
3058
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
3041
3059
|
*/
|
|
3042
3060
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3043
3061
|
/**
|
|
3044
3062
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
3045
3063
|
* provided when known.
|
|
3046
3064
|
*
|
|
3047
|
-
* @see {@link MatterSpecification.
|
|
3065
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
3048
3066
|
*/
|
|
3049
3067
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
3050
3068
|
}> | null, any>;
|
|
@@ -3053,19 +3071,19 @@ export declare namespace Channel {
|
|
|
3053
3071
|
/**
|
|
3054
3072
|
* Change the channel to the channel with the given Number in the ChannelList attribute.
|
|
3055
3073
|
*
|
|
3056
|
-
* @see {@link MatterSpecification.
|
|
3074
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3
|
|
3057
3075
|
*/
|
|
3058
3076
|
readonly changeChannelByNumber: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3059
3077
|
/**
|
|
3060
3078
|
* This field shall indicate the channel major number value (ATSC format) to which the channel should change.
|
|
3061
3079
|
*
|
|
3062
|
-
* @see {@link MatterSpecification.
|
|
3080
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3.1
|
|
3063
3081
|
*/
|
|
3064
3082
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3065
3083
|
/**
|
|
3066
3084
|
* This field shall indicate the channel minor number value (ATSC format) to which the channel should change.
|
|
3067
3085
|
*
|
|
3068
|
-
* @see {@link MatterSpecification.
|
|
3086
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3.2
|
|
3069
3087
|
*/
|
|
3070
3088
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3071
3089
|
}>, void, any>;
|
|
@@ -3078,14 +3096,14 @@ export declare namespace Channel {
|
|
|
3078
3096
|
* continue. For example, if the current channel is at index 0 and count value of -1 is given, then the
|
|
3079
3097
|
* current channel should change to the last channel.
|
|
3080
3098
|
*
|
|
3081
|
-
* @see {@link MatterSpecification.
|
|
3099
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.4
|
|
3082
3100
|
*/
|
|
3083
3101
|
readonly skipChannel: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3084
3102
|
/**
|
|
3085
3103
|
* This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is negative)
|
|
3086
3104
|
* the current channel.
|
|
3087
3105
|
*
|
|
3088
|
-
* @see {@link MatterSpecification.
|
|
3106
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.4.1
|
|
3089
3107
|
*/
|
|
3090
3108
|
count: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3091
3109
|
}>, void, any>;
|
|
@@ -3102,7 +3120,7 @@ export declare namespace Channel {
|
|
|
3102
3120
|
/**
|
|
3103
3121
|
* This attribute shall provide the list of supported channels.
|
|
3104
3122
|
*
|
|
3105
|
-
* @see {@link MatterSpecification.
|
|
3123
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.6.1
|
|
3106
3124
|
*/
|
|
3107
3125
|
readonly channelList: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3108
3126
|
/**
|
|
@@ -3111,7 +3129,7 @@ export declare namespace Channel {
|
|
|
3111
3129
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
3112
3130
|
* represented by a major or minor number.
|
|
3113
3131
|
*
|
|
3114
|
-
* @see {@link MatterSpecification.
|
|
3132
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
3115
3133
|
*/
|
|
3116
3134
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3117
3135
|
/**
|
|
@@ -3120,42 +3138,42 @@ export declare namespace Channel {
|
|
|
3120
3138
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
3121
3139
|
* represented by a major or minor number.
|
|
3122
3140
|
*
|
|
3123
|
-
* @see {@link MatterSpecification.
|
|
3141
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
3124
3142
|
*/
|
|
3125
3143
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3126
3144
|
/**
|
|
3127
3145
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
3128
3146
|
* field is optional, but SHOULD be provided when known.
|
|
3129
3147
|
*
|
|
3130
|
-
* @see {@link MatterSpecification.
|
|
3148
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
3131
3149
|
*/
|
|
3132
3150
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3133
3151
|
/**
|
|
3134
3152
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
3135
3153
|
* provided when known.
|
|
3136
3154
|
*
|
|
3137
|
-
* @see {@link MatterSpecification.
|
|
3155
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
3138
3156
|
*/
|
|
3139
3157
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3140
3158
|
/**
|
|
3141
3159
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
3142
3160
|
* be provided when known.
|
|
3143
3161
|
*
|
|
3144
|
-
* @see {@link MatterSpecification.
|
|
3162
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
3145
3163
|
*/
|
|
3146
3164
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3147
3165
|
/**
|
|
3148
3166
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
3149
3167
|
* provided when MajorNumber and MinorNumber are not available.
|
|
3150
3168
|
*
|
|
3151
|
-
* @see {@link MatterSpecification.
|
|
3169
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
3152
3170
|
*/
|
|
3153
3171
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3154
3172
|
/**
|
|
3155
3173
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
3156
3174
|
* provided when known.
|
|
3157
3175
|
*
|
|
3158
|
-
* @see {@link MatterSpecification.
|
|
3176
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
3159
3177
|
*/
|
|
3160
3178
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
3161
3179
|
}>[], any>;
|
|
@@ -3170,33 +3188,33 @@ export declare namespace Channel {
|
|
|
3170
3188
|
/**
|
|
3171
3189
|
* This attribute shall identify the channel lineup using external data sources.
|
|
3172
3190
|
*
|
|
3173
|
-
* @see {@link MatterSpecification.
|
|
3191
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.6.2
|
|
3174
3192
|
*/
|
|
3175
3193
|
readonly lineup: Attribute<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3176
3194
|
/**
|
|
3177
3195
|
* This field shall indicate the name of the operator, for example “Comcast”.
|
|
3178
3196
|
*
|
|
3179
|
-
* @see {@link MatterSpecification.
|
|
3197
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.1
|
|
3180
3198
|
*/
|
|
3181
3199
|
operatorName: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3182
3200
|
/**
|
|
3183
3201
|
* This field shall indicate the name of the provider lineup, for example "Comcast King County". This field is
|
|
3184
3202
|
* optional, but SHOULD be provided when known.
|
|
3185
3203
|
*
|
|
3186
|
-
* @see {@link MatterSpecification.
|
|
3204
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.2
|
|
3187
3205
|
*/
|
|
3188
3206
|
lineupName: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3189
3207
|
/**
|
|
3190
3208
|
* This field shall indicate the postal code (zip code) for the location of the device, such as "98052". This
|
|
3191
3209
|
* field is optional, but SHOULD be provided when known.
|
|
3192
3210
|
*
|
|
3193
|
-
* @see {@link MatterSpecification.
|
|
3211
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.3
|
|
3194
3212
|
*/
|
|
3195
3213
|
postalCode: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3196
3214
|
/**
|
|
3197
3215
|
* This field shall indicate the type of lineup. This field is optional, but SHOULD be provided when known.
|
|
3198
3216
|
*
|
|
3199
|
-
* @see {@link MatterSpecification.
|
|
3217
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.4
|
|
3200
3218
|
*/
|
|
3201
3219
|
lineupInfoType: import("../tlv/TlvObject.js").FieldType<LineupInfoType>;
|
|
3202
3220
|
}> | null, any>;
|
|
@@ -3218,26 +3236,26 @@ export declare namespace Channel {
|
|
|
3218
3236
|
*
|
|
3219
3237
|
* Upon success, the CurrentChannel attribute, if supported, shall be updated to reflect the change.
|
|
3220
3238
|
*
|
|
3221
|
-
* @see {@link MatterSpecification.
|
|
3239
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1
|
|
3222
3240
|
*/
|
|
3223
3241
|
readonly changeChannel: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3224
3242
|
/**
|
|
3225
3243
|
* This field shall contain a user-input string to match in order to identify the target channel.
|
|
3226
3244
|
*
|
|
3227
|
-
* @see {@link MatterSpecification.
|
|
3245
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1.1
|
|
3228
3246
|
*/
|
|
3229
3247
|
match: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3230
3248
|
}>, import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3231
3249
|
/**
|
|
3232
3250
|
* This field shall indicate the status of the command which resulted in this response.
|
|
3233
3251
|
*
|
|
3234
|
-
* @see {@link MatterSpecification.
|
|
3252
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.1
|
|
3235
3253
|
*/
|
|
3236
3254
|
status: import("../tlv/TlvObject.js").FieldType<Status>;
|
|
3237
3255
|
/**
|
|
3238
3256
|
* This field shall indicate Optional app-specific data.
|
|
3239
3257
|
*
|
|
3240
|
-
* @see {@link MatterSpecification.
|
|
3258
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.2
|
|
3241
3259
|
*/
|
|
3242
3260
|
data: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3243
3261
|
}>, any>;
|
|
@@ -3259,26 +3277,26 @@ export declare namespace Channel {
|
|
|
3259
3277
|
*
|
|
3260
3278
|
* Upon success, the CurrentChannel attribute, if supported, shall be updated to reflect the change.
|
|
3261
3279
|
*
|
|
3262
|
-
* @see {@link MatterSpecification.
|
|
3280
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1
|
|
3263
3281
|
*/
|
|
3264
3282
|
readonly changeChannel: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3265
3283
|
/**
|
|
3266
3284
|
* This field shall contain a user-input string to match in order to identify the target channel.
|
|
3267
3285
|
*
|
|
3268
|
-
* @see {@link MatterSpecification.
|
|
3286
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1.1
|
|
3269
3287
|
*/
|
|
3270
3288
|
match: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3271
3289
|
}>, import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3272
3290
|
/**
|
|
3273
3291
|
* This field shall indicate the status of the command which resulted in this response.
|
|
3274
3292
|
*
|
|
3275
|
-
* @see {@link MatterSpecification.
|
|
3293
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.1
|
|
3276
3294
|
*/
|
|
3277
3295
|
status: import("../tlv/TlvObject.js").FieldType<Status>;
|
|
3278
3296
|
/**
|
|
3279
3297
|
* This field shall indicate Optional app-specific data.
|
|
3280
3298
|
*
|
|
3281
|
-
* @see {@link MatterSpecification.
|
|
3299
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.2
|
|
3282
3300
|
*/
|
|
3283
3301
|
data: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3284
3302
|
}>, any>;
|
|
@@ -3296,14 +3314,14 @@ export declare namespace Channel {
|
|
|
3296
3314
|
* ProgramGuideResponse. Standard error codes shall be used when arguments provided are not valid. For
|
|
3297
3315
|
* example, if StartTime is greater than EndTime, the status code INVALID_ACTION shall be returned.
|
|
3298
3316
|
*
|
|
3299
|
-
* @see {@link MatterSpecification.
|
|
3317
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5
|
|
3300
3318
|
*/
|
|
3301
3319
|
readonly getProgramGuide: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3302
3320
|
/**
|
|
3303
3321
|
* This field shall indicate the beginning of the time window for which program guide entries are to be
|
|
3304
3322
|
* retrieved, as a UTC time. Entries with a start time on or after this value will be included in the results.
|
|
3305
3323
|
*
|
|
3306
|
-
* @see {@link MatterSpecification.
|
|
3324
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.1
|
|
3307
3325
|
*/
|
|
3308
3326
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3309
3327
|
/**
|
|
@@ -3311,7 +3329,7 @@ export declare namespace Channel {
|
|
|
3311
3329
|
* a UTC time. Entries with an end time on or before this value will be included in the results. This field can
|
|
3312
3330
|
* represent a past or future value but shall be greater than the StartTime.
|
|
3313
3331
|
*
|
|
3314
|
-
* @see {@link MatterSpecification.
|
|
3332
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.2
|
|
3315
3333
|
*/
|
|
3316
3334
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3317
3335
|
/**
|
|
@@ -3319,7 +3337,7 @@ export declare namespace Channel {
|
|
|
3319
3337
|
* a list of channels in this field, the response will only include entries corresponding to the specified
|
|
3320
3338
|
* channels.
|
|
3321
3339
|
*
|
|
3322
|
-
* @see {@link MatterSpecification.
|
|
3340
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.3
|
|
3323
3341
|
*/
|
|
3324
3342
|
channelList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3325
3343
|
/**
|
|
@@ -3328,7 +3346,7 @@ export declare namespace Channel {
|
|
|
3328
3346
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
3329
3347
|
* represented by a major or minor number.
|
|
3330
3348
|
*
|
|
3331
|
-
* @see {@link MatterSpecification.
|
|
3349
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
3332
3350
|
*/
|
|
3333
3351
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3334
3352
|
/**
|
|
@@ -3337,56 +3355,56 @@ export declare namespace Channel {
|
|
|
3337
3355
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
3338
3356
|
* represented by a major or minor number.
|
|
3339
3357
|
*
|
|
3340
|
-
* @see {@link MatterSpecification.
|
|
3358
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
3341
3359
|
*/
|
|
3342
3360
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3343
3361
|
/**
|
|
3344
3362
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
3345
3363
|
* field is optional, but SHOULD be provided when known.
|
|
3346
3364
|
*
|
|
3347
|
-
* @see {@link MatterSpecification.
|
|
3365
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
3348
3366
|
*/
|
|
3349
3367
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3350
3368
|
/**
|
|
3351
3369
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
3352
3370
|
* provided when known.
|
|
3353
3371
|
*
|
|
3354
|
-
* @see {@link MatterSpecification.
|
|
3372
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
3355
3373
|
*/
|
|
3356
3374
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3357
3375
|
/**
|
|
3358
3376
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
3359
3377
|
* be provided when known.
|
|
3360
3378
|
*
|
|
3361
|
-
* @see {@link MatterSpecification.
|
|
3379
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
3362
3380
|
*/
|
|
3363
3381
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3364
3382
|
/**
|
|
3365
3383
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
3366
3384
|
* provided when MajorNumber and MinorNumber are not available.
|
|
3367
3385
|
*
|
|
3368
|
-
* @see {@link MatterSpecification.
|
|
3386
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
3369
3387
|
*/
|
|
3370
3388
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3371
3389
|
/**
|
|
3372
3390
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
3373
3391
|
* provided when known.
|
|
3374
3392
|
*
|
|
3375
|
-
* @see {@link MatterSpecification.
|
|
3393
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
3376
3394
|
*/
|
|
3377
3395
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
3378
3396
|
}>[]>;
|
|
3379
3397
|
/**
|
|
3380
3398
|
* This field shall indicate the pagination token used for managing pagination progression.
|
|
3381
3399
|
*
|
|
3382
|
-
* @see {@link MatterSpecification.
|
|
3400
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.4
|
|
3383
3401
|
*/
|
|
3384
3402
|
pageToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3385
3403
|
/**
|
|
3386
3404
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
3387
3405
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
3388
3406
|
*
|
|
3389
|
-
* @see {@link MatterSpecification.
|
|
3407
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
3390
3408
|
*/
|
|
3391
3409
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3392
3410
|
/**
|
|
@@ -3395,7 +3413,7 @@ export declare namespace Channel {
|
|
|
3395
3413
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
3396
3414
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
3397
3415
|
*
|
|
3398
|
-
* @see {@link MatterSpecification.
|
|
3416
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
3399
3417
|
*/
|
|
3400
3418
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3401
3419
|
/**
|
|
@@ -3404,14 +3422,14 @@ export declare namespace Channel {
|
|
|
3404
3422
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
3405
3423
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
3406
3424
|
*
|
|
3407
|
-
* @see {@link MatterSpecification.
|
|
3425
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
3408
3426
|
*/
|
|
3409
3427
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3410
3428
|
}> | null>;
|
|
3411
3429
|
/**
|
|
3412
3430
|
* This field shall indicate the flags of the programs for which entries should be fetched.
|
|
3413
3431
|
*
|
|
3414
|
-
* @see {@link MatterSpecification.
|
|
3432
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.5
|
|
3415
3433
|
*/
|
|
3416
3434
|
recordingFlag: import("../tlv/TlvObject.js").OptionalFieldType<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
3417
3435
|
/**
|
|
@@ -3430,7 +3448,7 @@ export declare namespace Channel {
|
|
|
3430
3448
|
/**
|
|
3431
3449
|
* This field shall indicate the list of additional external content identifiers.
|
|
3432
3450
|
*
|
|
3433
|
-
* @see {@link MatterSpecification.
|
|
3451
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.6
|
|
3434
3452
|
*/
|
|
3435
3453
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3436
3454
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -3439,7 +3457,7 @@ export declare namespace Channel {
|
|
|
3439
3457
|
/**
|
|
3440
3458
|
* This field shall indicate Optional app-specific data.
|
|
3441
3459
|
*
|
|
3442
|
-
* @see {@link MatterSpecification.
|
|
3460
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.7
|
|
3443
3461
|
*/
|
|
3444
3462
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
3445
3463
|
}>, import("../tlv/TlvObject.js").TypeFromFields<{
|
|
@@ -3447,21 +3465,21 @@ export declare namespace Channel {
|
|
|
3447
3465
|
* This field shall indicate the necessary pagination attributes that define information for both the succeeding
|
|
3448
3466
|
* and preceding data pages.
|
|
3449
3467
|
*
|
|
3450
|
-
* @see {@link MatterSpecification.
|
|
3468
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.6.1
|
|
3451
3469
|
*/
|
|
3452
3470
|
paging: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3453
3471
|
/**
|
|
3454
3472
|
* This field shall indicate the token to retrieve the preceding page. Absence of this field denotes the
|
|
3455
3473
|
* response as the initial page.
|
|
3456
3474
|
*
|
|
3457
|
-
* @see {@link MatterSpecification.
|
|
3475
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12.1
|
|
3458
3476
|
*/
|
|
3459
3477
|
previousToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3460
3478
|
/**
|
|
3461
3479
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
3462
3480
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
3463
3481
|
*
|
|
3464
|
-
* @see {@link MatterSpecification.
|
|
3482
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
3465
3483
|
*/
|
|
3466
3484
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3467
3485
|
/**
|
|
@@ -3470,7 +3488,7 @@ export declare namespace Channel {
|
|
|
3470
3488
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
3471
3489
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
3472
3490
|
*
|
|
3473
|
-
* @see {@link MatterSpecification.
|
|
3491
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
3474
3492
|
*/
|
|
3475
3493
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3476
3494
|
/**
|
|
@@ -3479,7 +3497,7 @@ export declare namespace Channel {
|
|
|
3479
3497
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
3480
3498
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
3481
3499
|
*
|
|
3482
|
-
* @see {@link MatterSpecification.
|
|
3500
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
3483
3501
|
*/
|
|
3484
3502
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3485
3503
|
}> | null>;
|
|
@@ -3487,14 +3505,14 @@ export declare namespace Channel {
|
|
|
3487
3505
|
* This field shall indicate the token to retrieve the next page. Absence of this field denotes the response as
|
|
3488
3506
|
* the last page.
|
|
3489
3507
|
*
|
|
3490
|
-
* @see {@link MatterSpecification.
|
|
3508
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12.2
|
|
3491
3509
|
*/
|
|
3492
3510
|
nextToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3493
3511
|
/**
|
|
3494
3512
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
3495
3513
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
3496
3514
|
*
|
|
3497
|
-
* @see {@link MatterSpecification.
|
|
3515
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
3498
3516
|
*/
|
|
3499
3517
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
3500
3518
|
/**
|
|
@@ -3503,7 +3521,7 @@ export declare namespace Channel {
|
|
|
3503
3521
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
3504
3522
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
3505
3523
|
*
|
|
3506
|
-
* @see {@link MatterSpecification.
|
|
3524
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
3507
3525
|
*/
|
|
3508
3526
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3509
3527
|
/**
|
|
@@ -3512,7 +3530,7 @@ export declare namespace Channel {
|
|
|
3512
3530
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
3513
3531
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
3514
3532
|
*
|
|
3515
|
-
* @see {@link MatterSpecification.
|
|
3533
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
3516
3534
|
*/
|
|
3517
3535
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3518
3536
|
}> | null>;
|
|
@@ -3520,20 +3538,20 @@ export declare namespace Channel {
|
|
|
3520
3538
|
/**
|
|
3521
3539
|
* This field shall indicate the list of programs.
|
|
3522
3540
|
*
|
|
3523
|
-
* @see {@link MatterSpecification.
|
|
3541
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.6.2
|
|
3524
3542
|
*/
|
|
3525
3543
|
programList: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3526
3544
|
/**
|
|
3527
3545
|
* This field shall indicate a unique identifier for a program within an electronic program guide list. The
|
|
3528
3546
|
* identifier shall be unique across multiple channels.
|
|
3529
3547
|
*
|
|
3530
|
-
* @see {@link MatterSpecification.
|
|
3548
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.1
|
|
3531
3549
|
*/
|
|
3532
3550
|
identifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3533
3551
|
/**
|
|
3534
3552
|
* This field shall indicate the channel associated to the program.
|
|
3535
3553
|
*
|
|
3536
|
-
* @see {@link MatterSpecification.
|
|
3554
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.2
|
|
3537
3555
|
*/
|
|
3538
3556
|
channel: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3539
3557
|
/**
|
|
@@ -3542,7 +3560,7 @@ export declare namespace Channel {
|
|
|
3542
3560
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
3543
3561
|
* represented by a major or minor number.
|
|
3544
3562
|
*
|
|
3545
|
-
* @see {@link MatterSpecification.
|
|
3563
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
3546
3564
|
*/
|
|
3547
3565
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3548
3566
|
/**
|
|
@@ -3551,42 +3569,42 @@ export declare namespace Channel {
|
|
|
3551
3569
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
3552
3570
|
* represented by a major or minor number.
|
|
3553
3571
|
*
|
|
3554
|
-
* @see {@link MatterSpecification.
|
|
3572
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
3555
3573
|
*/
|
|
3556
3574
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3557
3575
|
/**
|
|
3558
3576
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
3559
3577
|
* field is optional, but SHOULD be provided when known.
|
|
3560
3578
|
*
|
|
3561
|
-
* @see {@link MatterSpecification.
|
|
3579
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
3562
3580
|
*/
|
|
3563
3581
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3564
3582
|
/**
|
|
3565
3583
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
3566
3584
|
* provided when known.
|
|
3567
3585
|
*
|
|
3568
|
-
* @see {@link MatterSpecification.
|
|
3586
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
3569
3587
|
*/
|
|
3570
3588
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3571
3589
|
/**
|
|
3572
3590
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
3573
3591
|
* be provided when known.
|
|
3574
3592
|
*
|
|
3575
|
-
* @see {@link MatterSpecification.
|
|
3593
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
3576
3594
|
*/
|
|
3577
3595
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3578
3596
|
/**
|
|
3579
3597
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
3580
3598
|
* provided when MajorNumber and MinorNumber are not available.
|
|
3581
3599
|
*
|
|
3582
|
-
* @see {@link MatterSpecification.
|
|
3600
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
3583
3601
|
*/
|
|
3584
3602
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3585
3603
|
/**
|
|
3586
3604
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
3587
3605
|
* provided when known.
|
|
3588
3606
|
*
|
|
3589
|
-
* @see {@link MatterSpecification.
|
|
3607
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
3590
3608
|
*/
|
|
3591
3609
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
3592
3610
|
}>>;
|
|
@@ -3594,34 +3612,34 @@ export declare namespace Channel {
|
|
|
3594
3612
|
* This field shall indicate an epoch time in seconds indicating the start time of a program, as a UTC time.
|
|
3595
3613
|
* This field can represent a past or future value.
|
|
3596
3614
|
*
|
|
3597
|
-
* @see {@link MatterSpecification.
|
|
3615
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.3
|
|
3598
3616
|
*/
|
|
3599
3617
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3600
3618
|
/**
|
|
3601
3619
|
* This field shall indicate an epoch time in seconds indicating the end time of a program, as a UTC time. This
|
|
3602
3620
|
* field can represent a past or future value but shall be greater than the StartTime.
|
|
3603
3621
|
*
|
|
3604
|
-
* @see {@link MatterSpecification.
|
|
3622
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.4
|
|
3605
3623
|
*/
|
|
3606
3624
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3607
3625
|
/**
|
|
3608
3626
|
* This field shall indicate the title or name for the specific program. For example, “MCIS: Los Angeles”.
|
|
3609
3627
|
*
|
|
3610
|
-
* @see {@link MatterSpecification.
|
|
3628
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.5
|
|
3611
3629
|
*/
|
|
3612
3630
|
title: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3613
3631
|
/**
|
|
3614
3632
|
* This field shall indicate the subtitle for the specific program. For example, “Maybe Today" which is an
|
|
3615
3633
|
* episode name for “MCIS: Los Angeles”. This field is optional but shall be provided if applicable and known.
|
|
3616
3634
|
*
|
|
3617
|
-
* @see {@link MatterSpecification.
|
|
3635
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.6
|
|
3618
3636
|
*/
|
|
3619
3637
|
subtitle: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3620
3638
|
/**
|
|
3621
3639
|
* This field shall indicate the brief description for the specific program. For example, a description of an
|
|
3622
3640
|
* episode. This field is optional but shall be provided if known.
|
|
3623
3641
|
*
|
|
3624
|
-
* @see {@link MatterSpecification.
|
|
3642
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.7
|
|
3625
3643
|
*/
|
|
3626
3644
|
description: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3627
3645
|
/**
|
|
@@ -3629,7 +3647,7 @@ export declare namespace Channel {
|
|
|
3629
3647
|
* of the standard Tags for Identifying Languages RFC 5646. This field is optional but shall be provided if
|
|
3630
3648
|
* known.
|
|
3631
3649
|
*
|
|
3632
|
-
* @see {@link MatterSpecification.
|
|
3650
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.8
|
|
3633
3651
|
*/
|
|
3634
3652
|
audioLanguages: import("../tlv/TlvObject.js").OptionalFieldType<string[]>;
|
|
3635
3653
|
/**
|
|
@@ -3639,14 +3657,14 @@ export declare namespace Channel {
|
|
|
3639
3657
|
* children but can be accepted in general for older children. This field is optional but shall be provided if
|
|
3640
3658
|
* known.
|
|
3641
3659
|
*
|
|
3642
|
-
* @see {@link MatterSpecification.
|
|
3660
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.9
|
|
3643
3661
|
*/
|
|
3644
3662
|
ratings: import("../tlv/TlvObject.js").OptionalFieldType<string[]>;
|
|
3645
3663
|
/**
|
|
3646
3664
|
* This field shall represent a URL of a thumbnail that clients can use to render an image for the program. The
|
|
3647
3665
|
* syntax of this field shall follow the syntax as specified in RFC 1738 and shall use the https scheme.
|
|
3648
3666
|
*
|
|
3649
|
-
* @see {@link MatterSpecification.
|
|
3667
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.10
|
|
3650
3668
|
*/
|
|
3651
3669
|
thumbnailUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3652
3670
|
/**
|
|
@@ -3654,35 +3672,35 @@ export declare namespace Channel {
|
|
|
3654
3672
|
* detail view. The syntax of this field shall follow the syntax as specified in RFC 1738 and shall use the
|
|
3655
3673
|
* https scheme.
|
|
3656
3674
|
*
|
|
3657
|
-
* @see {@link MatterSpecification.
|
|
3675
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.11
|
|
3658
3676
|
*/
|
|
3659
3677
|
posterArtUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3660
3678
|
/**
|
|
3661
3679
|
* This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
|
|
3662
3680
|
* syntax as specified in RFC 1738 and shall use the https scheme.
|
|
3663
3681
|
*
|
|
3664
|
-
* @see {@link MatterSpecification.
|
|
3682
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.12
|
|
3665
3683
|
*/
|
|
3666
3684
|
dvbiUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3667
3685
|
/**
|
|
3668
3686
|
* This field shall be a string, in ISO 8601 format, representing the date on which the program was released.
|
|
3669
3687
|
* This field is optional but when provided, the year shall be provided as part of the string.
|
|
3670
3688
|
*
|
|
3671
|
-
* @see {@link MatterSpecification.
|
|
3689
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.13
|
|
3672
3690
|
*/
|
|
3673
3691
|
releaseDate: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3674
3692
|
/**
|
|
3675
3693
|
* This field shall represent a string providing additional information on the parental guidance. This field is
|
|
3676
3694
|
* optional.
|
|
3677
3695
|
*
|
|
3678
|
-
* @see {@link MatterSpecification.
|
|
3696
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.14
|
|
3679
3697
|
*/
|
|
3680
3698
|
parentalGuidanceText: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3681
3699
|
/**
|
|
3682
3700
|
* This field shall represent the recording status of the program. This field is required if the RecordProgram
|
|
3683
3701
|
* feature is set.
|
|
3684
3702
|
*
|
|
3685
|
-
* @see {@link MatterSpecification.
|
|
3703
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.15
|
|
3686
3704
|
*/
|
|
3687
3705
|
recordingFlag: import("../tlv/TlvObject.js").OptionalFieldType<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
3688
3706
|
/**
|
|
@@ -3702,19 +3720,19 @@ export declare namespace Channel {
|
|
|
3702
3720
|
* This field shall represent the information of a series such as season and episode number. This field is
|
|
3703
3721
|
* optional but SHOULD be provided if the program represents a series and this information is available.
|
|
3704
3722
|
*
|
|
3705
|
-
* @see {@link MatterSpecification.
|
|
3723
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.16
|
|
3706
3724
|
*/
|
|
3707
3725
|
seriesInfo: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3708
3726
|
/**
|
|
3709
3727
|
* This field shall represent the season of the series associated to the program.
|
|
3710
3728
|
*
|
|
3711
|
-
* @see {@link MatterSpecification.
|
|
3729
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.1
|
|
3712
3730
|
*/
|
|
3713
3731
|
season: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3714
3732
|
/**
|
|
3715
3733
|
* This field shall represent the episode of the program.
|
|
3716
3734
|
*
|
|
3717
|
-
* @see {@link MatterSpecification.
|
|
3735
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.2
|
|
3718
3736
|
*/
|
|
3719
3737
|
episode: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3720
3738
|
}> | null>;
|
|
@@ -3722,19 +3740,19 @@ export declare namespace Channel {
|
|
|
3722
3740
|
* This field shall represent the category of a particular program. This field is optional but shall be provided
|
|
3723
3741
|
* if known.
|
|
3724
3742
|
*
|
|
3725
|
-
* @see {@link MatterSpecification.
|
|
3743
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.17
|
|
3726
3744
|
*/
|
|
3727
3745
|
categoryList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3728
3746
|
/**
|
|
3729
3747
|
* This field shall represent the category or genre of the program. Ex. News.
|
|
3730
3748
|
*
|
|
3731
|
-
* @see {@link MatterSpecification.
|
|
3749
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.1
|
|
3732
3750
|
*/
|
|
3733
3751
|
category: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3734
3752
|
/**
|
|
3735
3753
|
* This field shall represent the sub-category or sub-genre of the program. Ex. Local.
|
|
3736
3754
|
*
|
|
3737
|
-
* @see {@link MatterSpecification.
|
|
3755
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.2
|
|
3738
3756
|
*/
|
|
3739
3757
|
subCategory: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3740
3758
|
}>[]>;
|
|
@@ -3742,26 +3760,26 @@ export declare namespace Channel {
|
|
|
3742
3760
|
* This field shall represent a list of the cast or the crew on the program. A single cast member may have more
|
|
3743
3761
|
* than one role. This field is optional but shall be provided if known.
|
|
3744
3762
|
*
|
|
3745
|
-
* @see {@link MatterSpecification.
|
|
3763
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.18
|
|
3746
3764
|
*/
|
|
3747
3765
|
castList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3748
3766
|
/**
|
|
3749
3767
|
* This field shall represent the name of the cast member.
|
|
3750
3768
|
*
|
|
3751
|
-
* @see {@link MatterSpecification.
|
|
3769
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.1
|
|
3752
3770
|
*/
|
|
3753
3771
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3754
3772
|
/**
|
|
3755
3773
|
* This field shall represent the role of the cast member. Ex. Actor, Director.
|
|
3756
3774
|
*
|
|
3757
|
-
* @see {@link MatterSpecification.
|
|
3775
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.2
|
|
3758
3776
|
*/
|
|
3759
3777
|
role: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3760
3778
|
}>[]>;
|
|
3761
3779
|
/**
|
|
3762
3780
|
* This field shall indicate the list of additional external content identifiers.
|
|
3763
3781
|
*
|
|
3764
|
-
* @see {@link MatterSpecification.
|
|
3782
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.19
|
|
3765
3783
|
*/
|
|
3766
3784
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3767
3785
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -3781,14 +3799,14 @@ export declare namespace Channel {
|
|
|
3781
3799
|
/**
|
|
3782
3800
|
* Record a specific program or series when it goes live. This functionality enables DVR recording features.
|
|
3783
3801
|
*
|
|
3784
|
-
* @see {@link MatterSpecification.
|
|
3802
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7
|
|
3785
3803
|
*/
|
|
3786
3804
|
readonly recordProgram: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3787
3805
|
/**
|
|
3788
3806
|
* This field shall indicate the program identifier for the program that should be recorded. This value is
|
|
3789
3807
|
* provided by the identifier field in ProgramStruct.
|
|
3790
3808
|
*
|
|
3791
|
-
* @see {@link MatterSpecification.
|
|
3809
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.1
|
|
3792
3810
|
*/
|
|
3793
3811
|
programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3794
3812
|
/**
|
|
@@ -3796,13 +3814,13 @@ export declare namespace Channel {
|
|
|
3796
3814
|
* invoking record program on an episode with that flag set to true, the target should schedule record the whole
|
|
3797
3815
|
* series.
|
|
3798
3816
|
*
|
|
3799
|
-
* @see {@link MatterSpecification.
|
|
3817
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.2
|
|
3800
3818
|
*/
|
|
3801
3819
|
shouldRecordSeries: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
3802
3820
|
/**
|
|
3803
3821
|
* This field, if present, shall indicate the list of additional external content identifiers.
|
|
3804
3822
|
*
|
|
3805
|
-
* @see {@link MatterSpecification.
|
|
3823
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.3
|
|
3806
3824
|
*/
|
|
3807
3825
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3808
3826
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -3811,21 +3829,21 @@ export declare namespace Channel {
|
|
|
3811
3829
|
/**
|
|
3812
3830
|
* This field, if present, shall indicate app-specific data.
|
|
3813
3831
|
*
|
|
3814
|
-
* @see {@link MatterSpecification.
|
|
3832
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.4
|
|
3815
3833
|
*/
|
|
3816
3834
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
3817
3835
|
}>, void, any>;
|
|
3818
3836
|
/**
|
|
3819
3837
|
* Cancel recording for a specific program or series.
|
|
3820
3838
|
*
|
|
3821
|
-
* @see {@link MatterSpecification.
|
|
3839
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8
|
|
3822
3840
|
*/
|
|
3823
3841
|
readonly cancelRecordProgram: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3824
3842
|
/**
|
|
3825
3843
|
* This field shall indicate the program identifier for the program that should be cancelled from recording.
|
|
3826
3844
|
* This value is provided by the identifier field in ProgramStruct.
|
|
3827
3845
|
*
|
|
3828
|
-
* @see {@link MatterSpecification.
|
|
3846
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.1
|
|
3829
3847
|
*/
|
|
3830
3848
|
programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3831
3849
|
/**
|
|
@@ -3833,13 +3851,13 @@ export declare namespace Channel {
|
|
|
3833
3851
|
* recording. For example, invoking record program on an episode with that flag set to true, the target should
|
|
3834
3852
|
* schedule record the whole series.
|
|
3835
3853
|
*
|
|
3836
|
-
* @see {@link MatterSpecification.
|
|
3854
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.2
|
|
3837
3855
|
*/
|
|
3838
3856
|
shouldRecordSeries: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
3839
3857
|
/**
|
|
3840
3858
|
* This field, if present, shall indicate the list of additional external content identifiers.
|
|
3841
3859
|
*
|
|
3842
|
-
* @see {@link MatterSpecification.
|
|
3860
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.3
|
|
3843
3861
|
*/
|
|
3844
3862
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
3845
3863
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -3848,7 +3866,7 @@ export declare namespace Channel {
|
|
|
3848
3866
|
/**
|
|
3849
3867
|
* This field, if present, shall indicate app-specific data.
|
|
3850
3868
|
*
|
|
3851
|
-
* @see {@link MatterSpecification.
|
|
3869
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.4
|
|
3852
3870
|
*/
|
|
3853
3871
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
3854
3872
|
}>, void, any>;
|
|
@@ -3871,7 +3889,7 @@ export declare namespace Channel {
|
|
|
3871
3889
|
*
|
|
3872
3890
|
* ChannelCluster supports optional features that you can enable with the ChannelCluster.with() factory method.
|
|
3873
3891
|
*
|
|
3874
|
-
* @see {@link MatterSpecification.
|
|
3892
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6
|
|
3875
3893
|
*/
|
|
3876
3894
|
interface Cluster extends Identity<typeof ClusterInstance> {
|
|
3877
3895
|
}
|
|
@@ -3909,7 +3927,7 @@ export declare namespace Channel {
|
|
|
3909
3927
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
3910
3928
|
* represented by a major or minor number.
|
|
3911
3929
|
*
|
|
3912
|
-
* @see {@link MatterSpecification.
|
|
3930
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
3913
3931
|
*/
|
|
3914
3932
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3915
3933
|
/**
|
|
@@ -3918,42 +3936,42 @@ export declare namespace Channel {
|
|
|
3918
3936
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
3919
3937
|
* represented by a major or minor number.
|
|
3920
3938
|
*
|
|
3921
|
-
* @see {@link MatterSpecification.
|
|
3939
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
3922
3940
|
*/
|
|
3923
3941
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
3924
3942
|
/**
|
|
3925
3943
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
3926
3944
|
* field is optional, but SHOULD be provided when known.
|
|
3927
3945
|
*
|
|
3928
|
-
* @see {@link MatterSpecification.
|
|
3946
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
3929
3947
|
*/
|
|
3930
3948
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3931
3949
|
/**
|
|
3932
3950
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
3933
3951
|
* provided when known.
|
|
3934
3952
|
*
|
|
3935
|
-
* @see {@link MatterSpecification.
|
|
3953
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
3936
3954
|
*/
|
|
3937
3955
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3938
3956
|
/**
|
|
3939
3957
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
3940
3958
|
* be provided when known.
|
|
3941
3959
|
*
|
|
3942
|
-
* @see {@link MatterSpecification.
|
|
3960
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
3943
3961
|
*/
|
|
3944
3962
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3945
3963
|
/**
|
|
3946
3964
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
3947
3965
|
* provided when MajorNumber and MinorNumber are not available.
|
|
3948
3966
|
*
|
|
3949
|
-
* @see {@link MatterSpecification.
|
|
3967
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
3950
3968
|
*/
|
|
3951
3969
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3952
3970
|
/**
|
|
3953
3971
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
3954
3972
|
* provided when known.
|
|
3955
3973
|
*
|
|
3956
|
-
* @see {@link MatterSpecification.
|
|
3974
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
3957
3975
|
*/
|
|
3958
3976
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
3959
3977
|
}>[], any> & {
|
|
@@ -3968,27 +3986,27 @@ export declare namespace Channel {
|
|
|
3968
3986
|
/**
|
|
3969
3987
|
* This field shall indicate the name of the operator, for example “Comcast”.
|
|
3970
3988
|
*
|
|
3971
|
-
* @see {@link MatterSpecification.
|
|
3989
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.1
|
|
3972
3990
|
*/
|
|
3973
3991
|
operatorName: import("../tlv/TlvObject.js").FieldType<string>;
|
|
3974
3992
|
/**
|
|
3975
3993
|
* This field shall indicate the name of the provider lineup, for example "Comcast King County". This field is
|
|
3976
3994
|
* optional, but SHOULD be provided when known.
|
|
3977
3995
|
*
|
|
3978
|
-
* @see {@link MatterSpecification.
|
|
3996
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.2
|
|
3979
3997
|
*/
|
|
3980
3998
|
lineupName: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3981
3999
|
/**
|
|
3982
4000
|
* This field shall indicate the postal code (zip code) for the location of the device, such as "98052". This
|
|
3983
4001
|
* field is optional, but SHOULD be provided when known.
|
|
3984
4002
|
*
|
|
3985
|
-
* @see {@link MatterSpecification.
|
|
4003
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.3
|
|
3986
4004
|
*/
|
|
3987
4005
|
postalCode: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
3988
4006
|
/**
|
|
3989
4007
|
* This field shall indicate the type of lineup. This field is optional, but SHOULD be provided when known.
|
|
3990
4008
|
*
|
|
3991
|
-
* @see {@link MatterSpecification.
|
|
4009
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.6.4
|
|
3992
4010
|
*/
|
|
3993
4011
|
lineupInfoType: import("../tlv/TlvObject.js").FieldType<LineupInfoType>;
|
|
3994
4012
|
}> | null, any> & {
|
|
@@ -4006,7 +4024,7 @@ export declare namespace Channel {
|
|
|
4006
4024
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
4007
4025
|
* represented by a major or minor number.
|
|
4008
4026
|
*
|
|
4009
|
-
* @see {@link MatterSpecification.
|
|
4027
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
4010
4028
|
*/
|
|
4011
4029
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4012
4030
|
/**
|
|
@@ -4015,42 +4033,42 @@ export declare namespace Channel {
|
|
|
4015
4033
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
4016
4034
|
* represented by a major or minor number.
|
|
4017
4035
|
*
|
|
4018
|
-
* @see {@link MatterSpecification.
|
|
4036
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
4019
4037
|
*/
|
|
4020
4038
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4021
4039
|
/**
|
|
4022
4040
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
4023
4041
|
* field is optional, but SHOULD be provided when known.
|
|
4024
4042
|
*
|
|
4025
|
-
* @see {@link MatterSpecification.
|
|
4043
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
4026
4044
|
*/
|
|
4027
4045
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4028
4046
|
/**
|
|
4029
4047
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
4030
4048
|
* provided when known.
|
|
4031
4049
|
*
|
|
4032
|
-
* @see {@link MatterSpecification.
|
|
4050
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
4033
4051
|
*/
|
|
4034
4052
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4035
4053
|
/**
|
|
4036
4054
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
4037
4055
|
* be provided when known.
|
|
4038
4056
|
*
|
|
4039
|
-
* @see {@link MatterSpecification.
|
|
4057
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
4040
4058
|
*/
|
|
4041
4059
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4042
4060
|
/**
|
|
4043
4061
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
4044
4062
|
* provided when MajorNumber and MinorNumber are not available.
|
|
4045
4063
|
*
|
|
4046
|
-
* @see {@link MatterSpecification.
|
|
4064
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
4047
4065
|
*/
|
|
4048
4066
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4049
4067
|
/**
|
|
4050
4068
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
4051
4069
|
* provided when known.
|
|
4052
4070
|
*
|
|
4053
|
-
* @see {@link MatterSpecification.
|
|
4071
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
4054
4072
|
*/
|
|
4055
4073
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
4056
4074
|
}> | null, any>;
|
|
@@ -4082,20 +4100,20 @@ export declare namespace Channel {
|
|
|
4082
4100
|
/**
|
|
4083
4101
|
* This field shall contain a user-input string to match in order to identify the target channel.
|
|
4084
4102
|
*
|
|
4085
|
-
* @see {@link MatterSpecification.
|
|
4103
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.1.1
|
|
4086
4104
|
*/
|
|
4087
4105
|
match: import("../tlv/TlvObject.js").FieldType<string>;
|
|
4088
4106
|
}>, import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4089
4107
|
/**
|
|
4090
4108
|
* This field shall indicate the status of the command which resulted in this response.
|
|
4091
4109
|
*
|
|
4092
|
-
* @see {@link MatterSpecification.
|
|
4110
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.1
|
|
4093
4111
|
*/
|
|
4094
4112
|
status: import("../tlv/TlvObject.js").FieldType<Status>;
|
|
4095
4113
|
/**
|
|
4096
4114
|
* This field shall indicate Optional app-specific data.
|
|
4097
4115
|
*
|
|
4098
|
-
* @see {@link MatterSpecification.
|
|
4116
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.2.2
|
|
4099
4117
|
*/
|
|
4100
4118
|
data: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4101
4119
|
}>, any> & {
|
|
@@ -4113,7 +4131,7 @@ export declare namespace Channel {
|
|
|
4113
4131
|
* This field shall indicate the beginning of the time window for which program guide entries are to be
|
|
4114
4132
|
* retrieved, as a UTC time. Entries with a start time on or after this value will be included in the results.
|
|
4115
4133
|
*
|
|
4116
|
-
* @see {@link MatterSpecification.
|
|
4134
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.1
|
|
4117
4135
|
*/
|
|
4118
4136
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4119
4137
|
/**
|
|
@@ -4121,7 +4139,7 @@ export declare namespace Channel {
|
|
|
4121
4139
|
* a UTC time. Entries with an end time on or before this value will be included in the results. This field can
|
|
4122
4140
|
* represent a past or future value but shall be greater than the StartTime.
|
|
4123
4141
|
*
|
|
4124
|
-
* @see {@link MatterSpecification.
|
|
4142
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.2
|
|
4125
4143
|
*/
|
|
4126
4144
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4127
4145
|
/**
|
|
@@ -4129,7 +4147,7 @@ export declare namespace Channel {
|
|
|
4129
4147
|
* a list of channels in this field, the response will only include entries corresponding to the specified
|
|
4130
4148
|
* channels.
|
|
4131
4149
|
*
|
|
4132
|
-
* @see {@link MatterSpecification.
|
|
4150
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.3
|
|
4133
4151
|
*/
|
|
4134
4152
|
channelList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4135
4153
|
/**
|
|
@@ -4138,7 +4156,7 @@ export declare namespace Channel {
|
|
|
4138
4156
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
4139
4157
|
* represented by a major or minor number.
|
|
4140
4158
|
*
|
|
4141
|
-
* @see {@link MatterSpecification.
|
|
4159
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
4142
4160
|
*/
|
|
4143
4161
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4144
4162
|
/**
|
|
@@ -4147,56 +4165,56 @@ export declare namespace Channel {
|
|
|
4147
4165
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
4148
4166
|
* represented by a major or minor number.
|
|
4149
4167
|
*
|
|
4150
|
-
* @see {@link MatterSpecification.
|
|
4168
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
4151
4169
|
*/
|
|
4152
4170
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4153
4171
|
/**
|
|
4154
4172
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
4155
4173
|
* field is optional, but SHOULD be provided when known.
|
|
4156
4174
|
*
|
|
4157
|
-
* @see {@link MatterSpecification.
|
|
4175
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
4158
4176
|
*/
|
|
4159
4177
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4160
4178
|
/**
|
|
4161
4179
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
4162
4180
|
* provided when known.
|
|
4163
4181
|
*
|
|
4164
|
-
* @see {@link MatterSpecification.
|
|
4182
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
4165
4183
|
*/
|
|
4166
4184
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4167
4185
|
/**
|
|
4168
4186
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
4169
4187
|
* be provided when known.
|
|
4170
4188
|
*
|
|
4171
|
-
* @see {@link MatterSpecification.
|
|
4189
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
4172
4190
|
*/
|
|
4173
4191
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4174
4192
|
/**
|
|
4175
4193
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
4176
4194
|
* provided when MajorNumber and MinorNumber are not available.
|
|
4177
4195
|
*
|
|
4178
|
-
* @see {@link MatterSpecification.
|
|
4196
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
4179
4197
|
*/
|
|
4180
4198
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4181
4199
|
/**
|
|
4182
4200
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
4183
4201
|
* provided when known.
|
|
4184
4202
|
*
|
|
4185
|
-
* @see {@link MatterSpecification.
|
|
4203
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
4186
4204
|
*/
|
|
4187
4205
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
4188
4206
|
}>[]>;
|
|
4189
4207
|
/**
|
|
4190
4208
|
* This field shall indicate the pagination token used for managing pagination progression.
|
|
4191
4209
|
*
|
|
4192
|
-
* @see {@link MatterSpecification.
|
|
4210
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.4
|
|
4193
4211
|
*/
|
|
4194
4212
|
pageToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4195
4213
|
/**
|
|
4196
4214
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
4197
4215
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
4198
4216
|
*
|
|
4199
|
-
* @see {@link MatterSpecification.
|
|
4217
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
4200
4218
|
*/
|
|
4201
4219
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4202
4220
|
/**
|
|
@@ -4205,7 +4223,7 @@ export declare namespace Channel {
|
|
|
4205
4223
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
4206
4224
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
4207
4225
|
*
|
|
4208
|
-
* @see {@link MatterSpecification.
|
|
4226
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
4209
4227
|
*/
|
|
4210
4228
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4211
4229
|
/**
|
|
@@ -4214,14 +4232,14 @@ export declare namespace Channel {
|
|
|
4214
4232
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
4215
4233
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
4216
4234
|
*
|
|
4217
|
-
* @see {@link MatterSpecification.
|
|
4235
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
4218
4236
|
*/
|
|
4219
4237
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4220
4238
|
}> | null>;
|
|
4221
4239
|
/**
|
|
4222
4240
|
* This field shall indicate the flags of the programs for which entries should be fetched.
|
|
4223
4241
|
*
|
|
4224
|
-
* @see {@link MatterSpecification.
|
|
4242
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.5
|
|
4225
4243
|
*/
|
|
4226
4244
|
recordingFlag: import("../tlv/TlvObject.js").OptionalFieldType<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
4227
4245
|
/**
|
|
@@ -4240,7 +4258,7 @@ export declare namespace Channel {
|
|
|
4240
4258
|
/**
|
|
4241
4259
|
* This field shall indicate the list of additional external content identifiers.
|
|
4242
4260
|
*
|
|
4243
|
-
* @see {@link MatterSpecification.
|
|
4261
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.6
|
|
4244
4262
|
*/
|
|
4245
4263
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4246
4264
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -4249,7 +4267,7 @@ export declare namespace Channel {
|
|
|
4249
4267
|
/**
|
|
4250
4268
|
* This field shall indicate Optional app-specific data.
|
|
4251
4269
|
*
|
|
4252
|
-
* @see {@link MatterSpecification.
|
|
4270
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.5.7
|
|
4253
4271
|
*/
|
|
4254
4272
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
4255
4273
|
}>, import("../tlv/TlvObject.js").TypeFromFields<{
|
|
@@ -4257,21 +4275,21 @@ export declare namespace Channel {
|
|
|
4257
4275
|
* This field shall indicate the necessary pagination attributes that define information for both the succeeding
|
|
4258
4276
|
* and preceding data pages.
|
|
4259
4277
|
*
|
|
4260
|
-
* @see {@link MatterSpecification.
|
|
4278
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.6.1
|
|
4261
4279
|
*/
|
|
4262
4280
|
paging: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4263
4281
|
/**
|
|
4264
4282
|
* This field shall indicate the token to retrieve the preceding page. Absence of this field denotes the
|
|
4265
4283
|
* response as the initial page.
|
|
4266
4284
|
*
|
|
4267
|
-
* @see {@link MatterSpecification.
|
|
4285
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12.1
|
|
4268
4286
|
*/
|
|
4269
4287
|
previousToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4270
4288
|
/**
|
|
4271
4289
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
4272
4290
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
4273
4291
|
*
|
|
4274
|
-
* @see {@link MatterSpecification.
|
|
4292
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
4275
4293
|
*/
|
|
4276
4294
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4277
4295
|
/**
|
|
@@ -4280,7 +4298,7 @@ export declare namespace Channel {
|
|
|
4280
4298
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
4281
4299
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
4282
4300
|
*
|
|
4283
|
-
* @see {@link MatterSpecification.
|
|
4301
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
4284
4302
|
*/
|
|
4285
4303
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4286
4304
|
/**
|
|
@@ -4289,7 +4307,7 @@ export declare namespace Channel {
|
|
|
4289
4307
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
4290
4308
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
4291
4309
|
*
|
|
4292
|
-
* @see {@link MatterSpecification.
|
|
4310
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
4293
4311
|
*/
|
|
4294
4312
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4295
4313
|
}> | null>;
|
|
@@ -4297,14 +4315,14 @@ export declare namespace Channel {
|
|
|
4297
4315
|
* This field shall indicate the token to retrieve the next page. Absence of this field denotes the response as
|
|
4298
4316
|
* the last page.
|
|
4299
4317
|
*
|
|
4300
|
-
* @see {@link MatterSpecification.
|
|
4318
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.12.2
|
|
4301
4319
|
*/
|
|
4302
4320
|
nextToken: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4303
4321
|
/**
|
|
4304
4322
|
* This field shall indicate the maximum number of entries that should be retrieved from the program guide in a
|
|
4305
4323
|
* single response. It allows clients to specify the size of the paginated result set based on their needs.
|
|
4306
4324
|
*
|
|
4307
|
-
* @see {@link MatterSpecification.
|
|
4325
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.1
|
|
4308
4326
|
*/
|
|
4309
4327
|
limit: import("../tlv/TlvObject.js").OptionalFieldType<number>;
|
|
4310
4328
|
/**
|
|
@@ -4313,7 +4331,7 @@ export declare namespace Channel {
|
|
|
4313
4331
|
* the data following the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
4314
4332
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
4315
4333
|
*
|
|
4316
|
-
* @see {@link MatterSpecification.
|
|
4334
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.2
|
|
4317
4335
|
*/
|
|
4318
4336
|
after: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4319
4337
|
/**
|
|
@@ -4322,7 +4340,7 @@ export declare namespace Channel {
|
|
|
4322
4340
|
* the data preceding the specified cursor. In a Offset-based pagination system, the field, along with limit,
|
|
4323
4341
|
* indicate the offset from which entries in the program guide will be retrieved.
|
|
4324
4342
|
*
|
|
4325
|
-
* @see {@link MatterSpecification.
|
|
4343
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.11.3
|
|
4326
4344
|
*/
|
|
4327
4345
|
before: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4328
4346
|
}> | null>;
|
|
@@ -4330,20 +4348,20 @@ export declare namespace Channel {
|
|
|
4330
4348
|
/**
|
|
4331
4349
|
* This field shall indicate the list of programs.
|
|
4332
4350
|
*
|
|
4333
|
-
* @see {@link MatterSpecification.
|
|
4351
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.6.2
|
|
4334
4352
|
*/
|
|
4335
4353
|
programList: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4336
4354
|
/**
|
|
4337
4355
|
* This field shall indicate a unique identifier for a program within an electronic program guide list. The
|
|
4338
4356
|
* identifier shall be unique across multiple channels.
|
|
4339
4357
|
*
|
|
4340
|
-
* @see {@link MatterSpecification.
|
|
4358
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.1
|
|
4341
4359
|
*/
|
|
4342
4360
|
identifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
4343
4361
|
/**
|
|
4344
4362
|
* This field shall indicate the channel associated to the program.
|
|
4345
4363
|
*
|
|
4346
|
-
* @see {@link MatterSpecification.
|
|
4364
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.2
|
|
4347
4365
|
*/
|
|
4348
4366
|
channel: import("../tlv/TlvObject.js").FieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4349
4367
|
/**
|
|
@@ -4352,7 +4370,7 @@ export declare namespace Channel {
|
|
|
4352
4370
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
4353
4371
|
* represented by a major or minor number.
|
|
4354
4372
|
*
|
|
4355
|
-
* @see {@link MatterSpecification.
|
|
4373
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.1
|
|
4356
4374
|
*/
|
|
4357
4375
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4358
4376
|
/**
|
|
@@ -4361,42 +4379,42 @@ export declare namespace Channel {
|
|
|
4361
4379
|
* This field is required but shall be set to 0 for channels such as over-the-top channels that are not
|
|
4362
4380
|
* represented by a major or minor number.
|
|
4363
4381
|
*
|
|
4364
|
-
* @see {@link MatterSpecification.
|
|
4382
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.2
|
|
4365
4383
|
*/
|
|
4366
4384
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4367
4385
|
/**
|
|
4368
4386
|
* This field shall indicate the marketing name for the channel, such as “The CW" or "Comedy Central". This
|
|
4369
4387
|
* field is optional, but SHOULD be provided when known.
|
|
4370
4388
|
*
|
|
4371
|
-
* @see {@link MatterSpecification.
|
|
4389
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.3
|
|
4372
4390
|
*/
|
|
4373
4391
|
name: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4374
4392
|
/**
|
|
4375
4393
|
* This field shall indicate the call sign of the channel, such as "PBS". This field is optional, but SHOULD be
|
|
4376
4394
|
* provided when known.
|
|
4377
4395
|
*
|
|
4378
|
-
* @see {@link MatterSpecification.
|
|
4396
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.4
|
|
4379
4397
|
*/
|
|
4380
4398
|
callSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4381
4399
|
/**
|
|
4382
4400
|
* This field shall indicate the local affiliate call sign, such as "KCTS". This field is optional, but SHOULD
|
|
4383
4401
|
* be provided when known.
|
|
4384
4402
|
*
|
|
4385
|
-
* @see {@link MatterSpecification.
|
|
4403
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.5
|
|
4386
4404
|
*/
|
|
4387
4405
|
affiliateCallSign: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4388
4406
|
/**
|
|
4389
4407
|
* This shall indicate the unique identifier for a specific channel. This field is optional, but SHOULD be
|
|
4390
4408
|
* provided when MajorNumber and MinorNumber are not available.
|
|
4391
4409
|
*
|
|
4392
|
-
* @see {@link MatterSpecification.
|
|
4410
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.6
|
|
4393
4411
|
*/
|
|
4394
4412
|
identifier: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4395
4413
|
/**
|
|
4396
4414
|
* This shall indicate the type or grouping of a specific channel. This field is optional, but SHOULD be
|
|
4397
4415
|
* provided when known.
|
|
4398
4416
|
*
|
|
4399
|
-
* @see {@link MatterSpecification.
|
|
4417
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.5.7
|
|
4400
4418
|
*/
|
|
4401
4419
|
type: import("../tlv/TlvObject.js").OptionalFieldType<ChannelType>;
|
|
4402
4420
|
}>>;
|
|
@@ -4404,34 +4422,34 @@ export declare namespace Channel {
|
|
|
4404
4422
|
* This field shall indicate an epoch time in seconds indicating the start time of a program, as a UTC time.
|
|
4405
4423
|
* This field can represent a past or future value.
|
|
4406
4424
|
*
|
|
4407
|
-
* @see {@link MatterSpecification.
|
|
4425
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.3
|
|
4408
4426
|
*/
|
|
4409
4427
|
startTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4410
4428
|
/**
|
|
4411
4429
|
* This field shall indicate an epoch time in seconds indicating the end time of a program, as a UTC time. This
|
|
4412
4430
|
* field can represent a past or future value but shall be greater than the StartTime.
|
|
4413
4431
|
*
|
|
4414
|
-
* @see {@link MatterSpecification.
|
|
4432
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.4
|
|
4415
4433
|
*/
|
|
4416
4434
|
endTime: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4417
4435
|
/**
|
|
4418
4436
|
* This field shall indicate the title or name for the specific program. For example, “MCIS: Los Angeles”.
|
|
4419
4437
|
*
|
|
4420
|
-
* @see {@link MatterSpecification.
|
|
4438
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.5
|
|
4421
4439
|
*/
|
|
4422
4440
|
title: import("../tlv/TlvObject.js").FieldType<string>;
|
|
4423
4441
|
/**
|
|
4424
4442
|
* This field shall indicate the subtitle for the specific program. For example, “Maybe Today" which is an
|
|
4425
4443
|
* episode name for “MCIS: Los Angeles”. This field is optional but shall be provided if applicable and known.
|
|
4426
4444
|
*
|
|
4427
|
-
* @see {@link MatterSpecification.
|
|
4445
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.6
|
|
4428
4446
|
*/
|
|
4429
4447
|
subtitle: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4430
4448
|
/**
|
|
4431
4449
|
* This field shall indicate the brief description for the specific program. For example, a description of an
|
|
4432
4450
|
* episode. This field is optional but shall be provided if known.
|
|
4433
4451
|
*
|
|
4434
|
-
* @see {@link MatterSpecification.
|
|
4452
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.7
|
|
4435
4453
|
*/
|
|
4436
4454
|
description: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4437
4455
|
/**
|
|
@@ -4439,7 +4457,7 @@ export declare namespace Channel {
|
|
|
4439
4457
|
* of the standard Tags for Identifying Languages RFC 5646. This field is optional but shall be provided if
|
|
4440
4458
|
* known.
|
|
4441
4459
|
*
|
|
4442
|
-
* @see {@link MatterSpecification.
|
|
4460
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.8
|
|
4443
4461
|
*/
|
|
4444
4462
|
audioLanguages: import("../tlv/TlvObject.js").OptionalFieldType<string[]>;
|
|
4445
4463
|
/**
|
|
@@ -4449,14 +4467,14 @@ export declare namespace Channel {
|
|
|
4449
4467
|
* children but can be accepted in general for older children. This field is optional but shall be provided if
|
|
4450
4468
|
* known.
|
|
4451
4469
|
*
|
|
4452
|
-
* @see {@link MatterSpecification.
|
|
4470
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.9
|
|
4453
4471
|
*/
|
|
4454
4472
|
ratings: import("../tlv/TlvObject.js").OptionalFieldType<string[]>;
|
|
4455
4473
|
/**
|
|
4456
4474
|
* This field shall represent a URL of a thumbnail that clients can use to render an image for the program. The
|
|
4457
4475
|
* syntax of this field shall follow the syntax as specified in RFC 1738 and shall use the https scheme.
|
|
4458
4476
|
*
|
|
4459
|
-
* @see {@link MatterSpecification.
|
|
4477
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.10
|
|
4460
4478
|
*/
|
|
4461
4479
|
thumbnailUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4462
4480
|
/**
|
|
@@ -4464,35 +4482,35 @@ export declare namespace Channel {
|
|
|
4464
4482
|
* detail view. The syntax of this field shall follow the syntax as specified in RFC 1738 and shall use the
|
|
4465
4483
|
* https scheme.
|
|
4466
4484
|
*
|
|
4467
|
-
* @see {@link MatterSpecification.
|
|
4485
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.11
|
|
4468
4486
|
*/
|
|
4469
4487
|
posterArtUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4470
4488
|
/**
|
|
4471
4489
|
* This field shall represent the DVB-I URL associated to the program. The syntax of this field shall follow the
|
|
4472
4490
|
* syntax as specified in RFC 1738 and shall use the https scheme.
|
|
4473
4491
|
*
|
|
4474
|
-
* @see {@link MatterSpecification.
|
|
4492
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.12
|
|
4475
4493
|
*/
|
|
4476
4494
|
dvbiUrl: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4477
4495
|
/**
|
|
4478
4496
|
* This field shall be a string, in ISO 8601 format, representing the date on which the program was released.
|
|
4479
4497
|
* This field is optional but when provided, the year shall be provided as part of the string.
|
|
4480
4498
|
*
|
|
4481
|
-
* @see {@link MatterSpecification.
|
|
4499
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.13
|
|
4482
4500
|
*/
|
|
4483
4501
|
releaseDate: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4484
4502
|
/**
|
|
4485
4503
|
* This field shall represent a string providing additional information on the parental guidance. This field is
|
|
4486
4504
|
* optional.
|
|
4487
4505
|
*
|
|
4488
|
-
* @see {@link MatterSpecification.
|
|
4506
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.14
|
|
4489
4507
|
*/
|
|
4490
4508
|
parentalGuidanceText: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4491
4509
|
/**
|
|
4492
4510
|
* This field shall represent the recording status of the program. This field is required if the RecordProgram
|
|
4493
4511
|
* feature is set.
|
|
4494
4512
|
*
|
|
4495
|
-
* @see {@link MatterSpecification.
|
|
4513
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.15
|
|
4496
4514
|
*/
|
|
4497
4515
|
recordingFlag: import("../tlv/TlvObject.js").OptionalFieldType<import("../schema/BitmapSchema.js").TypeFromPartialBitSchema<{
|
|
4498
4516
|
/**
|
|
@@ -4512,19 +4530,19 @@ export declare namespace Channel {
|
|
|
4512
4530
|
* This field shall represent the information of a series such as season and episode number. This field is
|
|
4513
4531
|
* optional but SHOULD be provided if the program represents a series and this information is available.
|
|
4514
4532
|
*
|
|
4515
|
-
* @see {@link MatterSpecification.
|
|
4533
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.16
|
|
4516
4534
|
*/
|
|
4517
4535
|
seriesInfo: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4518
4536
|
/**
|
|
4519
4537
|
* This field shall represent the season of the series associated to the program.
|
|
4520
4538
|
*
|
|
4521
|
-
* @see {@link MatterSpecification.
|
|
4539
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.1
|
|
4522
4540
|
*/
|
|
4523
4541
|
season: import("../tlv/TlvObject.js").FieldType<string>;
|
|
4524
4542
|
/**
|
|
4525
4543
|
* This field shall represent the episode of the program.
|
|
4526
4544
|
*
|
|
4527
|
-
* @see {@link MatterSpecification.
|
|
4545
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.9.2
|
|
4528
4546
|
*/
|
|
4529
4547
|
episode: import("../tlv/TlvObject.js").FieldType<string>;
|
|
4530
4548
|
}> | null>;
|
|
@@ -4532,19 +4550,19 @@ export declare namespace Channel {
|
|
|
4532
4550
|
* This field shall represent the category of a particular program. This field is optional but shall be provided
|
|
4533
4551
|
* if known.
|
|
4534
4552
|
*
|
|
4535
|
-
* @see {@link MatterSpecification.
|
|
4553
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.17
|
|
4536
4554
|
*/
|
|
4537
4555
|
categoryList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4538
4556
|
/**
|
|
4539
4557
|
* This field shall represent the category or genre of the program. Ex. News.
|
|
4540
4558
|
*
|
|
4541
|
-
* @see {@link MatterSpecification.
|
|
4559
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.1
|
|
4542
4560
|
*/
|
|
4543
4561
|
category: import("../tlv/TlvObject.js").FieldType<string>;
|
|
4544
4562
|
/**
|
|
4545
4563
|
* This field shall represent the sub-category or sub-genre of the program. Ex. Local.
|
|
4546
4564
|
*
|
|
4547
|
-
* @see {@link MatterSpecification.
|
|
4565
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.8.2
|
|
4548
4566
|
*/
|
|
4549
4567
|
subCategory: import("../tlv/TlvObject.js").OptionalFieldType<string>;
|
|
4550
4568
|
}>[]>;
|
|
@@ -4552,26 +4570,26 @@ export declare namespace Channel {
|
|
|
4552
4570
|
* This field shall represent a list of the cast or the crew on the program. A single cast member may have more
|
|
4553
4571
|
* than one role. This field is optional but shall be provided if known.
|
|
4554
4572
|
*
|
|
4555
|
-
* @see {@link MatterSpecification.
|
|
4573
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.18
|
|
4556
4574
|
*/
|
|
4557
4575
|
castList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4558
4576
|
/**
|
|
4559
4577
|
* This field shall represent the name of the cast member.
|
|
4560
4578
|
*
|
|
4561
|
-
* @see {@link MatterSpecification.
|
|
4579
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.1
|
|
4562
4580
|
*/
|
|
4563
4581
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
4564
4582
|
/**
|
|
4565
4583
|
* This field shall represent the role of the cast member. Ex. Actor, Director.
|
|
4566
4584
|
*
|
|
4567
|
-
* @see {@link MatterSpecification.
|
|
4585
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.10.2
|
|
4568
4586
|
*/
|
|
4569
4587
|
role: import("../tlv/TlvObject.js").FieldType<string>;
|
|
4570
4588
|
}>[]>;
|
|
4571
4589
|
/**
|
|
4572
4590
|
* This field shall indicate the list of additional external content identifiers.
|
|
4573
4591
|
*
|
|
4574
|
-
* @see {@link MatterSpecification.
|
|
4592
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.5.7.19
|
|
4575
4593
|
*/
|
|
4576
4594
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4577
4595
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -4591,7 +4609,7 @@ export declare namespace Channel {
|
|
|
4591
4609
|
* This field shall indicate the program identifier for the program that should be recorded. This value is
|
|
4592
4610
|
* provided by the identifier field in ProgramStruct.
|
|
4593
4611
|
*
|
|
4594
|
-
* @see {@link MatterSpecification.
|
|
4612
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.1
|
|
4595
4613
|
*/
|
|
4596
4614
|
programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
4597
4615
|
/**
|
|
@@ -4599,13 +4617,13 @@ export declare namespace Channel {
|
|
|
4599
4617
|
* invoking record program on an episode with that flag set to true, the target should schedule record the whole
|
|
4600
4618
|
* series.
|
|
4601
4619
|
*
|
|
4602
|
-
* @see {@link MatterSpecification.
|
|
4620
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.2
|
|
4603
4621
|
*/
|
|
4604
4622
|
shouldRecordSeries: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
4605
4623
|
/**
|
|
4606
4624
|
* This field, if present, shall indicate the list of additional external content identifiers.
|
|
4607
4625
|
*
|
|
4608
|
-
* @see {@link MatterSpecification.
|
|
4626
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.3
|
|
4609
4627
|
*/
|
|
4610
4628
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4611
4629
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -4614,7 +4632,7 @@ export declare namespace Channel {
|
|
|
4614
4632
|
/**
|
|
4615
4633
|
* This field, if present, shall indicate app-specific data.
|
|
4616
4634
|
*
|
|
4617
|
-
* @see {@link MatterSpecification.
|
|
4635
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.7.4
|
|
4618
4636
|
*/
|
|
4619
4637
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
4620
4638
|
}>, void, any> & {
|
|
@@ -4631,7 +4649,7 @@ export declare namespace Channel {
|
|
|
4631
4649
|
* This field shall indicate the program identifier for the program that should be cancelled from recording.
|
|
4632
4650
|
* This value is provided by the identifier field in ProgramStruct.
|
|
4633
4651
|
*
|
|
4634
|
-
* @see {@link MatterSpecification.
|
|
4652
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.1
|
|
4635
4653
|
*/
|
|
4636
4654
|
programIdentifier: import("../tlv/TlvObject.js").FieldType<string>;
|
|
4637
4655
|
/**
|
|
@@ -4639,13 +4657,13 @@ export declare namespace Channel {
|
|
|
4639
4657
|
* recording. For example, invoking record program on an episode with that flag set to true, the target should
|
|
4640
4658
|
* schedule record the whole series.
|
|
4641
4659
|
*
|
|
4642
|
-
* @see {@link MatterSpecification.
|
|
4660
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.2
|
|
4643
4661
|
*/
|
|
4644
4662
|
shouldRecordSeries: import("../tlv/TlvObject.js").FieldType<boolean>;
|
|
4645
4663
|
/**
|
|
4646
4664
|
* This field, if present, shall indicate the list of additional external content identifiers.
|
|
4647
4665
|
*
|
|
4648
|
-
* @see {@link MatterSpecification.
|
|
4666
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.3
|
|
4649
4667
|
*/
|
|
4650
4668
|
externalIdList: import("../tlv/TlvObject.js").OptionalFieldType<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4651
4669
|
name: import("../tlv/TlvObject.js").FieldType<string>;
|
|
@@ -4654,7 +4672,7 @@ export declare namespace Channel {
|
|
|
4654
4672
|
/**
|
|
4655
4673
|
* This field, if present, shall indicate app-specific data.
|
|
4656
4674
|
*
|
|
4657
|
-
* @see {@link MatterSpecification.
|
|
4675
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.8.4
|
|
4658
4676
|
*/
|
|
4659
4677
|
data: import("../tlv/TlvObject.js").OptionalFieldType<Uint8Array<ArrayBufferLike>>;
|
|
4660
4678
|
}>, void, any> & {
|
|
@@ -4669,19 +4687,19 @@ export declare namespace Channel {
|
|
|
4669
4687
|
/**
|
|
4670
4688
|
* Change the channel to the channel with the given Number in the ChannelList attribute.
|
|
4671
4689
|
*
|
|
4672
|
-
* @see {@link MatterSpecification.
|
|
4690
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3
|
|
4673
4691
|
*/
|
|
4674
4692
|
readonly changeChannelByNumber: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4675
4693
|
/**
|
|
4676
4694
|
* This field shall indicate the channel major number value (ATSC format) to which the channel should change.
|
|
4677
4695
|
*
|
|
4678
|
-
* @see {@link MatterSpecification.
|
|
4696
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3.1
|
|
4679
4697
|
*/
|
|
4680
4698
|
majorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4681
4699
|
/**
|
|
4682
4700
|
* This field shall indicate the channel minor number value (ATSC format) to which the channel should change.
|
|
4683
4701
|
*
|
|
4684
|
-
* @see {@link MatterSpecification.
|
|
4702
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.3.2
|
|
4685
4703
|
*/
|
|
4686
4704
|
minorNumber: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4687
4705
|
}>, void, any>;
|
|
@@ -4694,14 +4712,14 @@ export declare namespace Channel {
|
|
|
4694
4712
|
* continue. For example, if the current channel is at index 0 and count value of -1 is given, then the
|
|
4695
4713
|
* current channel should change to the last channel.
|
|
4696
4714
|
*
|
|
4697
|
-
* @see {@link MatterSpecification.
|
|
4715
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.4
|
|
4698
4716
|
*/
|
|
4699
4717
|
readonly skipChannel: Command<import("../tlv/TlvObject.js").TypeFromFields<{
|
|
4700
4718
|
/**
|
|
4701
4719
|
* This field shall indicate the number of steps to increase (Count is positive) or decrease (Count is negative)
|
|
4702
4720
|
* the current channel.
|
|
4703
4721
|
*
|
|
4704
|
-
* @see {@link MatterSpecification.
|
|
4722
|
+
* @see {@link MatterSpecification.v141.Cluster} § 6.6.7.4.1
|
|
4705
4723
|
*/
|
|
4706
4724
|
count: import("../tlv/TlvObject.js").FieldType<number>;
|
|
4707
4725
|
}>, void, any>;
|