ags_vst_ibstream.h File Reference

#include <ags/vst3-capi/pluginterfaces/base/ags_vst_funknown.h>

Include dependency graph for ags_vst_ibstream.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	AGS_VST_IBSTREAM_IID   (ags_vst_ibstream_get_iid())
#define	AGS_VST_ISIZEABLE_STREAM_IID   (ags_vst_isizeable_stream_get_iid())

Typedefs
typedef struct IBStream	AgsVstIBStream
typedef struct ISizeableStream	AgsVstISizeableStream

Enumerations
enum	AgsVstIStreamSeekMode { AGS_VST_KIB_SEEK_SET = 0 , AGS_VST_KIB_SEEK_CUR , AGS_VST_KIB_SEEK_END }

Functions
AgsVstTUID *	ags_vst_ibstream_get_iid ()
AgsVstTResult	ags_vst_ibstream_read (AgsVstIBStream *ib_stream, gpointer buffer, gint32 num_bytes, gint32 *num_bytes_read)
AgsVstTResult	ags_vst_ibstream_write (AgsVstIBStream *ib_stream, gpointer buffer, gint32 num_bytes, gint32 *num_bytes_written)
AgsVstTResult	ags_vst_ibstream_seek (AgsVstIBStream *ib_stream, gint64 pos, gint32 mode, gint64 *result)
AgsVstTResult	ags_vst_ibstream_tell (AgsVstIBStream *ib_stream, gint64 *pos)
AgsVstTUID *	ags_vst_isizeable_stream_get_iid ()
AgsVstTResult	ags_vst_isizeable_stream_set_stream_size (AgsVstISizeableStream *isizeable_stream, gint64 stream_size)

Macro Definition Documentation

AGS_VST_IBSTREAM_IID

#define AGS_VST_IBSTREAM_IID   (ags_vst_ibstream_get_iid())

AGS_VST_ISIZEABLE_STREAM_IID

#define AGS_VST_ISIZEABLE_STREAM_IID   (ags_vst_isizeable_stream_get_iid())

Typedef Documentation

AgsVstIBStream

typedef struct IBStream AgsVstIBStream

AgsVstISizeableStream

typedef struct ISizeableStream AgsVstISizeableStream

Enumeration Type Documentation

AgsVstIStreamSeekMode

enum AgsVstIStreamSeekMode

Enumerator
AGS_VST_KIB_SEEK_SET
AGS_VST_KIB_SEEK_CUR
AGS_VST_KIB_SEEK_END

Function Documentation

ags_vst_ibstream_get_iid()

AgsVstTUID * ags_vst_ibstream_get_iid

(

)

Get IID.

Returns

the Steinberg::TUID as AgsVstTUID

Since

5.0.0

ags_vst_ibstream_read()

AgsVstTResult ags_vst_ibstream_read	(	AgsVstIBStream *	ib_stream,
		gpointer	buffer,
		gint32	num_bytes,
		gint32 *	num_bytes_read
	)

Read.

Parameters

ib_stream	the stream
buffer	the buffer
num_bytes	number of bytes
num_bytes_read	number of read

Returns

the return value

Since

5.0.0

ags_vst_ibstream_seek()

AgsVstTResult ags_vst_ibstream_seek	(	AgsVstIBStream *	ib_stream,
		gint64	pos,
		gint32	mode,
		gint64 *	result
	)

Seek.

Parameters

ib_stream	the stream
pos	the position
mode	mode
result	the result

Returns

the return value

Since

5.0.0

ags_vst_ibstream_tell()

AgsVstTResult ags_vst_ibstream_tell	(	AgsVstIBStream *	ib_stream,
		gint64 *	pos
	)

Tell.

Parameters

ib_stream	the stream
pos	the position

Returns

the return value

Since

5.0.0

ags_vst_ibstream_write()

AgsVstTResult ags_vst_ibstream_write	(	AgsVstIBStream *	ib_stream,
		gpointer	buffer,
		gint32	num_bytes,
		gint32 *	num_bytes_written
	)

Write.

Parameters

ib_stream	the stream
buffer	the buffer
num_bytes	number of bytes
num_bytes_written	number of read

Returns

the return value

Since

5.0.0

ags_vst_isizeable_stream_get_iid()

AgsVstTUID * ags_vst_isizeable_stream_get_iid

(

)

Get IID.

Returns

the Steinberg::TUID as AgsVstTUID

Since

5.0.0

ags_vst_isizeable_stream_set_stream_size()

AgsVstTResult ags_vst_isizeable_stream_set_stream_size	(	AgsVstISizeableStream *	isizeable_stream,
		gint64	stream_size
	)

Set stream size.

Parameters

isizeable_stream	the stream
stream_size	stream size

Returns

the return code

Since

5.0.0