Interface RecordProgramRequest

Input to the Channel recordProgram command

See

MatterSpecification.v13.Cluster § 6.6.7.7

interface RecordProgramRequest {
    data?: Uint8Array;
    externalIdList?: TypeFromFields<{
        name: FieldType<string>;
        value: FieldType<string>;
    }>[];
    programIdentifier: string;
    shouldRecordSeries: boolean;
}

Hierarchy (view full)

Properties

data? externalIdList? programIdentifier shouldRecordSeries

Properties

Optionaldata

data?: Uint8Array

This field, if present, shall indicate app-specific data.

See

MatterSpecification.v13.Cluster § 6.6.7.7.4

OptionalexternalIdList

externalIdList?: TypeFromFields<{
    name: FieldType<string>;
    value: FieldType<string>;
}>[]

This field, if present, shall indicate the list of additional external content identifiers.

See

MatterSpecification.v13.Cluster § 6.6.7.7.3

programIdentifier

programIdentifier: string

This field shall indicate the program identifier for the program that should be recorded. This value is provided by the identifier field in ProgramStruct.

See

MatterSpecification.v13.Cluster § 6.6.7.7.1

shouldRecordSeries

shouldRecordSeries: boolean

This field shall indicate whether the whole series associated to the program should be recorded. For example, invoking record program on an episode with that flag set to true, the target should schedule record the whole series.

See

MatterSpecification.v13.Cluster § 6.6.7.7.2

Settings

Member Visibility

On This Page

Properties