Description

VuoAudioFile interface.

Copyright: Copyright © 2012–2020 Kosada Incorporated. This code may be modified and distributed under the terms of the MIT License. For more information, see https://vuo.org/license.

Typedefs
typedef void *	VuoAudioFile
	A state object for firing display refresh events. More...

Functions
bool	VuoAudioFile_getInfo (VuoText url, VuoReal duration, VuoInteger channelCount, VuoReal *sampleRate) VuoWarnUnusedResult
	Returns information about the specified audio file. More...

VuoAudioFile	VuoAudioFile_make (VuoText url)
	Creates a new audio file decoder, and starts a decoding timer. More...

void	VuoAudioFile_enableTriggers (VuoAudioFile af, void(decodedChannels)(VuoList_VuoAudioSamples), void(finishedPlayback)(void))
	Specifies a trigger callback to invoke when a new audio sample buffer is ready for playback. More...

void	VuoAudioFile_disableTriggers (VuoAudioFile af)
	When this function returns, the trigger callback will no longer be called. More...

void	VuoAudioFile_setLoopType (VuoAudioFile af, VuoLoopType loop)
	Sets the behavior upon reaching the end of the audio file. More...

void	VuoAudioFile_setTime (VuoAudioFile af, VuoReal time)
	Seeks the playhead to the specified time in the audio file. More...

void	VuoAudioFile_play (VuoAudioFile af)
	Starts or resumes playback of the audio file from the current playhead time. More...

void	VuoAudioFile_pause (VuoAudioFile af)
	Pauses playback of the audio file, leaving the playhead at its current time. More...

bool	VuoAudioFile_isPlaying (VuoAudioFile af)
	Returns `true` if the audio file is currently playing. More...

Typedef Documentation

◆ VuoAudioFile

typedef void* VuoAudioFile

A state object for firing display refresh events.

Definition at line 28 of file VuoAudioFile.h.

Function Documentation

◆ VuoAudioFile_disableTriggers()

void VuoAudioFile_disableTriggers ( VuoAudioFile af )

When this function returns, the trigger callback will no longer be called.

Does not change playback status.

Definition at line 393 of file VuoAudioFile.c.

◆ VuoAudioFile_enableTriggers()

void VuoAudioFile_enableTriggers	(	VuoAudioFile	af,
		void(*)(VuoList_VuoAudioSamples)	decodedChannels,
		void(*)(void)	finishedPlayback
	)

Specifies a trigger callback to invoke when a new audio sample buffer is ready for playback.

Does not change playback status.

Definition at line 377 of file VuoAudioFile.c.

◆ VuoAudioFile_getInfo()

bool VuoAudioFile_getInfo	(	VuoText	url,
		VuoReal *	duration,
		VuoInteger *	channelCount,
		VuoReal *	sampleRate
	)

Returns information about the specified audio file.

Returns true on success, false if the file couldn't be read.

Definition at line 356 of file VuoAudioFile.c.

◆ VuoAudioFile_isPlaying()

bool VuoAudioFile_isPlaying ( VuoAudioFile af )

Returns true if the audio file is currently playing.

This is independent of whether a trigger callback is currently active.

Definition at line 464 of file VuoAudioFile.c.

◆ VuoAudioFile_make()

VuoAudioFile VuoAudioFile_make ( VuoText url )

Creates a new audio file decoder, and starts a decoding timer.

<

Definition at line 206 of file VuoAudioFile.c.

◆ VuoAudioFile_pause()

void VuoAudioFile_pause ( VuoAudioFile af )

Pauses playback of the audio file, leaving the playhead at its current time.

Definition at line 451 of file VuoAudioFile.c.

◆ VuoAudioFile_play()

void VuoAudioFile_play ( VuoAudioFile af )

Starts or resumes playback of the audio file from the current playhead time.

Definition at line 440 of file VuoAudioFile.c.

◆ VuoAudioFile_setLoopType()

void VuoAudioFile_setLoopType	(	VuoAudioFile	af,
		VuoLoopType	loop
	)

Sets the behavior upon reaching the end of the audio file.

Definition at line 407 of file VuoAudioFile.c.

◆ VuoAudioFile_setTime()

void VuoAudioFile_setTime	(	VuoAudioFile	af,
		VuoReal	time
	)

Seeks the playhead to the specified time in the audio file.

Definition at line 418 of file VuoAudioFile.c.