update docs

This commit is contained in:
Wim Taymans 2017-11-13 19:58:52 +01:00
parent 440f681f4b
commit 7204f3e047
8 changed files with 137 additions and 212 deletions

View file

@ -62,47 +62,27 @@ extern "C" {
#define SPA_TYPE_AUDIO_FORMAT__F64LE SPA_TYPE_AUDIO_FORMAT_BASE "F64LE"
#define SPA_TYPE_AUDIO_FORMAT__F64BE SPA_TYPE_AUDIO_FORMAT_BASE "F64BE"
/**
* spa_audio_flags:
* @SPA_AUDIO_FLAG_NONE: no valid flag
* @SPA_AUDIO_FLAG_UNPOSITIONED: the position array explicitly
* contains unpositioned channels.
*
* Extra audio flags
*/
/** Extra audio flags */
enum spa_audio_flags {
SPA_AUDIO_FLAG_NONE = 0,
SPA_AUDIO_FLAG_UNPOSITIONED = (1 << 0)
SPA_AUDIO_FLAG_NONE = 0, /*< no valid flag */
SPA_AUDIO_FLAG_UNPOSITIONED = (1 << 0), /*< the position array explicitly
* contains unpositioned channels. */
};
/**
* spa_audio_layout:
* @SPA_AUDIO_LAYOUT_INTERLEAVED: interleaved audio
* @SPA_AUDIO_LAYOUT_NON_INTERLEAVED: non-interleaved audio
*
* Layout of the audio samples for the different channels.
*/
/** Layout of the audio samples for the different channels. */
enum spa_audio_layout {
SPA_AUDIO_LAYOUT_INTERLEAVED = 0,
SPA_AUDIO_LAYOUT_NON_INTERLEAVED
SPA_AUDIO_LAYOUT_INTERLEAVED = 0, /*< interleaved audio */
SPA_AUDIO_LAYOUT_NON_INTERLEAVED /*< non-interleaved audio */
};
/**
* spa_audio_info_raw:
* @format: the format
* @flags: extra flags
* @layout: the sample layout
* @rate: the sample rate
* @channels: the number of channels
* @channel_mask: the channel mask
*/
/** Audio information description */
struct spa_audio_info_raw {
uint32_t format;
enum spa_audio_flags flags;
enum spa_audio_layout layout;
uint32_t rate;
uint32_t channels;
uint32_t channel_mask;
uint32_t format; /*< format, one of SPA_TYPE__AudioFormat */
enum spa_audio_flags flags; /*< extra flags */
enum spa_audio_layout layout; /*< sample layout */
uint32_t rate; /*< sample rate */
uint32_t channels; /*< number of channels */
uint32_t channel_mask; /*< channel mask */
};
#ifdef __cplusplus