_t_AIPluginStream Struct Reference

This structure allows a plug-in to implement a stream by supplying the stream methods. More...

#include <AIDataFilter.h>

List of all members.

Public Attributes
AIAPI AIErr(*	ReadProc )(struct _t_AIPluginStream *stream, char *buffer, size_t *count)
	Reads data from a stream.
AIAPI AIErr(*	WriteProc )(struct _t_AIPluginStream *stream, const char *buffer, size_t count)
	Writes data to a stream.
AIAPI AIErr(*	SeekProc )(struct _t_AIPluginStream *stream, ai::sizediff_t count)
	Seeks to a position in a stream.
AIAPI AIErr(*	MarkProc )(struct _t_AIPluginStream *stream, ai::sizediff_t *count)
	Marks the current position in a stream.
AIAPI AIErr(*	TerminateProc )(struct _t_AIPluginStream *stream)
	Terminates a stream.

---

Detailed Description

This structure allows a plug-in to implement a stream by supplying the stream methods.

A method can be NULL. If a null method is invoked, the calling function returns kDataFilterErr.

---

Member Data Documentation

AIAPI AIErr(* _t_AIPluginStream::MarkProc)(struct _t_AIPluginStream *stream, ai::sizediff_t *count)

Marks the current position in a stream.

Parameters:

	stream	The stream.
	count	[out] A buffer in which to return the offset into the stream.

AIAPI AIErr(* _t_AIPluginStream::ReadProc)(struct _t_AIPluginStream *stream, char *buffer, size_t *count)

Reads data from a stream.

Reads up to count bytes into buffer, returning the number of bytes that were read.

Parameters:

	stream	The stream.
	buffer	[out] A buffer in which to return the data.
	count	[in, out] A pointer to the maximum number of bytes to read. Returns the number of bytes actually read.

AIAPI AIErr(* _t_AIPluginStream::SeekProc)(struct _t_AIPluginStream *stream, ai::sizediff_t count)

Seeks to a position in a stream.

Parameters:

	stream	The stream.
	count	The offset into the stream.

AIAPI AIErr(* _t_AIPluginStream::TerminateProc)(struct _t_AIPluginStream *stream)

Terminates a stream.

Parameters:

The

stream.

AIAPI AIErr(* _t_AIPluginStream::WriteProc)(struct _t_AIPluginStream *stream, const char *buffer, size_t count)

Writes data to a stream.

Parameters:

	stream	The stream.
	buffer	A buffer containing the data.
	count	The number of bytes in buffer.

---

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

• AIDataFilter.h