D_GETMEDIASTATUS

This page applies to Harlequin v13.1r0 and later; and to Harlequin MultiRIP but not Harlequin Core

D_GETMEDIASTATUS Selector

Parameter: PluginMediaStatus * mediaStatus

The RIP calls this selector to get an update on the current output device's media status. Such information might be maintained by the plugin, or supplied by the device itself. Sheet media is not supported.

At present, the RIP makes this call:

When a new cassette is loaded.
When a new device (and hence possibly a new cassette) is selected.
Whenever any media is fed or cut.
Whenever a value is changed in the Cassette Manager dialog.

If the selector, or any feature of it, is not supported, the RIP maintains media status information itself. It performs its calculations using data it does have access to, such as the number of scanlines sent, the page resolution, and the number of automatic feeds that have taken place.

At each call, the RIP provides a PluginMediaStatus structure as the parameter. Some of the fields may already be filled in. When the output device itself can supply full media status information, the plugin can ignore the values the RIP sent.

Where a value is unset before a call, the plugin should return the corresponding value from its internal model, or leave the value as ‐1 if it does not support the feature.

The parameter passed with the selector is described below.

TEXT

      typedef struct PluginMediaStatus { int32 currentCassette; USERVALUE remainingLength; USERVALUE exposedLength; USERVALUE dummy;
    }PluginMediaStatus;

currentCassette

This field is not implemented. The plugin must set it to -1 .

remainingLength

The amount of media, in inches, remaining in the currently loaded cassette. If the plugin does not support this feature, it should set this field to -1 .

exposedLength

The amount of media currently in the take‐up cassette, in inches. If the plugin does not support this feature, it should set this field to -1 .

dummy

Not used. The plugin should set it to ‐1 for upward compatibility.