mth/ebiten
1
0
Fork 0
mirror of https://github.com/hajimehoshi/ebiten.git synced 2024-12-25 03:08:54 +01:00
Code Issues Packages Projects Releases Wiki Activity

audio: Update doc for errors (#331)

Browse Source
This commit is contained in:
Hajime Hoshi 2017-04-05 01:12:02 +09:00
parent b1c0c618b6
commit ebedb24e43
1 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
audio/audio.go
View File

@ -200,11 +200,15 @@ var (
) )
// NewContext creates a new audio context with the given sample rate (e.g. 44100). // NewContext creates a new audio context with the given sample rate (e.g. 44100).
//
// Error returned by NewContext is always nil as of 1.5.0-alpha.
//
// NewContext panics when an audio context is already created.
func NewContext(sampleRate int) (*Context, error) { func NewContext(sampleRate int) (*Context, error) {
theContextLock.Lock() theContextLock.Lock()
defer theContextLock.Unlock() defer theContextLock.Unlock()
if theContext != nil { if theContext != nil {
return nil, errors.New("audio: context is already created") panic("audio: context is already created")
} }
c := &Context{ c := &Context{
sampleRate: sampleRate, sampleRate: sampleRate,
@ -225,6 +229,8 @@ func NewContext(sampleRate int) (*Context, error) {
// In sync mode, the game logical time syncs the audio logical time and // In sync mode, the game logical time syncs the audio logical time and
// you will find audio stops when the game stops e.g. when the window is deactivated. // you will find audio stops when the game stops e.g. when the window is deactivated.
// In async mode, the audio never stops even when the game stops. // In async mode, the audio never stops even when the game stops.
//
// Update returns error when IO error occurs.
func (c *Context) Update() error { func (c *Context) Update() error {
// Initialize c.driver lazily to enable calling NewContext in an 'init' function. // Initialize c.driver lazily to enable calling NewContext in an 'init' function.
// Accessing driver functions requires the environment to be already initialized, // Accessing driver functions requires the environment to be already initialized,
@ -356,6 +362,8 @@ func NewPlayerFromBytes(context *Context, src []byte) (*Player, error) {
// //
// When closing, the stream owned by the player will also be closed by calling its Close. // When closing, the stream owned by the player will also be closed by calling its Close.
// //
// Close returns error when closing the source returns error.
//
// This function is concurrent-safe. // This function is concurrent-safe.
func (p *Player) Close() error { func (p *Player) Close() error {
p.players.removePlayer(p) p.players.removePlayer(p)
@ -392,6 +400,8 @@ func (p *Player) bufferLength() int {
// Play plays the stream. // Play plays the stream.
// //
// Play always returns nil.
//
// This function is concurrent-safe. // This function is concurrent-safe.
func (p *Player) Play() error { func (p *Player) Play() error {
p.players.addPlayer(p) p.players.addPlayer(p)
@ -407,6 +417,8 @@ func (p *Player) IsPlaying() bool {
// Rewind rewinds the current position to the start. // Rewind rewinds the current position to the start.
// //
// Rewind returns error when seeking the source returns error.
//
// This function is concurrent-safe. // This function is concurrent-safe.
func (p *Player) Rewind() error { func (p *Player) Rewind() error {
return p.Seek(0) return p.Seek(0)
@ -414,6 +426,8 @@ func (p *Player) Rewind() error {
// Seek seeks the position with the given offset. // Seek seeks the position with the given offset.
// //
// Seek returns error when seeking the source returns error.
//
// This function is concurrent-safe. // This function is concurrent-safe.
func (p *Player) Seek(offset time.Duration) error { func (p *Player) Seek(offset time.Duration) error {
p.players.addSeeking(p) p.players.addSeeking(p)
@ -431,6 +445,8 @@ func (p *Player) Seek(offset time.Duration) error {
// Pause pauses the playing. // Pause pauses the playing.
// //
// Pause always returns nil.
//
// This function is concurrent-safe. // This function is concurrent-safe.
func (p *Player) Pause() error { func (p *Player) Pause() error {
p.players.removePlayer(p) p.players.removePlayer(p)