oalplus::ObjectOps< tag::DirectState, tag::Source > Class Template Reference

Wrapper for OpenAL source operations. More...

#include </home/chochlik/devel/oglplus/include/oalplus/source.hpp>

Inherits ObjectName< tag::Source >.

Public Member Functions
void	Play (void)
	Starts the audio playback. More...
void	Pause (void)
	Pauses the audio playback. More...
void	Stop (void)
	Stops the audio playback. More...
void	Rewind (void)
	Rewinds the audio track. More...
SourceState	State (void) const
	Returns the source state. More...
void	Relative (bool value)
	Sets the source to relative or absoulte state. More...
bool	Relative (void) const
	Returns true if the source is relative. More...
void	Type (SourceType type)
	Sets the source type. More...
SourceType	Type (void) const
	Returns the source type. More...
void	Looping (bool value)
	Sets the looping mode. More...
bool	Looping (void) const
	Returns true if the source is in looping mode. More...
void	Buffer (const BufferName &buffer)
	Assigns an audio buffer to the source. More...
void	DetachBuffers (void)
	Detaches all queued buffers from the source. More...
void	QueueBuffers (const Sequence< BufferName > &buffers)
	Enqueues multiple buffers to the source. More...
void	UnqueueBuffers (const Sequence< BufferName > &buffers)
	Removes multiple buffers from the sources queue. More...
void	Gain (ALfloat value)
	Sets the value of gain. More...
ALfloat	Gain (void) const
	Returns the value of gain. More...
void	MinGain (ALfloat value)
	Sets the minimal value of gain. More...
ALfloat	MinGain (void) const
	Returns the minimal value of gain. More...
void	MaxGain (ALfloat value)
	Sets the maximum value of gain. More...
ALfloat	MaxGain (void) const
	Returns the maximum value of gain. More...
void	ReferenceDistance (ALfloat value)
	Sets the reference distance. More...
ALfloat	ReferenceDistance (void) const
	Returns the reference distance. More...
void	RolloffFactor (ALfloat value)
	Sets the value of rolloff factor. More...
ALfloat	RolloffFactor (void) const
	Returns the value of rolloff factor. More...
void	MaxDistance (ALfloat value)
	Sets the value of max distance used with some distance models. More...
ALfloat	MaxDistance (void) const
	Returns the value of max distance used with some distance models. More...
void	Pitch (ALfloat value)
	Sets the value of pitch. More...
ALfloat	Pitch (void) const
	Returns the value of pitch. More...
void	Position (const Vec3f &dir)
	Sets the position of the source. More...
void	Position (ALfloat x, ALfloat y, ALfloat z)
	Sets the position of the source. More...
Vec3f	Position (void) const
	Returns the position of the source. More...
void	Velocity (const Vec3f &dir)
	Sets the velocity of the source. More...
void	Velocity (ALfloat x, ALfloat y, ALfloat z)
	Sets the velocity of the source. More...
Vec3f	Velocity (void) const
	Returns the velocity of the source. More...
void	Direction (const Vec3f &dir)
	Sets the direction of the source. More...
void	Direction (ALfloat x, ALfloat y, ALfloat z)
	Sets the direction of the source. More...
Vec3f	Direction (void) const
	Returns the direction of the source. More...
void	ConeInnerAngle (Anglef angle)
	Sets the sound cone's inner angle. More...
Anglef	ConeInnerAngle (void) const
	Returns the sound cone's inner angle. More...
void	ConeOuterAngle (Anglef angle)
	Sets the sound cone's outer angle. More...
Anglef	ConeOuterAngle (void) const
	Returns the sound cone's outer angle. More...
void	ConeOuterGain (ALfloat value)
	Sets the sound cone's outer gain value. More...
ALfloat	ConeOuterGain (void) const
	Returns the sound cone's outer gain value. More...
void	SecOffset (ALfloat value)
	Sets the Sec-offset value. More...
void	SampleOffset (ALfloat value)
	Sets the sample-offset value. More...
void	ByteOffset (ALfloat value)
	Sets the byte-offset value. More...

Detailed Description

template<>
class oalplus::ObjectOps< tag::DirectState, tag::Source >

Wrapper for OpenAL source operations.

Note

Do not use this class directly, use Source instead

Related OpenAL symbols:

Member Function Documentation

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Buffer

(

const BufferName &

buffer

)

Assigns an audio buffer to the source.

Related OpenAL symbols:

alSourcei AL_BUFFER

void oalplus::ObjectOps< tag::DirectState, tag::Source >::ByteOffset

(

ALfloat

value

)

Sets the byte-offset value.

Related OpenAL symbols:

alSourcef AL_BYTE_OFFSET

void oalplus::ObjectOps< tag::DirectState, tag::Source >::ConeInnerAngle

(

Anglef

angle

)

Sets the sound cone's inner angle.

Related OpenAL symbols:

alSourcef AL_CONE_INNER_ANGLE

Anglef oalplus::ObjectOps< tag::DirectState, tag::Source >::ConeInnerAngle

(

void

)

const

Returns the sound cone's inner angle.

Related OpenAL symbols:

alGetSourcefv AL_CONE_INNER_ANGLE

References Degrees().

void oalplus::ObjectOps< tag::DirectState, tag::Source >::ConeOuterAngle

(

Anglef

angle

)

Sets the sound cone's outer angle.

Related OpenAL symbols:

alSourcef AL_CONE_OUTER_ANGLE

Anglef oalplus::ObjectOps< tag::DirectState, tag::Source >::ConeOuterAngle

(

void

)

const

Returns the sound cone's outer angle.

Related OpenAL symbols:

alGetSourcefv AL_CONE_OUTER_ANGLE

References Degrees().

void oalplus::ObjectOps< tag::DirectState, tag::Source >::ConeOuterGain

(

ALfloat

value

)

Sets the sound cone's outer gain value.

Related OpenAL symbols:

alSourcef AL_CONE_OUTER_GAIN

ALfloat oalplus::ObjectOps< tag::DirectState, tag::Source >::ConeOuterGain

(

void

)

const

Returns the sound cone's outer gain value.

Related OpenAL symbols:

alGetSourcefv AL_CONE_OUTER_GAIN

void oalplus::ObjectOps< tag::DirectState, tag::Source >::DetachBuffers

(

void

)

Detaches all queued buffers from the source.

Related OpenAL symbols:

alSourcei AL_BUFFER

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Direction

(

const Vec3f &

dir

)

Sets the direction of the source.

Related OpenAL symbols:

alSourcefv AL_DIRECTION

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Direction	(	ALfloat	x,
		ALfloat	y,
		ALfloat	z
	)

Sets the direction of the source.

Related OpenAL symbols:

alSource3f AL_DIRECTION

Vec3f oalplus::ObjectOps< tag::DirectState, tag::Source >::Direction

(

void

)

const

Returns the direction of the source.

Related OpenAL symbols:

alGetSourcefv AL_DIRECTION

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Gain

(

ALfloat

value

)

Sets the value of gain.

Related OpenAL symbols:

alSourcef AL_GAIN

ALfloat oalplus::ObjectOps< tag::DirectState, tag::Source >::Gain

(

void

)

const

Returns the value of gain.

Related OpenAL symbols:

alGetSourcefv AL_GAIN

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Looping

(

bool

value

)

Sets the looping mode.

Related OpenAL symbols:

alSourcei AL_LOOPING

bool oalplus::ObjectOps< tag::DirectState, tag::Source >::Looping

(

void

)

const

Returns true if the source is in looping mode.

Related OpenAL symbols:

alGetSourceiv AL_LOOPING

void oalplus::ObjectOps< tag::DirectState, tag::Source >::MaxDistance

(

ALfloat

value

)

Sets the value of max distance used with some distance models.

Related OpenAL symbols:

alSourcef AL_MAX_DISTANCE

ALfloat oalplus::ObjectOps< tag::DirectState, tag::Source >::MaxDistance

(

void

)

const

Returns the value of max distance used with some distance models.

Related OpenAL symbols:

alGetSourcefv AL_MAX_DISTANCE

void oalplus::ObjectOps< tag::DirectState, tag::Source >::MaxGain

(

ALfloat

value

)

Sets the maximum value of gain.

Related OpenAL symbols:

alSourcef AL_MAX_GAIN

ALfloat oalplus::ObjectOps< tag::DirectState, tag::Source >::MaxGain

(

void

)

const

Returns the maximum value of gain.

Related OpenAL symbols:

alGetSourcefv AL_MAX_GAIN

void oalplus::ObjectOps< tag::DirectState, tag::Source >::MinGain

(

ALfloat

value

)

Sets the minimal value of gain.

Related OpenAL symbols:

alSourcef AL_MIN_GAIN

ALfloat oalplus::ObjectOps< tag::DirectState, tag::Source >::MinGain

(

void

)

const

Returns the minimal value of gain.

Related OpenAL symbols:

alGetSourcefv AL_MIN_GAIN

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Pause

(

void

)

Pauses the audio playback.

Related OpenAL symbols:

alSourcePause

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Pitch

(

ALfloat

value

)

Sets the value of pitch.

Related OpenAL symbols:

alSourcef AL_PITCH

ALfloat oalplus::ObjectOps< tag::DirectState, tag::Source >::Pitch

(

void

)

const

Returns the value of pitch.

Related OpenAL symbols:

alGetSourcefv AL_PITCH

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Play

(

void

)

Starts the audio playback.

Related OpenAL symbols:

alSourcePlay

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Position

(

const Vec3f &

dir

)

Sets the position of the source.

Related OpenAL symbols:

alSourcefv AL_POSITION

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Position	(	ALfloat	x,
		ALfloat	y,
		ALfloat	z
	)

Sets the position of the source.

Related OpenAL symbols:

alSource3f AL_POSITION

Vec3f oalplus::ObjectOps< tag::DirectState, tag::Source >::Position

(

void

)

const

Returns the position of the source.

Related OpenAL symbols:

alGetSourcefv AL_POSITION

void oalplus::ObjectOps< tag::DirectState, tag::Source >::QueueBuffers

(

const Sequence< BufferName > &

buffers

)

Enqueues multiple buffers to the source.

Related OpenAL symbols:

alSourceQueueBuffers

void oalplus::ObjectOps< tag::DirectState, tag::Source >::ReferenceDistance

(

ALfloat

value

)

Sets the reference distance.

Related OpenAL symbols:

alSourcef AL_REFERENCE_DISTANCE

ALfloat oalplus::ObjectOps< tag::DirectState, tag::Source >::ReferenceDistance

(

void

)

const

Returns the reference distance.

Related OpenAL symbols:

alGetSourcefv AL_REFERENCE_DISTANCE

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Relative

(

bool

value

)

Sets the source to relative or absoulte state.

Related OpenAL symbols:

alSourcei AL_SOURCE_RELATIVE

bool oalplus::ObjectOps< tag::DirectState, tag::Source >::Relative

(

void

)

const

Returns true if the source is relative.

Related OpenAL symbols:

alGetSourceiv AL_SOURCE_RELATIVE

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Rewind

(

void

)

Rewinds the audio track.

Related OpenAL symbols:

alSourceRewind

void oalplus::ObjectOps< tag::DirectState, tag::Source >::RolloffFactor

(

ALfloat

value

)

Sets the value of rolloff factor.

Related OpenAL symbols:

alSourcef AL_ROLLOFF_FACTOR

ALfloat oalplus::ObjectOps< tag::DirectState, tag::Source >::RolloffFactor

(

void

)

const

Returns the value of rolloff factor.

Related OpenAL symbols:

alGetSourcefv AL_ROLLOFF_FACTOR

void oalplus::ObjectOps< tag::DirectState, tag::Source >::SampleOffset

(

ALfloat

value

)

Sets the sample-offset value.

Related OpenAL symbols:

alSourcef AL_SAMPLE_OFFSET

void oalplus::ObjectOps< tag::DirectState, tag::Source >::SecOffset

(

ALfloat

value

)

Sets the Sec-offset value.

Related OpenAL symbols:

alSourcef AL_SEC_OFFSET

SourceState oalplus::ObjectOps< tag::DirectState, tag::Source >::State

(

void

)

const

Returns the source state.

Related OpenAL symbols:

alGetSourceiv AL_SOURCE_STATE

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Stop

(

void

)

Stops the audio playback.

Related OpenAL symbols:

alSourceStop

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Type

(

SourceType

type

)

Sets the source type.

Related OpenAL symbols:

alSourcei AL_SOURCE_TYPE

SourceType oalplus::ObjectOps< tag::DirectState, tag::Source >::Type

(

void

)

const

Returns the source type.

Related OpenAL symbols:

alGetSourceiv AL_SOURCE_TYPE

void oalplus::ObjectOps< tag::DirectState, tag::Source >::UnqueueBuffers

(

const Sequence< BufferName > &

buffers

)

Removes multiple buffers from the sources queue.

Related OpenAL symbols:

alSourceUnqueueBuffers

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Velocity

(

const Vec3f &

dir

)

Sets the velocity of the source.

Related OpenAL symbols:

alSourcefv AL_VELOCITY

void oalplus::ObjectOps< tag::DirectState, tag::Source >::Velocity	(	ALfloat	x,
		ALfloat	y,
		ALfloat	z
	)

Sets the velocity of the source.

Related OpenAL symbols:

alSource3f AL_VELOCITY

Vec3f oalplus::ObjectOps< tag::DirectState, tag::Source >::Velocity

(

void

)

const

Returns the velocity of the source.

Related OpenAL symbols:

alGetSourcefv AL_VELOCITY

---

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

• /home/chochlik/devel/oglplus/include/oalplus/source.hpp