Method

PwgStreamset_requested_format

since: 0.1

Declaration [src]

_Bool
pwg_stream_set_requested_format (
  PwgStream* self,
  const char* sample_format,
  unsigned int rate,
  unsigned int channels,
  GError** error
)

Description [src]

Sets the raw audio format requested when the stream is started.

The current data path supports F32 samples with mono or stereo channel layouts. The default requested format is F32, 48000 Hz, stereo. The format can only be changed while the stream is stopped.

Stability: Unstable

Available since: 0.1

Parameters

sample_format

Type: const char*

Requested sample format name.

The data is owned by the caller of the method.

The value is a NUL terminated UTF-8 string.

rate

Type: unsigned int

Requested sample rate in Hz.

channels

Type: unsigned int

Requested channel count.

error

Type: GError **

The return location for a recoverable error.

The argument can be NULL.

If the return location is not NULL, then you must initialize it to a NULL GError*.

The argument will be left initialized to NULL by the method if there are no errors.

In case of error, the argument will be set to a newly allocated GError; the caller will take ownership of the data, and be responsible for freeing it.

Return value

Type: _Bool

TRUE when the requested format was accepted.