From 9d77ebfa414e349b4fe041483a72f1d127829d86 Mon Sep 17 00:00:00 2001 From: Chris Robinson Date: Fri, 21 May 2010 21:43:05 -0700 Subject: [PATCH] Mark new functions as added in 1.1 --- docs/html/files/alure-cpp.html | 2 +- docs/html/files/istream-cpp.html | 2 +- docs/html/files/stream-cpp.html | 6 +++--- docs/html/files/streamplay-cpp.html | 16 ++++++++-------- src/alure.cpp | 2 ++ src/istream.cpp | 2 ++ src/stream.cpp | 6 ++++++ src/streamplay.cpp | 16 ++++++++++++++++ 8 files changed, 39 insertions(+), 13 deletions(-) diff --git a/docs/html/files/alure-cpp.html b/docs/html/files/alure-cpp.html index 4a7443a..e1d7811 100644 --- a/docs/html/files/alure-cpp.html +++ b/docs/html/files/alure-cpp.html @@ -33,7 +33,7 @@ if (browserType) {document.write("
");if (browserV

alureSleep

ALURE_API ALboolean ALURE_APIENTRY alureSleep(ALfloat duration)

Rests the calling thread for the given number of seconds.

Returns

AL_FALSE on error.

-

alureGetProcAddress

ALURE_API void* ALURE_APIENTRY alureGetProcAddress(const ALchar *funcname)

Returns a pointer for the named ALURE function.

Returns

NULL on error.

+

alureGetProcAddress

ALURE_API void* ALURE_APIENTRY alureGetProcAddress(const ALchar *funcname)

Returns a pointer for the named ALURE function.

Returns

NULL on error.

Version Added: 1.1

diff --git a/docs/html/files/istream-cpp.html b/docs/html/files/istream-cpp.html index 4295c6e..99d891e 100644 --- a/docs/html/files/istream-cpp.html +++ b/docs/html/files/istream-cpp.html @@ -15,7 +15,7 @@ if (browserType) {document.write("
");if (browserV

Functions

-

alureSetIOCallbacks

ALURE_API ALboolean ALURE_APIENTRY alureSetIOCallbacks(
   void *(*open)(const char *filename, ALuint mode),
   void (*close)(void *handle),
   ALsizei (*read)(void *handle, ALubyte *buf, ALuint bytes),
   ALsizei (*write)(void *handle, const ALubyte *buf, ALuint bytes),
   alureInt64 (*seek)(void *handle, alureInt64 offset, int whence)
)

Provides callbacks for alternative methods to handle file I/O.  Passing NULL for all callbacks is a valid way to revert to normal I/O, otherwise they must all be specified.  Changing the callbacks will not affect open files (they will continue using the callbacks that were set at the time they were opened).

Parameters

openThis callback is called to open the named file.  The given mode is the access rights the open file should have.  Currently, this will always be 0 for read-only (applications should check this to make sure, as future versions may pass other values for other modes).  Upon success, a non-NULL handle must be returned which will be used as a unique identifier for the file.
closeThis callback is called to close an opened file handle.  The handle will no longer be used after this function.
readThis callback is called when data needs to be read from the given handle.  Up to the given number of bytes should be copied into ‘buf’ and the number of bytes actually copied should be returned.  Returning 0 means the end of the file has been reached (so non-blocking I/O methods should ensure at least 1 byte gets read), and negative indicates an error.
writeThis callback is called when data needs to be written to the given handle.  Up to the given number of bytes should be copied from ‘buf’ and the number of bytes actually copied should be returned.  A return value of 0 means no more data can be written (so non-blocking I/O methods should ensure at least 1 byte gets written), and negative indicates an error.
seekThis callback is called to reposition the offset of the file handle.  The given offset is interpreted according to ‘whence’, which may be SEEK_SET (absolute position from the start of the file), SEEK_CUR (relative position from the current offset), or SEEK_END (absolute position from the end of the file), as defined by standard C.  The new offset from the beginning of the file should be returned.  If the file cannot seek, such as when using a FIFO, -1 should be returned.

Returns

AL_FALSE on error.

+

alureSetIOCallbacks

ALURE_API ALboolean ALURE_APIENTRY alureSetIOCallbacks(
   void *(*open)(const char *filename, ALuint mode),
   void (*close)(void *handle),
   ALsizei (*read)(void *handle, ALubyte *buf, ALuint bytes),
   ALsizei (*write)(void *handle, const ALubyte *buf, ALuint bytes),
   alureInt64 (*seek)(void *handle, alureInt64 offset, int whence)
)

Provides callbacks for alternative methods to handle file I/O.  Passing NULL for all callbacks is a valid way to revert to normal I/O, otherwise they must all be specified.  Changing the callbacks will not affect open files (they will continue using the callbacks that were set at the time they were opened).

Parameters

openThis callback is called to open the named file.  The given mode is the access rights the open file should have.  Currently, this will always be 0 for read-only (applications should check this to make sure, as future versions may pass other values for other modes).  Upon success, a non-NULL handle must be returned which will be used as a unique identifier for the file.
closeThis callback is called to close an opened file handle.  The handle will no longer be used after this function.
readThis callback is called when data needs to be read from the given handle.  Up to the given number of bytes should be copied into ‘buf’ and the number of bytes actually copied should be returned.  Returning 0 means the end of the file has been reached (so non-blocking I/O methods should ensure at least 1 byte gets read), and negative indicates an error.
writeThis callback is called when data needs to be written to the given handle.  Up to the given number of bytes should be copied from ‘buf’ and the number of bytes actually copied should be returned.  A return value of 0 means no more data can be written (so non-blocking I/O methods should ensure at least 1 byte gets written), and negative indicates an error.
seekThis callback is called to reposition the offset of the file handle.  The given offset is interpreted according to ‘whence’, which may be SEEK_SET (absolute position from the start of the file), SEEK_CUR (relative position from the current offset), or SEEK_END (absolute position from the end of the file), as defined by standard C.  The new offset from the beginning of the file should be returned.  If the file cannot seek, such as when using a FIFO, -1 should be returned.

Returns

AL_FALSE on error.

Version Added: 1.1

diff --git a/docs/html/files/stream-cpp.html b/docs/html/files/stream-cpp.html index fd5009b..890f2c5 100644 --- a/docs/html/files/stream-cpp.html +++ b/docs/html/files/stream-cpp.html @@ -15,7 +15,7 @@ if (browserType) {document.write("
");if (browserV

Functions

-

alureStreamSizeIsMicroSec

ALURE_API ALboolean ALURE_APIENTRY alureStreamSizeIsMicroSec(ALboolean useUS)

Specifies whether the chunk size given to alureCreateStreamFrom* functions are bytes (AL_FALSE, default) or microseconds (AL_TRUE).  Specifying the size in microseconds can help manage the time needed in between needed updates (since the format and sample rate of the stream may not be known ahead of time), while specifying the size can help control memory usage.

Returns

Previously set value.

See Also

alureCreateStreamFromFile, alureCreateStreamFromMemory, alureCreateStreamFromStaticMemory, alureCreateStreamFromCallback

+

alureStreamSizeIsMicroSec

ALURE_API ALboolean ALURE_APIENTRY alureStreamSizeIsMicroSec(ALboolean useUS)

Specifies whether the chunk size given to alureCreateStreamFrom* functions are bytes (AL_FALSE, default) or microseconds (AL_TRUE).  Specifying the size in microseconds can help manage the time needed in between needed updates (since the format and sample rate of the stream may not be known ahead of time), while specifying the size can help control memory usage.

Returns

Previously set value.

Version Added: 1.1

See Also

alureCreateStreamFromFile, alureCreateStreamFromMemory, alureCreateStreamFromStaticMemory, alureCreateStreamFromCallback

alureCreateStreamFromFile

ALURE_API alureStream* ALURE_APIENTRY alureCreateStreamFromFile(
   const ALchar *fname,
   ALsizei chunkLength,
   ALsizei numBufs,
   ALuint *bufs
)

Opens a file and sets it up for streaming.  The given chunkLength is the number of bytes, or microseconds worth of bytes if alureStreamSizeIsMicroSec was last called with AL_TRUE, each buffer will fill with.  ALURE will optionally generate the specified number of buffer objects, fill them with the beginning of the data, then place the new IDs into the provided storage, before returning.  Requires an active context.

Returns

An opaque handle used to control the opened stream, or NULL on error.

See Also

alureStreamSizeIsMicroSec, alureCreateStreamFromMemory, alureCreateStreamFromStaticMemory, alureCreateStreamFromCallback

@@ -25,13 +25,13 @@ if (browserType) {document.write("
");if (browserV

alureCreateStreamFromCallback

ALURE_API alureStream* ALURE_APIENTRY alureCreateStreamFromCallback(
   ALuint (*callback)(void *userdata, ALubyte *data, ALuint bytes),
   void *userdata,
   ALenum format,
   ALuint samplerate,
   ALsizei chunkLength,
   ALsizei numBufs,
   ALuint *bufs
)

Creates a stream using the specified callback to retrieve data.  Requires an active context.

Parameters

callbackThis is called when more data is needed from the stream.  Up to the specified number of bytes should be written to the data pointer, and the number of bytes actually written should be returned.  The number of bytes written must be block aligned for the format (eg. a multiple of 4 for AL_FORMAT_STEREO16), or an OpenAL error may occur during buffering.
userdataA handle passed through to the callback.
formatThe format of the data the callback will be giving.  The format must be valid for the context.
samplerateThe sample rate (frequency) of the stream

Returns

An opaque handle used to control the opened stream, or NULL on error.

See Also

alureStreamSizeIsMicroSec, alureCreateStreamFromFile, alureCreateStreamFromMemory, alureCreateStreamFromStaticMemory

-

alureGetStreamFormat

ALURE_API ALboolean ALURE_APIENTRY alureGetStreamFormat(alureStream *stream,
ALenum *format,
ALuint *frequency,
ALuint *blockAlign)

Retrieves the format, frequency, and block-alignment used for the given stream.  If a parameter is NULL, that value will not be returned.

Returns

AL_FALSE on error.

+

alureGetStreamFormat

ALURE_API ALboolean ALURE_APIENTRY alureGetStreamFormat(alureStream *stream,
ALenum *format,
ALuint *frequency,
ALuint *blockAlign)

Retrieves the format, frequency, and block-alignment used for the given stream.  If a parameter is NULL, that value will not be returned.

Returns

AL_FALSE on error.

Version Added: 1.1

alureBufferDataFromStream

ALURE_API ALsizei ALURE_APIENTRY alureBufferDataFromStream(alureStream *stream,
ALsizei numBufs,
ALuint *bufs)

Buffers the given buffer objects with the next chunks of data from the stream.  The given buffer objects do not need to be ones given by the alureCreateStreamFrom* functions.  Requires an active context.

Returns

The number of buffers filled with new data, or -1 on error.  If the value returned is less than the number requested, the end of the stream has been reached.

alureRewindStream

ALURE_API ALboolean ALURE_APIENTRY alureRewindStream(alureStream *stream)

Rewinds the stream so that the next alureBufferDataFromStream call will restart from the beginning of the audio file.

Returns

AL_FALSE on error.

See Also

alureSetStreamOrder

-

alureSetStreamOrder

ALURE_API ALboolean ALURE_APIENTRY alureSetStreamOrder(alureStream *stream,
ALuint order)

Skips the module decoder to the specified order, so following buffering calls will decode from the specified order.  For non-module formats, setting order 0 is identical to rewinding the stream (other orders will fail).

Returns

AL_FALSE on error.

See Also

alureRewindStream

+

alureSetStreamOrder

ALURE_API ALboolean ALURE_APIENTRY alureSetStreamOrder(alureStream *stream,
ALuint order)

Skips the module decoder to the specified order, so following buffering calls will decode from the specified order.  For non-module formats, setting order 0 is identical to rewinding the stream (other orders will fail).

Returns

AL_FALSE on error.

Version Added: 1.1

See Also

alureRewindStream

alureDestroyStream

ALURE_API ALboolean ALURE_APIENTRY alureDestroyStream(alureStream *stream,
ALsizei numBufs,
ALuint *bufs)

Closes an opened stream.  For convenience, it will also delete the given buffer objects.  The given buffer objects do not need to be ones given by the alureCreateStreamFrom* functions.  Requires an active context.

Returns

AL_FALSE on error.

diff --git a/docs/html/files/streamplay-cpp.html b/docs/html/files/streamplay-cpp.html index 5bfae80..b11f0a9 100644 --- a/docs/html/files/streamplay-cpp.html +++ b/docs/html/files/streamplay-cpp.html @@ -15,21 +15,21 @@ if (browserType) {document.write("
");if (browserV

Functions

-

alurePlaySourceStream

ALURE_API ALboolean ALURE_APIENTRY alurePlaySourceStream(
   ALuint source,
   alureStream *stream,
   ALsizei numBufs,
   ALsizei loopcount,
   void (*eos_callback)(void *userdata, ALuint source),
   void *userdata
)

Starts playing a stream, using the specified source ID.  A stream can only be played if it is not already playing.  You must call alureUpdate at regular intervals to keep the stream playing.  If you fail to do so, the stream will underrun and cause a break in the playback until am update call can restart it.  It also is important that the current context is kept for alureUpdate calls, otherwise the method may start calling OpenAL with invalid IDs.  Note that checking the state of the specified source is not a good method to determine if a stream is playing.  If an underrun occurs, the source will enter a stopped state until it is automatically restarted.  Instead, set a flag using the callback to indicate the stream being stopped.

Parameters

sourceThe source ID to play the stream with.  Any buffers on the source will be unqueued.  It is valid to set source properties not related to the buffer queue or playback state (ie. you may change the source’s position, pitch, gain, etc, but you must not stop the source or queue/unqueue buffers on it).  To pause the source, call alurePauseSource.
streamThe stream to play.  Any valid stream will work, although looping will only work if the stream can be rewound (eg. streams made with alureCreateStreamFromCallback cannot loop, but will play for as long as the callback provides data).
numBufsThe number of buffers used to queue with the OpenAL source.  Each buffer will be filled with the chunk length specified when the stream was created.  This value must be at least 2.  More buffers at a larger size will decrease the time needed between updates, but at the cost of more memory usage.
loopcountThe number of times to loop the stream.  When the stream reaches the end of processing, it will be rewound to continue buffering data.  A value of -1 will cause the stream to loop indefinitely (or until alureStopSource is called).
eos_callbackThis callback will be called when the stream reaches the end, no more loops are pending, and the source reaches a stopped state.  It will also be called if an error occured and playback terminated.
userdataAn opaque user pointer passed to the callback.

Returns

AL_FALSE on error.

See Also

alureStopSource, alurePauseSource, alureGetSourceOffset, alureUpdate

+

alurePlaySourceStream

ALURE_API ALboolean ALURE_APIENTRY alurePlaySourceStream(
   ALuint source,
   alureStream *stream,
   ALsizei numBufs,
   ALsizei loopcount,
   void (*eos_callback)(void *userdata, ALuint source),
   void *userdata
)

Starts playing a stream, using the specified source ID.  A stream can only be played if it is not already playing.  You must call alureUpdate at regular intervals to keep the stream playing.  If you fail to do so, the stream will underrun and cause a break in the playback until am update call can restart it.  It also is important that the current context is kept for alureUpdate calls, otherwise the method may start calling OpenAL with invalid IDs.  Note that checking the state of the specified source is not a good method to determine if a stream is playing.  If an underrun occurs, the source will enter a stopped state until it is automatically restarted.  Instead, set a flag using the callback to indicate the stream being stopped.

Parameters

sourceThe source ID to play the stream with.  Any buffers on the source will be unqueued.  It is valid to set source properties not related to the buffer queue or playback state (ie. you may change the source’s position, pitch, gain, etc, but you must not stop the source or queue/unqueue buffers on it).  To pause the source, call alurePauseSource.
streamThe stream to play.  Any valid stream will work, although looping will only work if the stream can be rewound (eg. streams made with alureCreateStreamFromCallback cannot loop, but will play for as long as the callback provides data).
numBufsThe number of buffers used to queue with the OpenAL source.  Each buffer will be filled with the chunk length specified when the stream was created.  This value must be at least 2.  More buffers at a larger size will decrease the time needed between updates, but at the cost of more memory usage.
loopcountThe number of times to loop the stream.  When the stream reaches the end of processing, it will be rewound to continue buffering data.  A value of -1 will cause the stream to loop indefinitely (or until alureStopSource is called).
eos_callbackThis callback will be called when the stream reaches the end, no more loops are pending, and the source reaches a stopped state.  It will also be called if an error occured and playback terminated.
userdataAn opaque user pointer passed to the callback.

Returns

AL_FALSE on error.

Version Added: 1.1

See Also

alureStopSource, alurePauseSource, alureGetSourceOffset, alureUpdate

-

alurePlaySource

ALURE_API ALboolean ALURE_APIENTRY alurePlaySource(
   ALuint source,
   void (*callback)(void *userdata, ALuint source),
   void *userdata
)

Plays the specified source ID and watches for it to stop.  When a source enters an AL_STOPPED state, the specified callback will be called by alureUpdate to alert the application.  As with alurePlaySourceStream, the current context must not be changed while the source is being watched (before the callback is called or alureStopSource is called).  It also must not be deleted while being watched.

Parameters

sourceThe source ID to play.  As with alurePlaySourceStream, it is valid to set source properties not related to the playback state (ie. you may change a source’s position, pitch, gain, etc).  Pausing a source and restarting a paused source is allowed, and the callback will still be invoked when the source naturally reaches an AL_STOPPED state.
callbackThe callback to be called when the source stops.
userdataAn opaque user pointer passed to the callback.

Returns

AL_FALSE on error.

See Also

alureStopSource, alureUpdate

+

alurePlaySource

ALURE_API ALboolean ALURE_APIENTRY alurePlaySource(
   ALuint source,
   void (*callback)(void *userdata, ALuint source),
   void *userdata
)

Plays the specified source ID and watches for it to stop.  When a source enters an AL_STOPPED state, the specified callback will be called by alureUpdate to alert the application.  As with alurePlaySourceStream, the current context must not be changed while the source is being watched (before the callback is called or alureStopSource is called).  It also must not be deleted while being watched.

Parameters

sourceThe source ID to play.  As with alurePlaySourceStream, it is valid to set source properties not related to the playback state (ie. you may change a source’s position, pitch, gain, etc).  Pausing a source and restarting a paused source is allowed, and the callback will still be invoked when the source naturally reaches an AL_STOPPED state.
callbackThe callback to be called when the source stops.
userdataAn opaque user pointer passed to the callback.

Returns

AL_FALSE on error.

Version Added: 1.1

See Also

alureStopSource, alureUpdate

-

alureStopSource

ALURE_API ALboolean ALURE_APIENTRY alureStopSource(ALuint source,
ALboolean run_callback)

Stops the specified source ID, and any associated stream.  The previously specified callback will be invoked if ‘run_callback’ is not AL_FALSE.  Sources that were not started with alurePlaySourceStream or alurePlaySource will still be stopped, but will not have any callback called for them.

Returns

AL_FALSE on error.

See Also

alurePlaySourceStream, alurePlaySource

+

alureStopSource

ALURE_API ALboolean ALURE_APIENTRY alureStopSource(ALuint source,
ALboolean run_callback)

Stops the specified source ID, and any associated stream.  The previously specified callback will be invoked if ‘run_callback’ is not AL_FALSE.  Sources that were not started with alurePlaySourceStream or alurePlaySource will still be stopped, but will not have any callback called for them.

Returns

AL_FALSE on error.

Version Added: 1.1

See Also

alurePlaySourceStream, alurePlaySource

-

alurePauseSource

ALURE_API ALboolean ALURE_APIENTRY alurePauseSource(ALuint source)

Pauses the specified source ID, and any associated stream.  This is needed to avoid potential race conditions with sources that are playing a stream.

Note that it is possible for the specified source to become stopped, and any associated stream to finish, before this function is called, causing the callback to be delayed until after the function returns and alureUpdate detects the stopped source.

Returns

AL_FALSE on error.

See Also

alureResumeSource, alurePlaySourceStream, alurePlaySource

+

alurePauseSource

ALURE_API ALboolean ALURE_APIENTRY alurePauseSource(ALuint source)

Pauses the specified source ID, and any associated stream.  This is needed to avoid potential race conditions with sources that are playing a stream.

Note that it is possible for the specified source to become stopped, and any associated stream to finish, before this function is called, causing the callback to be delayed until after the function returns and alureUpdate detects the stopped source.

Returns

AL_FALSE on error.

Version Added: 1.1

See Also

alureResumeSource, alurePlaySourceStream, alurePlaySource

-

alureResumeSource

ALURE_API ALboolean ALURE_APIENTRY alureResumeSource(ALuint source)

Resumes the specified source ID after being paused.

Returns

AL_FALSE on error.

See Also

alurePauseSource

+

alureResumeSource

ALURE_API ALboolean ALURE_APIENTRY alureResumeSource(ALuint source)

Resumes the specified source ID after being paused.

Returns

AL_FALSE on error.

Version Added: 1.1

See Also

alurePauseSource

-

alureGetSourceOffset

ALURE_API alureUInt64 ALURE_APIENTRY alureGetSourceOffset(ALuint source)

Gets the sample offset of the specified source.  For sources started with alurePlaySourceStream, this will be the total samples played.  The offset will loop back to 0 when the stream rewinds for any specified loopcount.  For non-streamed sources, the function will behave as if retrieving the AL_SAMPLE_OFFSET source value.

Returns

(alureUInt64)-1 on error.

See Also

alurePlaySourceStream

+

alureGetSourceOffset

ALURE_API alureUInt64 ALURE_APIENTRY alureGetSourceOffset(ALuint source)

Gets the sample offset of the specified source.  For sources started with alurePlaySourceStream, this will be the total samples played.  The offset will loop back to 0 when the stream rewinds for any specified loopcount.  For non-streamed sources, the function will behave as if retrieving the AL_SAMPLE_OFFSET source value.

Returns

(alureUInt64)-1 on error.

Version Added: 1.1

See Also

alurePlaySourceStream

-

alureUpdate

ALURE_API void ALURE_APIENTRY alureUpdate(void)

Updates the running list of streams, and checks for stopped sources.  This makes sure that sources played with alurePlaySourceStream are kept fed from their associated stream, and sources played with alurePlaySource are still playing.  It will call their callbacks as needed.

See Also

alurePlaySourceStream, alurePlaySource

+

alureUpdate

ALURE_API void ALURE_APIENTRY alureUpdate(void)

Updates the running list of streams, and checks for stopped sources.  This makes sure that sources played with alurePlaySourceStream are kept fed from their associated stream, and sources played with alurePlaySource are still playing.  It will call their callbacks as needed.

Version Added: 1.1

See Also

alurePlaySourceStream, alurePlaySource

-

alureUpdateInterval

ALURE_API ALboolean ALURE_APIENTRY alureUpdateInterval(ALfloat interval)

Sets up a timer or thread to automatically call alureUpdate at the given interval, in seconds.  If the timer or thread is already running, the update interval will be modified.  A 0 or negative interval will stop alureUpdate from being called.

Returns

AL_FALSE on error.

See Also

alureUpdate

+

alureUpdateInterval

ALURE_API ALboolean ALURE_APIENTRY alureUpdateInterval(ALfloat interval)

Sets up a timer or thread to automatically call alureUpdate at the given interval, in seconds.  If the timer or thread is already running, the update interval will be modified.  A 0 or negative interval will stop alureUpdate from being called.

Returns

AL_FALSE on error.

Version Added: 1.1

See Also

alureUpdate

diff --git a/src/alure.cpp b/src/alure.cpp index 04414bc..2a0a472 100644 --- a/src/alure.cpp +++ b/src/alure.cpp @@ -883,6 +883,8 @@ ALURE_API ALboolean ALURE_APIENTRY alureSleep(ALfloat duration) * * Returns: * NULL on error. + * + * *Version Added*: 1.1 */ ALURE_API void* ALURE_APIENTRY alureGetProcAddress(const ALchar *funcname) { diff --git a/src/istream.cpp b/src/istream.cpp index 818abad..478d0db 100644 --- a/src/istream.cpp +++ b/src/istream.cpp @@ -226,6 +226,8 @@ extern "C" { * * Returns: * AL_FALSE on error. + * + * *Version Added*: 1.1 */ ALURE_API ALboolean ALURE_APIENTRY alureSetIOCallbacks( void* (*open)(const char *filename, ALuint mode), diff --git a/src/stream.cpp b/src/stream.cpp index f1e44a3..7438af7 100644 --- a/src/stream.cpp +++ b/src/stream.cpp @@ -126,6 +126,8 @@ extern "C" { * Returns: * Previously set value. * + * *Version Added*: 1.1 + * * See Also: * , , * , @@ -367,6 +369,8 @@ ALURE_API alureStream* ALURE_APIENTRY alureCreateStreamFromCallback( * * Returns: * AL_FALSE on error. + * + * *Version Added*: 1.1 */ ALURE_API ALboolean ALURE_APIENTRY alureGetStreamFormat(alureStream *stream, ALenum *format, ALuint *frequency, ALuint *blockAlign) @@ -482,6 +486,8 @@ ALURE_API ALboolean ALURE_APIENTRY alureRewindStream(alureStream *stream) * Returns: * AL_FALSE on error. * + * *Version Added*: 1.1 + * * See Also: * */ diff --git a/src/streamplay.cpp b/src/streamplay.cpp index 75463d3..06d2d3d 100644 --- a/src/streamplay.cpp +++ b/src/streamplay.cpp @@ -237,6 +237,8 @@ extern "C" { * Returns: * AL_FALSE on error. * + * *Version Added*: 1.1 + * * See Also: * , , , */ @@ -390,6 +392,8 @@ ALURE_API ALboolean ALURE_APIENTRY alurePlaySourceStream(ALuint source, * Returns: * AL_FALSE on error. * + * *Version Added*: 1.1 + * * See Also: * , */ @@ -449,6 +453,8 @@ ALURE_API ALboolean ALURE_APIENTRY alurePlaySource(ALuint source, * Returns: * AL_FALSE on error. * + * *Version Added*: 1.1 + * * See Also: * , */ @@ -510,6 +516,8 @@ ALURE_API ALboolean ALURE_APIENTRY alureStopSource(ALuint source, ALboolean run_ * Returns: * AL_FALSE on error. * + * *Version Added*: 1.1 + * * See Also: * , , */ @@ -554,6 +562,8 @@ ALURE_API ALboolean ALURE_APIENTRY alurePauseSource(ALuint source) * Returns: * AL_FALSE on error. * + * *Version Added*: 1.1 + * * See Also: * */ @@ -602,6 +612,8 @@ ALURE_API ALboolean ALURE_APIENTRY alureResumeSource(ALuint source) * Returns: * (alureUInt64)-1 on error. * + * *Version Added*: 1.1 + * * See Also: * */ @@ -650,6 +662,8 @@ ALURE_API alureUInt64 ALURE_APIENTRY alureGetSourceOffset(ALuint source) * from their associated stream, and sources played with are * still playing. It will call their callbacks as needed. * + * *Version Added*: 1.1 + * * See Also: * , */ @@ -755,6 +769,8 @@ restart: * Returns: * AL_FALSE on error. * + * *Version Added*: 1.1 + * * See Also: * */ -- 2.11.4.GIT