AIFXGWriteStreamInterface Struct Reference

Streaming interface to be supplied by the client, to be used when calling AIFXGFileFormatSuite::ExportFXGToStream(). More...

#include <AIFXGFileFormat.h>

List of all members.

Public Attributes
AIAPI AIBoolean(*	IsExistingAsset )(AIFXGWriteStreamInterface *stream, ai::int16 assetType, const ai::UnicodeString &assetPath)
	Callback to client to check whether an asset currently exists in an asset folder.
AIAPI AIErr(*	BeginAsset )(AIFXGWriteStreamInterface *stream, ai::int16 assetType, const ai::UnicodeString &assetName, const ai::UnicodeString &mimeType)
	Callback to client to open an asset.
AIAPI AIErr(*	EndAsset )(AIFXGWriteStreamInterface *stream, ai::int16 assetType)
	Callback to client to close an opened asset.
AIAPI size_t(*	WriteBytes )(AIFXGWriteStreamInterface *stream, const ai::uint8 *buffer, const size_t maxToWrite)
	Callback to client to write bytes to current stream.
AIAPI ai::int16(*	GetExpandOptionForArt )(AIFXGWriteStreamInterface *stream, AIArtHandle art, ai::int32 *expandFlags)
	Callback to determine the appropriate expand setting for an art object.
AIAPI AIBoolean(*	GeneratePrivateDataForArt )(AIFXGWriteStreamInterface *stream, AIArtHandle art)
	Callback to report whether client wants private data generation for an art object.
AIAPI AIErr(*	GetPublicID )(AIFXGWriteStreamInterface *stream, ai::UnicodeString &publicID)
	Callback to retrieve the filepath/name of the current stream.
AIAPI AIErr(*	GetRelativeImageFolderPath )(AIFXGWriteStreamInterface *stream, ai::UnicodeString &relImageFolderPath)
	Callback to retrieve the relative Image folder path, so that the BitmapGraphic FXG tag can create the proper relative path of the image source.
AIAPI AIErr(*	DeleteAutoGeneratedImage )(AIFXGWriteStreamInterface *stream, const ai::UnicodeString &imageName)
	Internal.

---

Detailed Description

Streaming interface to be supplied by the client, to be used when calling AIFXGFileFormatSuite::ExportFXGToStream().

---

Member Data Documentation

AIAPI AIErr(* AIFXGWriteStreamInterface::BeginAsset)(AIFXGWriteStreamInterface *stream, ai::int16 assetType, const ai::UnicodeString &assetName, const ai::UnicodeString &mimeType)

Callback to client to open an asset.

Parameters:

	stream	[in] The stream pointer that the client has passed to AIFXGFileFormatSuite::ExportFXGToStream()
	assetType	[in] Type of asset See AIFXGAssetTypeEnum
	assetName	[in/out] Name of asset. Client can change the input name, so that the export plug-in can use the changed name.
	mimeType	[in] Mime type of asset

Returns:

kCanceledErr if client does not want to receive further write and close calls for this particular open-asset call.

AIAPI AIErr(* AIFXGWriteStreamInterface::DeleteAutoGeneratedImage)(AIFXGWriteStreamInterface *stream, const ai::UnicodeString &imageName)

Internal.

AIAPI AIErr(* AIFXGWriteStreamInterface::EndAsset)(AIFXGWriteStreamInterface *stream, ai::int16 assetType)

Callback to client to close an opened asset.

Parameters:

	stream	[in] The stream pointer that the client has passed to AIFXGFileFormatSuite::ExportFXGToStream()
	assetType	[in] The asset type to close.

Returns:

kNoErr on success

AIAPI AIBoolean(* AIFXGWriteStreamInterface::GeneratePrivateDataForArt)(AIFXGWriteStreamInterface *stream, AIArtHandle art)

Callback to report whether client wants private data generation for an art object.

If not, application private data corresponding to the art is not written. (Note that this function returns a constant value, not an error code.)

Parameters:

	stream	[in] The stream pointer which the client has passed to AIFXGFileFormatSuite::ExportFXGToStream
	art	[in] The art for which private data should be generated.

Returns:

True if client wants private data generation for this particular art, false otherwise.

AIAPI ai::int16(* AIFXGWriteStreamInterface::GetExpandOptionForArt)(AIFXGWriteStreamInterface *stream, AIArtHandle art, ai::int32 *expandFlags)

Callback to determine the appropriate expand setting for an art object.

If client returns kAIFXGExpandArtOptionExpand, it must fill expandFlags; see AIExpandSuite::Expand() for flags, (Note that this function returns a constant value, not an error code.)

Parameters:

	stream	[in] The stream pointer that the client has passed to AIFXGFileFormatSuite::ExportFXGToStream()
	art	[in] The art for which an expand setting is needed.
	expandFlag	[out] The expand flags setting when kAIFXGExpandArtOptionExpand is returned.

Returns:

One of the values of AIFXGExpandArtOptionEnum, kAIFXGExpandArtOptionNone for default processing.

AIAPI AIErr(* AIFXGWriteStreamInterface::GetPublicID)(AIFXGWriteStreamInterface *stream, ai::UnicodeString &publicID)

Callback to retrieve the filepath/name of the current stream.

Parameters:

	stream	[in] The stream pointer that the client has passed to AIFXGFileFormatSuite::ExportFXGToStream()
	pulicID	[out] The filepath/name of the current stream. This is used in open-asset calls.

Returns:

kNoErr on success.

AIAPI AIErr(* AIFXGWriteStreamInterface::GetRelativeImageFolderPath)(AIFXGWriteStreamInterface *stream, ai::UnicodeString &relImageFolderPath)

Callback to retrieve the relative Image folder path, so that the BitmapGraphic FXG tag can create the proper relative path of the image source.

For example, if client returns the path "MyFile.assets/images" and the image file name is MyImage.png, the entry in the BitmapGrapic tag is source="\@Embed('MyFile.assets/images/MyImage.png')".

Parameters:

	stream	[in] The stream pointer that the client has passed to AIFXGFileFormatSuite::ExportFXGToStream()
	relImageFolderPath	[out] The relative path to the image folder.

Returns:

kNoErr on success.

AIAPI AIBoolean(* AIFXGWriteStreamInterface::IsExistingAsset)(AIFXGWriteStreamInterface *stream, ai::int16 assetType, const ai::UnicodeString &assetPath)

Callback to client to check whether an asset currently exists in an asset folder.

Parameters:

	stream	[in] The stream pointer that the client has passed to AIFXGFileFormatSuite::ExportFXGToStream().
	assetType	[in] The type of the asset, an AIFXGAssetTypeEnum value.
	assetPath	[in] The asset path.

Returns:

True if the asset exists in the asset folder, false otherwise.

AIAPI size_t(* AIFXGWriteStreamInterface::WriteBytes)(AIFXGWriteStreamInterface *stream, const ai::uint8 *buffer, const size_t maxToWrite)

Callback to client to write bytes to current stream.

(Note that this function returns a constant value, not an error code.)

Parameters:

	stream	[in] The stream pointer that the client has passed to AIFXGFileFormatSuite::ExportFXGToStream()
	buffer	[in] A buffer to write to current stream
	maxToWrite	[in] The maximum number of bytes to write

Returns:

actual bytes written

---

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

• AIFXGFileFormat.h