UriOperationBufferSize Property

Summary

Gets or sets the size of the buffer used in URI-based load or information operations.

Syntax

Objective-C

C++

Java

public int UriOperationBufferSize { get; set; }

Public Property UriOperationBufferSize As Integer

@property (nonatomic, assign) NSUInteger uriOperationBufferSize

public int getUriOperationBufferSize() 
public void setUriOperationBufferSize(int value)

public: 
property int UriOperationBufferSize { 
   int get(); 
   void set (    int ); 
}

Property Value

A value specifying the size of the buffer (in bytes) used in streaming operations. The value should be greater or equal to 1. Default value is 4096.

Remarks

The value of the UriOperationBufferSize property is used to determine the size of the temporary buffer used when streaming image file data using any of the URI-based load or information operations.

The following methods use the value of this property internally to allocate the temporary buffer:

GetInformation(Uri, bool)
GetInformation(Uri, bool, int)
Task<CodecsImageInfo> RasterCodecs-GetInformationAsync(ILeadStream stream, bool totalPages)
Task<CodecsImageInfo> RasterCodecs-GetInformationAsync(ILeadStream stream, bool totalPages, int pageNumber)
Load(Uri uri)
Load(Uri uri, int pageNumber)
Load(Uri uri, int pageNumber, CodecsLoadByteOrder order, int firstPage, int lastPage)
Task<RasterImage> LoadAsync(ILeadStream stream)
Task<RasterImage> LoadAsync(ILeadStream stream, int pageNumber)
Task<RasterImage> LoadAsync(ILeadStream stream, int pageNumber, CodecsLoadByteOrder order, int firstPage, int lastPage)
LoadAsync(Uri uri, object userState)
LoadAsync(Uri uri, int pageNumber, object userState)
LoadAsync(Uri uri, int bitsPerPixel, CodecsLoadByteOrder order, int firstPage, int lastPage, object userState)
LoadAsync(Uri uri, LeadRect tile, object userState)
LoadAsync(Uri uri, LeadRect tile, int bitsPerPixel, CodecsLoadByteOrder order, int firstPage, int lastPage, object userState)
GetTotalPages(Uri uri)
GetFormat(Uri uri)
Task<bool> LoadSvgAsync(ILeadStream stream, int pageNumber, CodecsLoadSvgOptions options)
LoadSvgAsync(Uri uri, int pageNumber, CodecsLoadSvgOptions, object userState)

The default size of the buffer is 4096 (4 KBytes). This means that the RasterCodecs object will try to load the image data in 4 KBytes chunks of data.

Increasing the buffer size might enhance the performance while also increasing the amount of memory resources used.

Example

For an example, refer to Load.

Requirements

Target Platforms