ebiten/exp/audio/audio.go

// Copyright 2015 Hajime Hoshi
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package audio

import (
	"github.com/hajimehoshi/ebiten/internal/audio"
)

// SampleRate returns the sampling frequency (e.g. 44100).
const SampleRate = audio.SampleRate

// MaxChannel is a max number of channels.
const MaxChannel = audio.MaxChannel

// Queue queues the given data to the given channel.
// The given data is queued to the end of the buffer.
// This may not be played immediately when data already exists in the buffer.
//
// channel must be -1 or a channel index.
// If channel is -1, an empty channel is automatically selected.
//
// If the channel is not empty, this function does nothing and returns false.
// This returns true otherwise.
//
// data's format must be linear PCM (44100Hz, 16bits, 2 channel stereo, little endian)
// without a header (e.g. RIFF header).
func Queue(channel int, data []byte) bool {
	return audio.Queue(channel, data)
}

// IsPlaying returns a boolean value which indicates if the channel buffer has data to play.
func IsPlaying(channel int) bool {
	return audio.IsPlaying(channel)
}

// TODO: Add Clear function