Represents the type of encoding used in a stream or accepted by a sink. \since 1.0
Represents the type of value type of a property on a \ref pa_format_info. \since 2.0
Converts a string of the form returned by \a pa_encoding_to_string() back to * a \a pa_encoding_t. \since 1.0
Returns a printable string representing the given encoding type. \since 1.0
Returns a new \a pa_format_info struct and representing the same format as \a src. \since 1.0
Frees a \a pa_format_info structure. \since 1.0
Frees a string array returned by \ref pa_format_info_get_prop_string_array. \since 2.0
Utility function to take a \a pa_sample_spec and generate the corresponding * \a pa_format_info. * * Note that if you want the server to choose some of the stream parameters, * for example the sample rate, so that they match the device parameters, then * you shouldn't use this function. In order to allow the server to choose * a parameter value, that parameter must be left unspecified in the * pa_format_info object, and this function always specifies all parameters. An * exception is the channel map: if you pass NULL for the channel map, then the * channel map will be left unspecified, allowing the server to choose it. * * \since 2.0
Parse a human-readable string of the form generated by * \a pa_format_info_snprint() into a pa_format_info structure. \since 1.0
Gets the channel map stored in the format info. Returns a negative error * code on failure. If the channel map property is not * set at all, returns a negative integer. \since 13.0
Gets the channel count stored in the format info. Returns a negative error * code on failure. If the channels property is not set at all, returns a * negative integer. \since 13.0
Gets an integer property from the given format info. Returns 0 on success and a negative integer on failure. \since 2.0
Gets an integer array property from the given format info. \a values contains the values and \a n_values contains the * number of elements. The caller must free \a values using \ref pa_xfree. Returns 0 on success and a negative integer on * failure. \since 2.0
Gets an integer range property from the given format info. Returns 0 on success and a negative integer on failure. * \since 2.0
Gets a string property from the given format info. The caller must free the returned string using \ref pa_xfree. Returns * 0 on success and a negative integer on failure. \since 2.0
Gets a string array property from the given format info. \a values contains the values and \a n_values contains * the number of elements. The caller must free \a values using \ref pa_format_info_free_string_array. Returns 0 on success and * a negative integer on failure. \since 2.0
Gets the type of property \a key in a given \ref pa_format_info. \since 2.0
Gets the sample rate stored in the format info. Returns a negative error * code on failure. If the sample rate property is not set at all, returns a * negative integer. \since 13.0
Gets the sample format stored in the format info. Returns a negative error * code on failure. If the sample format property is not set at all, returns a * negative integer. \since 13.0
Returns non-zero if the format represented by \a first is a subset of * the format represented by \a second. This means that \a second must * have all the fields that \a first does, but the reverse need not * be true. This is typically expected to be used to check if a * stream's format is compatible with a given sink. In such a case, * \a first would be the sink's format and \a second would be the * stream's. \since 1.0
Returns non-zero when the format info structure represents a PCM * (i.e.\ uncompressed data) format. \since 1.0
Allocates a new \a pa_format_info structure. Clients must initialise at * least the encoding field themselves. Free with pa_format_info_free. \since 1.0
Convenience method to set the channel map as a property on the given * format. * * Note for PCM: If the channel map is left unspecified in the pa_format_info * object, then the server will select the stream channel map. In that case the * stream channel map will most likely match the device channel map, meaning * that remixing will be avoided. * * \since 1.0
Convenience method to set the number of channels as a property on the given * format. * * Note for PCM: If the channel count is left unspecified in the pa_format_info * object, then the server will select the stream channel count. In that case * the stream channel count will most likely match the device channel count, * meaning that up/downmixing will be avoided. * * \since 1.0
Sets an integer property on the given format info. \since 1.0
Sets a property with a list of integer values on the given format info. \since 1.0
Sets a property which can have any value in a given integer range on the given format info. \since 1.0
Sets a string property on the given format info. \since 1.0
Sets a property with a list of string values on the given format info. \since 1.0
Convenience method to set the sampling rate as a property on the given * format. * * Note for PCM: If the sample rate is left unspecified in the pa_format_info * object, then the server will select the stream sample rate. In that case the * stream sample rate will most likely match the device sample rate, meaning * that sample rate conversion will be avoided. * * \since 1.0
Convenience method to set the sample format as a property on the given * format. * * Note for PCM: If the sample format is left unspecified in the pa_format_info * object, then the server will select the stream sample format. In that case * the stream sample format will most likely match the device sample format, * meaning that sample format conversion will be avoided. * * \since 1.0
Make a human-readable string representing the given format. Returns \a s. \since 1.0
Utility function to generate a \a pa_sample_spec and \a pa_channel_map corresponding to a given \a pa_format_info. The * conversion for PCM formats is straight-forward. For non-PCM formats, if there is a fixed size-time conversion (i.e. all * IEC61937-encapsulated formats), a "fake" sample spec whose size-time conversion corresponds to this format is provided and * the channel map argument is ignored. For formats with variable size-time conversion, this function will fail. Returns a * negative integer if conversion failed and 0 on success. \since 2.0
Returns non-zero when the format info structure is valid. \since 1.0
\cond fulldocs
Maximum required string length for * pa_format_info_snprint(). Please note that this value can change * with any release without warning and without being considered API * or ABI breakage. You should not use this definition anywhere where * it might become part of an ABI. \since 1.0
\cond fulldocs
Represents the format of data provided in a stream or processed by a sink. \since 1.0