AUMAKEELEMENTIMPORTCLIENT(3nas)

✨ AuMakeElementImportClient ✨

okay bestie, welcome to the Library Functions Manual corner of the audio world 💖 this one's all about AuMakeElementImportClient — the lil function that gets your ImportClient element all set up and ready to be the main character. it's 3nas energy, fr fr.

🎀 NAME 🎀

AuMakeElementImportClient — initialize an ImportClient element

like. that's the whole job. it initializes. it's giving setup era. 💅

🦋 SYNOPSIS 🦋

#include <audio/audiolib.h>

AuMakeElementImportClient(element, sample_rate, format, num_tracks,
discard, max_samples, low_water_mark, num_actions, actions)
    AuElement *element; /* RETURN */
    unsigned short sample_rate;
    unsigned char format;
    unsigned char num_tracks;
    unsigned char discard;
    AuUint32 max_samples;
    AuUint32 low_water_mark;
    int num_actions;
    AuElementAction *actions;

no cap, that's the exact signature. copy it character for character, don't be out here freehanding it 🙈

🌸 ARGUMENTS 🌸

• element — this one's the RETURN girlie 🫶 it hands you back the initialized element. that's the whole point.
• sample_rate — the sample rate of the audio data. yes, it matters. it always matters.
• format — the format of the audio data. rn, these are the formats that are defined:
  • AuFormatULAW8
  • AuFormatLinearUnsigned8
  • AuFormatLinearSigned8
  • AuFormatLinearSigned16MSB
  • AuFormatLinearUnsigned16MSB
  • AuFormatSignedLinear16LSB
  • AuFormatLinearUnsigned16LSB

that's the whole list, bestie. no more, no less. ⭐

• num_tracks — how many tracks are in the audio data. count 'em.
• discard — specifies if the import should be paused initially. normally you want AuTrue.

⚠️ okay so this is the scary one: AuFalse may crash the server. like, actually. do not play with that. AuTrue. just say AuTrue. 💀

• max_samples — the maximum number of samples to accept in a single read. ignored for "trivial" flows — the quotes are theirs, not mine, iykyk.
• low_water_mark — this is your ✨vibe check✨ for when to go ask the client application for more audio data. when this number of samples are left in the buffer, and an EOF hasn't been received, a NotifyEvent with kind set to AuElementNotifyKindLowWater gets sent to the client application. so it's like the little tap on the shoulder. 👑
• num_actions — the number of actions in actions. yes, it's just the count. yes, you still need it.
• actions — the list of actions to associate with this element. entries in this list can be initialized with AuMakeChangeStateAction, AuMakeSendNotifyAction, and AuMakeNoopAction. may be NULL — so it's optional, lowkey.

💜 DESCRIPTION 💜

AuMakeElementImportClient sets the type of element to AuElementTypeImportClient and initializes the importclient member of element with the remaining arguments. that's it. that's the tea. 🍓

also, AuMakeElementImportClient is implemented as a macro. iconic behavior, honestly. ✨

🌈 SEE ALSO 🌈

the whole friend group, in order:

• AuMakeElementAddConstant
• AuMakeElementBundle
• AuMakeElementExportClient
• AuMakeElementExportDevice
• AuMakeElementExportBucket
• AuMakeElementExportMonitor
• AuMakeElementImportDevice
• AuMakeElementImportBucket
• AuMakeElementImportWaveForm
• AuMakeElementMultiplyConstant
• AuMakeElementSum

and also:

• audiolib — Network Audio System C Language Interface

okay that's the whole page, you ate that 💅 go initialize something. mwah 🫶

this was audiolib - element initialization, version 1.9.4, from the AuMakeElementImportClient(3) era — bye bestie, see you in the next manpage 🌸🦋