Class

Ogg

Ogg(filename, buffersizeopt)

Constructor

# new Ogg(filename, buffersizeopt)

load OggVorbis for sound playback.

Note: OggVorbis module must be loaded by calling LoadLibrary("vorbis") before using!

Parameters:
Name Type Attributes Description
filename string

file name of the soundfile to load.

buffersize number <optional>

playback buffer size, default is 16KiB.

See:
  • LoadLibrary()

Members

number

# buffersize

playback buffer size

number

# channels

number of channels.

Array.<string>

# comments

ogg vorbis comments

number

# duration

length of the ogg in seconds

string

# filename

name of file

number

# maxframesize

max frame size

number

# numsamples

length of the ogg in samples

number

# samplerate

sample rate.

string

# vendor

vendor field

Methods

# Close()

Close Ogg after use.

# CurrentSample() → {number}

current play pos

the current sample index.

number

# Play()

must be called periodically (e.g. every Loop()) to update the playback buffer.

# Rewind()

rewind to the start of the Ogg.

# Seek(idx)

move audio to specified sample index.

Parameters:
Name Type Description
idx number

new play index