structure describing an audio stream format with helper functions More...

Public Member Functions
ik_s32	getSampleSize () const
	returns the size of a sample of the data described by the stream data in bytes More...

ik_s32	getFrameSize () const
	returns the frame size of the stream data in bytes More...

ik_s32	getSampleDataSize () const
	returns the size of the sample data in bytes More...

ik_s32	getBytesPerSecond () const
	returns amount of bytes per second More...

Public Attributes
ik_s32	ChannelCount
	channels, 1 for mono, 2 for stereo More...

ik_s32	FrameCount
	amount of frames in the sample data or stream. More...

ik_s32	SampleRate
	samples per second More...

ESampleFormat	SampleFormat
	format of the sample data More...

Detailed Description

structure describing an audio stream format with helper functions

Definition at line 26 of file ik_SAudioStreamFormat.h.

Member Function Documentation

ik_s32 irrklang::SAudioStreamFormat::getBytesPerSecond ( ) const

inline

returns amount of bytes per second

Definition at line 61 of file ik_SAudioStreamFormat.h.

ik_s32 irrklang::SAudioStreamFormat::getFrameSize ( ) const

inline

returns the frame size of the stream data in bytes

Definition at line 48 of file ik_SAudioStreamFormat.h.

ik_s32 irrklang::SAudioStreamFormat::getSampleDataSize ( ) const

inline

returns the size of the sample data in bytes

Definition at line 55 of file ik_SAudioStreamFormat.h.

ik_s32 irrklang::SAudioStreamFormat::getSampleSize ( ) const

inline

returns the size of a sample of the data described by the stream data in bytes

Definition at line 42 of file ik_SAudioStreamFormat.h.

ik_s32 irrklang::SAudioStreamFormat::ChannelCount

channels, 1 for mono, 2 for stereo

Definition at line 29 of file ik_SAudioStreamFormat.h.

ik_s32 irrklang::SAudioStreamFormat::FrameCount

amount of frames in the sample data or stream.

If the stream has an unknown lenght, this is -1

Definition at line 33 of file ik_SAudioStreamFormat.h.

ESampleFormat irrklang::SAudioStreamFormat::SampleFormat

format of the sample data

Definition at line 39 of file ik_SAudioStreamFormat.h.

ik_s32 irrklang::SAudioStreamFormat::SampleRate

samples per second

Definition at line 36 of file ik_SAudioStreamFormat.h.

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