open_file Method (driver_id, filename, overwrite, format, option)

Open a file for audio output. The file format is determined by the audio driver used.

Declaration Syntax

Visual Basic

Visual C++

public static ao_device open_file(
	int driver_id,
	string filename,
	bool overwrite,
	ao_sample_format format,
	IntPtr option
)

Public Shared Function open_file ( _
	driver_id As Integer, _
	filename As String, _
	overwrite As Boolean, _
	format As ao_sample_format, _
	option As IntPtr _
) As ao_device

public:
static ao_device^ open_file(
	int driver_id, 
	String^ filename, 
	bool overwrite, 
	ao_sample_format^ format, 
	IntPtr option
)

Parameters

driver_id (Int32): The ID number of the driver as returned by either driver_id(String) or default_driver_id()()().

filename (String): Name of the file in which to store the audio. The special filename "-" corresponds to stdout.

overwrite (Boolean): If true, the file is automatically overwritten. If false, then a preexisting file will cause the function to return null.

format (ao_sample_format): A structure describing the sample format.

option (IntPtr): A linked list of options to be passed to the driver or NULL if no options are needed. Unsupported options are ignored.

Return Value

An ao_device structure which must be passed in subsequent calls to play(ao_device, array<Byte>[]()[], UInt32) and close(ao_device).

Assembly: libao-sharp (Module: libao-sharp) Version: 0.8.8.18341