brother-ql / core/src / BrotherQLMedia
Interface: BrotherQLMedia
Brother QL media descriptor.
Extends MediaDescriptor with the dots-based geometry the raster encoder needs. The base palette field flips the driver into multi-plane mode — only DK-22251 declares one in the registry.
Extends
Properties
dieCutMaskedAreaDots?
optionaldieCutMaskedAreaDots?:number
Die-cut masked area in dots (registration windows).
geometry?
optionalgeometry?:object
Per-head-family geometry. narrow = 128-pin head (PT-E550W, PT-P750W); wide = 560-pin head (PT-P900 family). DK entries leave both unset and use the flat fields below; TZe / HSe entries leave the flat fields undefined and populate narrow and/or wide per the Raster Command Reference PDFs. undefined on a head family means "this tape doesn't fit this head" (e.g. 36 mm TZe and 31 mm HSe-3:1 have no narrow entry).
narrow?
optionalnarrow?:TapeGeometry
wide?
optionalwide?:TapeGeometry
id
id:
number
Unique identifier within the driver family.
Overrides
MediaDescriptor.id
leftMarginPins?
optionalleftMarginPins?:number
printableDots?
optionalprintableDots?:number
DK-only flat geometry. PT-* entries populate geometry instead.
rightMarginPins?
optionalrightMarginPins?:number
tapeSystem
tapeSystem:
TapeSystem
Tape system this entry belongs to. Drives lookup gating in findMediaByDimensions(width, height, engine) so QL engines never resolve TZe / HSe entries and vice versa.
type
type:
MediaType
Media type classification — driver-specific string values.
Common values: 'continuous', 'die-cut', 'tape'. Drivers may define additional values as needed.
Overrides
MediaDescriptor.type