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