ao_info

declared in "ao/ao.h";

This structure describes the attributes of an output driver.

typedef struct { int type; /* live output or file output? */ char *name; /* full name of driver */ char *short_name; /* short name of driver */ char *comment; /* driver comment */ int preferred_byte_format; int priority; char **options; int option_count; } ao_info;

Relevant Struct Members

type

The output type of the driver:

• AO_TYPE_LIVE - Live output.
• AO_TYPE_FILE - File output.

name

A longer name for the driver which may contain whitespace, but no newlines. It is useful for telling users what output driver is in use.

short_name

A short identifier for the driver. The short name contains only alphanumeric characters, and no whitespace. It is used to look up the driver ID number using ao_driver_id().

preferred_byte_format

Specifies the preferred ordering of the sample bytes. Using the driver with this byte format usually results in slightly less memory usage and slightly less CPU usage because a swap buffer will not be needed. See ao_sample_format for a list of allowed values.

priority

A positive integer ranking how likely it is for this driver to be the default. The default driver will be a functioning driver with highest priority. See the drivers document for more explanation.

comment

Pointer to a driver comment string (possibly NULL). It may contain newlines.

options

An array of strings which list the option keys accepted by this driver.

option_count

Number of strings in options array.