BRLMMediaInfo
A class for media information.
Overview
You use this object to know about media in your printer.
Properties
mediaType
A type of media in your printer.
Declaration
@property (nonatomic, readonly) BRLMMediaInfoMediaType mediaType;
backgroundColor
A label color of the media in your printer.
Declaration
@property (nonatomic, readonly) BRLMMediaInfoBackgroundColor backgroundColor;
inkColor
A printing color of media in your printer.
Declaration
@property (nonatomic, readonly) BRLMMediaInfoInkColor inkColor;
width_mm
The width of media of your printer in millimeters. Rounded to the nearest whole number.
Declaration
@property (nonatomic, readonly) int width_mm;
height_mm
The height of media of your printer in millimeters. Rounded to the nearest whole number. If the media is continuous length, it returns 0.
Declaration
@property (nonatomic, readonly) int height_mm;
isHeightInfinite
Whether the the media is continuous length or not
Declaration
@property (nonatomic, readonly) bool isHeightInfinite;
Instance Methods
getPTLabelSize
Get the size of label.
If the type of media is not for PT series, this methods failes and returns undefined value in BRLMPTPrintSettingsLabelSize
.
Declaration
- (BRLMPTPrintSettingsLabelSize) getPTLabelSize:(bool * _Nonnull)succeeded;
Parameters
Name | Type | Description |
---|---|---|
succeeded | bool * _Nonnull | Return whether the method is succeeded or not. |
Return Value
See BRLMPTPrintSettingsLabelSize
.
getQLLabelSize
Get the size of label.
If the type of media is not for QL series, this methods failes and returns undefined value in BRLMQLPrintSettingsLabelSize
.
Declaration
- (BRLMQLPrintSettingsLabelSize) getQLLabelSize:(bool * _Nonnull)succeeded;
Parameters
Name | Type | Description |
---|---|---|
succeeded | bool * _Nonnull | Return whether the method is succeeded or not. |
Return Value
See BRLMQLPrintSettingsLabelSize
.
Types
BRLMMediaInfoMediaType
Declaration
typedef NS_ENUM(NSInteger, BRLMMediaInfoMediaType) { BRLMMediaInfoMediaTypePTLaminate, BRLMMediaInfoMediaTypePTNonLaminate, BRLMMediaInfoMediaTypePTFabric, BRLMMediaInfoMediaTypeQLInfiniteLable, BRLMMediaInfoMediaTypeQLDieCutLable, BRLMMediaInfoMediaTypePTHeatShrink, BRLMMediaInfoMediaTypePTFLe, BRLMMediaInfoMediaTypePTFlexibleID, BRLMMediaInfoMediaTypePTSatin, BRLMMediaInfoMediaTypePTSelfLaminate, BRLMMediaInfoMediaTypeIncompatible, BRLMMediaInfoMediaTypeUnknown, };
BRLMMediaInfoBackgroundColor
Declaration
typedef NS_ENUM(NSInteger, BRLMMediaInfoBackgroundColor) { BRLMMediaInfoBackgroundColorStandard, BRLMMediaInfoBackgroundColorWhite, BRLMMediaInfoBackgroundColorOthers, BRLMMediaInfoBackgroundColorClear, BRLMMediaInfoBackgroundColorRed, BRLMMediaInfoBackgroundColorBlue, BRLMMediaInfoBackgroundColorYellow, BRLMMediaInfoBackgroundColorGreen, BRLMMediaInfoBackgroundColorBlack, BRLMMediaInfoBackgroundColorClearWithWhiteInk, BRLMMediaInfoBackgroundColorPremiumGold, BRLMMediaInfoBackgroundColorPremiumSilver, BRLMMediaInfoBackgroundColorPremiumOthers, BRLMMediaInfoBackgroundColorMaskingOthers, BRLMMediaInfoBackgroundColorMatteWhite, BRLMMediaInfoBackgroundColorMatteClear, BRLMMediaInfoBackgroundColorMatteSilver, BRLMMediaInfoBackgroundColorSatinGold, BRLMMediaInfoBackgroundColorSatinSilver, BRLMMediaInfoBackgroundColorPastelPurple, BRLMMediaInfoBackgroundColorBlueWithWhiteInk, BRLMMediaInfoBackgroundColorRedWithWhiteInk, BRLMMediaInfoBackgroundColorFluorescentOrange, BRLMMediaInfoBackgroundColorFluorescentYellow, BRLMMediaInfoBackgroundColorBerryPink, BRLMMediaInfoBackgroundColorLightGray, BRLMMediaInfoBackgroundColorLimeGreen, BRLMMediaInfoBackgroundColorSatinNavyBlue, BRLMMediaInfoBackgroundColorSatinWineRed, BRLMMediaInfoBackgroundColorFabricYellow, BRLMMediaInfoBackgroundColorFabricPink, BRLMMediaInfoBackgroundColorFabricBlue, BRLMMediaInfoBackgroundColorTubeWhite, BRLMMediaInfoBackgroundColorSelfLaminatedWhite, BRLMMediaInfoBackgroundColorFlexibleWhite, BRLMMediaInfoBackgroundColorFlexibleYellow, BRLMMediaInfoBackgroundColorCleaningWhite, BRLMMediaInfoBackgroundColorStencilWhite, BRLMMediaInfoBackgroundColorLightBlue_Satin, BRLMMediaInfoBackgroundColorMint_Satin, BRLMMediaInfoBackgroundColorSilver_Satin, BRLMMediaInfoBackgroundColorIncompatible, BRLMMediaInfoBackgroundColorUnknown, };
BRLMMediaInfoInkColor
Declaration
typedef NS_ENUM(NSInteger, BRLMMediaInfoInkColor) { BRLMMediaInfoInkColorStandard, BRLMMediaInfoInkColorWhite, BRLMMediaInfoInkColorOthers, BRLMMediaInfoInkColorRed, BRLMMediaInfoInkColorBlue, BRLMMediaInfoInkColorBlack, BRLMMediaInfoInkColorGold, BRLMMediaInfoInkColorRedAndBlack, BRLMMediaInfoInkColorFabricBlue, BRLMMediaInfoInkColorCleaningBlack, BRLMMediaInfoInkColorStencilBlack, BRLMMediaInfoInkColorIncompatible, BRLMMediaInfoInkColorUnknown, };