Blame doc/ao_plugin_set_option.html

Packit 57f8ee
<html>
Packit 57f8ee
Packit 57f8ee
<head>
Packit 57f8ee
<title>libao - function - ao_plugin_set_option</title>
Packit 57f8ee
<link rel=stylesheet href="style.css" type="text/css">
Packit 57f8ee
</head>
Packit 57f8ee
Packit 57f8ee
<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
Packit 57f8ee
Packit 57f8ee
Packit 57f8ee

libao documentation

Packit 57f8ee

libao version 1.2.0 - 201401271

Packit 57f8ee
Packit 57f8ee
Packit 57f8ee
Packit 57f8ee

ao_plugin_set_option

Packit 57f8ee
Packit 57f8ee

declared in "ao/plugin.h";

Packit 57f8ee
Packit 57f8ee

Set a new option key-value pair for a device. This will only be

Packit 57f8ee
called after 
Packit 57f8ee
href="ao_plugin_device_init.html">ao_plugin_device_init() is called.
Packit 57f8ee
Unrecognized option keys are silently ignored, but invalid option
Packit 57f8ee
values will cause the function to return a failing error code.
Packit 57f8ee
Packit 57f8ee


Packit 57f8ee
Packit 57f8ee
Packit 57f8ee
	
Packit 57f8ee
Packit 57f8ee
int ao_plugin_set_option(ao_device *device, const char *key, const char *value);
Packit 57f8ee
Packit 57f8ee
	
Packit 57f8ee
Packit 57f8ee
Packit 57f8ee
Packit 57f8ee

Parameters

Packit 57f8ee
Packit 57f8ee
device
Packit 57f8ee
Pointer to the device structure.
Packit 57f8ee
key
Packit 57f8ee
A string holding the option key. The calling function retains ownership
Packit 57f8ee
of this memory.
Packit 57f8ee
value
Packit 57f8ee
A string holding the option value. The calling function retains ownership
Packit 57f8ee
of this memory.
Packit 57f8ee
Packit 57f8ee
Packit 57f8ee

Return Values

Packit 57f8ee
Packit 57f8ee
  • 1 indicates success.
  • Packit 57f8ee
    Packit 57f8ee
  • 0 indicates failure.
  • Packit 57f8ee
    href="ao_plugin_device_clear.html">ao_plugin_device_clear() should be
    Packit 57f8ee
    called to ensure the deallocate of all private data structures.
    Packit 57f8ee
    Packit 57f8ee

    Packit 57f8ee
    Packit 57f8ee


    Packit 57f8ee

    Packit 57f8ee
    Packit 57f8ee
    Packit 57f8ee

    copyright © 2001-2003 Stan Seibert, 2010-2011 Monty

    Packit 57f8ee

    xiph.org
    monty@xiph.org

    Packit 57f8ee
    Packit 57f8ee

    libao documentation

    Packit 57f8ee

    libao version 1.2.0 - 201401271

    Packit 57f8ee
    Packit 57f8ee
    Packit 57f8ee
    Packit 57f8ee
    </body>
    Packit 57f8ee
    Packit 57f8ee
    </html>