pulseaudio-d ~master (2021-12-03T03:16:30.5977825)

pulse.sample

pulse
Undocumented in source.

Members

Aliases

pa_sample_format_is_ne
alias pa_sample_format_is_ne = pa_sample_format_is_le

Returns 1 when the specified format is native endian, 0 when * not. Returns -1 when endianness does not apply to the * specified format, or endianess is unknown. \since 0.9.16

pa_sample_format_is_re
alias pa_sample_format_is_re = pa_sample_format_is_be

Returns 1 when the specified format is reverse endian, 0 when * native. Returns -1 when endianness does not apply to the * specified format, or endianess is unknown. \since 0.9.16

pa_sample_format_t
alias pa_sample_format_t = pa_sample_format
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
pa_usec_t
alias pa_usec_t = c_ulong

Type for usec specifications (unsigned). Always 64 bit.

Enums

pa_sample_format
enum pa_sample_format

Sample format

Functions

pa_bytes_per_second
size_t pa_bytes_per_second(const(pa_sample_spec)* spec)

Return the amount of bytes that constitute playback of one second of * audio, with the specified sample spec.

pa_bytes_snprint
char* pa_bytes_snprint(char* s, size_t l, uint v)

Pretty print a byte size value (i.e.\ "2.5 MiB"). Returns \a s.

pa_bytes_to_usec
pa_usec_t pa_bytes_to_usec(ulong length, const(pa_sample_spec)* spec)

Calculate the time it would take to play a buffer of the specified * size with the specified sample type. The return value will always * be rounded down for non-integral return values.

pa_channels_valid
int pa_channels_valid(ubyte channels)

Return non-zero if the channel count is within the supported range. * \since 5.0

pa_frame_size
size_t pa_frame_size(const(pa_sample_spec)* spec)

Return the size of a frame with the specific sample type

pa_parse_sample_format
pa_sample_format_t pa_parse_sample_format(const(char)* format)

Parse a sample format text. Inverse of pa_sample_format_to_string()

pa_sample_format_is_be
int pa_sample_format_is_be(pa_sample_format_t f)

Returns 1 when the specified format is big endian, 0 when * little endian. Returns -1 when endianness does not apply to the * specified format, or endianess is unknown. \since 0.9.16

pa_sample_format_is_le
int pa_sample_format_is_le(pa_sample_format_t f)

Returns 1 when the specified format is little endian, 0 when * big endian. Returns -1 when endianness does not apply to the * specified format, or endianess is unknown. \since 0.9.16

pa_sample_format_to_string
const(char)* pa_sample_format_to_string(pa_sample_format_t f)

Return a descriptive string for the specified sample format. \since 0.8

pa_sample_format_valid
int pa_sample_format_valid(uint format)

Return non-zero if the given integer is a valid sample format. \since 5.0

pa_sample_rate_valid
int pa_sample_rate_valid(uint rate)

Return non-zero if the rate is within the supported range. \since 5.0

pa_sample_size
size_t pa_sample_size(const(pa_sample_spec)* spec)

Return the size of a sample with the specific sample type

pa_sample_size_of_format
size_t pa_sample_size_of_format(pa_sample_format_t f)

Similar to pa_sample_size() but take a sample format instead of a * full sample spec. \since 0.9.15

pa_sample_spec_equal
int pa_sample_spec_equal(const(pa_sample_spec)* a, const(pa_sample_spec)* b)

Return non-zero when the two sample type specifications match

pa_sample_spec_init
pa_sample_spec* pa_sample_spec_init(pa_sample_spec* spec)

Initialize the specified sample spec and return a pointer to * it. The sample spec will have a defined state but * pa_sample_spec_valid() will fail for it. \since 0.9.13

pa_sample_spec_snprint
char* pa_sample_spec_snprint(char* s, size_t l, const(pa_sample_spec)* spec)

Pretty print a sample type specification to a string. Returns \a s.

pa_sample_spec_valid
int pa_sample_spec_valid(const(pa_sample_spec)* spec)

Return non-zero when the sample type specification is valid

pa_usec_to_bytes
size_t pa_usec_to_bytes(pa_usec_t t, const(pa_sample_spec)* spec)

Calculates the size of a buffer required, for playback duration * of the time specified, with the specified sample type. The * return value will always be rounded down for non-integral * return values. \since 0.9

Manifest constants

PA_BYTES_SNPRINT_MAX
enum PA_BYTES_SNPRINT_MAX;

Maximum required string length for pa_bytes_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 0.9.16

PA_CHANNELS_MAX
enum PA_CHANNELS_MAX;

Maximum number of allowed channels

PA_RATE_MAX
enum PA_RATE_MAX;

Maximum allowed sample rate

PA_SAMPLE_ALAW
enum PA_SAMPLE_ALAW;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_SAMPLE_FLOAT32
enum PA_SAMPLE_FLOAT32;

A Shortcut for PA_SAMPLE_FLOAT32NE

PA_SAMPLE_FLOAT32BE
enum PA_SAMPLE_FLOAT32BE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_SAMPLE_FLOAT32LE
enum PA_SAMPLE_FLOAT32LE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_SAMPLE_FLOAT32NE
enum PA_SAMPLE_FLOAT32NE;

32 Bit IEEE floating point, native endian

PA_SAMPLE_FLOAT32RE
enum PA_SAMPLE_FLOAT32RE;

32 Bit IEEE floating point, reverse endian

PA_SAMPLE_S16BE
enum PA_SAMPLE_S16BE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_SAMPLE_S16LE
enum PA_SAMPLE_S16LE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_SAMPLE_S16NE
enum PA_SAMPLE_S16NE;

Signed 16 Bit PCM, native endian

PA_SAMPLE_S16RE
enum PA_SAMPLE_S16RE;

Signed 16 Bit PCM, reverse endian

PA_SAMPLE_S24BE
enum PA_SAMPLE_S24BE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_SAMPLE_S24LE
enum PA_SAMPLE_S24LE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_SAMPLE_S24NE
enum PA_SAMPLE_S24NE;

Signed 24 Bit PCM packed, native endian. \since 0.9.15

PA_SAMPLE_S24RE
enum PA_SAMPLE_S24RE;

Signed 24 Bit PCM, packed reverse endian. \since 0.9.15

PA_SAMPLE_S24_32BE
enum PA_SAMPLE_S24_32BE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_SAMPLE_S24_32LE
enum PA_SAMPLE_S24_32LE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_SAMPLE_S24_32NE
enum PA_SAMPLE_S24_32NE;

Signed 24 Bit PCM in LSB of 32 Bit words, native endian. \since 0.9.15

PA_SAMPLE_S24_32RE
enum PA_SAMPLE_S24_32RE;

Signed 24 Bit PCM, in LSB of 32 Bit words, reverse endian. \since 0.9.15

PA_SAMPLE_S32BE
enum PA_SAMPLE_S32BE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_SAMPLE_S32LE
enum PA_SAMPLE_S32LE;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.
PA_SAMPLE_S32NE
enum PA_SAMPLE_S32NE;

Signed 32 Bit PCM, native endian

PA_SAMPLE_S32RE
enum PA_SAMPLE_S32RE;

Signed 32 Bit PCM, reverse endian

PA_SAMPLE_SPEC_SNPRINT_MAX
enum PA_SAMPLE_SPEC_SNPRINT_MAX;

Maximum required string length for * pa_sample_spec_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.

PA_SAMPLE_U8
enum PA_SAMPLE_U8;

\cond fulldocs

PA_SAMPLE_ULAW
enum PA_SAMPLE_ULAW;
Undocumented in source but is binding to C. You might be able to learn more by searching the web for its name.

Structs

pa_sample_spec
struct pa_sample_spec

A sample format and attribute specification

Meta

Source

See Source File

pulse modules

Page generated by adrdox