Référence API JavaScript

Les fabricants peuvent utiliser l’API JavaScript présentée ici, en combinaison avec un fichier XML Bidi, pour fournir une prise en charge de Bidi sur une connexion USB à un périphérique d’impression.

Pour plus d’informations sur la communication Bidi USB avec un périphérique d’impression, veuillez consulter la section USB Bidi Extender.

Bidi sur USB

méthode getSchemas

Cette méthode gère les requêtes Bidi GET telles que \Printer.Consumables.YellowInk:Level. Le code JavaScript est capable de faire des requêtes à l’imprimante en utilisant le bus USB et de lire les réponses à mesure qu’elles reviennent.

syntaxe

function getSchemas(scriptContext, printerStream, schemaRequests, printerBidiSchemaResponses);

Paramètres (méthode getSchemas)

scriptContext [in] Un objet IPrinterScriptContext qui fournit l’accès aux groupes de propriétés pertinents. printerStream

[in] Un objet IPrinterScriptableSequentialStream qui permet un accès en lecture et en écriture au bus USB. schemaRequests

[in] Objet tableau contenant toutes les chaînes de requêtes Bidi demandées. printerBidiSchemaResponses

[out] Objet que le script utilise pour stocker toutes les réponses aux clés de requête.

Valeurs de retour (méthode getSchemas)

méthode setSchema

Cette méthode gère les opérations Bidi SET. Le script peut déterminer la valeur du schéma Bidi entrant pour soit définir des données dans le périphérique, soit effectuer une action sur le périphérique comme nettoyer les têtes d’encre.

Si le périphérique n’est pas prêt à traiter les données spécifiées, la méthode peut retourner une valeur de 1 pour indiquer que l’appel doit être réessayé après une période d’attente.

Paramètres (méthode setSchema)

scriptContext [in] Un objet IPrinterScriptContext qui fournit l’accès aux groupes de propriétés pertinents. printerStream

[in] Un objet IPrinterScriptableSequentialStream qui permet un accès en lecture et en écriture au bus USB. printerBidiSchemaElement

[in] Un objet IPrinterBidiSchemaElement qui contient toutes les données associées à la valeur du schéma Bidi à définir.

Valeurs de retour (méthode setSchema)

méthode getStatus

Cette méthode est utilisée pour obtenir le statut non sollicité d’une imprimante pendant que le périphérique est en cours d’impression. Cette fonction est appelée uniquement pendant l’impression. Le périphérique doit fournir des données sur le canal de lecture que ce script peut interpréter en valeurs de schéma Bidi. Comme le canal d’écriture vers le périphérique est bloqué par les données d’impression, seul le statut non sollicité est pris en charge ici.

Cette méthode est appelée à plusieurs reprises pendant l’impression. Il est attendu que le périphérique ne retourne des données que si elles sont disponibles et que le script peut les comprendre. Si le périphérique ne prend pas en charge le statut non sollicité ou qu’il n’est pas nécessaire de rappeler cette fonction, le script doit retourner une valeur de 2 qui indiquera au thread d’exécution getStatus dans USBMon de se terminer avec succès.

Paramètres (méthode getStatus)

scriptContext [in] Un objet IPrinterScriptContext qui fournit l’accès aux groupes de propriétés pertinents. printerStream

[in] Un objet IPrinterScriptableSequentialStream qui permet un accès en lecture au bus USB. printerBidiSchemaResponses

[out] Objet que le script utilise pour stocker toutes les réponses aux clés de requête.

Valeurs de retour (méthode getStatus)

méthode startPrintJob

USBMon appelle cette méthode pendant StartDocPort. Appeler startPrintJob permet au pilote de modifier le flux d’impression ou de mettre en œuvre un protocole de demande/réponse basé sur l’hôte qui est utilisé pendant que le périphérique d’impression imprime un travail. L’objet de contexte de travail est transmis à la fonction pour permettre au code JavaScript du fabricant de gérer les propriétés du travail et d’accéder aux flux de données persistants. Les données d’impression sont transmises sous forme de tableau JavaScript pour que le code JavaScript les traite. startPrintJob fournit également un accès au périphérique d’impression de la manière suivante :

• Via le flux d’impression

• Via un objet qui peut renvoyer des réponses de schéma Bidi pour USBMon à traiter

Syntaxe (méthode startPrintJob)

function startPrintJob(jobScriptContext, printerStream, printerBidiSchemaResponses);

Paramètres (méthode startPrintJob)

jobScriptContext [in] Un objet IPrinterScriptUsbJobContext qui donne au code JavaScript du fabricant un accès au groupe de propriétés du travail et au(x) flux de données persistant(s). printerStream

[in] Un objet IPrinterScriptableSequentialStream, que le code JavaScript du fabricant peut utiliser pour lire et écrire des données vers le périphérique d’impression. printerBidiSchemaResponses

[out] Un objet IPrinterBidiSchemaResponses que le code JavaScript du fabricant peut utiliser pour renvoyer toute modification/mise à jour de la valeur du schéma Bidi.

Valeurs de retour (méthode startPrintJob)

méthode writePrintData

USBMon appelle cette méthode pendant writePort. Appeler writePrintData permet au pilote de modifier le flux d’impression ou de mettre en œuvre un protocole de demande/réponse basé sur l’hôte qui est utilisé pendant que le périphérique d’impression imprime un travail. L’objet de contexte de travail est passé dans la méthode pour permettre au code JavaScript du fabricant de gérer les propriétés du travail et d’accéder aux flux de données persistants. Les données d’impression sont transmises sous forme de tableau JavaScript pour que le code JavaScript les traite. writePrintData fournit également un accès au périphérique d’impression de la manière suivante :

• Via le flux d’impression

• Via un objet qui peut renvoyer des réponses de schéma Bidi pour USBMon à traiter

function writePrintData(jobScriptContext, writePrintDataProgress, printData, printerStream, printerBidiSchemaResponses);

Paramètres (méthode writePrintData)

jobScriptContext [in] Un objet IPrinterScriptUsbJobContext qui donne au code JavaScript du fabricant un accès au groupe de propriétés du travail et au(x) flux de données persistant(s). writePrintDataProgress

[in] Un objet IPrinterScriptableSequentialStream que le code JavaScript du fabricant peut utiliser pour lire et écrire des données vers le périphérique d’impression. printData

[in] Un objet IDispatch, un tableau JavaScript des données d’impression actuelles. Le paramètre printData permet au code JavaScript de manipuler les données avant de les mettre en cache dans l’un des flux de données dans jobScriptContext ou de les envoyer à l’imprimante via printerStream. printerStream

[in] Un objet IPrinterScriptableSequentialStream que le code JavaScript du fabricant peut utiliser pour lire et écrire des données vers le périphérique d’impression. printerBidiSchemaResponses

[out] Un objet IPrinterBidiSchemaResponses que le code JavaScript du fabricant peut utiliser pour renvoyer toute modification ou mise à jour des valeurs du schéma Bidi.

Valeurs de retour (méthode writePrintData)

méthode endPrintJob

USBMon appelle cette méthode pendant endDocPort. Appeler endPrintJob permet au pilote de modifier le flux d’impression ou de mettre en œuvre un protocole de demande/réponse basé sur l’hôte qui est utilisé pendant que le périphérique d’impression imprime un travail. L’objet de contexte de travail est transmis à la méthode pour permettre au code JavaScript du fabricant de :

• Terminer le traitement de toutes les données d’impression persistantes

• Accéder au périphérique d’impression via le flux d’impression

• Accéder à un objet qui peut transmettre des réponses de schéma Bidi pour USBMon à traiter

function endPrintJob(jobScriptContext, printerStream, printerBidiSchemaResponses);

Paramètres (méthode endPrintJob)

jobScriptContext [in] Un objet IPrinterScriptUsbJobContext qui donne au code JavaScript du fabricant un accès au groupe de propriétés du travail et au(x) flux de données persistant(s). printerStream

[in] Un objet IPrinterScriptableSequentialStream que le code JavaScript du fabricant peut utiliser pour lire et écrire des données vers le périphérique d’impression. printerBidiSchemaResponses

[out] Un objet IPrinterBidiSchemaResponses que le code JavaScript du fabricant peut utiliser pour renvoyer toute modification ou mise à jour des valeurs du schéma Bidi.

Valeurs de retour (méthode endPrintJob)

Bidi sur USB secondaire

Si le périphérique prend en charge une interface USB secondaire, alors le périphérique peut utiliser les méthodes getSchemas et setSchema décrites dans les sections précédentes, en plus de la méthode requestStatus.

méthode requestStatus

Cette méthode est appelée au lieu de getStatus, si la directive BidiUSBStatusInterface a été spécifiée dans le fichier manifeste du pilote v4. requestStatus est utilisée pour obtenir le statut d’un périphérique d’impression pendant que le périphérique imprime.

Le schéma suivant fournit une vue d’ensemble de l’architecture de l’extension USB Bidi, montrant le scénario où la directive BidiUSBStatusInterface a été spécifiée et la communication est donc routée via une interface USB alternative.

Cette méthode est appelée à plusieurs reprises pendant l’impression. Il est attendu que le périphérique ne retourne des données que si elles sont disponibles et que le script peut les comprendre. Si le périphérique ne prend pas en charge le statut sollicité ou qu’il n’est pas nécessaire de rappeler cette méthode, le script doit retourner une valeur de 2 qui indiquera au thread d’exécution getStatus dans USBMon de se terminer avec succès.

Paramètres (méthode requestStatus)

scriptContext [in] Un objet IPrinterScriptContext qui fournit l’accès aux groupes de propriétés pertinents. printerStream

[in] Un objet IPrinterScriptableSequentialStream qui permet un accès en lecture et en écriture au bus USB. printerBidiSchemaResponses

[out] Objet que le script utilise pour stocker toutes les réponses aux clés de requête.

Valeurs de retour (méthode requestStatus)

Articles connexes

IPrinterScriptContext

IPrinterScriptableSequentialStream

USB Bidi Extender