Parameters for all requests

• companyid - The companyid is a unique code that is given as part of your subscription to access the API. This code must be supplied as part of the header for each API request.

Refer to the Documentation page for each specific request and the supported Parameters

StitchPlayer

Format

/api/[design component]/StitchPlayer

Design component can be Lettering, a design, or a compound.

Description

Generates a stitch player for the specified design component.

Parameters

• SPM - The number of stitches rendered per minute. Default value is 5000.
• Background - Background colour of the stitch player specified as an RGB sextuplet. Default is white "ffffff".
• AutoStart - True/false value indicating if the player should automatically start once loaded. Default is false.
• Loop - True/false value indicating if the player should automatically loop. Default is false.
• ImageSize - Size of the image drawn in memory. Does not relate to the actual width/height of the player control. Increasing the value will increase the quality of the rendering, but at a cost to performance. Default value is 500. Not used by the HTML5 player.

Example

/api/Lettering/StitchPlayer?Text=Pulse&Palette[0]=ff0000&SPM=20000

Output

---