xref: /third_party/alsa-lib/src/conf.c

150 The comma (,) or semicolon (;) can separate value assignments. It is not
174 The configuration file defines id (key) and value pairs. The id (key) can be
176 underscore (_). The value can be either a string, an integer, a real number,
254 name [=] value [,|;]
258         name1 [=] value [,|;]
263 name.name1 [=] value [,|;]
304 name. The type and the default value are specified in the compound block:
595  * and the value is a valid path, it returns this value.  If unspecified, it
596  * returns the default value, "/usr/share/alsa".
1724  * Otherwise, the source node's value replaces the destination node's
1725  * value.
1860  * \return A positive value when true, zero when false, otherwise a negative error code.
2466  * The value of the new node is zero (for numbers), or \c NULL (for
2496  * with value \c 0.
2521  * and with value \c 0.
2546  * with value \c 0.0.
2568  * with value \c NULL.
2593  * with value \c NULL.
2754  * \brief Creates an integer configuration node with the given initial value.
2758  * \param[in] value The initial value of the new node.
2762  * with value \a value.
2772 int snd_config_imake_integer(snd_config_t **config, const char *id, const long value)
2779 	(*config)->u.integer = value;
2784  * \brief Creates a 64-bit-integer configuration node with the given initial value.
2788  * \param[in] value The initial value of the new node.
2792  * and with value \a value.
2802 int snd_config_imake_integer64(snd_config_t **config, const char *id, const long long value)
2809 	(*config)->u.integer64 = value;
2814  * \brief Creates a real number configuration node with the given initial value.
2818  * \param[in] value The initial value of the new node.
2822  * with value \a value.
2829 int snd_config_imake_real(snd_config_t **config, const char *id, const double value)
2836 	(*config)->u.real = value;
2841  * \brief Creates a string configuration node with the given initial value.
2845  * \param[in] value The initial value of the new node.  May be \c NULL.
2849  * with a copy of the string \c value.
2859 int snd_config_imake_string(snd_config_t **config, const char *id, const char *value)
2867 	if (value) {
2868 		tmp->u.string = strdup(value);
2881  * \brief Creates a string configuration node with the given initial value.
2885  * \param[in] value The initial value of the new node.  May be \c NULL.
2889  * contains with a copy of the string \c value, replacing any character other
2900 int snd_config_imake_safe_string(snd_config_t **config, const char *id, const char *value)
2909 	if (value) {
2910 		tmp->u.string = strdup(value);
2933  * \brief Creates a pointer configuration node with the given initial value.
2937  * \param[in] value The initial value of the new node.
2941  * with value \c value.
2948 int snd_config_imake_pointer(snd_config_t **config, const char *id, const void *value)
2955 	(*config)->u.ptr = value;
2960  * \brief Changes the value of an integer configuration node.
2962  * \param value The new value for the node.
2973 int snd_config_set_integer(snd_config_t *config, long value)
2978 	config->u.integer = value;
2983  * \brief Changes the value of a 64-bit-integer configuration node.
2985  * \param value The new value for the node.
2996 int snd_config_set_integer64(snd_config_t *config, long long value)
3001 	config->u.integer64 = value;
3006  * \brief Changes the value of a real-number configuration node.
3008  * \param value The new value for the node.
3016 int snd_config_set_real(snd_config_t *config, double value)
3021 	config->u.real = value;
3026  * \brief Changes the value of a string configuration node.
3028  * \param value The new value for the node.  May be \c NULL.
3032  * \a value string in the node.
3042 int snd_config_set_string(snd_config_t *config, const char *value)
3048 	if (value) {
3049 		new_string = strdup(value);
3061  * \brief Changes the value of a pointer configuration node.
3063  * \param value The new value for the node.  May be \c NULL.
3073 int snd_config_set_pointer(snd_config_t *config, const void *value)
3078 	config->u.ptr = value;
3083  * \brief Changes the value of a configuration node.
3085  * \param ascii The new value for the node, as an ASCII string.
3088  * This function changes the node's value to a new value that is parsed
3093  * valid value with the same type as the node's type.  For a string
3094  * node, the node's new value is a copy of \a ascii.
3099  * <dt>-EINVAL<dd>The value in \a ascii cannot be parsed.
3100  * <dt>-ERANGE<dd>The value in \a ascii is too big for the node's type.
3154  * \brief Returns the value of an integer configuration node.
3156  * \param[out] ptr The node's value.
3177  * \brief Returns the value of a 64-bit-integer configuration node.
3179  * \param[out] ptr The node's value.
3200  * \brief Returns the value of a real-number configuration node.
3202  * \param[out] ptr The node's value.
3220  * \brief Returns the value of a real or integer configuration node.
3222  * \param[out] ptr The node's value.
3225  * If the node's type is integer or integer64, the value is converted
3248  * \brief Returns the value of a string configuration node.
3250  * \param[out] ptr The function puts the node's value at the address
3256  * invalid when the node's value changes or when the node is freed.
3278  * \brief Returns the value of a pointer configuration node.
3280  * \param[out] ptr The function puts the node's value at the address
3299  * \brief Returns the value of a configuration node as a string.
3309  * For a string node with \c NULL value, the returned string is \c NULL.
3394  * \return The same value as the result of the \c strcmp function, i.e.,
3414  * This function writes a textual representation of \a config's value to
3645  * identified by an alias, which is a string node whose value is taken
3932  * variable \c ALSA_CONFIG_PATH.  If this is not set, the default value
4270 			SNDERR("Invalid bool value in field errors");
4370 	if (snd_config_search(n, "value", &tn) < 0 ||
4372 		SNDERR("Unable to find field table.value");
4803  * The returned iterator is valid if it is not equal to the return value
4823  * The returned iterator is valid if it is not equal to the return value
4844  * The return value can be understood as pointing past the last child of
5001  * \return A non-negative value if successful, otherwise a negative error code.
5224  * \return A non-negative value if successful, otherwise a negative error code.
5643  * \return A non-negative value if successful, otherwise a negative error code.
5647  * respective argument value, or the default argument value, or nothing.
5678  * \return A non-negative value if successful, otherwise a negative error code.
5682  * respective argument value, or the default argument value, or nothing.
5747  * \return A non-negative value if successful, otherwise a negative error code.

Indexes created Thu Nov 07 10:32:03 CST 2024