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: Add comments about errors (#331)

Browse Source
This commit is contained in:
Hajime Hoshi 2017-04-18 00:59:10 +09:00
parent e06334c95f
commit 1497d52928
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
audio/audio.go
View File

@ -230,7 +230,7 @@ func NewContext(sampleRate int) (*Context, error) {
// 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. // Update returns error when IO error occurs in the underlying IO object.
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,
@ -323,6 +323,9 @@ type Player struct {
// //
// Note that the given src can't be shared with other Players. // Note that the given src can't be shared with other Players.
// //
// NewPlayer tries to rewind src by calling Seek to get the current position.
// NewPlayer returns error when the Seek returns error.
//
// This function is concurrent-safe. // This function is concurrent-safe.
func NewPlayer(context *Context, src ReadSeekCloser) (*Player, error) { func NewPlayer(context *Context, src ReadSeekCloser) (*Player, error) {
if context.players.hasSource(src) { if context.players.hasSource(src) {
@ -352,6 +355,8 @@ func NewPlayer(context *Context, src ReadSeekCloser) (*Player, error) {
// //
// The format of src should be same as noted at NewPlayer. // The format of src should be same as noted at NewPlayer.
// //
// NewPlayerFromBytes returns error in the same situation of NewPlayer.
//
// This function is concurrent-safe. // This function is concurrent-safe.
func NewPlayerFromBytes(context *Context, src []byte) (*Player, error) { func NewPlayerFromBytes(context *Context, src []byte) (*Player, error) {
b := BytesReadSeekCloser(src) b := BytesReadSeekCloser(src)