Overview

Sample Code

Programming Guide

API Reference

Support

HPS.Stream.File Class Reference

The File class provides functions to import and export HSF files. More...

Static Public Member Functions

static HPS.Stream.ExportNotifier Export (string in_file_name, HPS.SegmentKey in_segment, HPS.Stream.ExportOptionsKit in_options)
 Performs an asychronous HSF export of the given segment with the provided options to a given filename. An exception will be thrown if a problem is encountered during export. More...
 
static HPS.Stream.ExportNotifier Export (HPS.SegmentKey in_segment, HPS.Stream.ExportOptionsKit in_options, out byte[][] out_hsf_buffers)
 Performs an asychronous HSF export of the given segment with the provided options to a list of output buffers. An exception will be thrown if a problem is encountered during export. More...
 
static HPS.Stream.ImportNotifier Import (string in_file_name, HPS.Stream.ImportOptionsKit in_options)
 Performs an asynchronous import of the specified HSF file with the provided options. May throw an IOException prior to starting the asynchronous import. More...
 
static HPS.Stream.ImportNotifier Import (byte[][] in_hsf_buffers, HPS.Stream.ImportOptionsKit in_options)
 Performs an asynchronous import of the specified HSF file with the provided options. May throw an IOException prior to starting the asynchronous import. More...
 

Detailed Description

The File class provides functions to import and export HSF files.

Member Function Documentation

static HPS.Stream.ExportNotifier HPS.Stream.File.Export ( string  in_file_name,
HPS.SegmentKey  in_segment,
HPS.Stream.ExportOptionsKit  in_options 
)
inlinestatic

Performs an asychronous HSF export of the given segment with the provided options to a given filename. An exception will be thrown if a problem is encountered during export.

Parameters
in_file_nameName of the file to write the HSF data to.
in_segmentSegment containing the data to export.
in_optionsOptions controlling the export of the HSF data.
Returns
An ExportNotifier object that can be used to query the export progress and status.
static HPS.Stream.ExportNotifier HPS.Stream.File.Export ( HPS.SegmentKey  in_segment,
HPS.Stream.ExportOptionsKit  in_options,
out byte  out_hsf_buffers[][] 
)
inlinestatic

Performs an asychronous HSF export of the given segment with the provided options to a list of output buffers. An exception will be thrown if a problem is encountered during export.

Parameters
in_segmentSegment containing the data to export.
in_optionsOptions controlling the export of the HSF data.
out_hsf_buffersThe output buffers the exported HSF data is written to.
Returns
An ExportNotifier object that can be used to query the export progress and status.
static HPS.Stream.ImportNotifier HPS.Stream.File.Import ( string  in_file_name,
HPS.Stream.ImportOptionsKit  in_options 
)
inlinestatic

Performs an asynchronous import of the specified HSF file with the provided options. May throw an IOException prior to starting the asynchronous import.

Parameters
in_file_nameName of HSF file to import.
in_optionsOptions controlling the import of the HSF file (e.g., segment to import into).
Returns
An ImportNotfier object that can be used to query the import progress and status.
static HPS.Stream.ImportNotifier HPS.Stream.File.Import ( byte  in_hsf_buffers[][],
HPS.Stream.ImportOptionsKit  in_options 
)
inlinestatic

Performs an asynchronous import of the specified HSF file with the provided options. May throw an IOException prior to starting the asynchronous import.

Parameters
in_hsf_buffersThe buffer of HSF data to import.
in_optionsOptions controlling the import of the HSF file (e.g., segment to import into).
Returns
An ImportNotfier object that can be used to query the import progress and status.

The documentation for this class was generated from the following file: