ObjectAL  2.1
ObjectAL API Reference (iOS) for Kobold2D developers
Static Public Member Functions
OALTools Class Reference

Miscellaneous tools used by ObjectAL. More...

#include <OALTools.h>

List of all members.

Static Public Member Functions

NSURL * urlForPath: (NSString *path)
 Returns the URL corresponding to the specified path.
void notifyExtAudioError:function:description: (OSStatus errorCode,[function] const char *function,[description] NSString *description,[,]...)
 Notify an error if the specified ExtAudio error code indicates an error.
void notifyAudioSessionError:function:description: (OSStatus errorCode,[function] const char *function,[description] NSString *description,[,]...)
 Notify an error if the specified AudioSession error code indicates an error.

Detailed Description

Miscellaneous tools used by ObjectAL.

Member Function Documentation

void OALTools::notifyAudioSessionError:function:description: ( OSStatus  errorCode,
[function] const char*  function,
[description] NSString*  description,
[,]   ... 
) [static, virtual]

Notify an error if the specified AudioSession error code indicates an error.

This will log the error and also potentially post an audio error notification (OALAudioErrorNotification) if it is suspected that this error is a result of the audio session getting corrupted.

Parameters:
errorCode,:The error code returned from an OS call.
function,:The function name where the error occurred.
description,:A printf-style description of what happened.
void OALTools::notifyExtAudioError:function:description: ( OSStatus  errorCode,
[function] const char*  function,
[description] NSString*  description,
[,]   ... 
) [static, virtual]

Notify an error if the specified ExtAudio error code indicates an error.

This will log the error and also potentially post an audio error notification (OALAudioErrorNotification) if it is suspected that this error is a result of the audio session getting corrupted.

Parameters:
errorCode,:The error code returned from an OS call.
function,:The function name where the error occurred.
description,:A printf-style description of what happened.
NSURL * OALTools::urlForPath: ( NSString*  path) [static, virtual]

Returns the URL corresponding to the specified path.

If the path is not absolute (starts with a "/"), this method will look for the file in the application's main bundle.

Parameters:
pathThe path to convert to a URL.
Returns:
The corresponding URL or nil if a URL could not be formed.
The documentation for this class was generated from the following files: