Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
XmlThe Xml has the following following elements and meaning
The embedded xml has the following elements and attributes
Image processing filter values
ReadContainer permission on the category is required.
This is the backwards compatible implementation of this method.
This implementation does not throw any exceptions, instead callers must examine the outcome of the call in the Status and StatusText output parameters.
[This is preliminary documentation and is subject to change.]
Returns details about Image Processing settings for a single category.
Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
public string GetImageProcessingData( ConnectionId connectionId, SessionId sessionId, string xmlParameterData, out int status, out string statusText )
Parameters
- connectionId
- Type: ContentStudioConnectionId
A value that identifies the web site - sessionId
- Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId). - xmlParameterData
- Type: SystemString
XML that contains the parameters that this call uses. This XML is according to the Content Studio parameters XML schema - status
- Type: SystemInt32
An integer indicating result of the call. Zero is success. - statusText
- Type: SystemString
The textual representation of the call result.
Return Value
Type: StringXml
<root> <status>0</status> <statustext>Success</statustext> <idata> <imageprocesslevel>3</imageprocesslevel> <imageprocessdata><lt;rootgt;<ltimages<gtlt;origgt;<ltadj w="570" h="570" r="1" q="80" f="-1" s="0" sw="2" sr="0" /<gtlt;thumbw="51" h="51" r="1" q="80" f="-1" s="0" sw="2" sr="0gt;<ltimages<gtlt;/rootgt;</imageprocessdataidata> </root>
Element | Description |
---|---|
root/status | Integer: indicates the outcome of the call. Always 0 which indicates success. |
root/statustext | String: indicates the textual outcome of the call. Always 'Success'. |
root/imageprocesslevel | Integer: Indicates how image processing should be performed on images files in the category. For more information see CategoryManagerImageProcessingLevels. |
root/imageprocessdata | String: An embedded xml document that specifies settings used |
The embedded xml has the following syntax
<root> <images> <orig /> <adj w="570" h="570" r="1" q="80" f="-1" s="0" sw="2" sr="0" /> <thumb w="51" h="51" r="1" q="80" f="-1" s="0" sw="2" sr="0" /> </images> </root>
Element/Attribute | Description |
---|---|
root/images/orig | Specifies settings for the original image |
root/images/adj | Specifies settings for the adjusted version of the image |
root/images/thumb | Specifies settings for the thumbnail version of the image |
The adj and thumb elements have the following attributes that specifies settings. | |
w | Maximum height (in pixels) of the resulting image |
h | Maximum width (in pixels) of the resulting image |
r | Bit (0 or 1). 1 to use normalized scaling, 0 otherwise. |
q | Integer: Quality (in percent) of the resulting image. |
f | Integer: Specifies the image filter to use. For more information see table below. |
s | Integer: Specifies the sharpening intensity. Value is between 1 and 100. |
sw | Integer: Specifies the sharpening window (radius). Value is between 2 and 36. |
sr | Bit(0 or 1). 1 to use smart resizing; otherwise 0. |
Value | Algorithm name |
---|---|
0 | PassThruFilter |
1 | TriangleFilter |
2 | HermiteFilter |
3 | BellFilter |
4 | CubicBSplineFilter |
5 | LanczosFilter(LanczosFilter.DefaultRadius) |
6 | MitchellFilter |
7 | NearestNeighborFilter |
8 | HighQualityBilinearFilter |
9 | BilinearFilter |
10 | BilinearFilter |
11 | BicubicFilter |
Any other value | BellFilter |
Content Studio permissions
Remarks
See Also